Channels

Get recent channels (cursor paged)

Keyset-paginated page of the channels of the user ordered by channel activity, newest first. Start with no cursor (optionally a date anchor), then keep re-issuing with cursor = next_cursor (same direction) while has_more is true. The cursor carries a tie-breaker, so channels sharing an activity timestamp are neither skipped nor repeated. Optional source_type + source_value restrict it to derived channels, like /channels/recent/derived.

get/v4/channels/recent

Request

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

Query parameters

direction'older' | 'newer'

older walks back from the newest channel (or from date); newer returns channels whose activity moved past date or cursor. Keep it the same across a cursor sequence.

datestring date-time

Optional first-page anchor (older/newer than this instant). Omit it with direction=older to start from the newest channel; direction=newer needs date or cursor. Ignored when cursor is provided.

cursorstring

Opaque cursor returned as next_cursor by a previous response. When provided it supersedes date and continues strictly beyond the last channel of that page, with no overlap and no gaps between channels that share a timestamp.

limitnumber

Maximum number of channels to return (default: 50).

include_deletedboolean
source_type'user_id' | 'channel_id' | 'workspace_id' | 'message_id' | 'share_link_id'

Restrict to derived channels with this source. Requires source_value.

source_valuestring

Source value to match. Requires source_type.

Response

has_moreboolean required

True when more channels remain beyond this page in the requested direction. Do not infer the end from channels.length < limit: a page can come back short when a channel was removed between the membership read and hydration.

next_cursorstring nullable required

Opaque cursor marking where this page ended. While has_more is true, send it back as cursor (same direction) for the next page. With direction=newer it is also returned on the final page, and an empty page echoes the position it was asked from (the cursor, or the date anchor as a cursor): store it and send it later with direction=newer to get the channels whose activity moved since. With direction=older it is null once has_more is false.

Changes

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