Retrieve users

Retrieve a list of users in a workspace. This call supports pagination; default page size includes 20 users.

SecurityJWT
Request
query Parameters
email
string

Filter by a user’s email address. This is not case sensitive.

name
string

Filter by a user’s name. This is not case sensitive.

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
header Parameters
Workspace
required
string

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

Example: corodevonmicrosoftcom_TX7T_u
Responses
200

Success

400

Bad request, validation error

401

Unauthorized request

403

Access forbidden

429

Too Many Requests

500

Internal server error

get/v1/users
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "totalElements": 0
}