Sign in
Organization Group

List organization group workspaces

Get workspaces for an organization group object. Returned objects contain subset of workspace attributes.

<Callout type="info"> The endpoint provides read-only view for users with the `organization_group_admin` role for managing memberships. </Callout>
get/api/v1/organization_groups/{organizationGroupID}/workspaces

Path parameters

organizationGroupIDinteger required

A unique integer value identifying organization group.

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.

organizationinteger

Filter workspaces by organization

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

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 345,
      "url": "https://example.rossum.app/api/v1/organization_groups/42/workspaces/345",
      "name": "East West Trading Co",
      "organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/123",
      "queues": [
        "https://example.rossum.app/api/v1/organization_groups/42/queues/1",
        "https://example.rossum.app/api/v1/organization_groups/42/queues/2"
      ]
    }
  ]
}

Changes

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