latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

workspaces

Sorted lists all User's Workspaces with possibility to search

User has to be a member of the Workspaces. In context of tenant admin or with permission contract.list_all workspaces where you are a member will be bellow

get/workspaces/all/list

Query parameters

contract_idstring required

Contract identifier

page[size]integer

Amount of items per page

page[number]integer

Number of page you want to display

searchstring

Search query

isMembertrue

allow to filter own workspaces for users with for tenant admin role or with 'contract.list_all' permission

Response

Example response

{
  "data": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/workspaces/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "name": "Workspace Name",
        "flow_stats_enabled_default": true
      },
      "relationships": {
        "contract": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          },
          "links": {
            "self": "/v2/contracts/5b4f337bff4304610483ba67"
          }
        },
        "members": {
          "data": [
            {
              "id": "5b4f337bff4304610483ba67"
            }
          ],
          "links": {
            "self": "/v2/workspaces/5b4f337bff4304610483ba67/members"
          }
        }
      }
    }
  ],
  "meta": {
    "total": 6,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  },
  "links": {
    "self": "/v2/workspaces"
  }
}