Contacts API

Contacts API

Overview

URLhttps://(subdomain).matters.cloud/api/v1/contacts
Methods SupportedGETPUTPOSTDELETE
DescriptionAllows you to create individual contacts
Allows you to retrieve a list of contacts
Allows you to update details on a contact
Allows you to delete a contact

Get Contacts

The following elements are returned in the Contacts response:
IdInternal unique identifier
First nameFirst name of contact person
Middle nameMiddle name of contact person
Last nameLast name of contact person
User idUnique identifier of user who is listed as the contact owner
Job titleJob title of contact person
Home phoneHome phone number of contact person
Business phoneBusiness phone number of contact person
Mobile phoneMobile phone number of contact person
EmailEmail address of contact person
Organization idUnique identifier of organization who is listed as the primary contact employer

Filter parameters

The most common filters have been added to allow results to be filtered, for example:

https://(subdomain)/api/v1/contacts?first_name=Aaron&last_name=Francis

When using individually or combined with the AND operator:

First nameequalsfirst_name=Aaron
Middle nameequalsmiddle_name=John
Last nameequalslast_name=Francis

Post Contacts

Use this method to create or update one or more contact records

When you are updating a contact you don’t need to specify every element. If you exclude an element then the existing value will be preserved.

The following is required to create a contact

First nameFirst name of contact person

The following are optional when creating/updating contacts

Middle nameMiddle name of contact person
Last nameLast name of contact person
User idUnique identifier of user who is listed as the contact owner
Job titleJob title of contact person
Home phoneHome phone number of contact person
Business phoneBusiness phone number of contact person
Mobile phoneMobile phone number of contact person
EmailEmail address of contact person
Organization idUnique identifier of organization who is listed as the primary contact employer