CHchift
Syncs

Get syncs

Changed on

Returns all syncs configured for your account.

get/syncs

Request

Query parameters

consumers_status'all' | 'enabled' | 'not_enabled'

Filter on the consumers of a sync.

"enabled" mirrors the dashboard rule: the consumer has enabled at least one default flow of the sync. "not_enabled" is every other linked consumer.

Filters the consumers listed on each sync. 'enabled' keeps the consumers who enabled at least one default flow of the sync (the dashboard's 'enabled' status), 'not_enabled' keeps the other linked consumers. Defaults to 'all'.

Response

Successful Response

namestring required
configobject nullable
syncidstring uuid required
consumersstring[] required
modulestring nullable

The agentic sync it is, e.g. 'spend_to_accounting': set it up with the agentic routes. Null for a sync defined by its flows.

Changes

  • 020884969534Revision changes
    • breaking

      the response property const value presync was removed for the status

    • warning

      added the new datalayer enum value to the /// response property for the response status

    • warning

      added the new mcp enum value to the /// response property for the response status

    • warning

      added the new presync enum value to the /// response property for the response status

    • info

      added the new optional query request parameter consumers_status

    • info

      added the non-success response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status