Workspaces (v5)

Get Workspaces

List all workspaces for the logged-in user with pagination

get/v5/workspaces

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/v5/workspaces
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Query parameters

direction'older' | 'newer'
limitnumber

Number of items to return (min: 1, max: 100)

datestring

Anchor timestamp to start from. Uses updated_at. Ignored when starting_after/ending_before is provided.

starting_afterstring

Cursor to fetch the next page (use value from next_cursor).

ending_beforestring

Cursor to fetch the previous page (use value from previous_cursor).

rolesRole[]

List of roles that logged user must have to list workspaces. Defaults to all roles. Can be passed as repeated parameters: roles=admin&roles=guest

typesWorkspaceType[]

List of workspace types to filter by. Can be passed as repeated parameters: types=standard&types=webcontact

include_totalboolean

Whether to include the total count in the response. Defaults to false for better performance.

Response

next_cursorstring nullable

Cursor to fetch the next page

has_moreboolean required

Whether there are more items to fetch

totalnumber nullable

Total number of workspaces (filtered by the query). Only included when include_total=true is provided in the query.

Changes

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