Users

List all users

Retrieve a paginated list of all registered users in your workspace.

The List Users endpoint retrieves a paginated list of all users in your application. This is useful for admin dashboards, CRM systems, or managing accounts at scale.

Endpoint

GET /v1/users

Query Parameters

Parameter	Type	Required	Description
page	int	No	The page number to retrieve (default: 1).
limit	int	No	Number of users per page (default: 25, max: 100).
status	string	No	Filter users by status (active, suspended, pending).
search	string	No	Search by name or email.

Headers

Key	Value	Required
Authorization	Bearer <access_token>	Yes

Response

Successful Response (200 OK)

{
  "data": [
    {
      "id": "user_123",
      "email": "user1@example.com",
      "name": "Jane Doe",
      "status": "active",
      "created_at": "2024-09-18T10:15:00Z",
      "updated_at": "2025-01-10T14:22:00Z"
    },
    {
      "id": "user_124",
      "email": "user2@example.com",
      "name": "John Smith",
      "status": "suspended",
      "created_at": "2024-11-05T09:00:00Z",
      "updated_at": "2025-02-01T16:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total_pages": 10,
    "total_records": 250
  }
}

Field	Type	Description
data	array	List of user objects.
pagination.page	int	Current page number.
pagination.limit	int	Number of records per page.
pagination.total_pages	int	Total number of pages available.
pagination.total_records	int	Total number of users in the system.

Error Response (401 / 403)

{
  "error": "unauthorized",
  "message": "You do not have permission to access this resource."
}

Error Code	Meaning
unauthorized	Missing or invalid access token.
forbidden	User does not have permission to list all users.

Example Usage

cURL

curl -X GET "https://api.example.com/v1/users?page=1&limit=25&status=active" \
  -H "Authorization: Bearer admin_access_token"

JavaScript (Fetch)

const response = await fetch("https://api.example.com/v1/users?page=1&limit=25&status=active", {
  method: "GET",
  headers: {
    "Authorization": "Bearer admin_access_token"
  }
});

const data = await response.json();
console.log(data.pagination.total_records);

Use query parameters like status and search to narrow results and reduce response payload size.

Remove a user

Retrieve account details

Need help? Contact Support

Join our Discord Community

Questions? Contact Sales

On this page

Title