List Sync Drafts

Changed on

List sync drafts across every sync in the workspace, oldest change first. Poll with status=pending and read every page each time: the list shows the current state, not a feed of changes.

get/syncs/drafts

Request

  • Base URL
    https://api.hightouch.com/api/v1
  • Auth
    HTTP bearer

Query parameters

status'pending' | 'approved' | 'rejected' | 'canceled'

The state of a sync draft. New values may be added, so treat an unknown value as closed.

filter on the draft's status (default pending)

syncIdnumber double

only drafts for this sync

updatedSincestring date-time

only drafts changed at or after this ISO timestamp

limitnumber double

the most drafts to return on a page, from 1 to 100 (default 100)

cursorstring

the nextCursor from the previous page

Response

Ok

nextCursorstring nullable required

Pass as cursor to read the next page; null on the last page. A page can hold fewer than limit drafts and still have a next page.

Changes