updates

Get paged channel membership updates (seen_seq, notified, sort order)

The channel_updates previously embedded in GET /updates, paged by a (since, channel_id) keyset cursor: repeat with since=next_since and channel_id=next_channel_id while has_more is true.

get/channel-updates

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/channel-updates
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Query parameters

sincestring date-time required

Exclusive lower bound on the membership last_updated_at. For page N+1, pass next_since from page N verbatim (millisecond precision matters for the tie-breaking channel_id).

channel_idstring

Keyset tie-breaker: pass next_channel_id from the previous page together with its next_since as since.

limitnumber

Response

number_of_channel_updatesnumber required
has_moreboolean required

True when more channel updates exist past this page; request the next page with since=next_since and channel_id=next_channel_id.

next_sincestring date-time nullable

Keyset cursor date for the next page; pass verbatim as since. Null when the page is empty.

next_channel_idstring nullable

Keyset cursor channel id for the next page; null when the page is empty.

Changes

No recorded changes to this operation across all 1 revision of this API.