Skip to main content
GET
/
users
Query users
curl --request GET \
  --url https://api.authsignal.com/v1/users \
  --header 'Authorization: Basic <encoded-value>'
{
  "users": [
    {
      "userId": "<string>",
      "email": "<string>",
      "phoneNumber": "<string>",
      "username": "<string>",
      "displayName": "<string>",
      "isEnrolled": true,
      "enrolledVerificationMethods": [],
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "lastEvaluatedUserId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use your Authsignal Server API secret key as the username and leave the password empty. The secret key can be found in the API Keys section of the Authsignal Portal settings page.

Query Parameters

​
username
string

Filter users by username.

​
email
string

Filter users by email address.

​
phoneNumber
string

Filter users by phone number in E.164 format.

​
token
string

Filter users by token.

​
limit
integer

The maximum number of users to return.

​
lastEvaluatedUserId
string

The user ID to start the query from. Use this for pagination by passing the lastEvaluatedUserId from the previous response.

Response

OK

​
users
object[]

The list of users matching the query.

​
lastEvaluatedUserId
string

The user ID to use as the starting point for the next page of results. If not present, there are no more results.