Contacts

List contact

Retrieve a collection of contacts.

get

/contacts

Authorizations

Query parameters

skipinteger · int32 · default: 0

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

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

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

Add a new contact

post

/contacts

Authorizations

Body

namestring · min: 1 · max: 64

The name of contact.

emailstring · max: 128

The email of contact.

companystring · max: 128

The company name of contact.

titlestring · max: 128

The title of contact.

businessstring · max: 128

The business phone number of contact.

business2string · max: 128

The secondary business phone number of contact.

mobile_phonestring · max: 128

The mobile phone number of contact.

mobile_phone2string · max: 128

The secondary mobile phone number of contact.

home_phonestring · max: 128

The home phone number of contact.

home_phone2string · max: 128

The secondary home phone number of contact.

otherstring · max: 128

The other phone number of contact.

business_faxstring · max: 128

The business fax of contact.

home_faxstring · max: 128

The home fax of contact.

addressstring · max: 128

The address.

notesstring · max: 1024

The notes of contact.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/contacts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created contact

Retrieve contact

Retrieves details of a contact.

get

/contacts/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of contact.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

Update a contact

Update an contact.

post

/contacts/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of contact.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64

The name of contact.

emailstring · max: 128

The email of contact.

companystring · max: 128

The company name of contact.

titlestring · max: 128

The title of contact.

businessstring · max: 128

The business phone number of contact.

business2string · max: 128

The secondary business phone number of contact.

mobile_phonestring · max: 128

The mobile phone number of contact.

mobile_phone2string · max: 128

The secondary mobile phone number of contact.

home_phonestring · max: 128

The home phone number of contact.

home_phone2string · max: 128

The secondary home phone number of contact.

otherstring · max: 128

The other phone number of contact.

business_faxstring · max: 128

The business fax of contact.

home_faxstring · max: 128

The home fax of contact.

addressstring · max: 128

The address.

notesstring · max: 1024

The notes of contact.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/contacts/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

4XX

200

No body

OK