Projects
Events
Campaigns
Subscriptions
Journeys
Templates
Contacts
API keys
curl --request GET \
--url https://apix.spotzee.com/api/client/lists \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": 91,
"project_id": 42,
"name": "Newsletter subscribers — Q2 2026",
"type": "static",
"state": "draft",
"version": 3,
"is_visible": true,
"created_at": "<string>",
"updated_at": "<string>",
"rule": {
"uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
"type": "wrapper",
"group": "user",
"path": "data.country",
"operator": "<string>",
"id": 123,
"root_uuid": "<string>",
"parent_uuid": "<string>",
"value": "<string>",
"frequency": {
"period": {
"type": "rolling",
"unit": "hour",
"value": 123
},
"operator": "=",
"count": 123
},
"children": "<array>"
},
"rule_id": 123,
"users_count": 12584,
"tags": [
"<string>"
],
"refreshed_at": "<string>"
}
],
"nextCursor": "<string>",
"prevCursor": "<string>",
"limit": 123
}List lists
Returns a paginated list of lists in the project, ordered by updated_at descending by default. Includes both static (manually managed) and dynamic (rule-driven) lists.
curl --request GET \
--url https://apix.spotzee.com/api/client/lists \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": 91,
"project_id": 42,
"name": "Newsletter subscribers — Q2 2026",
"type": "static",
"state": "draft",
"version": 3,
"is_visible": true,
"created_at": "<string>",
"updated_at": "<string>",
"rule": {
"uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
"type": "wrapper",
"group": "user",
"path": "data.country",
"operator": "<string>",
"id": 123,
"root_uuid": "<string>",
"parent_uuid": "<string>",
"value": "<string>",
"frequency": {
"period": {
"type": "rolling",
"unit": "hour",
"value": 123
},
"operator": "=",
"count": 123
},
"children": "<array>"
},
"rule_id": 123,
"users_count": 12584,
"tags": [
"<string>"
],
"refreshed_at": "<string>"
}
],
"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
Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.
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 lists.
Paginated response of Lists.
Page of results, ordered per the request’s sort and direction.
Hide child attributes
Hide child attributes
Numeric list identifier.
91
Identifier of the project the list belongs to.
42
Human-readable list name.
"Newsletter subscribers — Q2 2026"
A static list has explicit members. A dynamic list is materialised from a rule tree.
static, dynamic Current list state. loading while a refresh is in progress; ready once members are materialised.
draft, ready, loading Monotonically incrementing version. Bumped on rule edits.
3
Whether the list is shown in the in-product UI list directory.
Time the list was created. ISO 8601.
Time the list was last modified. ISO 8601.
Membership rule tree for dynamic lists. Absent on static lists.
Hide child attributes
Hide child attributes
Stable client-supplied UUID for this rule node — preserved across edits.
"b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91"
Type of value the rule node holds. wrapper is a logical group; the rest are leaf comparisons.
wrapper, string, number, boolean, date, array, shopify_purchase Where the rule applies — to the contact (user), an event (event), or inherited from the parent wrapper.
user, event, parent Dotted path on the contact or event payload. For wrappers, leave empty.
"data.country"
Comparison or logical operator. See RuleOperator for the canonical list.
Internal numeric identifier of a persisted rule node. Omit on create.
UUID of the root wrapper of the rule tree this node belongs to.
UUID of the immediate parent wrapper.
Right-hand side of a leaf comparison. Omitted on wrapper nodes.
Required event count and operator over a time period — used by event-frequency rules.
Hide child attributes
Hide child attributes
Time window for an event-frequency rule — rolling (relative) or fixed (absolute).
=, <, <=, >, >= Nested rule nodes — present on wrapper types.
Internal identifier of the persisted root rule, when present.
Cached size of the list. May lag a few seconds behind reality.
12584
Tags applied to the list. Used for organisation and filtering.
Time the dynamic list was last refreshed.
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?