Skip to main content
GET
List workspaces

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"