Docs
/
/
Contact supportLog inGet started
Overview
Client libraries
API keys
Authentication
Rate limits
Batch rate limits
Idempotent requests
Data retention
Bulk endpoints
Trigger data filtering
Pagination
Errors
Common error codes
Overview
Set an object
Get an object
List objects in a collection
Delete an object
List preference sets
Get object preference set
Update a preference set
List object schedules
List messages
Get channel data
Set channel data
Unset channel data
List subscriptions
Add subscriptions
Delete subscriptions
Get startedLog inContact support
Platform
Integrations
In-app UI
API reference
CLI reference
Management API
Developer tools
Tutorials

List subscriptions

List subscriptions for an object. Either list the recipients that subscribe to the provided object, or list the objects that the provided object is subscribed to. Determined by the `mode` query parameter.

List subscriptions

List subscriptions for an object. Either list the recipients that subscribe to the provided object, or list the objects that the provided object is subscribed to. Determined by the mode query parameter.

Endpoint

GET/v1/objects/{collection}/{object_id}/subscriptions

Rate limit

Tier 4

Path parameters

object_id
string

Unique identifier for the object.

collection
string

The collection this object belongs to.

Query parameters

mode
enum(string)

Mode of the request. recipient to list the objects that the provided object is subscribed to, object to list the recipients that subscribe to the provided object.

recipientobject
include[]
enum(string)[]

Additional fields to include in the response.

preferences
recipients[]
RecipientReference[]

Recipients to filter by (only used if mode is object).

objects[]
ObjectReference[]

Objects to filter by (only used if mode is recipient).

collection
string

The collection the recipient object belongs to.

id
string

An identifier for the recipient object.

after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

page_size
integer

The number of items per page (defaults to 50).

Returns

ListSubscriptionsResponse

A response containing a list of subscriptions.

entries
Subscription[]

A list of subscriptions.

__typename
string
Required

The typename of the schema.

inserted_at
string(date-time)
Required

Timestamp when the resource was created.

object
Object
Required

A custom Object entity which belongs to a collection.

__typename
string
Required

The typename of the schema.

collection
string
Required

The collection this object belongs to.

created_at
string(date-time)

Timestamp when the resource was created.

id
string
Required

Unique identifier for the object.

properties
object(any)

The custom properties associated with the object.

updated_at
string(date-time)
Required

The timestamp when the resource was last updated.

properties
object(any)

The custom properties associated with the subscription relationship.

recipient
2 possible types
Required

A recipient of a notification, which is either a user or an object.

updated_at
string(date-time)
Required

The timestamp when the resource was last updated.

page_info
PageInfo

Pagination information for a list of resources.

__typename
string

The typename of the schema.

after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

page_size
integer

The number of items per page (defaults to 50).

New chat