Docs·Workspace
GET
/api/v1/spreelytics/referencesList references
Returns the audience's references, latest date first. A reference marks a dated moment, such as a launch or a price change, and the app draws it as a marker on every time-series chart of the audience.
Every role can call it, Viewer included.
Keys: an account key or an audience key. Getting started explains both kinds.
Parameters
| Prop | In | Type | Notes |
|---|---|---|---|
contactListId | query | string | The audience id, a UUID. With an audience key it must be that key's own audience. |
Response
An array of SpreelyticsReferenceDto.
| Prop | Type | Notes |
|---|---|---|
id | string | The reference id. |
title | string | The label shown on the marker. |
description | string | The longer note, or null. |
date | string | The marked moment. Create and update calls answer in ISO 8601, the list in the database form (2026-09-30 09:00:00+00). |
color | string | The marker colour: a preset such as var(--chart-1), a #rrggbb hex, or null for the default colour. |
createdAt | string | When it was created. Only the create call answers in ISO 8601 (2026-09-30T09:00:00.000Z). Every other call returns the database form (2026-09-30 09:00:00+00), so parse both. |
updatedAt | string | When it last changed. Create and update calls answer in ISO 8601, lists and reads in the database form, as with createdAt. |
Request
curl 'https://app.spreelytics.com/api/v1/spreelytics/references?contactListId=…' \
-H 'Authorization: Bearer YOUR_API_KEY'
const url = new URL('https://app.spreelytics.com/api/v1/spreelytics/references');
url.searchParams.set('contactListId', '…');
const res = await fetch(url, {
headers: { Authorization: 'Bearer YOUR_API_KEY' },
});
const data = await res.json();
import requests
res = requests.get(
"https://app.spreelytics.com/api/v1/spreelytics/references",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"contactListId": "…"},
)
data = res.json()
Response
[
{
"id": "string",
"title": "string",
"description": "string",
"date": "string",
"color": "string",
"createdAt": "string",
"updatedAt": "string"
}
]