List users

Retrieves all users

Available include parameters

Parameter	Description
servers	List of servers the user has access to

Filters

Parameter
email
uuid
username
external_id

Sort by

Parameter
id
uuid

GET/api/application/users

Authorization

ApplicationToken

AuthorizationBearer <token>

Application API key (generated at /admin/api)

In: header

Query Parameters

include?string

Comma-separated list of related resources to embed in each returned object. Accepted values are listed in the include-parameters table above.

filter[email]?string

Partial match on the email address.

filter[uuid]?string

Partial match on the user UUID.

filter[username]?string

Partial match on the username.

filter[external_id]?string

Partial match on the external ID.

sort?string

Sort by id or uuid; prefix with - for descending.

Value in"id" | "-id" | "uuid" | "-uuid"

page?integer

Page of results to return.

per_page?integer

Number of results per page (default 50).

Default50

Response Body

`application/json`

curl -X GET "https://pterodactyl.file.properties/api/application/users?include=servers&filter%5Bemail%5D=user%40example.com&filter%5Buuid%5D=6e1a3b2c&filter%5Busername%5D=wardle&filter%5Bexternal_id%5D=store-1234&sort=id&page=1&per_page=50" \  -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"

{
  "object": "list",
  "data": [
    {
      "object": "user",
      "attributes": {
        "id": 1,
        "external_id": null,
        "uuid": "c4e3a2a1-1f0b-4d8e-9c2a-1a2b3c4d5e6f",
        "username": "adminuser",
        "email": "[email protected]",
        "first_name": "Admin",
        "last_name": "User",
        "language": "en",
        "root_admin": true,
        "2fa": false,
        "created_at": "2025-06-20T14:23:36+00:00",
        "updated_at": "2026-05-30T13:26:37+00:00"
      }
    },
    {
      "object": "user",
      "attributes": {
        "id": 2,
        "external_id": null,
        "uuid": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "username": "exampleuser",
        "email": "[email protected]",
        "first_name": "Example",
        "last_name": "User",
        "language": "en",
        "root_admin": false,
        "2fa": false,
        "created_at": "2025-06-25T19:52:45+00:00",
        "updated_at": "2026-01-25T18:47:21+00:00"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}