Sign in

v1

latestOpenAPI 3.0.32026-08-064799140.5 KB
Users

List users

Returns a list of project users.

The list supports pagination and sorting:

  • The sort parameter only supports the created field (use created for ascending, -created for descending).
  • Users can be filtered by:
    • Single user ID using userID
    • Multiple user IDs using userIDs (max 1000)
    • Multiple WebAuthn IDs using webauthnIDs (max 1000)
    • Single identifier using identifierValue and identifierType together
    • Multiple identifiers using identifierValues and identifierType together (max 1000)

Filtering rules:

  • Only one filter type can be used at a time: userID, userIDs, webauthnIDs, or identifier filters
  • userID and userIDs are mutually exclusive
  • identifierValue and identifierValues are mutually exclusive
  • When filtering by identifier(s), identifierType must be provided
get/users

Query parameters

userIDstring
Example:usr-4693224802260150919

Filter by specific user ID (format usr-<number>). Cannot be used together with userIDs.

userIDsstring[]

Filter by multiple user IDs (comma-separated). Cannot be used together with userID, webauthnIDs, or identifier filters. Maximum 1000 IDs.

[
  "usr-4693224802260150919",
  "usr-1234567890123456789"
]
userIDPatternstring
Example:usr-%

Filter by user IDs matching the given pattern. Supports % as a wildcard character. Cannot be used together with other filter types.

webauthnIDsstring[]

Filter by multiple WebAuthn IDs (comma-separated). Cannot be used together with other filter types. Maximum 1000 IDs.

[
  "abc123def456",
  "xyz789ghi012"
]
identifierValuestring
Example:jane@doe.com

Filter by identifier value (email, phone, or username). Must be used together with identifierType. Cannot be used together with identifierValues.

identifierValuesstring[]

Filter by multiple identifier values (comma-separated). Must be used together with identifierType. Cannot be used together with identifierValue. Maximum 1000 values.

[
  "jane@doe.com",
  "john@example.com"
]
identifierType'email' | 'phone' | 'username'
Example:email

Type of identifier to filter by. Must be used together with identifierValue or identifierValues.

status'active' | 'pending' | 'disabled' | 'deleted'
Example:active

Filter by user status.

sort'+created' | '-created'
Example:-created

Sort field. Only created is supported.

  • Use +created for ascending order
  • Use -created for descending order
includeIdentifiersboolean

Whether to include login identifiers in the response. Defaults to true.

pageinteger
Example:1

The page number to retrieve for paginated results.

pageSizeinteger
Example:20

The number of items to return per page. Useful for pagination.

Response

List of users.

Example response

{
  "users": [
    {
      "userID": "usr-4693224802260150919",
      "fullName": "Jane Doe",
      "emailIdentifiers": [
        {
          "identifierID": "ide-4693224802260150919",
          "value": "jane@doe.com",
          "userID": "usr-4693224802260150919"
        }
      ],
      "phoneNumberIdentifiers": [
        {
          "identifierID": "ide-4693224802260150919",
          "value": "jane@doe.com",
          "userID": "usr-4693224802260150919"
        }
      ],
      "usernameIdentifiers": [
        {
          "identifierID": "ide-4693224802260150919",
          "value": "jane@doe.com",
          "userID": "usr-4693224802260150919"
        }
      ],
      "socialAccounts": [
        {
          "socialAccountID": "soc-6060375336139150919",
          "providerType": "github",
          "identifierValue": "jane@doe.com",
          "userID": "usr-4693224802260150919",
          "foreignID": "53150919",
          "avatarURL": "https://avatars.githubusercontent.com/u/53150919?v=4",
          "fullName": "Jane Doe"
        }
      ]
    }
  ]
}