(Quick Reference)
Service: List of contacts
Description: This web service returns a json list of contacts.
URL:
https://BASE_URL/api/VERSION/contacts
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc-desc |
| sort | Orders the results by the specified field | String | no | |
The max parameter is set to 100 by default.
Filters parameters:
| Name | Description | Type | Required | Possible values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| customerReference | Filters by the customer's reference | String | no | |
| firstName | Filters by the resource's firstName | String | no | |
| lastName | Filters by the resource's lastName | String | no | |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 1,
"max": 5,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 5,
"customerReference": "C0959",
"customer": {
"id": 3229,
"reference": "C0959",
"name": "Marie's Jewelry",
"href": "/api/v1.0/customers/3229"
},
"firstName": "Marie",
"lastName": "Schrader",
"mobile": "",
"fax": "",
"email": "",
"fonction": "Commercial",
"phone": "",
"phone2": "",
"comment": "",
"country": "",
"city": "",
"postalCode": "",
"address": "",
"isDecisionMaker": true,
"photo": null,
"user": {
"id": 4,
"reference": "emp-00",
"href": "/api/v1.0/users/4"
},
"organization": "entity1",
"dateCreated": "2015-12-18T13:21:18Z",
"lastUpdated": "2016-08-16T13:35:20Z"
}
]
}
To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:
<BASE_URL>/entity1-1450169988465/photoContact/small_1471508040029_2938_marie_schrader.png
Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
