API documentation
Method list
Test your request
Changelog


getCrmClientData
The method allows you to retrieve detailed data of a specific CRM client, including notes.


Input parameters
crm_client_idintID of the CRM client to retrieve.
include_custom_extra_fieldsbool(optional, false by default) Download values of custom additional fields.



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
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.
notestextClient notes.
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.
custom_extra_fieldsarrayA list containing CRM client custom extra fields returned only if the input parameter include_custom_extra_fields is set to true, where the key is the extra field ID and value is an extra field content for given extra field. The list of extra fields can be retrieved with getCrmClientExtraFields method.
In case of file the following format is returned as value:
{
    "title": "file.pdf" (varchar(40) - the file name)
    "url": "https://upload.cdn.baselinker.com/crm_clients_extra_fields/23/caa37889b042cb92b4fed8677423893f.pdf" (url - the file url)
}



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