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();
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

res = ss_client.directory.directory_member_history(member_id=371893, page=0, limit=25)

# Handle response
print(res)
curl --request GET \
--url https://api.syllable.cloud/api/v1/directory_members/{member_id}/history \
--header 'Syllable-API-Key: <api-key>'
const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};

fetch('https://api.syllable.cloud/api/v1/directory_members/{member_id}/history', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.syllable.cloud/api/v1/directory_members/{member_id}/history",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Syllable-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.syllable.cloud/api/v1/directory_members/{member_id}/history"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Syllable-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.syllable.cloud/api/v1/directory_members/{member_id}/history")
.header("Syllable-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/directory_members/{member_id}/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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