List help center users

Returns your help center users, newest first.

GET /v1/users

Bearer token scope content:write

curl 'https://api.ferndesk.com/v1/users?start_cursor=eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ&page_size=20&email=alice%40example.com' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "results": [
    {
      "id": "hcusr_01JXYB3S2Y8C",
      "helpdeskId": "help_01JXYA7B3T7G",
      "email": "[email protected]",
      "name": "Alice Example",
      "emailVerified": true,
      "disabled": false,
      "attributes": {
        "plan": "enterprise",
        "role": "admin",
        "beta": true,
        "seats": 25,
        "groups": [
          "beta",
          "internal"
        ],
        "availableFrameworks.csrd": true
      },
      "lastLoginAt": "2026-01-15T18:25:43.511Z",
      "createdAt": "2026-01-15T18:25:43.511Z",
      "updatedAt": "2026-01-15T18:25:43.511Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ"
}

Cursor-paginated help center users

Query parameters

· 3

start_cursor string

Opaque cursor taken from the previous response’s next_cursor.

page_size integer · min: 1· max: 100· default: 20

Items per page.

email string · email · pattern

Exact address to look up, matched case-insensitively.

Query parameters

Responses