Get workspaces

get

https://{hostname}/v1/workspaces

Use this endpoint to retrieve the list of workspaces available for the specified user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

offset

integer

0 to 19900

Defaults to 0

limit

integer

1 to 100

Defaults to 100

sort

string

A comma-separated list of columns by which results are sorted. Valid columns:

name

filter[name]

string

length ≤ 30

Filter workspaces by the workspace name.

filter[id]

string

length ≤ 200

Retrieve specific workspaces by providing a comma-separated list of workspaces IDs.

filter[workspace_admin]

string

enum

Filter workspaces based on the workspace admin privilege. When the workspace_admin filter is set to true and the user has workspace admin privilege, all workspaces within the account are returned, otherwise, only workspaces accessible to the user are returned.

Allowed:

Headers

x-oneflow-api-token

string

required

length between 40 and 40

The API key of your Oneflow account.

x-oneflow-user-email

string

The email address of a registered Oneflow user.

Responses

400

Invalid format or content of the request.

401

The API token or the user email is invalid.

403

The request is not authorized by the server.

Language

URL

Loading…

Response

Choose an example:

application/json

200Returns the list of workspaces.