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.

SecurityJWT
Request
query Parameters
page
string >= 0
Default: "0"

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

Example: page=0
pageSize
string [ 10 .. 500 ]
Default: "20"

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

Example: pageSize=50
search
string

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

header Parameters
Workspace
required
string

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

Example: corodevonmicrosoftcom_TX7T_u
Responses
400

Bad request, validation error

401

Unauthorized request

403

Access forbidden

429

Too Many Requests

500

Internal server error

get/v1/workspaces/search
Request samples 
Response samples 
application/problem+json
{
  • "status": 400,
  • "title": "Bad request",
  • "errors": [
    ],
  • "timestamp": "2022-08-21T19:44:32.351Z",
  • "traceId": "a029fd656529d7dc"
}