Skip to main content
POST
Sync signals

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Headers

cdf-version
string

cdf version header. Use this to specify the requested CDF release.

Example:

"alpha"

Body

application/json

Sync request for signals.

Request for syncing signals for a sink.

sink
EmailSinkId · object
required

Reference to a sink. If the type is "user", the user must exist in the user profiles API.

cursor
string

Cursor returned by a previous sync request. Omit to start syncing from the beginning. Unlike list cursors, sync cursors are persistent and may be stored and reused later.

limit
integer
default:100

Maximum number of signals to return.

Required range: 1 <= x <= 1000

Response

A list of signals, a cursor for the next sync, and a flag indicating whether more data is available.

List of signals with a persistent cursor for the next sync.

items
SignalRead · object[]
required
Maximum array length: 1000
nextCursor
string
required

Cursor to use in the next sync request. Always present.

moreData
boolean
required

Whether more signals are immediately available. If true, another sync request with the returned cursor will return more results right away.

Last modified on October 6, 2026