Skip to main content
GET
/
api
/
v1
/
directory_members
/
{member_id}
/
history
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.directoryMemberHistory({
    memberId: 371893,
  });

  console.log(result);
}

run();
{
  "items": [
    {
      "directory_member_id": 123,
      "version": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "<string>",
      "user_email": "<string>",
      "extensions": [
        {
          "name": "<string>",
          "numbers": [
            {
              "number": "<string>",
              "rules": [
                {
                  "language": "en"
                }
              ]
            }
          ]
        }
      ],
      "contact_tags": {},
      "comments": "Updated phone number",
      "operation": "update"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

​
Syllable-API-Key
string
header
required

Path Parameters

​
member_id
integer
required

Query Parameters

​
page
integer
default:0

Page number (0-based)

Required range: x >= 0
​
limit
integer
default:25

Items per page

Required range: 1 <= x <= 100
​
order_by_direction
enum<string>
default:asc

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

Available options:
asc,
desc
​
response_format
enum<string>
default:normalized

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

Available options:
normalized,
raw

Response

Successful Response

​
items
DirectoryMemberHistoryResponse · object[]
required

List of items returned from the query

​
page
integer
required

The page number of the results (0-based)

Example:

0

​
page_size
integer
required

The number of items returned per page

Example:

25

​
total_pages
integer | null

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

Example:

4

​
total_count
integer | null

The total number of items returned from the query

Example:

100