List Workspace Contact Topic Opt-outs

get

https://{subdomain}.myclickfunnels.com/api/v2/workspaces/{workspace_id}/contacts/unsubscribed_topics

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspace_id

string

required

Query Params

after

string

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

per_page

integer

≥ 1

Defaults to 20

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

string

enum

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

Allowed:

sort_property

string

enum

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.

Allowed:

filter

object

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.

Responses

200OK

401Unauthorized

404Not Found

422Unprocessable Entity - per_page must be a positive integer.