v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Contacts

Get Contacts for User

get/domains/{domain}/users/{user}/contacts

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

Query parameters

includeDomainboolean

Whether to include onnet domain users, will also match the users to contact details. (values: "yes"/"no", default "no")

Response

unique-idstring required

This is a unique id that will be generated automatically on new contact create.

name-first-namestring required
name-middle-namestring required
name-last-namestring required
emailstring required
companystring required
phonenumber-workstring required
phonenumber-cellstring required
phonenumber-faxstring required
phonenumber-homestring required
tagsstring required
created-datetimestring required