Contacts

PreviousGlobal holidays NextFavorite

Was this helpful?

List personal contact

Retrieve a collection of personal contacts.

get

/user/contacts

Authorizations

Query parameters

skipinteger int32

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

topinteger int32

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/user/contacts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "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",
      "favorite": true,
      "sync_type": "Microsoft 365",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Add a new personal contact

post

/user/contacts

Authorizations

Body

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/user/contacts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created contact

Retrieve personal contact details

Retrieves details of a personal contact.

get

/user/contacts/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of contact.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/user/contacts/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "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",
  "favorite": true,
  "sync_type": "Microsoft 365",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Update a personal contact

Update a personal contact.

post

/user/contacts/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of contact.

Body

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.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/user/contacts/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json'

200

4XX

No body