Skip to content

Area: Developers

GET

Get a profile

Path
/profiles
Auth
Secret key · server only
GET
/profiles
curl --request GET \
--url https://releva.ai/api/v0/profiles \
--header 'Authorization: Bearer <token>'

Returns one identified profile. Pass exactly one of profileId, email or phoneNumber. A profileId that was merged into another profile returns the surviving profile, so id can differ from the one you asked for. Anonymous visitors (no email or phone) are not stored as profiles and return 404.

profileId
string

Your customer id (the profile id).

email
string format: email

Matched case-insensitively.

phoneNumber
string

International (%2B359888000101) or national form, as you sent it when writing. Encode + as %2B.

The profile.

Media typeapplication/json
object
profile
required

Every property is always present; missing values are null.

object
id
required

Your customer id, or a generated UUID for profiles created without one.

string
email
required
string | null
phoneNumber
required

International form.

string | null
firstName
required
string | null
lastName
required
string | null
registeredAt
required
string | null format: date-time
subscribedAt
required

Null when not subscribed.

string | null format: date-time
unsubscribedAt
required
string | null format: date-time
birthday
required
string | null format: date
tags
required
Array<string>
subscriptions
required
Array<string>
custom
required
One of:

Custom profile fields grouped by type. New keys become available in segment conditions.

object
string
Array<object>
object
key
required
string
values
required
Array<string>
numeric
Array<object>
object
key
required
string
values
required
Array<number>
date
Array<object>
object
key
required
string
values
required
Array<string>
location
required
One of:
object
lat
number
lon
number
consent
required
string | null
unsubscribeLink
required
string | null

Example

{
"profile": {
"id": "DEMO-CUST-1001",
"email": "maria@example.com",
"phoneNumber": "+359888000101",
"firstName": "Maria",
"lastName": "Example",
"registeredAt": "2026-05-01T09:00:00.000Z",
"subscribedAt": "2026-05-01T09:05:00.000Z",
"unsubscribedAt": null,
"birthday": "1990-05-17",
"tags": [
"vip"
],
"subscriptions": [
"marketing"
],
"custom": {
"string": [
{
"key": "loyaltyTier",
"values": [
"gold"
]
}
]
},
"location": {
"lat": 42.6977,
"lon": 23.3219
},
"consent": "privacyPolicy",
"unsubscribeLink": "https://demo-store.example.com/unsubscribe/DEMO-CUST-1001"
}
}

Authentication or validation error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "Exactly one of (profileId",
"phoneNumber": null,
"email) is required.": null
}

The domain is disabled.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Domain is disabled. Please reach out to support@releva.ai to enable it."
}

No identified profile matches.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Profile not found."
}

Unexpected server error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}