Authentication

Authenticaiton to the Gaggle Mail API is by an x-api-key request header. You can request an API key for your My Profile page and include it in all your requests.

To perform any operation on a group the API key must belong to an administrator of that group. Equally, to perform any API operation on an Organization the API key must belong to an Organization administrator.

x-api-key: <my-api-key>

Authentication Errors

Missing API key

{
  'message': 'No API key found.'
}

Expired or invalid API key

{
  'message': 'Invalid api key.'
}