Skip to main content
GET
/
api
/
v3
/
workspaces
List workspaces
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/workspaces \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "workspace_type": "<string>",
      "document_upload_method": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_role": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lighton.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
document_upload_method
enum<string>

Method for adding documents to this workspace: manual uploads or synced from datasources

  • manual - Manual
  • synced - Synced
Available options:
manual,
synced
​
group_id
integer
​
group_name
string
​
name
string
​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
user_role
enum<string>
  • owner - Owner
  • editor - Editor
  • viewer - Viewer
Available options:
editor,
owner,
viewer
​
workspace_type
enum<string>
  • company - Company
  • personal - Personal
  • custom - Custom
Available options:
company,
custom,
personal

Response

List of workspaces where the user is a member

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"