Get a paged array of contacts

curl --request GET \
  --url https://api.splose.com/v1/contacts \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "type": "Standard",
      "name": "Plan Manager",
      "title": "Mr.",
      "firstName": "Harry",
      "lastName": "Potter",
      "preferredName": "Harry",
      "occupation": "Contractor",
      "companyName": "splose",
      "providerNumber": "12345678",
      "doctorType": "GP",
      "associatedPatientIds": [
        123
      ],
      "associatedInvoiceIds": [
        123
      ],
      "associatedCaseIds": [
        123
      ],
      "email": "[email protected]",
      "addressL1": "123 King William Street",
      "addressL2": "",
      "addressL3": "",
      "suburb": "Adelaide",
      "state": "SA",
      "postalCode": "5000",
      "country": "Australia",
      "phoneNumbers": [
        {
          "phoneNumber": "401234567",
          "type": "Mobile",
          "code": "+61"
        }
      ],
      "archived": false,
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

GET

contacts

curl --request GET \
  --url https://api.splose.com/v1/contacts \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "type": "Standard",
      "name": "Plan Manager",
      "title": "Mr.",
      "firstName": "Harry",
      "lastName": "Potter",
      "preferredName": "Harry",
      "occupation": "Contractor",
      "companyName": "splose",
      "providerNumber": "12345678",
      "doctorType": "GP",
      "associatedPatientIds": [
        123
      ],
      "associatedInvoiceIds": [
        123
      ],
      "associatedCaseIds": [
        123
      ],
      "email": "[email protected]",
      "addressL1": "123 King William Street",
      "addressL2": "",
      "addressL3": "",
      "suburb": "Adelaide",
      "state": "SA",
      "postalCode": "5000",
      "country": "Australia",
      "phoneNumbers": [
        {
          "phoneNumber": "401234567",
          "type": "Mobile",
          "code": "+61"
        }
      ],
      "archived": false,
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id_gt

integer | null

The starting object id of the next page

Example:

200

id_lt

integer | null

The starting object id of the previous page

Example:

100

update_gt

Search for objects updated after this date time

Example:

"2023-07-30T09:00:00.000Z"

update_lt

Search for objects updated before this date time

Example:

"2023-07-30T09:00:00.000Z"

include_archived

enum<string> | null

default:false

Whether archived objects should be retrieved, default is false

Available options:

true,

false

firstname

string | null

Contact firstname

Example:

"Harry"

lastname

string | null

Contact lastname

Example:

"Potter"

string<email> | null

Contact email

Example:

"[email protected]"

phoneNumber

string | null

Contact phone number without country code

Example:

"0412345678"

Response

200 - application/json

A paged array of contacts

data

object[]

required

Show child attributes

data.id

integer

required

Contact id

Required range: x > 0

Example:

1

data.type

string | null

required

Contact type

Example:

"Standard"

data.name

string | null

required

Contact name

Example:

"Plan Manager"

data.title

string | null

required

Contact title

Example:

"Mr."

data.firstName

string | null

required

Contact first name

Example:

"Harry"

data.lastName

string | null

required

Contact last name

Example:

"Potter"

data.preferredName

string | null

required

Contact preferred name

Example:

"Harry"

data.occupation

string | null

required

Contact occupation

Example:

"Contractor"

data.companyName

string | null

required

Contact company name

Example:

"splose"

data.providerNumber

string | null

required

Contact provider number

Example:

"12345678"

data.doctorType

string | null

required

Contact doctor type

Example:

"GP"

data.associatedPatientIds

number[] | null

required

The associated patients' id in this contact

data.associatedInvoiceIds

number[] | null

required

The associated invoices' id in this contact

data.associatedCaseIds

number[] | null

required

The associated invoices' id in this contact

data.email

string | null

required

Contact email

Example:

"[email protected]"

data.addressL1

string | null

required

Contact address line 1

Example:

"123 King William Street"

data.addressL2

string | null

required

Contact address line 2

Example:

""

data.addressL3

string | null

required

Contact address line 3

Example:

""

data.suburb

string | null

required

Contact city

Example:

"Adelaide"

data.state

string | null

required

Contact state

Example:

"SA"

data.postalCode

string | null

required

Contact post code

Example:

"5000"

data.country

string | null

required

Contact country

Example:

"Australia"

data.phoneNumbers

object[]

Show child attributes

data.phoneNumbers.phoneNumber

string

required

Phone number

Example:

"401234567"

data.phoneNumbers.type

enum<string> | null

Phone number type

Available options:

Mobile,

Home,

Work,

Fax,

Other

Example:

"Mobile"

data.phoneNumbers.code

string | null

Phone country code

Example:

"+61"

data.archived

boolean | null

default:false

Whether the contact has been archived

data.createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

data.updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"

links

object

required

Show child attributes

links.previousPage

string

The link to retrieve next page

Example:

"/v1/${object_type}?id_gt=200"

links.nextPage

string

The link to retrieve previous page

Example:

"/v1/${object_type}?id_lt=100"

Update single patient custom field Create single contact

⌘I

Get started

API Reference

Get a paged array of contacts

Authorizations

Query Parameters

Response