Contacts::UnsubscribedTopic

List Workspace Contact Topic Opt-outs

Changed on

List topic opt-outs across the accessible workspace. Filter by id, contact_id or topic_id.

get/workspaces/{workspace_id}/contacts/unsubscribed_topics

Request

Path parameters

workspace_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

idstring

Comma-separated numeric id values.

contact_idstring

Comma-separated numeric contact_id values.

topic_idstring

Comma-separated numeric topic_id values.

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

Response

OK

idinteger
public_idstring
contact_idinteger
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": 77,
    "public_id": "kQzRbX",
    "contact_id": 4821,
    "topic": {
      "id": 15,
      "public_id": "AbCdEf",
      "name": "Promotions"
    },
    "created_at": "2026-10-01T09:12:44.000Z",
    "updated_at": "2026-10-01T09:12:44.000Z"
  }
]

Changes