Skip to main content
GET
/
api
/
v1
/
directory_members
Python (SDK)
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.list(limit=25)

    # Handle response
    print(res)
{
  "items": [
    {
      "name": "<string>",
      "type": "<string>",
      "id": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "extensions": [
        {
          "name": "work",
          "numbers": [
            {
              "number": "+1234567890",
              "rules": [
                {
                  "language": "en"
                }
              ]
            }
          ]
        }
      ],
      "contact_tags": {
        "tag1": [
          "value1"
        ],
        "tag2": [
          "value2"
        ]
      },
      "last_updated_by": "[email protected]"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

​
Syllable-API-Key
string
header
required

Query Parameters

​
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
​
page
integer | null
default:0

Page number (0-based)

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

Items per page

Required range: x >= 0
​
search_fields
enum<string>[]

Fields to search; aligns with search_field_values

Available options:
id,
name,
name_exact,
type,
extensions,
contact_tags,
updated_at
​
search_field_values
string[]

Values for search_fields in matching order

​
order_by
enum<string> | null

Field to order results by

Available options:
id,
name,
name_exact,
type,
extensions,
contact_tags,
updated_at
​
order_by_direction
enum<string> | null

Direction to order results

Available options:
asc,
desc
​
fields
enum<string>[] | null

Fields to include in response

Available options:
id,
name,
name_exact,
type,
extensions,
contact_tags,
updated_at
​
start_datetime
string | null

Start datetime for filtering results

​
end_datetime
string | null

End datetime for filtering results

Response

Successful Response

​
items
DirectoryMember · 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