ASasksyllable
users
V1

List Users

Changed on

List the existing users.

get/api/v1/users/

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/users/
  • Auth
    API key in header Syllable-API-Key

Query parameters

pageinteger nullable

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25
search_fieldsUserProperties[]

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'email' | 'first_name' | 'last_name' | 'role_id' | 'role_name' | 'email_first_name_last_name' | 'activity_status' | 'last_updated'

Names of user fields supported for filtering/sorting on list endpoint.

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsUserProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z
end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "email": "user@syllable.ai",
      "first_name": "Jane",
      "last_name": "Smith",
      "role_id": 1,
      "last_updated_comments": "Updated to change which role was assigned",
      "id": 1,
      "role_name": "Admin",
      "email_sent": true,
      "last_updated_by": "admin@email.com",
      "last_session_at": "2025-01-01T12:00:00Z"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes