curl --request GET \
--url https://apix.spotzee.com/api/client/campaigns \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": 24,
"project_id": 123,
"type": "blast",
"name": "<string>",
"channel": "email",
"subscription_id": 123,
"provider_id": 123,
"state": "draft",
"created_at": "<string>",
"updated_at": "<string>",
"list_ids": [
123
],
"exclusion_list_ids": [
123
],
"delivery": {
"sent": 123,
"total": 123,
"opens": 123,
"clicks": 123,
"bounced": 123
},
"tags": [
"<string>"
],
"send_in_user_timezone": true,
"send_at": "<string>",
"custom_domain_id": 123
}
],
"nextCursor": "<string>",
"prevCursor": "<string>",
"limit": 123
}Returns a paginated list of campaigns in the project, ordered by created_at descending by default.
curl --request GET \
--url https://apix.spotzee.com/api/client/campaigns \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": 24,
"project_id": 123,
"type": "blast",
"name": "<string>",
"channel": "email",
"subscription_id": 123,
"provider_id": 123,
"state": "draft",
"created_at": "<string>",
"updated_at": "<string>",
"list_ids": [
123
],
"exclusion_list_ids": [
123
],
"delivery": {
"sent": 123,
"total": 123,
"opens": 123,
"clicks": 123,
"bounced": 123
},
"tags": [
"<string>"
],
"send_in_user_timezone": true,
"send_at": "<string>",
"custom_domain_id": 123
}
],
"nextCursor": "<string>",
"prevCursor": "<string>",
"limit": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt
Use this file to discover all available pages before exploring further.
Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.
Opaque cursor returned by a previous page response. Omit on the first request.
Direction to walk relative to cursor. Defaults to next when omitted.
next, prev Maximum results per page. Use -1 to request all (rate-limited; large pages may be rejected).
-1 <= x <= 10025
Field to sort by. Defaults vary per resource.
"created_at"
Sort direction. Defaults vary per resource.
asc, desc Free-text search across the resource’s indexed fields.
A page of campaigns.
Paginated response of CampaignList.
Page of results, ordered per the request’s sort and direction.
Hide child attributes
Numeric campaign identifier.
24
blast campaigns send to every contact in the target lists. trigger campaigns fire per-user when an event matches.
blast, trigger Delivery channel the campaign sends through.
email, text, push, webhook, in_app Subscription type a contact must be opted in to in order to receive this campaign.
Delivery provider used to send the campaign.
Campaign lifecycle state. Set state: "scheduled" (with send_at) to send a blast; set state: "aborted" to cancel.
draft, scheduled, loading, running, finished, aborting, aborted IDs of the lists targeted by the campaign.
IDs of lists whose members should be excluded from the campaign.
When true, send_at is interpreted as a wall-clock time in each contact’s local timezone.
When the campaign should send. ISO 8601 string accepted on input.
Optional override of the project’s default tracking and from-address domain.
Opaque cursor for the next page. null when no further pages exist.
Opaque cursor for the previous page. null when on the first page.
Page size used to build this response.
Was this page helpful?