STstuut
integrations

Request a Sync

Request a data sync for an integration connection.

post/v2/integrations/connections/{connection_id}/sync

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

connection_idstring required

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
status'scheduled' | 'queued' | 'running' | 'cancelled' | 'failed' | 'pending_retry' | 'complete' required
attemptinteger required

Number of attempts made to run this sync. 0 means no attempts have been made.

batch_idstring uuid nullable required
completed_atstring date-time required
entity_idstring nullable required
errorstring nullable required

Error message if the sync failed.

file_idstring nullable required
is_initial_syncboolean required
is_one_offboolean required

Whether or not this is a one off sync

model_idstring required
pagination_stateobject nullable required
started_atstring date-time required
timerange_endstring date-time required
timerange_startstring date-time required
objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

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