GET
/
api
/
v1
/
directory_members
curl --request GET \
  --url https://api.syllable.cloud/api/v1/directory_members/ \
  --header 'Syllable-API-Key: <api-key>'
{
  "items": [
    {
      "name": "Jane Doe",
      "type": "contact",
      "extensions": [
        {
          "name": "work",
          "numbers": [
            {
              "number": "+1234567890",
              "rules": [
                {
                  "language": "en"
                }
              ]
            }
          ]
        }
      ],
      "contact_tags": {},
      "updated_at": "2023-11-07T05:31:56Z",
      "last_updated_by": "<string>",
      "id": 1
    }
  ],
  "page": 0,
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

​
Syllable-API-Key
string
header
required

Query Parameters

​
page
integer | null
default:0

The page number from which to start (0-based)

Required range: x >= 0
Examples:

0

​
limit
integer
default:25

The maximum number of items to return

Required range: x >= 0
Examples:

25

​
search_fields
enum<string>[]

String names of fields to search. Correspond by index to search field values

Examples:

"name"

​
search_field_values
string[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Examples:

"Some Object Name"

​
order_by
enum<string> | null

The field whose value should be used to order the results

Available options:
id,
name,
type,
extensions,
contact_tags,
updated_at
Examples:

"name"

​
order_by_direction
enum<string> | null

The direction in which to order the results

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

The fields to include in the response

​
start_datetime
string | null

The start datetime for filtering results

Examples:

"2023-01-01T00:00:00Z"

​
end_datetime
string | null

The end datetime for filtering results

Examples:

"2024-01-01T00:00:00Z"

Response

200
application/json

Successful Response

The response is of type object.