Sign in
Organization Group

Retrieve queue

Get queue for an organization group object. Returned object contains subset of queue 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}/queues/{queueID}

Path parameters

organizationGroupIDinteger required

A unique integer value identifying organization group.

queueIDinteger required

A unique integer value identifying this queue.

Response

OK

idinteger

ID of the queue.

urlstring uri

Membership URL of the queue.

namestring

Name of the queue.

organizationstring uri

Membership URL of the organization.

workspacestring uri

Membership URL of the workspace.

Example response

{
  "id": 654,
  "url": "https://example.rossum.app/api/v1/organization_groups/42/queues/654",
  "name": "Received invoices",
  "organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/321",
  "workspace": "https://example.rossum.app/api/v1/organization_groups/42/workspaces/12"
}

Changes

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