Documentation | Objects › List Subscriptions

Objects

objects

Methods

Add Subscriptions -> Array<

Subscription

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

Add subscriptions for an object. If a subscription already exists, it will be updated.

Delete An Object -> string

delete/v1/objects/{collection}/{object_id}

Delete an object

Delete Subscriptions -> Array<

Subscription

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

Delete subscriptions

Get An Object ->

Object

get/v1/objects/{collection}/{object_id}

Get an object

Get Channel Data ->

ChannelData

get/v1/objects/{collection}/{object_id}/channel_data/{channel_id}

Get channel data

Get A Preference Set ->

PreferenceSet

get/v1/objects/{collection}/{object_id}/preferences/{preference_set_id}

Get a preference set

List Objects In A Collection -> EntriesCursor<

Object

get/v1/objects/{collection}

List objects in a collection

Parameters

collection: string

after: string

Optional

The cursor to fetch entries after

before: string

Optional

The cursor to fetch entries before

page_size: number

Optional

The page size to fetch

Response fields

entries: Array<

Object

The list of objects

page_info: { __typename, page_size, after, 1 more... }

The information about a paginated result

Request example

curl https://api.knock.app/v1/objects/$COLLECTION \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "entries": [
    {
      "id": "project_1",
      "__typename": "Object",
      "collection": "projects",
      "updated_at": "2024-05-22T12:00:00Z",
      "created_at": null
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "page_size": 25,
    "after": null,
    "before": null
  }
}

List Messages -> EntriesCursor<

Message

get/v1/objects/{collection}/{object_id}/messages

List messages

List Schedules -> EntriesCursor<

Schedule

get/v1/objects/{collection}/{object_id}/schedules

List schedules

List Subscriptions -> EntriesCursor<

Subscription

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

List subscriptions for an object. Either list all subscriptions that belong to the object, or all subscriptions that this object has. Determined by the mode query parameter.

Parameters

collection: string

object_id: string

after: string

Optional

The cursor to fetch entries after

before: string

Optional

The cursor to fetch entries before

mode:

Optional

Mode of the request

"recipient"

"object"

objects: Array<

Optional

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

UnionMember0 = string

A user identifier

ObjectReference = { id, collection }

An object reference to a recipient

page_size: number

Optional

The page size to fetch

recipients: Array<

Optional

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

UnionMember0 = string

A user identifier

ObjectReference = { id, collection }

An object reference to a recipient

Response fields

entries: Array<

Subscription

The list of subscriptions

page_info: { __typename, page_size, after, 1 more... }

The information about a paginated result

Request example

curl https://api.knock.app/v1/objects/$COLLECTION/$OBJECT_ID/subscriptions \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "entries": [
    {
      "__typename": "Subscription",
      "inserted_at": "2021-01-01T00:00:00Z",
      "object": {
        "id": "project_1",
        "__typename": "Object",
        "collection": "projects",
        "updated_at": "2024-05-22T12:00:00Z",
        "created_at": null
      },
      "recipient": {
        "id": "jane",
        "__typename": "User",
        "updated_at": "2024-05-22T12:00:00Z",
        "avatar": null,
        "created_at": null,
        "email": "[email protected]",
        "name": "Jane Doe",
        "phone_number": null,
        "timezone": null
      },
      "updated_at": "2021-01-01T00:00:00Z",
      "properties": {
        "foo": "bar"
      }
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "page_size": 25,
    "after": null,
    "before": null
  }
}