List

Get information about customers in the system

HTTP Request

GET /api/v3/accounts

Query Parameters

Parameter	Default	Description
q	blank	Search condition, can be customer name, address, email, phone number
limit	50	Limit the number of records returned
page	1	Current page
custom_fields	null	Search conditions by data definition fields
custom_field_list	null	The data definition fields to retrieve

The search condition by custom field is a bit special.

Example: custom_fields[expected_flight] = "like|hanoi"

Where

• expected_flight: the name of the custom field to search for
• like|hanoi: is the condition and search value separated by a "|"
• Supported search conditions include ">", ">=", "<", "<=", "like", "="
• You can search for multiple custom fields in a single search, in which case the results will be returned according to the AND operator.

The custom_field_list condition will pass the codes of the custom fields, separated by commas.

Example: custom_field_list = "expected_flight,transporter"

Response

{
  "records": [
    {
      "account_id": "13989",
      "account_code": "KH13989",
      "account_name": "Nam Truong Giang Investment and Development Company",
      "address": "",
      "phone": "0436554788",
      "email": "",
      "website": "",
      "logo": "https://sample.getflycrm.com/assets/images/noavatar.png",
      "birthday": "0000-00-00",
      "description": "",
      "created_at": "2016-12-14 08:20:00",
      "account_type": "",
      "contract_signing_date": null,
      "school_": null,
      "class": null,
      "expected_flight": null,
      "ticket_issuance_date": null,
      "product_group": null,
      "contacts": [
          {
              "contact_id": "14007",
              "first_name": "Nguyen Van Nam",
              "last_name": null,
              "phone_mobile": "0906221583",
              "email": "[email protected]",
              "description": null,
              "title": null
          },
          {
              "contact_id": "14069",
              "first_name": "Tran Hoai Thu",
              "last_name": null,
              "phone_mobile": "",
              "email": null,
              "description": null,
              "title": null
          }
      ]
    },
    {}
  ],
  "pagination": {
      "page": 2,
      "total_record": 629,
      "total_page": 13
  }
}