ASasksyllable
directory

Directory Member List

Changed on

List directory members.

Filter by contact tags with tags.<key>=<value>. Values use case-insensitive literal substring matching within the selected key. Repeat a key to match any supplied value; filters for different keys must all match. Unknown keys and empty values return no matches.

get/api/v1/directory_members/

Request

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

Query parameters

include_deletedboolean

If true, include soft-deleted members in the list. Default excludes them. Ignored when status is explicitly supplied.

status'all' | 'active' | 'deleted'

Filter contacts by deletion status: all includes active and deleted contacts; active excludes deleted contacts; deleted includes only deleted contacts. When supplied, overrides include_deleted. When omitted, include_deleted controls inclusion.

response_format'normalized' | 'raw'

Response shape selector for directory member APIs.

Directory response format: normalized (default) strips @hours and formats times; raw returns stored @hours values.

pageinteger nullable

Page number (0-based)

limitinteger

Items per page

search_fieldsDirectoryMemberProperties[]

Fields to search; aligns with search_field_values

search_field_valuesstring[]

Values for search_fields in matching order

order_by'id' | 'name' | 'name_exact' | 'type' | 'extensions' | 'contact_tags' | 'created_at' | 'updated_at' | 'deleted_at' | 'created_by'

Field to order results by

order_by_direction'asc' | 'desc'

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

Direction to order results

fieldsDirectoryMemberProperties[] nullable

Fields to include in response

start_datetimestring nullable

Start datetime for filtering results

end_datetimestring nullable

End datetime for filtering results

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": [
    {
      "name": "Jane Doe",
      "type": "Operator",
      "extensions": [
        {
          "name": "work",
          "numbers": [
            {
              "number": "+1234567890",
              "rules": [
                {
                  "language": "en"
                }
              ]
            }
          ]
        }
      ],
      "contact_tags": {
        "tag1": [
          "value1"
        ],
        "tag2": [
          "value2"
        ]
      },
      "comments": "Updated to add new extension",
      "id": 1,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "last_updated_by": "user@email.com",
      "created_by": "user@email.com"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes