Contact

address_1	string or null <= 255 characters
address_2	string or null <= 255 characters
address_3	string or null <= 255 characters
archived_at	string or null <date-time>
city	string or null <= 255 characters
company_name	string or null <= 255 characters
country	string or null
country_code	string or null <= 2 characters ISO 3166-1 country code
created_at	string <date-time>
deleted_at	string or null <date-time>
doctor_type	string or null Enum: "general_practitioner" "specialist"
email	string or null <= 255 characters
first_name	string or null <= 255 characters
id	string <int64>
last_name	string or null <= 255 characters
	object
notes	string or null
occupation	string or null <= 255 characters
	Array of objects or null (PhoneNumber)
post_code	string or null <= 255 characters
preferred_name	string or null
provider_number	string or null <= 255 characters
state	string or null <= 255 characters
title	string or null
type	string or null Enum: "Doctor" "3rd Party Payer" "Standard"
type_code	integer or null Enum: 0 1 2
updated_at	string <date-time>

{"address_1": "string",
"address_2": "string",
"address_3": "string",
"archived_at": "2019-08-24T14:15:22Z",
"city": "string",
"company_name": "string",
"country": "string",
"country_code": "AU",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"doctor_type": "general_practitioner",
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
},
"notes": "string",
"occupation": "string",
"phone_numbers": [{"normalized_number": "39012345678",
"number": "0-123-456-78",
"phone_type": "Fax"
}
],
"post_code": "string",
"preferred_name": "string",
"provider_number": "string",
"state": "string",
"title": "string",
"type": "Doctor",
"type_code": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

List contacts

get/contacts

SecuritybasicAuth

Request

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
company_name	string
created_at	date-time
deleted_at	date-time
email	string
first_name	string
id	int64
last_name	string
occupation	string
type_code	integer
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"contacts": [{"address_1": "string",
"address_2": "string",
"address_3": "string",
"archived_at": "2019-08-24T14:15:22Z",
"city": "string",
"company_name": "string",
"country": "string",
"country_code": "AU",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"doctor_type": "general_practitioner",
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
},
"notes": "string",
"occupation": "string",
"phone_numbers": [{"normalized_number": "39012345678",
"number": "0-123-456-78",
"phone_type": "Fax"
}
],
"post_code": "string",
"preferred_name": "string",
"provider_number": "string",
"state": "string",
"title": "string",
"type": "Doctor",
"type_code": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/contacts?page=2",
"previous": "https://api.au1.cliniko.com/v1/contacts?page=1",
"next": "https://api.au1.cliniko.com/v1/contacts?page=3"
}
}

Create contact

post/contacts

SecuritybasicAuth

Request

Request Body schema: application/json

address_1	string or null <= 255 characters
address_2	string or null <= 255 characters
address_3	string or null <= 255 characters
city	string or null <= 255 characters
company_name	string or null <= 255 characters
country_code	string or null <= 2 characters ISO 3166-1 country code
doctor_type	string or null Enum: "general_practitioner" "specialist"
email	string or null <= 255 characters
first_name	string or null <= 255 characters
last_name	string or null <= 255 characters
notes	string or null
occupation	string or null <= 255 characters
	Array of objects
post_code	string or null <= 255 characters
preferred_name	string or null
provider_number	string or null <= 255 characters
state	string or null <= 255 characters
title	string or null
type_code	integer or null Enum: 0 1 2

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"company_name": "string",
"country_code": "AU",
"doctor_type": "general_practitioner",
"email": "string",
"first_name": "string",
"last_name": "string",
"notes": "string",
"occupation": "string",
"post_code": "string",
"preferred_name": "string",
"provider_number": "string",
"state": "string",
"title": "string",
"type_code": 0,
"phone_numbers": [{"phone_type": "Mobile",
"number": "0-123-456-78"
}
]
}

Response samples

application/json

{"address_1": "string",
"address_2": "string",
"address_3": "string",
"archived_at": "2019-08-24T14:15:22Z",
"city": "string",
"company_name": "string",
"country": "string",
"country_code": "AU",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"doctor_type": "general_practitioner",
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
},
"notes": "string",
"occupation": "string",
"phone_numbers": [{"normalized_number": "39012345678",
"number": "0-123-456-78",
"phone_type": "Fax"
}
],
"post_code": "string",
"preferred_name": "string",
"provider_number": "string",
"state": "string",
"title": "string",
"type": "Doctor",
"type_code": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

Get contact

get/contacts/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

query Parameters

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
deleted_at	date-time

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"address_1": "string",
"address_2": "string",
"address_3": "string",
"archived_at": "2019-08-24T14:15:22Z",
"city": "string",
"company_name": "string",
"country": "string",
"country_code": "AU",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"doctor_type": "general_practitioner",
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
},
"notes": "string",
"occupation": "string",
"phone_numbers": [{"normalized_number": "39012345678",
"number": "0-123-456-78",
"phone_type": "Fax"
}
],
"post_code": "string",
"preferred_name": "string",
"provider_number": "string",
"state": "string",
"title": "string",
"type": "Doctor",
"type_code": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

Update contact

patch/contacts/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

address_1	string or null <= 255 characters
address_2	string or null <= 255 characters
address_3	string or null <= 255 characters
city	string or null <= 255 characters
company_name	string or null <= 255 characters
country_code	string or null <= 2 characters ISO 3166-1 country code
doctor_type	string or null Enum: "general_practitioner" "specialist"
email	string or null <= 255 characters
first_name	string or null <= 255 characters
last_name	string or null <= 255 characters
notes	string or null
occupation	string or null <= 255 characters
	Array of objects
post_code	string or null <= 255 characters
preferred_name	string or null
provider_number	string or null <= 255 characters
state	string or null <= 255 characters
title	string or null
type_code	integer or null Enum: 0 1 2

Responses

200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"address_1": "string",
"address_2": "string",
"address_3": "string",
"city": "string",
"company_name": "string",
"country_code": "AU",
"doctor_type": "general_practitioner",
"email": "string",
"first_name": "string",
"last_name": "string",
"notes": "string",
"occupation": "string",
"post_code": "string",
"preferred_name": "string",
"provider_number": "string",
"state": "string",
"title": "string",
"type_code": 0,
"phone_numbers": [{"phone_type": "Mobile",
"number": "0-123-456-78"
}
]
}

Response samples

application/json

{"address_1": "string",
"address_2": "string",
"address_3": "string",
"archived_at": "2019-08-24T14:15:22Z",
"city": "string",
"company_name": "string",
"country": "string",
"country_code": "AU",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"doctor_type": "general_practitioner",
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/contacts/1"
},
"notes": "string",
"occupation": "string",
"phone_numbers": [{"normalized_number": "39012345678",
"number": "0-123-456-78",
"phone_type": "Fax"
}
],
"post_code": "string",
"preferred_name": "string",
"provider_number": "string",
"state": "string",
"title": "string",
"type": "Doctor",
"type_code": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

Archive contactDeprecated

delete/contacts/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived successfully

Request samples

curl
JavaScript
Python
Ruby

Archive contact

post/contacts/{id}/archive

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived

Request samples

curl
JavaScript
Python
Ruby