Use the cases method to search for, get info on, update, or create a contact in your CRM.
API Documentation on Postman
Our API Documentation is now available on Postman which includes code samples, interactive documentation, and so much more.
Depreciation Notice
The below documentation is for our v1 Contacts API endpoint. This is still supported, but specifically works only for CRM Contacts.
For FuseDesk contacts – and a better API experience – you’ll want to use our newer v2 Contacts API endpoint.
Request URL:
https://YOURAPPNAME.fusedesk.com/api/v1/contacts
Supported Methods: GET, POST
Authorization: See Authorization
Permission Needed: View Contacts
Return Codes: See Return Codes
Search for a contact in your CRM
Request URL: https://YOURAPPNAME.fusedesk.com/api/v1/contacts
Request Method: GET
Parameters:
Field | Type | Required | Info |
search | string | Yes | What to search your CRM for |
Get info on one contact from your CRM
Request URL: https://YOURAPPNAME.fusedesk.com/api/v1/contacts/{crmContactId}
Request Method: GET
Paramaters: none
Example JSON Response:
{ "Phone1": "(508) 555-1212", "CompanyID": 0, "Email": "[email protected]", "FirstName": "Foo", "Id": 8, "LastName": "Example" }
Create a new contact in your CRM
Request URL: https://YOURAPPNAME.fusedesk.com/api/v1/contacts
Request Method: POST
Parameters:
Field | Type | Required | Info |
FirstName | string | No | Contact’s First Name |
LastName | string | No | Contact’s Last Name |
string | No | Contact’s Email Address | |
Phone1 | string | No | Contact’s Primary Phone Number |
Phone2 | string | No | Contact’s Secondary Phone Number |
dupecheck | boolean | No | Dupe check the contact in your CRM by email address if set to True, i.e. if an existing contact already exists with the Email provided, we’ll return back the existing contact instead of creating a new contact. Defaults to false, i.e. always create a new contact. |
Update an existing CRM contact
Request URL: https://YOURAPPNAME.fusedesk.com/api/v1/contacts/{crmContactId}
Request Method: POST
Parameters: any valid CRM contact field, including custom fields