Sign in

v1

latestOpenAPI 3.0.12026-08-064278250.7 KB
workspaces

Search for a workspace

This endpoint can be used to search for a workspace which you have access to. The workspace header defines the parent workspace to search below.

get/v1/workspaces/search

Query parameters

pagestring

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

pageSizestring

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

searchstring

Filter by id, display name, company name and domain. This is not case sensitive.

Filter by id, display name, company name and domain. This is not case sensitive.

Headers

Workspacestring required

The workspace identifier, which isolates API requests inside the provided workspace scope.

Response

Success

totalElementsinteger

The total number of records that exist for the request.

Example response

{
  "items": [
    {
      "id": "corodevonmicrosoftcom_EZ90_b",
      "companyName": "Company Name",
      "displayName": "Child workspace",
      "type": "child",
      "domain": "child-workspace.com",
      "maxProtectedUsers": 25,
      "overCapacityAllowance": 0.1,
      "maxDevicesLimit": 25,
      "limited": true,
      "notificationsLevel": "none",
      "parentWorkspaceId": "coroparent_123",
      "lastAdminLoginTime": 1693562400000,
      "workspaceCreationTime": 1641009600000,
      "workspaceCreationType": "direct"
    }
  ]
}