Sign in
Beta
Directories

Get Directory

Changed on

Retrieve a directory by its identifier.

get/api/v1/beta/directories/{directory_id}

Request

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

Path parameters

directory_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring required

Unique identifier for the directory.

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project the directory belongs to.

namestring required

Human-readable name for the directory.

descriptionstring nullable

Optional description shown to users.

data_source_idstring nullable

Optional data source id the directory syncs from. Null if just manual uploads.

deleted_atstring date-time nullable

Optional timestamp of when the directory was deleted. Null if not deleted.

Changes