Skip to main content
GET
/
api
/
users
Error
A valid request URL is required to generate request examples
{
  "users": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "role_id": 123,
      "role": {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "is_system_role": true
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "teams": [
        {
          "id": "<string>",
          "name": "<string>",
          "business_unit_id": "<string>",
          "business_unit_name": "<string>"
        }
      ],
      "access_profile": {
        "id": 123,
        "user_id": "<string>",
        "parent_profile_id": 123,
        "name": "<string>",
        "is_active": true,
        "expires_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "total_pages": 123,
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Query Parameters

​
page
integer
default:1

Page number (1-based)

Required range: x >= 1
​
limit
integer
default:20

Number of users per page (max 100)

Required range: 1 <= x <= 100
​
search
string

Search by name or email

Response

Successful response

​
users
object[]
​
total
integer

Total number of users matching the query

​
page
integer

Current page number

​
limit
integer

Number of users per page

​
total_pages
integer

Total number of pages

​
has_more
boolean

Whether more pages are available