workspaces

Get Workspace

Changed on

Get a single workspace by ID, scoped to the current org and identity.

get/api/v1/workspaces/{workspace_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/workspaces/{workspace_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Organization-Id
    • or HTTP bearer

Path parameters

workspace_idstring uuid required

Query parameters

include_deletedboolean

Also return the workspace if it has been deleted.

data_plane_idstring uuid nullable

Accepted only from a data plane service; other callers get 403.

Response

Successful Response

idstring uuid required
organization_idstring uuid nullable
created_atstring date-time required
display_namestring required
is_personalboolean required
is_deletedboolean required
tenant_handlestring nullable
data_plane_urlstring nullable
read_onlyboolean
role_idstring uuid nullable
role_namestring nullable
permissionsstring[] nullable

Changes