---
title: "Directory Member List"
method: GET
path: "/api/v1/directory_members/"
tags: ["directory"]
---

# Directory Member List

`GET /api/v1/directory_members/`

List the directory_members

## Query parameters

- `include_deleted` boolean — If true, include soft-deleted members in the list. Default excludes them.
- `response_format` 'normalized' | 'raw' — Response shape selector for directory member APIs.
- `page` integer, nullable — Page number (0-based)
- `limit` integer — Items per page
- `search_fields` DirectoryMemberProperties[] — Fields to search; aligns with search_field_values
- `search_field_values` string[] — Values for search_fields in matching order
- `order_by` 'id' | 'name' | 'name_exact' | 'type' | 'extensions' | 'contact_tags' | 'created_at' | 'updated_at' | 'deleted_at' | 'created_by'
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` DirectoryMemberProperties[], nullable — Fields to include in response
- `start_datetime` string, nullable — Start datetime for filtering results
- `end_datetime` string, nullable — End datetime for filtering results

## Response `200`

Successful Response

- ListResponseDirectoryMember
  - `items` DirectoryMember[], required — List of items returned from the query
    - `name` string, required — Name of the directory member
    - `type` string, required — Type of the directory member
    - `extensions` DirectoryExtension[], nullable — List of extensions for the directory member
      - `name` string, required — Directory extension name
      - `numbers` DirectoryExtensionNumber[], nullable — Directory extension numbers.
        - `number` string, required — Phone number or SIP URI
        - `rules` object[], nullable — Directory extension number rules. To include a language rule, use key "language" with a language code value.
    - `contact_tags` object, nullable — Tags for the directory member
    - `comments` string, nullable — The comments for the most recent edit to the directory member
    - `id` integer, required — Internal ID of the directory member
    - `created_at` string, date-time, required — When the contact was created
    - `updated_at` string, date-time, required — Timestamp of most recent update
    - `deleted_at` string, date-time, nullable — When the contact was deleted, if deleted
    - `last_updated_by` string, nullable — Email of the user who last updated the directory member
    - `created_by` string, nullable — Email of the user who created the directory member
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/versions/ac3228f980bb/schema)