Profiles

List profiles

Returns a list of profiles, including profiles that have not joined the loyalty program.

GEThttps://api.cevoid.com/v2/profiles

Request

curl 'https://api.cevoid.com/v2/profiles' \
  -H "Authorization: Bearer ${CEVOID_API_KEY}"

fetch("https://api.cevoid.com/v2/profiles", {
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

const response = await fetch("https://api.cevoid.com/v2/profiles", {
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
  },
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.get(
    "https://api.cevoid.com/v2/profiles",
    headers={
        "Authorization": f"Bearer {os.environ['CEVOID_API_KEY']}",
    },
)
response.raise_for_status()
print(response.json())

<?php

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.cevoid.com/v2/profiles',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('CEVOID_API_KEY'),
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.cevoid.com/v2/profiles", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer " + os.Getenv("CEVOID_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

require "net/http"

uri = URI("https://api.cevoid.com/v2/profiles")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CEVOID_API_KEY")}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.body

Response

{
  "data": [
    {
      "id": "prf_sarah",
      "external_id": "customer_7391056823401",
      "name": "Sarah Johnson",
      "first_name": "Sarah",
      "last_name": "Johnson",
      "email": "sarah.johnson@example.com",
      "avatar_url": "https://cdn.cevoid.com/avatars/prf_sarah/profile.jpg",
      "country": "US",
      "language": "en",
      "location": "San Francisco, CA",
      "social_instagram_handle": "sarah.lifestyle",
      "social_tiktok_handle": "sarah.creates",
      "social_x_handle": "sarah_j",
      "birthday": "1992-04-18",
      "name_display_format": "FIRST_LAST_INITIAL",
      "bio": "Lifestyle creator and photography enthusiast",
      "notes": "VIP customer; prefers email communication",
      "created_at": "2026-01-15T09:30:00.000Z",
      "updated_at": "2026-01-20T14:22:15.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJpZCI6InByZl9zYXJhaCJ9"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 400,
  "code": "bad_request",
  "message": "Bad request",
  "request_id": "req_abc123"
}

{
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "request_id": "req_abc123"
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Forbidden",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 422,
  "code": "validation_error",
  "message": "Validation error",
  "request_id": "req_abc123"
}

{
  "status": 429,
  "code": "rate_limit_exceeded",
  "message": "Rate limit exceeded",
  "request_id": "req_abc123",
  "additional_data": {
    "retry_after_seconds": 1
  }
}

{
  "status": 500,
  "code": "internal_server_error",
  "message": "Internal server error",
  "request_id": "req_abc123"
}

Authorizations

Authorizationbearer tokenheaderrequired

Send Authorization: Bearer <key>, where the key is your API key.

Query parameters

cursorstring

Opaque cursor returned from a previous list response

Example: eyJpZCI6InBvc3RfMDEifQ

limitinteger

Page size between 1 and 100

Range: 1 <= x <= 100
Example: 25

Response

200 Successful response application/json

dataobject[]required

Items returned for this page.

Item properties (19)

idstringrequired

Cevoid profile ID.

Example: prf_abc123

external_idstring

Identifier this profile carries in the workspace source system, when known. Secret-key only.

Example: 7391056823401

namestring

Display name of the profile.

Example: Sarah Johnson

first_namestring

First name of the profile.

Example: Sarah

last_namestring

Last name of the profile.

Example: Johnson

emailstring

Email address for the profile. Secret-key only.

Example: sarah.johnson@example.com

avatar_urlstring

Profile image URL.

Example: https://cdn.cevoid.com/avatars/profile123/profile.jpg

countrystring

Country code associated with the profile.

Example: US

languagestring

Preferred language code associated with the profile.

Example: en

locationstring

Free-form location associated with the profile. Secret-key only.

Example: San Francisco, CA

birthdaystring<date>

Birthday in YYYY-MM-DD format. Secret-key only.

Example: 1992-04-18

name_display_formatenum<string>

Preferred format for displaying the profile name.

Allowed values: FULL FIRST_LAST_INITIAL FIRST ANONYMOUS
Example: FIRST_LAST_INITIAL

biostring

Profile biography text. Secret-key only.

Example: Lifestyle blogger and photography enthusiast

notesstring

Notes visible only to secret keys.

Example: VIP customer, prefers email communication

created_atstring<date-time>required

ISO 8601 timestamp when the profile was created.

Example: 2024-01-15T09:30:00.000Z

updated_atstring<date-time>required

ISO 8601 timestamp when the profile was last updated.

Example: 2024-01-20T14:22:15.000Z

has_morebooleanrequired

Whether another page of results is available.

Example: true

next_cursorstring | nullrequired

Opaque cursor to request the next page, or null when the list is exhausted.

Example: eyJpZCI6InJlc291cmNlXzI1In0

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

400 Bad request application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

401 Unauthorized application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

403 Forbidden application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

422 Validation error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

429 Too many requests application/json

additional_dataobjectrequired

Machine-readable rate-limit details.

Properties (2)

retry_after_secondsintegerrequired

Range: 0 <= x

{key}any

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (6)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Retry-Afterinteger

Seconds to wait before retrying the request

500 Internal server error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available