Download Directory Members

Download the entire directory as a JSON file.

GET /api/v1/directory_members/download

Python (SDK)

Python

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_download()

    # Handle response
    print(res)

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

Response

200

application/json

Directory downloaded successfully