Get a profile
- Path
/profiles- Auth
- Secret key · server only
const url = 'https://releva.ai/api/v0/profiles';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Your customer id (the profile id).
Matched case-insensitively.
International (%2B359888000101) or national form, as you sent it when writing. Encode + as %2B.
Responses
Section titled “Responses”The profile.
object
Every property is always present; missing values are null.
object
Your customer id, or a generated UUID for profiles created without one.
International form.
Null when not subscribed.
Custom profile fields grouped by type. New keys become available in segment conditions.
object
object
object
object
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.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "Exactly one of (profileId", "phoneNumber": null, "email) is required.": null}{ "message": "The object '' contains forbidden keys: 'foo'."}{ "message": "The 'email' field must be a valid e-mail."}{ "message": "sendToEmail is not supported on GET /api/v0/profiles. To request a data export, POST /api/v0/profiles/exports with a JSON body."}{ "message": "Authorization header is missing."}The domain is disabled.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "Domain is disabled. Please reach out to support@releva.ai to enable it."}No identified profile matches.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "Profile not found."}Unexpected server error.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}