Get opt-outs filtered by category or overall opt-outs if no category specified
643 matches
60 actions
PostHog
60 actions
- Fetch CI checks for a report's implementation PRGETv1.0.0
- Fetch comments for a report's implementation PRGETv1.0.0
- Fetch the diff for a commit artefactGETv1.0.0
- Get a channelGETv1.0.0
- Get a loopGETv1.0.0
- Get a run by IDGETv1.0.0
- Get a single artefactGETv1.0.0
- Get a team's quota-limit stateGETv1.0.0
- Get active breakpoints (External API)GETv1.0.0
- Get active task session storage accessGETv1.0.0
- Get app sandbox statusGETv1.0.0
- Get breakpoint hitsGETv1.0.0
- Get channel instructionsGETv1.0.0
- Get iframe connection info for a running appGETv1.0.0
- Get repository readinessGETv1.0.0
- Get scout metadataGETv1.0.0
- Get taskGETv1.0.0
- Get task runGETv1.0.0
- Get task run logsGETv1.0.0
- Get the channel's CONTEXT.md generation taskGETv1.0.0
- Get the current project profileGETv1.0.0
- Get the team's active onboarding wizard cloud runGETv1.0.0
- listGETv1.0.0
- List a report's artefactsGETv1.0.0
- List a report's signalsGETv1.0.0
- List a run's emitted findingsGETv1.0.0
- List blind-spots skills and which one is activeGETv1.0.0
- List channel feed messagesGETv1.0.0
- List channelsGETv1.0.0
- List distinct task repositoriesGETv1.0.0
- List external customer analytics accountsGETv1.0.0
- List living artifacts for a task runGETv1.0.0
- List loop runsGETv1.0.0
- List loopsGETv1.0.0
- List marketing data sourcesGETv1.0.0
- List mentions of the requesterGETv1.0.0
- List pinned tasksGETv1.0.0
- List project members for reviewer routingGETv1.0.0
- List recent emitted findings across all runsGETv1.0.0
- List recent reviewsGETv1.0.0
- List recipients opted out of a message categoryGETv1.0.0
- List review perspectives and their enablementGETv1.0.0
- List review validators and which one is activeGETv1.0.0
- List scout configsGETv1.0.0
- List streamlit appsGETv1.0.0
- List subscription deliveriesGETv1.0.0
- List suppressed email addresses for the teamGETv1.0.0
- List task runsGETv1.0.0
- List the inbox reports a run's findings linked toGETv1.0.0
- List the requester's task activityGETv1.0.0
- List thread messagesGETv1.0.0
- query_draft_sql_retrieveGETv1.0.0
- query_log_retrieveGETv1.0.0
- query_retrieveGETv1.0.0
- Read the connected project's identityGETv1.0.0
- retrieveGETv1.0.0
- Retrieve a streamlit appGETv1.0.0
- Retrieve one review's detailGETv1.0.0
- Retrieve subscription deliveryGETv1.0.0
- retrieve_session_summaries_configGETv1.0.0
Analytics/PostHog
List recipients opted out of a message category
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
{
"type": "object",
"properties": {
"category_key": {
"type": "string"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"project_id": {
"type": "string"
},
"search": {
"type": "string"
}
},
"required": [
"project_id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
{
"type": "object",
"description": "OpenAPI shape for the paginated opt-outs response, so the generated clients get the\n{count, next, previous, results} envelope instead of an untyped object.",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"description": "Total number of opted-out recipients for the category."
},
"next": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "URL for the next page, or null on the last page."
},
"previous": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "URL for the previous page, or null on the first page."
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"identifier",
"preferences",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Server-assigned UUID for this recipient's preference record."
},
"identifier": {
"type": "string",
"description": "The recipient identifier (e.g. email address)."
},
"preferences": {
"description": "Map of category ID to preference status (`OPTED_IN`, `OPTED_OUT` or `NO_PREFERENCE`). The reserved `$all` key covers every marketing message.",
"type": "object"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When the preference was last updated."
}
}
}
}
}
}