Application A P I
List users
Returns a paginated list of panel users visible to the application API key.
GET
/api/application/usersAuthorization
default AuthorizationBearer <token>
Application API requests require an application API token, or a client API token, that belongs to a root administrator. Admin API requests require a client API token that belongs to a root administrator, and reject application API tokens. Client API requests require a client API token.
In: header
Query Parameters
per_page?integer
Number of users to return per page, up to 100.
filter[email]?string
Filter users by email address.
filter[uuid]?string
Filter users by UUID.
filter[username]?string
Filter users by username.
filter[external_id]?string
Filter users by external identifier.
sort?string
Sort users by id or uuid. Prefix with "-" for descending order.
Value in
- "id"
- "-id"
- "uuid"
- "-uuid"
include?"servers"
Comma-separated relationships to include. Supports "servers" when the key can read servers.
Value in
- "servers"
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/application/users?per_page=50&filter%5Bemail%5D=user%40example.com&filter%5Buuid%5D=0d1f6f4d-9f78-4cf9-9d5a-6f7f4c9f4d6a&filter%5Busername%5D=example-user&filter%5Bexternal_id%5D=billing-system-42&sort=-id&include=servers"{ "object": "list", "data": [ { "object": "user", "attributes": { "id": 22021, "external_id": "string", "uuid": "e0dcf339-0bc7-4561-ab00-369ac65ab880", "username": "floy88_afzdiebpaq", "email": "[email protected]", "first_name": "Cruz", "last_name": "Adams", "language": "en", "root_admin": false, "2fa": false, "created_at": "2026-09-22T14:45:22+00:00", "updated_at": "2026-09-22T14:45:22+00:00" }, "meta": { "resource": "https://panel.example.test/api/application/users/1" } } ], "meta": { "pagination": { "total": 1, "count": 1, "per_page": 50, "current_page": 1, "total_pages": 1, "links": { "property1": "string", "property2": "string" } } }}