List all directories | Clerk API (unofficial showcase)

2 parameters

limitintegeroptional

Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.

Default:10

offsetintegeroptional

Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.

Default:0

3 status codes

200A list of directories

dataarray<object>required

total_countintegerrequired

Total number of directories.

401Authentication invalid

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

403Authorization invalid

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

Error handling

A 401 is returned: Authentication invalid. A 403 is returned: Authorization invalid.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.directories.list({
  limit: 20,
  offset: 0,
});

{
  "data": [
    {
      "object": "directory",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "enterprise_connection_id": "550e8400-e29b-41d4-a716-446655440000",
      "endpoint_url": "https://example.com",
      "provider": "Example Academy Trust",
      "enabled": true,
      "group_role_mapping_enabled": true,
      "custom_attributes": [
        {
          "name": "Example Name",
          "key": "example_key_abc123",
          "sso_path": "example_value",
          "scim_path": "example_value",
          "directory_path": "example_value",
          "multi_valued": true
        }
      ],
      "api_key": "example_key_abc123",
      "created_at": 1,
      "updated_at": "2026-01-15T09:00:00Z"
    }
  ],
  "total_count": 42
}

Request

Response

Errors