Get a list of invitations for a role

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
  "invitations": [
    {
      "id": 159323,
      "email": "ceo@company.com"
    },
    {
      "id": 782942,
      "email": "good.employee@company.com"
    },
    {
      "id": 782312,
      "email": "other.employee@company.com"
    }
  ]
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String