API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- Ledger accounts
- Journals
- Journal entries
- Employees
- Analytic plans
- Analytic accounts
- Miscellaneous operations
- Outstandings
- VAT codes
- Attachments
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
- Objectives
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
- Taxes
Payment
- Payments
- Balances
- Transactions
- Refunds
Banking
- Financial institutions
- Banking accounts
- Transactions
Advanced
- Webhooks
- Syncs
- GETGet syncs
- GETGet sync
- GETGet sync information for one consumer
- POSTEnable a flow for a specific consumer
- POSTSend a custom event for a specific flow
- GETGet execution start/end timestamp
- GETGet execution data for a specific consumer and a specific datastore
- GETGet executions information for one consumer/flow/sync
- PATCHUpdate flow mappings for a specific consumer
- PATCHUpdate flow settings for a specific consumer
- GET
- Issues
- Datastores
Syncs
Get sync information for one consumer
Returns sync information (creation date, mapping) related to a specific consumer
GET
/
consumers
/
{consumerid}
/
syncs
/
{syncid}
Copy
Ask AI
curl --request GET \
--url https://api.chift.eu/consumers/{consumerid}/syncs/{syncid} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"syncid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sync_name": "<string>",
"status": "inactive",
"status_details": "<string>",
"link_createdon": "2023-11-07T05:31:56Z",
"link_mappings": [
{
"name": "<string>",
"description": "<string>",
"display_order": 0,
"challenge_question": "<string>",
"values": [
{
"source_id": "<string>",
"target_id": "<string>"
}
],
"sub_mapping_name": "<string>",
"sub_mapping_description": "<string>"
}
],
"link_metadata": {},
"enabled_flows": [
{
"name": "<string>",
"description": "<string>",
"id": "<string>",
"config": {
"definitionFields": [
{}
],
"doorkeyFields": [
{}
],
"customFields": [
{}
],
"datastores": [
{
"id": "<string>",
"name": "<string>",
"status": "active",
"definition": {
"columns": [
{
"name": "<string>",
"title": "<string>",
"type": "<string>",
"optional": true
}
],
"search_column": "<string>"
}
}
]
},
"values": {},
"enabled_on": "2023-11-07T05:31:56Z",
"trigger": {
"id": "<string>",
"type": "timer",
"cronschedule": "<string>"
}
}
]
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Response
200
application/json
Successful Response
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url https://api.chift.eu/consumers/{consumerid}/syncs/{syncid} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"syncid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sync_name": "<string>",
"status": "inactive",
"status_details": "<string>",
"link_createdon": "2023-11-07T05:31:56Z",
"link_mappings": [
{
"name": "<string>",
"description": "<string>",
"display_order": 0,
"challenge_question": "<string>",
"values": [
{
"source_id": "<string>",
"target_id": "<string>"
}
],
"sub_mapping_name": "<string>",
"sub_mapping_description": "<string>"
}
],
"link_metadata": {},
"enabled_flows": [
{
"name": "<string>",
"description": "<string>",
"id": "<string>",
"config": {
"definitionFields": [
{}
],
"doorkeyFields": [
{}
],
"customFields": [
{}
],
"datastores": [
{
"id": "<string>",
"name": "<string>",
"status": "active",
"definition": {
"columns": [
{
"name": "<string>",
"title": "<string>",
"type": "<string>",
"optional": true
}
],
"search_column": "<string>"
}
}
]
},
"values": {},
"enabled_on": "2023-11-07T05:31:56Z",
"trigger": {
"id": "<string>",
"type": "timer",
"cronschedule": "<string>"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.