v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Workspace

Get workspaces

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

get/workspaces

Query parameters

offsetinteger
limitinteger
sortstring

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

  • name
filter[name]string

Filter workspaces by the workspace name.

filter[id]string

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

filter[workspace_admin]'true' | 'false'

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.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email

The email address of a registered Oneflow user.

Response

Returns the list of workspaces.

countinteger required