API Reference
API Reference

Get Directory Member History

Get version history for a directory member (contact). Version 1 is always the oldest; order_by_direction only controls response order.

GET/api/v1/directory_members/{member_id}/history

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

Path parameters

member_id integer path required

Query parameters

page integer query optional

Page number (0-based)

Default 0Minimum 0Example 0
limit integer query optional

Items per page

Default 25Minimum 1Maximum 100Example 25
order_by_direction enum<string> query optional

Sort by oldest first (asc) or newest first (desc). Version 1 is always the oldest.

Allowed values ["asc","desc"]Default ascExample asc
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

Responses

200Successful Response

application/json

response ListResponse_DirectoryMemberHistoryResponse_ required
5 fields
itemsDirectoryMemberHistoryResponse[]required

List of items returned from the query

Item schema
itemsDirectoryMemberHistoryResponserequired

API response for one version in a directory member's history (GET /{member_id}/history).

10 fields
directory_member_idintegerrequired

ID of the directory member

versionintegerrequired

1-based ordinal in the history list (1 = oldest)

timestampstring (date-time)required

When this version was recorded

namestringrequired

Name at this version

typestringrequired

Type at this version

extensionsDirectoryExtension[]optional

Extensions at this version

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_tagsobjectoptional

Contact tags at this version

1 field
{key}string[]optional
Item schema
itemsstringrequired
user_emailstringrequired

User who made the change

commentsstring | nulloptional

Optional comment for this version

operationstring | nulloptional

What produced this row: create, update, delete, restore, bulk_load. Null for rows created before this field existed.

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": [
    {
      "directory_member_id": 0,
      "version": 0,
      "timestamp": "string",
      "name": "string",
      "type": "string",
      "extensions": [
        {
          "name": "string",
          "numbers": "string"
        }
      ],
      "contact_tags": "string",
      "user_email": "string",
      "comments": "string",
      "operation": "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"
    }
  ]
}