List users registered against the calling publisher.
Header Parameters
Media type the client can parse. Always application/json for this API.
application/jsonQuery Parameters
1-based page index for paginated collection endpoints. When omitted, the first page
is returned. Response bodies include prev and next URLs for navigation.
Filter results to a single end-user by the publisher-supplied unique identifier. When omitted, the endpoint returns records for all users belonging to the calling publisher.
Response
User list returned. Per-publisher-type variants are covered in the schema.
Response Attributes
User list envelope. Gift Card publishers see total-amount;
Affiliate publishers see the full cashback-lifecycle breakdown
(pending / approved / payable / paid / declined). SSO-enabled publishers
additionally receive a token for each user — an SSO login token that places
the user directly into their white-label session.
Show child attributes
Authentication failed. Common causes: missing Authorization header, malformed bearer
token, token expired (tokens live 10 hours), or — on getToken itself — HMAC signature
mismatch due to clock drift or wrong secret.
Response Attributes
Human-readable failure reason. Safe to surface to integrators but not end-users.
Alternative error message field used by a subset of endpoints (notably getToken
and authentication failures). Integrators should check for both message and
error when parsing failure responses.
Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on
most error paths; a few auth-layer failures omit it.
Your publisher account has an IP allow-list and the request came from an address that is not on it. The API checks the caller's IP address on every request once a list exists. Ask Spendstream to add the address, or to clear the list if you do not want the restriction. See IP allow-listing in the guide.
Response Attributes
Rate limit exceeded. The POST /getToken endpoint is rate-limited to five requests
per minute, and the limit is currently shared across all publishers; other endpoints may be throttled at the reverse-proxy layer
in response to abusive traffic. Wait and retry with exponential backoff; the
Retry-After header tells you the minimum wait in seconds.
Response Attributes
Human-readable failure reason. Safe to surface to integrators but not end-users.
Alternative error message field used by a subset of endpoints (notably getToken
and authentication failures). Integrators should check for both message and
error when parsing failure responses.
Numeric status code echoing the HTTP status (e.g. 400, 401). Populated on
most error paths; a few auth-layer failures omit it.
Response