Skip to main content
GET
/
v1beta1
/
users
List Users
curl --request GET \
  --url https://api.example.com/v1beta1/users
{
  "400": {},
  "401": {},
  "500": {},
  "count": 123,
  "users": [
    {
      "id": "<string>",
      "name": "<string>",
      "title": "<string>",
      "email": "<string>",
      "avatar": "<string>",
      "state": "<string>",
      "metadata": {},
      "created_at": {},
      "updated_at": {}
    }
  ]
}
Retrieve a list of users with optional filtering by organization, group, state, or keyword search.

​
Authentication

This endpoint requires authentication. Include a valid bearer token in the Authorization header.

​
Query Parameters

​
page_size
integer
Number of users to return per page. Used for pagination.
​
page_num
integer
Page number to retrieve. Used for pagination.
​
keyword
string
Search keyword to filter users by name or email.
​
org_id
string
Filter users by organization ID. Returns only users belonging to the specified organization.
​
group_id
string
Filter users by group ID. Returns only users belonging to the specified group.
​
state
string
Filter users by state. Possible values:
  • enabled - Active users
  • disabled - Disabled users

​
Response

​
count
integer
Total count of users returned in the response.
​
users
array
Array of user objects.
​
id
string
Unique identifier for the user (UUID).
​
name
string
User’s username or slug.
​
title
string
User’s title or display name.
​
email
string
User’s email address.
​
avatar
string
URL to the user’s avatar image.
​
state
string
Current state of the user account (enabled or disabled).
​
metadata
object
Custom metadata associated with the user.
​
created_at
timestamp
Timestamp when the user was created.
​
updated_at
timestamp
Timestamp when the user was last updated.

​
Example Request

curl -X GET 'https://api.frontier.example.com/v1beta1/users?page_size=10&org_id=org_123' \
  -H 'Authorization: Bearer <token>'

​
Example Response

{
  "count": 2,
  "users": [
    {
      "id": "9f256f86-4a1e-4b2a-9c45-6d2c8f5a3b7e",
      "name": "john.doe",
      "title": "John Doe",
      "email": "[email protected]",
      "avatar": "https://example.com/avatars/john.jpg",
      "state": "enabled",
      "metadata": {
        "department": "Engineering"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-03-01T14:22:00Z"
    },
    {
      "id": "7a3c9b2d-5e4f-4a1b-8c6d-9e2f1a3b5c7d",
      "name": "jane.smith",
      "title": "Jane Smith",
      "email": "[email protected]",
      "avatar": "https://example.com/avatars/jane.jpg",
      "state": "enabled",
      "metadata": {},
      "created_at": "2024-02-10T09:15:00Z",
      "updated_at": "2024-02-10T09:15:00Z"
    }
  ]
}

​
Error Codes

​
400
error
Bad Request - Invalid parameters provided.
​
401
error
Unauthorized - Invalid or missing authentication token.
​
500
error
Internal Server Error - An unexpected error occurred.

Build docs developers (and LLMs) love

Get started for freeTalk to us