workspaces

List Workspaces

Changed on

Get all workspaces visible to this auth in the current org. Does not create a new workspace/org.

get/api/v1/workspaces

Request

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

Query parameters

include_deletedboolean
data_plane_idstring uuid nullable

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

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

  • a0acb3a6a101Revision changes
    • info

      added the new optional query request parameter data_plane_id