API Reference
API Reference

Directory Member List

List the directory_members

GET/api/v1/directory_members/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

include_deleted boolean query optional

If true, include soft-deleted members in the list. Default excludes them.

Default falseExample false
response_format enum<string> query optional

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

Allowed values ["normalized","raw"]Default normalizedExample normalized
page integer | null query optional

Page number (0-based)

Default 0Minimum 0Example 0
limit integer query optional

Items per page

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

Fields to search; aligns with search_field_values

Default []Example []
Item schema
itemsenum<string>required
Allowed values ["id","name","name_exact","type","extensions","contact_tags","created_at","updated_at","deleted_at","created_by"]
search_field_values string[] query optional

Values for search_fields in matching order

Default []Example []
Item schema
itemsstringrequired
order_by enum<string> | null query optional

Field to order results by

Allowed values ["id","name","name_exact","type","extensions","contact_tags","created_at","updated_at","deleted_at","created_by"]
order_by_direction enum<string> | null query optional

Direction to order results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

Fields to include in response

Default []Example []
Item schema
itemsenum<string>required
Allowed values ["id","name","name_exact","type","extensions","contact_tags","created_at","updated_at","deleted_at","created_by"]
start_datetime string | null query optional

Start datetime for filtering results

end_datetime string | null query optional

End datetime for filtering results

Responses

200Successful Response

application/json

response ListResponse_DirectoryMember_ required
5 fields
itemsDirectoryMember[]required

List of items returned from the query

Item schema
itemsDirectoryMemberrequired

Model for a directory member (i.e. a contact).

11 fields
namestringrequired

Name of the directory member

typestringrequired

Type of the directory member

extensionsDirectoryExtension[] | nulloptional

List of extensions for the directory member

Item schema
itemsDirectoryExtensionrequired
2 fields
namestringrequired

Directory extension name

numbersDirectoryExtensionNumber[] | nulloptional

Directory extension numbers.

Item schema
itemsDirectoryExtensionNumberrequired
3 fields
numberstringrequired

Phone number or SIP URI

rulesobject[] | nulloptional

Directory extension number rules. To include a language rule, use key "language" with a language code value.

Item schema
itemsobjectrequired
1 field
{key}stringoptional
sip_transfer_modeenum<string> | nulloptional

How to perform the SIP transfer, INVITE or REFER.

Allowed values ["refer","invite"]
contact_tagsobject | nulloptional

Tags for the directory member

1 options
{key}string[]optional
Item schema
itemsstringrequired
commentsstring | nulloptional

The comments for the most recent edit to the directory member

idintegerrequired

Internal ID of the directory member

created_atstring (date-time)required

When the contact was created

updated_atstring (date-time)required

Timestamp of most recent update

deleted_atstring (date-time) | nulloptional

When the contact was deleted, if deleted

last_updated_bystring | nulloptional

Email of the user who last updated the directory member

created_bystring | nulloptional

Email of the user who created the directory member

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

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

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "name": "string",
      "type": "string",
      "extensions": "string",
      "contact_tags": "string",
      "comments": "string",
      "id": 0,
      "created_at": "string",
      "updated_at": "string",
      "deleted_at": "string",
      "last_updated_by": "string",
      "created_by": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}