API Reference

Get existing workspaces

get
https://app.{clusterId}.lightup.ai/api//workspaces/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required
Defaults to v1

An enumeration.

Allowed:
Query Params
string
enum
Defaults to false

Set value to 'true' to include deactivated workspaces in the response. Omit this parameter to exclude

Allowed:
string
enum
Defaults to false

Set value to 'true' to exclude workspaces where requestor isn't a member. Has no effect unless requestor is an App Admin, as all other users always only see workspaces where they are members.

Allowed:
string

Filter workspaces by name. Case sensitive. Exact match.

Headers
string
required

Input 'Bearer access-token'. To obtain access token, see API, API Credentials: Get access token.

Response

Updated 7 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago