Sirportly

Toggle Menu

Listing all contacts

This method will return a paginated list of all contacts which are configured for your account.

URL

/api/v2/contacts/all

Supported Parameters

  • page - the number of the page which you wish to display (optional, defaults to 1)

Example JSON

{
  "pagination": {
    "page": 1,
    "offset": 0,
    "per_page": 30,
    "pages": 1,
    "total_records": 3
  },
  "records": [
    {
      "id": 1,
      "reference": "ADAM",
      "name": "Adam Cooke",
      "abbreviated_name": "Adam C",
      "company": "aTech Media",
      "pin": "390976",
      "created_at": "2012-03-20T09:28:41Z",
      "discussion_count": 2,
      "contact_methods": [
        {
          "id": 1,
          "method_type": "email",
          "data": "adam@atechmedia.com",
          "default": true
        }
      ]
    },
    {
      "id": 4,
      "reference": null,
      "name": "Joe Bloggs",
      "abbreviated_name": "Joe B",
      "company": null,
      "pin": "417888",
      "created_at": "2012-03-21T08:58:35Z",
      "discussion_count": 1,
      "contact_methods": [
        {
          "id": 4,
          "method_type": "email",
          "data": "test@atechmedia.com",
          "default": true
        }
      ]
    },
    {
      "id": 2,
      "reference": null,
      "name": "Sir Portly",
      "abbreviated_name": "Sir P",
      "company": null,
      "pin": "046896",
      "created_at": "2012-03-20T15:22:23Z",
      "discussion_count": 15,
      "contact_methods": [
        {
          "id": 2,
          "method_type": "facebook",
          "data": "277829662292946",
          "default": true
        }
      ]
    }
  ]
}