Skip to Content
SendlySendly
API ReferenceTopics

Get a contact's topic preferences

GET
/api/v1/contacts/{id}/topics

Everything this contact has said they want, as the send path reads it.

subscribed on each topic is the EFFECTIVE answer: a contact who has never answered has no row at all, and the topic's default_opt_in decides what that silence means. It is folded in here so no caller has to reimplement the rule.

The top-level subscribed is the global marketing opt-out, and it OUTRANKS every topic. A caller reading only the topic list would conclude somebody is reachable when they are not.

Requires the topics:read scope — View the topics you mail about and who is subscribed to each.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string

Resource id.

Formatuuid

Response Body

The contact's preferences

application/json
  1. response

Everything this contact has said about what they want. subscribed on a topic already folds in default_opt_in, so a contact who has never answered still reads correctly.

contact_id*string
subscribed*boolean

The global marketing opt-out, which OUTRANKS every topic. False means no marketing reaches this contact whatever the topics below say.

topics*array<>
Example Request
curl -X GET 'https://api.sendly.now/api/v1/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/topics'
Example Response
{  "contact_id": "string",  "subscribed": true,  "topics": [    {      "topic_id": "string",      "key": "string",      "name": "string",      "subscribed": true,      "pending": true    }  ]}