Contacts Hub API Examples
These examples show how to use the Contacts API. The Contacts hub provides access to key information for your contacts at your clients, vendors, prospective clients, and government agencies. You can create and update contact names, addresses, phone numbers, related firms and activities, as well as details about future opportunities.
Related Topics:
- Get
Contact Metadata
The contact metadata provides a summary of every field in the database for a contact record, including the name, data type, default value, maximum length, and whether it is a required field. - Get
Contacts
Use this API to read all contacts currently in the Contacts hub. - Read (GET)
Contact
Use this API to read a single contact from the Contacts hub. - Create (POST)
Contact
Use this API to create a new contact in the Contacts hub. - Update (PUT)
Contact
Use this API to update a single contact in the Contacts hub. - Delete (DELETE)
Contact
Use this API to delete a single contact from the Contacts hub. - Read (GET)
Employees Associated with a
Contact
Use this API to read all employees associated with a contact in the Contacts hub. - Read (GET) Categories Associated with a
Contact
Use this API to read all categories associated with a contact in the Contacts hub. Use this endpoint to retrieve categories that apply to the contact. A contact may have many applied categories. The categories are useful for grouping contacts together based on something that they have in common, which then allows you to search for contacts with specific characteristics. - Read (GET)
Projects Associated with a
Contact
Use this API to read all projects associated with a contact in the Contacts hub. - Read (GET)
Campaigns Associated with a
Contact
Use this API to read all marketing campaigns associated with a contact in the Contacts hub. - Read (GET)
Contacts Associated with a
Contact
Use this API to read all contacts associated with a contact in the Contacts hub. - Read (GET) Contact Qualification Status
Use this API to read the contact qualification status from the Contacts hub. - Qualify (POST) a Contact
Use this API to qualify an existing contact in the Contacts hub. - Disqualify (POST) a Contact
Use this API to disqualify an existing contact in the Contacts hub. - Revert (POST) a Contact Back to a Lead
Use this API to revert an existing contact from a qualified status back to a lead in the Contacts hub. - Read (GET) Links Associated with a Contact
Use this API to read links associated with a contact from the Contacts hub. - Read (GET) Files Associated with a
Contact
Use this API to read all files associated with a contact in the Contacts hub. - Read (GET) Custom Tables Associated with a
Contact
Use this API to read custom tables associated with a contact in the Contacts hub.
Parent Topic: Hub APIs