Get a Workspace

This endpoint allows you to retrieve a workspace along with its relations (members and collections). It is restricted to admin and company admin users.

GET /api/v2/workspaces/{id}

Try it

Get a Workspace

cURL

curl --request GET \
  --url https://paradigm.lighton.ai/api/v2/workspaces/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 123,
  "name": "<string>",
  "workspace_type": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "summaries": [
    {
      "language": "en",
      "summary": "<string>"
    }
  ],
  "collections": [
    {
      "id": 123,
      "name": "<string>",
      "collection_type": "<string>"
    }
  ],
  "members": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer token authentication

Path Parameters

id · integer · required

The unique identifier of the workspace.

Response

200

application/json

Successful response

id · integer · required

name · string · required

workspace_type · string · required

description · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

summaries · object[] · required

Show child attributes

summaries. language · enum<string> · required

Language of the summary.

• en - English
• fr - French
• es - Spanish
• it - Italian
• ar - Arabic
• nl - Dutch
• sv - Swedish
• de - German
• ja - Japanese
• zh - Chinese
• ko - Korean

Available options: en, fr, es, it, ar, nl, sv, de, ja, zh, ko

summaries. summary · string · required

Summary of the workspace.

collections · object[] · required

Show child attributes

collections. id · integer · required

collections. name · string · required

collections. collection_type · string · required

members · object[] · required

Show child attributes

members. id · integer · required

members. first_name · string · required

members. last_name · string · required

members. email · string · required