Memberships

List workspace/channel membership deltas

Returns membership rows for the given workspace and/or channel, optionally restricted to a user and/or to rows updated after updated_since. Only rows in workspaces/channels the caller has access to are returned. Rows are sorted (last_updated_at, id) ascending; if a list contains exactly limit rows, page by passing the last row’s last_updated_at as updated_since and its id as membership_id.

get/memberships

Request

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

Query parameters

updated_sincestring date-time

Only return memberships whose last_updated_at is after this timestamp. Omit to return all memberships in scope.

membership_idstring

Tie-breaking cursor for paging: with updated_since set to the last row’s last_updated_at, pass that row’s id to resume past rows sharing the same timestamp. Requires updated_since.

limitnumber

Maximum rows returned per list. If a list contains exactly this many rows, more matching rows may exist — re-request with a narrower updated_since window or a larger limit.

workspace_idstring

Workspace to list memberships for. At least one of workspace_id or channel_id is required.

channel_idstring

Channel to list memberships for. At least one of workspace_id or channel_id is required.

user_idstring

Only return memberships belonging to this user. Omit to return memberships for all users in scope.

type'workspace' | 'channel' | 'both'

Which membership kinds to return. Defaults to both. Incompatible with channel_id when set to workspace.

Response

total_resultsnumber required

Number of rows returned across both lists (not the total number of matching rows). limit applies to each list independently, so this can be up to 2×limit.

workspace_resultsnumber required

Number of rows returned in workspace_memberships.

channel_resultsnumber required

Number of rows returned in channel_memberships.

Changes

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