Fetch workspaces

A GET request to the /workspaces endpoint retrieves a paginated list of workspaces belonging to your organization, including each workspace's uuid.

Note that the workspaceUuid required to address a workspace in certain v2 endpoints is returned in the response body of this endpoint.

Request URL

get https://api.plan.routific.com/v2/workspaces

Request Payload

//none

Sample Response Payload

{
  "items": [
    {
      "uuid": "0b0e4bcf-PLACEHOLDER-uuid",
      "id": 42,
      "name": "Vancouver AM"
    }
  ],
  "nextCursor": "aWQ6MTA5OTc5NA"
}

Here's a description of payload attributes returned in the response:

Fields	Type	Description
uuid	String	Unique identifier of the workspace. Use this to address the workspace on all endpoints that require a `workspaceUuid`.
id	Integer	The numeric workspace ID, used by endpoints on the v1 of the API.
name	String	Name of the workspace, as shown in the Routific UI.
nextCursor	String	Optional. Pass the `nextCursor` value returned from a previous response to fetch the next page. If nextCursor value returned is `null`, there are no more Workspaces in the list.