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
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
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
Returns a sync by id
GET
/
syncs
/
{syncid}
curl --request GET \
--url https://api.chift.eu/syncs/{syncid} \
--header 'Authorization: Bearer <token>'
{
"name": "<string>",
"connections": [
{
"one_api": 123,
"connection_type": 123,
"display_order": 0,
"display_hidden": false
}
],
"mappings": [],
"syncid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"consumers": [
"<string>"
],
"flows": [
{
"name": "<string>",
"description": "<string>",
"id": "<string>",
"execution": {
"type": "code",
"data": {
"name": "<string>"
}
},
"config": {
"definitionFields": [
{}
],
"doorkeyFields": [
{}
],
"customFields": [
{}
],
"datastores": []
},
"triggers": [
{
"id": "<string>",
"type": "timer",
"cronschedules": [
"<string>"
],
"visible": true,
"definitionFields": [
{}
],
"options": {}
}
]
}
]
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Response
200
application/json
Successful Response
Minimum length:
1
An enumeration.
Available options:
active
, inactive
An enumeration.
Available options:
fixed
, api
An enumeration.
Available options:
fixed
, api
curl --request GET \
--url https://api.chift.eu/syncs/{syncid} \
--header 'Authorization: Bearer <token>'
{
"name": "<string>",
"connections": [
{
"one_api": 123,
"connection_type": 123,
"display_order": 0,
"display_hidden": false
}
],
"mappings": [],
"syncid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"consumers": [
"<string>"
],
"flows": [
{
"name": "<string>",
"description": "<string>",
"id": "<string>",
"execution": {
"type": "code",
"data": {
"name": "<string>"
}
},
"config": {
"definitionFields": [
{}
],
"doorkeyFields": [
{}
],
"customFields": [
{}
],
"datastores": []
},
"triggers": [
{
"id": "<string>",
"type": "timer",
"cronschedules": [
"<string>"
],
"visible": true,
"definitionFields": [
{}
],
"options": {}
}
]
}
]
}