Projects
Events
Campaigns
Subscriptions
- PATCHBulk toggle the current contact’s subscription states
- GETList subscription types
- POSTCreate a subscription type
- GETGet a subscription type
- PATCHUpdate a subscription type
- POSTBulk toggle subscription states across many contacts
- GETList a contact’s subscription states
- PATCHBulk toggle a contact’s subscription states
Journeys
Templates
Contacts
API keys
Organisation
curl --request GET \
--url https://apix.spotzee.com/api/client/projects \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": 42,
"organization_id": 7,
"name": "Acme Marketing",
"locale": "en-AU",
"timezone": "Australia/Sydney",
"created_at": "2026-04-28T05:14:00.000Z",
"updated_at": "2026-04-28T05:14:00.000Z",
"description": "<string>",
"website_url": "https://acme.example",
"text_opt_out_message": "<string>",
"text_help_message": "<string>",
"link_wrap_email": true,
"link_wrap_push": true,
"track_opens_email": true,
"deeplink_mirror_url": "https://links.acme.example",
"role": "admin",
"has_provider": true
}
],
"nextCursor": "<string>",
"prevCursor": "<string>",
"limit": 123
}List projects in the organisation
Returns a paginated list of projects belonging to the calling key’s organisation. Sensitive internal fields are excluded from each row.
curl --request GET \
--url https://apix.spotzee.com/api/client/projects \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": 42,
"organization_id": 7,
"name": "Acme Marketing",
"locale": "en-AU",
"timezone": "Australia/Sydney",
"created_at": "2026-04-28T05:14:00.000Z",
"updated_at": "2026-04-28T05:14:00.000Z",
"description": "<string>",
"website_url": "https://acme.example",
"text_opt_out_message": "<string>",
"text_help_message": "<string>",
"link_wrap_email": true,
"link_wrap_push": true,
"track_opens_email": true,
"deeplink_mirror_url": "https://links.acme.example",
"role": "admin",
"has_provider": true
}
],
"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.
Authorizations
Organisation-scoped admin API key (ok_…). Pass in the Authorization: Bearer <key> header. Used to manage projects and other organisation-level resources.
Query Parameters
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.
Response
A page of projects.
Paginated response of OrgProjectList.
Page of results, ordered per the request’s sort and direction.
Hide child attributes
Hide child attributes
Numeric project identifier.
42
Identifier of the owning organisation.
7
Human-readable project name.
"Acme Marketing"
Default BCP-47 locale used for content rendering and timestamp formatting.
"en-AU"
Default IANA timezone used for time-of-day scheduling.
"Australia/Sydney"
Time the project was created. ISO 8601.
"2026-04-28T05:14:00.000Z"
Time the project was last modified. ISO 8601.
"2026-04-28T05:14:00.000Z"
Optional free-text description of the project.
The project’s public website URL, if set.
"https://acme.example"
Custom opt-out reply for SMS recipients. When omitted, a system default is used.
Custom HELP reply for SMS recipients. When omitted, a system default is used.
When true, links in email content are rewritten through the tracking domain.
When true, links in push payloads are rewritten through the tracking domain.
When true, an open-tracking pixel is embedded in outgoing email.
HTTPS-only mirror URL used for Universal Links and App Links resolution.
"https://links.acme.example"
Caller’s effective role on this project. Populated on single-project responses (create/update); omitted on the list endpoint to avoid per-row joins.
support, smtpproxy, editor, publisher, admin "admin"
Whether the project has at least one delivery provider configured. Populated on single-project responses; omitted on the list endpoint.
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?