Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Consumers

Retrieve the url of a sync for a specific consumer

This route can be used to retrieve the url that can be shared with your clients to allow them to connect as specified in a sync

post/consumers/{consumer_id}/syncs

Path parameters

consumer_idstring uuid required

Request body

syncidstring uuid required
integrationidsstring[] nullable

[OPTIONAL] Can be used to specify maximum one integrationid for each One API that you want to highlight. If specified, only this connector will be displayed to your clients.

countrystring nullable

ISO 3166-1 alpha-2 country code to filter connectors by country. Ignored if integrationids are provided.

link_metadataobject nullable

Response

Successful Response

urlstring required