Contacts

List personal contact

get

Retrieve a collection of personal contacts.

Authorizations

Query parameters

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

4XX

Error

get

HTTPcURLJavaScriptPython

GET /api/user/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",
      "favorite": true
    }
  ]
}

Add a new personal contact

post

Authorizations

Body

namestring · min: 1 · max: 64Optional

The name of contact.

emailstring · max: 128Optional

The email of contact.

companystring · max: 128Optional

The company name of contact.

titlestring · max: 128Optional

The title of contact.

businessstring · max: 128Optional

The business phone number of contact.

business2string · max: 128Optional

The secondary business phone number of contact.

mobile_phonestring · max: 128Optional

The mobile phone number of contact.

mobile_phone2string · max: 128Optional

The secondary mobile phone number of contact.

home_phonestring · max: 128Optional

The home phone number of contact.

home_phone2string · max: 128Optional

The secondary home phone number of contact.

otherstring · max: 128Optional

The other phone number of contact.

business_faxstring · max: 128Optional

The business fax of contact.

home_faxstring · max: 128Optional

The home fax of contact.

addressstring · max: 128Optional

The address.

notesstring · max: 1024Optional

The notes of contact.

Responses

201

Created contact

application/json

4XX

Error

post

HTTPcURLJavaScriptPython

POST /api/user/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"
}

Retrieve personal contact details

get

Retrieves details of a personal contact.

Authorizations

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

HTTPcURLJavaScriptPython

GET /api/user/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",
  "favorite": true
}

Update a personal contact

post

Update a personal contact.

Authorizations

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

The name of contact.

emailstring · max: 128Optional

The email of contact.

companystring · max: 128Optional

The company name of contact.

titlestring · max: 128Optional

The title of contact.

businessstring · max: 128Optional

The business phone number of contact.

business2string · max: 128Optional

The secondary business phone number of contact.

mobile_phonestring · max: 128Optional

The mobile phone number of contact.

mobile_phone2string · max: 128Optional

The secondary mobile phone number of contact.

home_phonestring · max: 128Optional

The home phone number of contact.

home_phone2string · max: 128Optional

The secondary home phone number of contact.

otherstring · max: 128Optional

The other phone number of contact.

business_faxstring · max: 128Optional

The business fax of contact.

home_faxstring · max: 128Optional

The home fax of contact.

addressstring · max: 128Optional

The address.

notesstring · max: 1024Optional

The notes of contact.

Responses

200

OK

4XX

Error

post

HTTPcURLJavaScriptPython

POST /api/user/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