Ferndesk

Users

List help center users

Returns help center users for your organization. Use the optional email filter to look up a specific user before updating saved attributes.

GET /users

List help center users

curl --request GET \
  --url 'https://api.ferndesk.com/v1/users' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "items": [
    {
      "id": "<string>",
      "helpdeskId": "<string>",
      "email": "<email>",
      "name": "<string>",
      "emailVerified": true,
      "disabled": true,
      "attributes": {},
      "lastLoginAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

Paginated help center users

Authorizations

  • Authorization string required header

    All requests require a Bearer token in the Authorization header. API keys are prefixed with fdsk_ and should be kept secret. You can generate and manage keys from the Developer settings page.

Query Parameters

  • email string (email)

    Optional exact email filter. Matching is case-insensitive. Example: [email protected]

  • limit integer

    Maximum number of items to return (1-100). Example: 20

  • offset integer

    Number of items to skip before collecting results. Example: 0

Response

application/json
  • items[] object array

    Current page items. Help center user payload.

    + Show Child Attributes
    • id string

      Ferndesk help center user ID (hcusr_...).

    • helpdeskId string

      Ferndesk helpdesk ID (help_...).

    • email string (email)

      Help center user email address. Emails are stored lowercase.

    • name string | null

      Display name for the help center user.

    • emailVerified boolean

      Whether the email has been verified through a help center auth flow.

    • disabled boolean

      Whether the user is disabled. Disabled users cannot keep active sessions.

    • attributes object

      Saved user attributes used by user-group rules. Values may be strings, numbers, booleans, or arrays of one primitive type.

      + Show Child Attributes
      • [key: string] anyOf additional
        + Show Child Attributes
        • anyOf options 4 variants anyOf

          One or more options can apply.

          + Show Child Attributes
          • option 1 string | number | boolean
          • option 2 array
            + Show Child Attributes
            • items[] string array item
          • option 3 array
            + Show Child Attributes
            • items[] number array item
          • option 4 array
            + Show Child Attributes
            • items[] boolean array item
    • lastLoginAt string | null

      Most recent help center login timestamp, if any.

    • createdAt string

      ISO 8601 timestamp in UTC.

    • updatedAt string

      ISO 8601 timestamp in UTC.

  • limit integer

    Page size used for this response.

  • offset integer

    Number of skipped records for this page.

  • total integer

    Total matching records across all pages.