Get started
API Reference
- Patient
- Contact
- Service
- Location
- Practitioner
- Appointment
- Support activity
- Support item
- Invoice
- Payment method
- Waitlist
- Screener
- Patient form
- Case
- Availability
- Payment
- Custom field
Contact
Create single contact
Create single contact
Copy
curl --request POST \
--url https://api.splose.com/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "Standard",
"name": "Plan Manager",
"title": "Mr.",
"firstName": "Harry",
"lastName": "Potter",
"preferredName": "Harry",
"profession": "Contractor",
"companyName": "splose",
"providerNumber": "12345678",
"doctorType": "GP",
"email": "harry@hogwarts.edu",
"addressL1": "123 King William Street",
"addressL2": "",
"addressL3": "",
"suburb": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
]
}'
Copy
{
"id": 1,
"type": "Standard",
"name": "Plan Manager",
"title": "Mr.",
"firstName": "Harry",
"lastName": "Potter",
"preferredName": "Harry",
"profession": "Contractor",
"companyName": "splose",
"providerNumber": "12345678",
"doctorType": "GP",
"associatedPatientIds": [
123
],
"associatedInvoiceIds": [
123
],
"associatedCaseIds": [
123
],
"email": "harry@hogwarts.edu",
"addressL1": "123 King William Street",
"addressL2": "",
"addressL3": "",
"suburb": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
],
"archived": false,
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Successfully created contact
The response is of type object
.
Copy
curl --request POST \
--url https://api.splose.com/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "Standard",
"name": "Plan Manager",
"title": "Mr.",
"firstName": "Harry",
"lastName": "Potter",
"preferredName": "Harry",
"profession": "Contractor",
"companyName": "splose",
"providerNumber": "12345678",
"doctorType": "GP",
"email": "harry@hogwarts.edu",
"addressL1": "123 King William Street",
"addressL2": "",
"addressL3": "",
"suburb": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
]
}'
Copy
{
"id": 1,
"type": "Standard",
"name": "Plan Manager",
"title": "Mr.",
"firstName": "Harry",
"lastName": "Potter",
"preferredName": "Harry",
"profession": "Contractor",
"companyName": "splose",
"providerNumber": "12345678",
"doctorType": "GP",
"associatedPatientIds": [
123
],
"associatedInvoiceIds": [
123
],
"associatedCaseIds": [
123
],
"email": "harry@hogwarts.edu",
"addressL1": "123 King William Street",
"addressL2": "",
"addressL3": "",
"suburb": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
],
"archived": false,
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z"
}
Assistant
Responses are generated using AI and may contain mistakes.