API ReferenceCollections

Refresh All Source Connections

Trigger data synchronization for all source connections in the collection.



The sync jobs run asynchronously in the background, so this endpoint returns immediately with job details that you can use to track progress. You can monitor the status of individual data synchronization using the source connection endpoints.

Path parameters

readable_idstringRequired
The unique readable identifier of the collection to refresh

Headers

X-API-Keystring or nullOptional
X-Organization-IDstring or nullOptional

Response

Successful Response
source_connection_idstringformat: "uuid"
Unique identifier of the source connection for which this data refresh is running.
idstringformat: "uuid"
Unique identifier for this specific data refresh operation.
organization_idstringformat: "uuid"
Identifier of the organization that owns this data refresh operation.
created_by_emailstring or nullformat: "email"

Email address of the user who initiated this data refresh (for manually triggered operations).

modified_by_emailstring or nullformat: "email"
Email address of the user who last modified this data refresh operation.
created_atstring or nullformat: "date-time"

Timestamp when this data refresh was created and queued (ISO 8601 format).

modified_atstring or nullformat: "date-time"

Timestamp when this data refresh was last modified (ISO 8601 format).

statusenum or null

Current execution status of the data refresh:
• created: Operation has been created but not yet queued
• pending: Operation is queued and waiting to start
• in_progress: Currently running and processing data
• completed: Finished successfully with all data processed
• failed: Encountered errors and could not complete
• cancelled: Manually cancelled before completion

entities_insertedinteger or nullDefaults to 0
Number of new data entities that were added to the collection during this refresh.
entities_updatedinteger or nullDefaults to 0
Number of existing entities that were modified and updated during this refresh.
entities_deletedinteger or nullDefaults to 0
Number of entities that were removed from the collection because they no longer exist in the source.
entities_keptinteger or nullDefaults to 0

Number of entities that were checked but required no changes because they were already up-to-date.

entities_skippedinteger or nullDefaults to 0
Number of entities that were intentionally skipped due to filtering rules or processing decisions.
entities_encounteredmap from strings to integers or null
Detailed breakdown of entities processed by type or category.
started_atstring or nullformat: "date-time"

Timestamp when the data refresh began active processing (ISO 8601 format).

completed_atstring or nullformat: "date-time"

Timestamp when the data refresh finished successfully (ISO 8601 format).

failed_atstring or nullformat: "date-time"

Timestamp when the data refresh failed (ISO 8601 format).

errorstring or null
Detailed error message if the data refresh failed.

Errors