Sign in
Users

List Users

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Admins, Agents and Light Agents
get/api/v2/users

Query parameters

role'end-user' | 'agent' | 'admin'

Filters the results by role. Possible values are "end-user", "agent", or "admin"

role[]string

Filters the results by more than one role using the format role[]={role}&role[]={role}

permission_setinteger

For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request

external_idstring

List users by external id. External id has to be unique for each user under the same account.

page[size]integer

Number of records per page (required for cursor pagination)

page[after]string

Cursor for pagination (opaque string)

Response

Success response

Example response

{
  "users": [
    {
      "active": true,
      "alias": "Mr. Johnny",
      "created_at": "2009-07-20T22:55:29Z",
      "custom_role_id": 9373643,
      "details": "",
      "email": "johnny@example.com",
      "external_id": "sai989sur98w9",
      "iana_time_zone": "Pacific/Pago_Pago",
      "id": 35436,
      "last_login_at": "2011-05-05T10:38:52Z",
      "locale": "en-US",
      "locale_id": 1,
      "moderator": true,
      "name": "Johnny Agent",
      "notes": "Johnny is a nice guy!",
      "only_private_comments": false,
      "organization_id": 57542,
      "phone": "+15551234567",
      "photo": {
        "content_type": "image/png",
        "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic.png",
        "id": 928374,
        "name": "my_funny_profile_pic.png",
        "size": 166144,
        "thumbnails": [
          {
            "content_type": "image/png",
            "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",
            "id": 928375,
            "name": "my_funny_profile_pic_thumb.png",
            "size": 58298
          }
        ]
      },
      "restricted_agent": true,
      "role": "agent",
      "role_type": 0,
      "shared": false,
      "shared_agent": false,
      "signature": "Have a nice day, Johnny",
      "suspended": true,
      "tags": [
        "enterprise",
        "other_tag"
      ],
      "ticket_restriction": "assigned",
      "time_zone": "Copenhagen",
      "updated_at": "2011-05-05T10:38:52Z",
      "url": "https://company.zendesk.com/api/v2/users/35436.json",
      "user_fields": {
        "user_date": "2012-07-23T00:00:00Z",
        "user_decimal": 5.1,
        "user_dropdown": "option_1"
      },
      "verified": true
    }
  ]
}

Changes