Get a list of users in your account

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)
users: [
  {
    "id": 8192,
    "first_name": "Valerie",
    "last_name": "Vyne",
    "email": "valerie@company.com",
    "created_at": 1374261385,
    "updated_at": 1374261385,
    "last_sign_in_at": 1374261399
  },
  {
    "id": 8193,
    "first_name": "Valerie",
    "last_name": "Vbot",
    "email": "valerie.vbot@company.com",
    "created_at": 1374261385,
    "updated_at": 1374261385,
    "last_sign_in_at": 1374261399
  },
],
summary: {
  page: 1,
  per_page: 20,
  count: 28
}

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

team_id
optional

Filter the list of users to a specific team

Validations:

  • Parameter has to be Integer.

team_ids
optional

Filters the list of users to teams specified in this list

Validations:

  • Must be an array of any type

invite_accepted_only
optional

Filter the list of users to only those who have accepted their invite

Validations:

  • Parameter has to be Boolean.

include
optional

Include each user’s team membership to your account in the response

Validations:

  • Must be an array of any type


Metadata:
--- team_memberships