getCrmClientData
The method allows you to retrieve detailed data of a specific CRM client, including notes.
Input parameters
Output data:
A sample request in PHP:
| crm_client_id | int | ID of the CRM client to retrieve. |
| include_custom_extra_fields | bool | (optional, false by default) Download values of custom additional fields. |
Output data
The method returns the data in JSON format.
| status | varchar(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_id | int | CRM client ID. |
| status_id | int | Client status ID. |
| star | int | Star type. Values from 0 to 5. 0 means no star. |
| login | text | Client login. |
| phone | text | Client phone. |
| text | Client email. | |
| notes | text | Client notes. |
| contractor_id | int | Base Connect contractor ID associated with the client (0 if none). The list can be retrieved with getConnectIntegrationContractors method. |
| invoice_company | text | Invoice company name. |
| invoice_fullname | text | Invoice full name. |
| invoice_address | text | Invoice address. |
| invoice_postcode | text | Invoice postcode. |
| invoice_city | text | Invoice city. |
| invoice_state | text | Invoice state/province. |
| invoice_country_code | text | Invoice country code. |
| invoice_tax_id | text | Invoice tax ID. |
| delivery_company | text | Delivery company name. |
| delivery_fullname | text | Delivery full name. |
| delivery_address | text | Delivery address. |
| delivery_postcode | text | Delivery postcode. |
| delivery_city | text | Delivery city. |
| delivery_state | text | Delivery state/province. |
| delivery_country_code | text | Delivery country code. |
| custom_extra_fields | array | A 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: