Gets up to a max of 150 contacts.

Required permissions: View Contacts and transactions

get

Query parameters

filterstringOptional

topinteger · int32Optional

Number of Records to Return. Max = 150

skipinteger · int32Optional

Number of Records to Skip.

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

totalContactsinteger · int32Optional

totalReturnedinteger · int32Optional

startinteger · int32Optional

nextinteger · int32Optional

401

Incorrect Permissions or Invalid API Token

application/json

500

Engage Server Error. Unable to process response at this time.

application/json

get/database/contacts

GET /database/contacts?apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Accept: */*

{
  "totalContacts": 1,
  "totalReturned": 1,
  "start": 1,
  "next": 1,
  "selectedContacts": [
    {
      "referenceID": "00000000-0000-0000-0000-000000000000",
      "data": [
        {
          "fieldID": "text",
          "name": "text",
          "value": "text"
        }
      ],
      "source": "text"
    }
  ]
}