API: Contacts
Table of Contents
The ERP API Contacts endpoint provides a list of contacts and their associated information from the Enapps ERP system. As standard, this method returns 1000 records per page. It is recommended that the results of this API request are stored locally with the view to map e-commerce users with the associated contact. This, should be used in conjunction with Partners and Addresses APIs.
| Base URL | |
| https://<server>:<port>/api/v1 |
| Endpoint | /contacts |
| Method | GET |
Retrieve contacts
Request params | |||
| Name | Type | Required | Description |
| _id | integer | No |
ID of a specific Contact to obtain only 1 Contact record details. |
| string | No |
Filter records by the specified email address. | |
| partner_id | integer | No |
ID of a partner obtained from Partners API response. |
| create_date | date_time | No |
Filter records created from the specified date and later (%Y-%m-%d %H:%M:%S) |
| write_date | date_time | No |
Filter records modified from the specified date and later (%Y-%m-%d %H:%M:%S) |
| additional_fields | array/list | No |
Provide field names of additional fields not part of the standard Endpoint. For more information please refer to Additional Fields |
| page | integer | No |
Optional pagination parameter. |
Response params | ||
| Name | Type | Description |
| id | integer | Contact unique ID |
| partner_id | integer | Partner unique ID |
| first_name | string | First name |
| last_name | string | Last name |
| string | Email address | |
| res_adresses_id | integer | Associated address id. Use Addresses API for obtaining full details of addresses. |
| create_date | date_time | Date of creation (%Y-%m-%d %H:%M:%S) |
| write_date | date_time | Modification date (%Y-%m-%d %H:%M:%S) |
| type | string | Contact type: ‘primary’ (default) or ‘contact’ |
| crm_type | string | CRM type: customer/prospect/etc. |
Examples | |
| HTTP |
GET /api/v1/contacts/ HTTP/1.1 Host: company.erp.zone:4095 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI35IkpXVCJ9.eyJleHAiOjE2OTc2MzEwOTgsInQiOiJhY2Nlc3MiLCJsIjoid29vY29tbWVyY2VhcGkiLCJkYiI6InByb2R1Y3Rpb25fZGV2In0.WXymUki1f_3-_qVm1cKp8gTDqHBFGJs9uEEzhy4 |