The following macros are not currently supported in the header:
- style
GET /contacts
Only available in v0.2.x
The following endpoint is currently unavailable. It will be released in version 1.2.x with the mobile applications.
Resource URL
Returns an array of contacts
GET /contacts
Parameters
Table of allowed parameters.
_page | unsigned int | The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources. |
---|---|---|
_limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. |
_offset | unsigned int | The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page . |
_fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
_filters | partial string | Allows you to filter contacts. For more information on available filters, please see the filter action. |
_search | string | Allows you to search for a contact with a given string. This will look against first name, surname, mobile and email. |
Filters
For a list of filters, please see the contacts endpoint page, found here.
Handling the response
Returns an array of contact objects. Please see GET contact information.