List Directories

get/api/v1/beta/directories

Query parameters

project_idstring uuid nullable

organization_idstring uuid nullable

namestring nullable

type'user' | 'index' | 'ephemeral' nullable

include_deletedboolean

page_sizeinteger nullable

page_tokenstring nullable

Cookies

sessionstring nullable

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Changes

Changed in 10 of the 33 revisions of this API.712

Jun 9, 2026b17341164de92See the full diff
- ○
  added the optional property detail/items/ctx to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property detail/items/input to the response with the 422 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 27, 20261c29e1491a384See the full diff
- ○
  added the enum value ephemeral to the property anyOf[subschema #1]/ of the query request parameter type
  request-parameter-property-enum-value-added
- ○
  added the optional property items/items/expires_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/system_metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/type to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 23, 202634da5826db1c2See the full diff
- ●
  deleted the query request parameter data_source_id
  request-parameter-removed
- ●
  removed the optional property items/items/data_source_id from the response with the 200 status
  response-optional-property-removed
May 21, 2026fb63fb8d662c2See the full diff
- ○
  added the new optional query request parameter data_source_id
  new-optional-request-parameter
- ○
  added the optional property items/items/data_source_id to the response with the 200 status
  response-optional-property-added
This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 16, 2026c317ed7c691a2See the full diff
- ●
  deleted the query request parameter data_source_id
  request-parameter-removed
- ●
  removed the optional property items/items/data_source_id from the response with the 200 status
  response-optional-property-removed
May 14, 20261bbc901f8c0d2See the full diff
- ○
  added the new optional query request parameter data_source_id
  new-optional-request-parameter
- ○
  added the optional property items/items/data_source_id to the response with the 200 status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 12, 2026548a0c57fdd62See the full diff
- ●
  deleted the query request parameter data_source_id
  request-parameter-removed
- ●
  removed the optional property items/items/data_source_id from the response with the 200 status
  response-optional-property-removed
Apr 29, 2026beb65a9b42eb1See the full diff
- ○
  added the new optional query request parameter type
  new-optional-request-parameter
Apr 29, 2026456551b43e3e1See the full diff
- ●
  deleted the query request parameter type
  request-parameter-removed
Apr 24, 20261bbc901f8c0d1See the full diff
- ○
  added the new optional query request parameter type
  new-optional-request-parameter
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history