Sign in
Workspace

List workspaces

Retrieve all workspace objects.

get/api/v1/workspaces

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

namestring

Name of the workspace filter

organizationinteger

ID of an organization to filter workspaces by

ordering'id' | '-id' | 'name' | '-name'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 7540,
      "name": "East West Trading Co",
      "url": "https://example.rossum.app/api/v1/workspaces/7540",
      "autopilot": true,
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "queues": [
        "https://example.rossum.app/api/v1/queues/8199",
        "https://example.rossum.app/api/v1/queues/8236"
      ],
      "metadata": {
        "some_key": "some_value"
      },
      "created_by": "https://example.rossum.app/api/v1/users/10775",
      "created_at": "2021-04-26T10:08:03.856648Z",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.