Contacts
The company’s address book: callers, clinics, shelters and other organizations. Incoming calls are linked to a contact by phone number, so store numbers in any common format and Ambula normalises them.
List contacts
GET/v1/contacts
Requires the scope contacts:read.
Available from phase 2
The company's contacts (contacten): people and organizations such as clinics and shelters.
Query parameters
phonestring
Look a contact up by phone number, in any common format: 06 1234 5678 and +31612345678 find the same contact.
typestring
person or organization.
created_afterISO 8601
Only records created after this time.
created_beforeISO 8601
Only records created before this time.
updated_afterISO 8601
Only records changed after this time. For a sync, pass your last sync time minus 60 seconds and deduplicate by id.
limitinteger
Page size, 1 to 100. Default 25.
cursorstring
The next_cursor of the previous page.
Get a contact
GET/v1/contacts/{id}
Requires the scope contacts:read.
Available from phase 2
One contact.
Create a contact
POST/v1/contacts
Requires the scope contacts:write.
Available from phase 2
Create a contact. The phone number is normalised, so incoming calls from it are linked to the contact.
Body
typestringrequired
person or organization.
namestringrequired
Name.
phonestring
Phone number, in any common format.
organization_typestring
For organizations: medical, shelter or other.
addressstring
Address.
Update a contact
PATCH/v1/contacts/{id}
Requires the scope contacts:write.
Available from phase 2
Change a contact. Send If-Match with the ETag from your last read.
Body
phonestring
Phone number.
addressstring
Address.
Delete a contact
DELETE/v1/contacts/{id}
Requires the scope contacts:write.
Available from phase 2
Delete a contact.