[GET] List Contacts

Description: Contacts are a list of people whom you have conversation with at least once.

REST Method: GET

URL: /contacts.json

Request

Name Type Required Default Options Notes
developer_api_key String Yes Developer api key
per_page Int No 25 0-100 Number of contacts per page
page Int No 1 Page number
order String No asc asc/desc Order of results
begins_with String No Initial character for search contact

Using curl

curl -X GET 'https://api.bornevia.com/contacts.json?developer_api_key=[YOUR_DEVELOPER_API_KEY]&per_page=1&page=1&order=asc&begins_with=tj'

Response

Response Name Type Notes
Header Status Int 200 - Success
400 - Per page is not a number or in between 0 and 100
400 - Page is not a number or page is less than 0
400 - Order is not 'asc' or 'desc'
Body contacts Collection Collection of contact objects
[
  {
    "id": 33234,
    "name": "Tjiu Suryanto",
    "created_at": "2015-03-02T09:22:11.000Z",
    "updated_at": "2015-03-02T09:22:11.000Z",
    "email_addresses": [
      {
        "name": "Tjiu Suryanto",
        "address": "tjiu.suryanto@bornevia.com"
      }
    ]
  }
]
Last updated on 2nd Apr 2016