Contact
Manage your contacts.
Retrieve a collection of contacts.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100OK
Error
GET /api/contacts HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"email": "text",
"company": "text",
"title": "text",
"business": "text",
"business2": "text",
"mobile_phone": "text",
"mobile_phone2": "text",
"home_phone": "text",
"home_phone2": "text",
"other": "text",
"business_fax": "text",
"home_fax": "text",
"address": "text",
"notes": "text",
"sync_type": "Microsoft 365"
}
]
}The name of contact.
The email of contact.
The company name of contact.
The title of contact.
The business phone number of contact.
The secondary business phone number of contact.
The mobile phone number of contact.
The secondary mobile phone number of contact.
The home phone number of contact.
The secondary home phone number of contact.
The other phone number of contact.
The business fax of contact.
The home fax of contact.
The address.
The notes of contact.
Created contact
Error
POST /api/contacts HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272
{
"name": "text",
"email": "text",
"company": "text",
"title": "text",
"business": "text",
"business2": "text",
"mobile_phone": "text",
"mobile_phone2": "text",
"home_phone": "text",
"home_phone2": "text",
"other": "text",
"business_fax": "text",
"home_fax": "text",
"address": "text",
"notes": "text"
}{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}Retrieves details of a contact.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Error
GET /api/contacts/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"email": "text",
"company": "text",
"title": "text",
"business": "text",
"business2": "text",
"mobile_phone": "text",
"mobile_phone2": "text",
"home_phone": "text",
"home_phone2": "text",
"other": "text",
"business_fax": "text",
"home_fax": "text",
"address": "text",
"notes": "text",
"sync_type": "Microsoft 365"
}Update an contact.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of contact.
The email of contact.
The company name of contact.
The title of contact.
The business phone number of contact.
The secondary business phone number of contact.
The mobile phone number of contact.
The secondary mobile phone number of contact.
The home phone number of contact.
The secondary home phone number of contact.
The other phone number of contact.
The business fax of contact.
The home fax of contact.
The address.
The notes of contact.
OK
Error
POST /api/contacts/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272
{
"name": "text",
"email": "text",
"company": "text",
"title": "text",
"business": "text",
"business2": "text",
"mobile_phone": "text",
"mobile_phone2": "text",
"home_phone": "text",
"home_phone2": "text",
"other": "text",
"business_fax": "text",
"home_fax": "text",
"address": "text",
"notes": "text"
}No content
Delete a certain contact by it's unique id.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
Error
POST /api/contacts/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content