API documentation
Method list
Test your request
Changelog


getCrmClients
The method allows you to retrieve a list of CRM clients. The client list can be limited using the filters described in the method parameters. A maximum of 100 clients are returned at a time. To retrieve full client details (including notes), use the getCrmClientData method.


Input parameters
pageintResults page number (100 results per page, numbered from 1).
filter_crm_client_idintFilter by exact CRM client ID.
filter_emailvarchar(220)Filter by email (partial match).
filter_phonevarchar(156)Filter by phone (partial match).
filter_loginvarchar(156)Filter by login (partial match).
filter_invoice_companyvarchar(500)Filter by invoice company name (partial match).
filter_invoice_tax_idvarchar(50)Filter by invoice tax ID (partial match).
filter_invoice_fullnamevarchar(500)Filter by invoice full name (partial match).
filter_status_idintFilter by exact status ID.



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
clientsarrayAn array of CRM clients containing the fields listed below. The notes field is not included in the list - use getCrmClientData method to retrieve full client details.
| - crm_client_idintCRM client ID.
| - status_idintClient status ID.
| - starintStar type. Values from 0 to 5. 0 means no star.
| - logintextClient login.
| - phonetextClient phone.
| - emailtextClient email.
| - contractor_idintBase Connect contractor ID associated with the client (0 if none). The list can be retrieved with getConnectIntegrationContractors method.
| - invoice_companytextInvoice company name.
| - invoice_fullnametextInvoice full name.
| - invoice_addresstextInvoice address.
| - invoice_postcodetextInvoice postcode.
| - invoice_citytextInvoice city.
| - invoice_statetextInvoice state/province.
| - invoice_country_codetextInvoice country code.
| - invoice_tax_idtextInvoice tax ID.
| - delivery_companytextDelivery company name.
| - delivery_fullnametextDelivery full name.
| - delivery_addresstextDelivery address.
| - delivery_postcodetextDelivery postcode.
| - delivery_citytextDelivery city.
| - delivery_statetextDelivery state/province.
| - delivery_country_codetextDelivery country code.



Sample
Input data:
Output data:
A sample request in PHP: