Beta
Directories

List Directories

Changed on
get/api/v1/beta/directories

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

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

  • b17341164de9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 1c29e1491a38Revision changes
    • info

      added the enum value ephemeral to the property anyOf[subschema #1]/ of the query request parameter type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status