Retrieve Topic

GEThttps://api.inboxjot.com/v1/topics/{topic_id}

Retrieves one topic. Needs a Full key. A key limited to one domain answers 403.

GET/v1/topics/{topic_id}

1
2

curl -X GET https://api.inboxjot.com/v1/topics/top_06d2mfk8r6pn2tc8yw3hd \
  -H "Authorization: Bearer $INBOXJOT_API_KEY"

{
  "id": "top_06d2mfk8r6pn2tc8yw3hd",
  "name": "Product updates",
  "description": "New features, once a month.",
  "default_subscribed": true,
  "visibility": "public",
  "double_opt_in": false,
  "form_enabled": false,
  "sender_name": null,
  "sender_email": null,
  "redirect_url": null,
  "is_default": false,
  "counts": {
    "subscribed": 3120,
    "pending": 14,
    "unsubscribed": 96
  },
  "created_at": "2026-09-02T10:12:00.000Z",
  "updated_at": "2026-09-02T10:12:00.000Z"
}

Returns the topic.

Path Parameters

topic_idstringrequired

The topic id.

Response

idstring

The topic id.

namestring

The topic name.

descriptionstring | null

Shown on the preference page.

default_subscribedboolean

Whether a new contact is subscribed until they choose.

visibilitystring

public or private.

double_opt_inboolean

Whether a form sign-up must confirm by email.

form_enabledboolean

Whether the hosted sign-up form is on.

sender_namestring | null

The from name for confirmation emails.

sender_emailstring | null

The from address for confirmation emails.

redirect_urlstring | null

The page shown after someone signs up.

is_defaultboolean

True for the default topic. Campaigns use it when no topic is set.

countsobject

How many contacts chose each status.

created_atstring

When it was created.

updated_atstring

When it last changed.

Responses

{ "id": "top_06d2mfk8r6pn2tc8yw3hd", "name": "Product updates", "description": "New features, once a month.", "default_subscribed": true, "visibility": "public", "double_opt_in": false, "form_enabled": false, "sender_name": null, "sender_email": null, "redirect_url": null, "is_default": false, "counts": { "subscribed": 3120, "pending": 14, "unsubscribed": 96 }, "created_at": "2026-09-02T10:12:00.000Z", "updated_at": "2026-09-02T10:12:00.000Z" }