Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
contact

Get a paged array of contacts

Get a paged array of contacts

get/contacts

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

firstnamestring nullable

Contact firstname

Example:Harry
lastnamestring nullable

Contact lastname

Example:Potter
emailstring email nullable

Contact email

Example:harry@hogwarts.edu
phoneNumberstring nullable

Contact phone number without country code

Example:0412345678

Response

A paged array of contacts

Example response

{
  "data": [
    {
      "id": 1,
      "type": "Standard",
      "name": "Plan Manager",
      "title": "Mr.",
      "firstName": "Harry",
      "lastName": "Potter",
      "preferredName": "Harry",
      "occupation": "Contractor",
      "companyName": "splose",
      "providerNumber": "12345678",
      "doctorType": "GP",
      "email": "harry@hogwarts.edu",
      "addressL1": "123 King William Street",
      "suburb": "Adelaide",
      "state": "SA",
      "postalCode": "5000",
      "country": "Australia",
      "phoneNumbers": [
        {
          "type": "Mobile",
          "code": "+61",
          "phoneNumber": "401234567"
        }
      ]
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}