Skip to main content
GET
/
v2
/
session
/
apps
/
{appID}
/
users
List users
curl --request GET \
  --url https://api.prelude.dev/v2/session/apps/{appID}/users \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "id": "<string>",
      "status": "<string>",
      "identifiers": [
        {
          "type": "phone_number",
          "value": "<string>"
        }
      ],
      "profile": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
appID
string
required

The id of the app the request refers to. An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

Query Parameters

​
identifier_type
enum<string>

The type of the identifier.

Available options:
phone_number,
email_address
​
identifier_value
string

The URL encoded value of the identifier.

Examples:

"%2B306912345678"

"test%40example.com"

Response

OK

​
users
object[]
required