A contact's topic subscriptions

id is a contact id or a phone number (preferences belong to the number, so a number that is not a contact still answers).

GET/v1/contacts/{id}/topics

Path Parameters

idstringrequired

Details

consent_status is the global opt-out state: when it is opted_out nothing is sent, whatever the topics say.

Responses

200JSON object
Each topic and whether this number is subscribed
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404Error
Not found
429Error
Rate limit or quota exceeded

Response Fields

objecttopic_subscriptions
phonestring
contact_idstring
Nullable.
consent_statusopted_out, opted_in, no_record
dataarray of TopicSubscription

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404
Not found
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "object": "topic_subscriptions",
  "consent_status": "opted_out"
}