Get Object Preferences
All Categories
API to get object category preferences
GET
Authorizations
Pass as Bearer <API_KEY>
. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
Used to group similar objects together. Give plural namespace like teams, organizations, and roles.
Unique identifier of the object in your system
Query Parameters
to fetch object preferences for a particular tenant
set this flag to true
if you want to fetch channel list for opt-out categories.
Filter preference categories with tags assigned to them. Used to filter preference categories relevant to the user on UI based on their roles, department or teams.
You can apply single tag filter like tags=tag1
or build nested conditions using logical operators - and
, or
, not
, exists
.
Example:
tags=admin
tags={"or":[{"and":["admin","sales"]},{"and":["admin","manager"]}]}
tags={"not":"admin"}
tags={"exists":true}
Response
200
application/json
200
The response is of type object
.