Skip to main content
GET
/
users
/
{userId}
/
subscriptions
List a contact’s subscription states
curl --request GET \
  --url https://apix.spotzee.com/api/client/users/{userId}/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "subscription_id": 7,
      "state": 1,
      "name": "Weekly newsletter",
      "channel": "email"
    }
  ],
  "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

​
Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Path Parameters

​
userId
string
required

Numeric ID (admin scope) or contact external_id (project scope) — the route resolves both.

Example:

"cust-9f4b21"

Query Parameters

​
cursor
string

Opaque cursor returned by a previous page response. Omit on the first request.

​
page
enum<string>

Direction to walk relative to cursor. Defaults to next when omitted.

Available options:
next,
prev
​
limit
integer | null
default:25

Maximum results per page. Use -1 to request all (rate-limited; large pages may be rejected).

Required range: -1 <= x <= 100
Example:

25

​
sort
string

Field to sort by. Defaults vary per resource.

Example:

"created_at"

​
direction
enum<string>

Sort direction. Defaults vary per resource.

Available options:
asc,
desc
​
q
string

Free-text search across the resource’s indexed fields.

Response

A page of subscription states for the contact.

Paginated response of ContactSubscriptionList.

​
results
object[]
required

Page of results, ordered per the request’s sort and direction.

​
nextCursor
string | null
required

Opaque cursor for the next page. null when no further pages exist.

​
prevCursor
string | null
required

Opaque cursor for the previous page. null when on the first page.

​
limit
integer
required

Page size used to build this response.