List workspaces

Get a list of workspaces a user is a part of.

GET

/ v1 / workspaces

Authorization

X-API-Key

string

required

Header with the name X-API-Key where the value is your API key.

Query parameters

cursor

string

Use if a previous request returned a cursor. Will page through results.
ids

array<string>

Expand details of specific workspaces, instead of getting all of them.

Response

200 - application/json - object

meta

object

required

Contains the nextCursor, if one exists, along with the pageSize.
- nextCursor
  
  string
  
  Make the same query with the new cursor to get more results.
- pageSize
  
  number
  
  The number of results in this response.
workspaces

array<object>

required

An array of workspace objects.
- id
  
  string
  
  required
  
  The ID of the workspace.
- name
  
  string
  
  required
  
  The name of the workspace.
- teamId
  
  string
  
  required
  
  The ID of the team.
- type
  
  string
  
  required
  
  Whether the workspace is a team or individual type.
- labels
  
  array<object>
  
  required
  
  An array of labels.
  name
  
  string
  
  The name of the label.
- statuses
  
  array<object>
  
  required
  
  An array of statuses for the workspace.
  name
  
  string
  
  The name of the status.
  
  isDefaultStatus
  
  boolean
  
  Whether this status is a default status for the workspace.
  
  isResolvedStatus
  
  boolean
  
  Whether this is a resolved (terminated) status for the workspace.