Contacts

List personal contact

Retrieve a collection of personal contacts.

GEThttp://127.0.0.1:8888/api/user/contacts

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/user/contacts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "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

POSThttp://127.0.0.1:8888/api/user/contacts

Body

application/json

namestring

The name of contact.

emailstring

The email of contact.

companystring

The company name of contact.

titlestring

The title of contact.

businessstring

The business phone number of contact.

business2string

The secondary business phone number of contact.

mobile_phonestring

The mobile phone number of contact.

mobile_phone2string

The secondary mobile phone number of contact.

home_phonestring

The home phone number of contact.

home_phone2string

The secondary home phone number of contact.

otherstring

The other phone number of contact.

business_faxstring

The business fax of contact.

home_faxstring

The home fax of contact.

addressstring

The address.

notesstring

The notes of contact.

Response

2014XX

Created contact

Body

application/json

idall of

The unique ID of contact.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/user/contacts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve personal contact details

Retrieves details of a personal contact.

GEThttp://127.0.0.1:8888/api/user/contacts/{id}

Path parameters

id*all of

The unique ID of contact.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of contact.

namestring

The name of contact.

emailstring

The email of contact.

companystring

The company name of contact.

titlestring

The title of contact.

businessstring

The business phone number of contact.

business2string

The secondary business phone number of contact.

mobile_phonestring

The mobile phone number of contact.

mobile_phone2string

The secondary mobile phone number of contact.

home_phonestring

The home phone number of contact.

home_phone2string

The secondary home phone number of contact.

otherstring

The other phone number of contact.

business_faxstring

The business fax of contact.

home_faxstring

The home fax of contact.

addressstring

The address.

notesstring

The notes of contact.

sync_typeenum

The synchronization method.
Can be either:

• Microsoft 365: Sync from Microsoft 365.

Microsoft 365

favoriteboolean

Mark if a contact has been added to the favorites list.

Example: true

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/user/contacts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "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

Update a personal contact.

POSThttp://127.0.0.1:8888/api/user/contacts/{id}

Path parameters

id*all of

The unique ID of contact.

Body

application/json

namestring

The name of contact.

emailstring

The email of contact.

companystring

The company name of contact.

titlestring

The title of contact.

businessstring

The business phone number of contact.

business2string

The secondary business phone number of contact.

mobile_phonestring

The mobile phone number of contact.

mobile_phone2string

The secondary mobile phone number of contact.

home_phonestring

The home phone number of contact.

home_phone2string

The secondary home phone number of contact.

otherstring

The other phone number of contact.

business_faxstring

The business fax of contact.

home_faxstring

The home fax of contact.

addressstring

The address.

notesstring

The notes of contact.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/user/contacts/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();