Skip to main content
GET
Get users

Authorizations

x-api-key
string
header
required

Query Parameters

page
string
default:1

Page number for pagination. Minimum value is 1. Defaults to 1.

pageSize
string
default:25

Number of users per page. Minimum is 1, maximum is 100. Defaults to 25.

Case-insensitive match on the user name or email.

role
enum<string>

Only workspace admins (admin) or only the other members (member).

Available options:
admin,
member

Response

Users retrieved successfully

data
object[]
required
meta
object
required