Sync Customers
Get a list of newly added or updated customers from a specified time to the present
HTTP Request
[GET] /api/v6/accounts/sync
Query Parameters
Fields
| Fields | Type | Description |
|---|---|---|
| id | integer | Identifier |
| account_code | string | Customer code |
| account_name | string | Customer name |
| description | string | Description |
| billing_address_street | string | Address |
| phone_office | numeric | Customer phone number |
| string | Customer email | |
| mgr_email | string | Manager email |
| mgr_display_name | string | Manager name |
| website | string | Website |
| logo | string | Customer photo |
| birthday | timestamp | Birthday |
| sic_code | string | Tax code |
| created_at | timestamp | Creation date |
| account_type | string | Customer type |
| account_source | string | Completer |
| relation_id | integer | Relationship identifier |
| relation_name | string | Relationship name |
| gender | string | Gender |
| total_revenue | float | Total revenue |
| contacts | array | Contacts |
| detail_custom_fields | object | Defined fields |
Filtering
| Fields | Support | Type | Description |
|---|---|---|---|
| last_sync | eq | timestamp | Used to filter customers created or modified from this timestamp to the present |
Sort
| Sort (field) | Direction |
|---|---|
| id | asc,desc |
Limit & Offset
| Type | Description | |
|---|---|---|
| Limit | integer | Number of records to retrieve |
| Offset | integer | Number of records to skip |
Example
HTTP Request
GET api/v6/accounts/sync?filtering[last_sync]=1699554513 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json
Status
200 OK
Response
[
{
"account_id": "1",
"account_code": "BID00001",
"account_name": "Company A",
"description": "Company A",
"email": "",
"billing_address_street": "2132 Van Co - Viet Tri City",
"phone_office": "09443443337",
"logo": "https://xxxx.getflycrm.com/assets/images/noavatar.png",
"website": null,
"relation_id": "23",
"birthday": null,
"account_type": "1,2,3,4",
"account_source": null,
"sic_code": null,
"country_id": "0",
"province_id": "0",
"district_id": "0",
"contacts": [
{
"contact_id": "1",
"first_name": "Ta Quang Chung",
"last_name": null,
"phone_mobile": null,
"email": "[email protected]",
"description": "",
"title": "Manager"
}
],
"custom_fields": {
"brand": "VN",
"university": "",
"company_name": "",
"customer_email": "",
"order_date": ""
}
}
]