Skip to main content
GET
/
users
List users
curl --request GET \
  --url https://backendapi.corbado.io/v2/users \
  --header 'Authorization: Basic <encoded-value>'
{
  "users": [
    {
      "userID": "usr-4693224802260150919",
      "status": "pending",
      "emailIdentifiers": [
        {
          "identifierID": "ide-4693224802260150919",
          "type": "email",
          "value": "[email protected]",
          "status": "pending",
          "userID": "usr-4693224802260150919"
        }
      ],
      "phoneNumberIdentifiers": [
        {
          "identifierID": "ide-4693224802260150919",
          "type": "email",
          "value": "[email protected]",
          "status": "pending",
          "userID": "usr-4693224802260150919"
        }
      ],
      "usernameIdentifiers": [
        {
          "identifierID": "ide-4693224802260150919",
          "type": "email",
          "value": "[email protected]",
          "status": "pending",
          "userID": "usr-4693224802260150919"
        }
      ],
      "socialAccounts": [
        {
          "socialAccountID": "soc-6060375336139150919",
          "providerType": "github",
          "identifierValue": "[email protected]",
          "userID": "usr-4693224802260150919",
          "foreignID": "53150919",
          "avatarURL": "https://avatars.githubusercontent.com/u/53150919?v=4",
          "fullName": "Jane Doe"
        }
      ],
      "created": "<string>",
      "createdMS": 123,
      "updated": "<string>",
      "updatedMs": 123,
      "fullName": "Jane Doe",
      "explicitWebauthnID": "<string>"
    }
  ],
  "paging": {
    "page": 1,
    "totalPages": 123,
    "totalItems": 123
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication is used to authenticate requests to the Backend API. The username is the project ID and the password is the API secret.

The project ID and API secret can be found in the Developer Panel.

Query Parameters

​
userID
string

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

Example:

"usr-4693224802260150919"

​
userIDs
string[]

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

Example:
[
  "usr-4693224802260150919",
  "usr-1234567890123456789"
]
​
userIDPattern
string

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

Example:

"usr-%"

​
webauthnIDs
string[]

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

Example:
["abc123def456", "xyz789ghi012"]
​
identifierValue
string

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

Example:

"[email protected]"

​
identifierValues
string[]

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

Example:
["[email protected]", "[email protected]"]
​
identifierType
enum<string>

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

Available options:
email,
phone,
username
Example:

"email"

​
status
enum<string>

Filter by user status.

Available options:
active,
pending,
disabled,
deleted
Example:

"active"

​
sort
enum<string>

Sort field. Only created is supported.

  • Use +created for ascending order
  • Use -created for descending order
Available options:
+created,
-created
Example:

"-created"

​
includeIdentifiers
boolean
default:true

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

​
page
integer
default:1

The page number to retrieve for paginated results.

Example:

1

​
pageSize
integer
default:10

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

Example:

20

Response

List of users.

​
users
object[]
required
​
paging
object
required