Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List contact topics

GET/contacts/{id}/topics
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstringrequired
min length 1
Responses
200

Every topic of the team with the contact's effective subscription and whether it was chosen explicitly

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
idstring<uuid>required
namestringrequired
descriptionstring | nullrequired
subscriptionstringrequired

Effective choice: the contact's explicit one, else the topic's default

Allowed:opt_inopt_out
explicitbooleanrequired

True when the contact or the API chose this; false when it is the topic's default

visibilitystringrequired

The hosted preference page lists public topics only

Allowed:publicprivate
has_morebooleanrequired
Allowed:false
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/contacts/string/topics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "subscription": "opt_in",
      "explicit": true,
      "visibility": "public"
    }
  ],
  "has_more": false
}

Was this page helpful?