v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
beta.admin.users

Get Users

List Organization members and pending invitations.

get/v1/admin/users

Query parameters

pageinteger

Page number to return.

Page number to return.

page_sizeinteger

Maximum number of results per page.

Maximum number of results per page.

emailstring nullable

Email address to filter users and invitations.

Example:alice.martin@example.com

Email address to filter users and invitations.

Response

OK

totalinteger nullable required

Total number of users and invitations that match the request.

pageinteger nullable required

Page number returned.

page_sizeinteger nullable required

Maximum number of results per page.

Example response

{
  "members": [
    {
      "name": "Alice Martin",
      "email": "alice.martin@example.com",
      "workspaces": [
        {
          "name": "Product Team"
        }
      ]
    }
  ],
  "invites": [
    {
      "email": "alice.martin@example.com"
    }
  ]
}