SPspott
Clients

List clients

Returns a list of clients. Uses cursor pagination.

get/clients

Request

Query parameters

limitinteger
Example:25

Number of clients to return per page (min: 1, max: 50, default: 25).

cursorstring
Example:eyJtb2RpZmllZEF0IjoiMjAyNC0xMS0wNlQxMDozMDowMC4wMDBaIiwiaWQiOiJjb21wYW55LTEyMyJ9

Base64-encoded cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. Omit for the first page.

modifiedSincestring date-time

Filter clients by sync watermark on or after this date. Useful for incremental synchronization. Defaults to beginning of time if not provided.

modifiedUntilstring date-time

Filter clients by sync watermark on or before this date. Useful for bounded synchronization snapshots. If omitted, no upper bound is applied.

listIdsstring[]

Filter clients by client list IDs.

[
  "client-list-123",
  "client-list-456"
]

Response

Successfully retrieved clients. Returns items array with pagination info containing cursor for the next page.

Changes

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