List

Get customer information in the system

HTTP Request

[GET] /api/v6/accounts

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
email	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	Customer source
relation_id	integer	Relationship identifier
relation_name	string	Relationship name
gender	string	Gender
total_revenue	float	Total revenue
contacts	array	Contacts
account_manager	integer	Customer manager
accessible_user_ids	array	Related users
custom_fields	object	Defined fields

Filtering

Fields	Support	Type	Description
id	eq,in,not_in	integer	Customer identifier
account_code	eq,contains	string	Customer code
account_name	eq	string	Customer name
relation_id	eq,in,not_in	integer	Relationship
phone_fax	eq,contains	numeric	Fax number
contact_phone	eq,contains	numeric	Customer contact phone number
account_type	eq,in,not_in	string	Customer type
account_source	eq,in	string	Customer source
industry	eq	string	Rating
billing_address_street	eq,contains	string	Address
phone_office	eq,contains	numeric	Phone number
birthday	eq,gte,lte	timestamp	Birthday
birthday_day	eq,gte,lte	integer	Birthday day
birthday_month	eq	integer	Birthday month
birthday_year	eq	integer	Birthday year
website	eq,contains	string	Website
sic_code	eq,contains	string	Tax code
valid	is,in	bool	Valid or not
email	eq,contains	string	Email
description	eq,contains	string	Description
country_id	eq	integer	Country
province_id	eq	integer	Province/City
district_id	eq	integer	District
account_manager	eq,in,not_in	integer	Manager
source_type	eq	string	Source type
created_at	eq,gte,lte,between	timestamp	Creation date
updated_at	eq,gte,lte,between	timestamp	Modification date
gender	eq	integer	Gender
creator_id	eq	integer	Creator
email_unsubcribe	eq	bool	Unsubscribe from email
referrer_id	eq	integer	Referrer identifier
contact_id	eq	integer	Contact identifier
contact_name	eq,contains	string	Contact name
contact_phone	eq,contains	numeric	Contact number
contact_email	eq,contains	string	Contact email
has_sale_order	is	bool	Has sales order
sale_order_status	eq,in	integer	Sales order status
sale_order_date	eq,gte,lte,gt,lt,between,not_between	timestamp	Sales order date
has_purchase_order	is	bool	Has purchase order
purchase_order_date	eq,gte,lte,gt,lt,between,not_between	timestamp	Purchase order date
campaign_id	eq	integer	Campaign
opportunity_status_id	eq,in	integer	Opportunity status
opportunity_created_at	eq,gt,gte,lt,lte	timestamp	Opportunity creation date

Sort

| Sort (field) | Direction |
|:-------------|-----------|
| id | asc,desc |
| account_name | asc,desc |
| account_code | asc,desc |
| email | 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?fields=account_name,custom_fields&filtering[id]=4&limit=1&offset=1 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

Response

{
  "data": [
    {
      "id": 4,
      "account_name": "TEST ACCOUNT API",
      "account_manager": 123,
      "accessible_user_ids": [1,2,3,4],
      "custom_fields": {
        "field_1": 111
      }
    }
  ],
  "has_more": false,
  "offset": 0,
  "limited": 1
}