Account Request URL
-Base Endpoint
-
Contact Groups
Creates a new Contact Group.
api/v2/contact_groups.json
name
Contact Groups
Updates a contact group.
api/v2/contact_groups/{id}.json
id, name
Communication Logs
Records a communication log. Requires valid "subject_type" and "subject_id".,api/v2/communication_logs.json,subject_type|subject_id|user|type|message|formatted_at|location|url|direction|user_record_id|client_record_id|archived
Communication Logs
Returns all communication logs for a lead or contact. Respects pipeline_view
only returns entries associated with the given pipeline.
api/v2/leads/{id}/communication_logs.json
Communication Templates
Returns all communication templates made by the currently authenticated user.
api/v2/communication_templates.json
Communication Templates
Creates a communication template.
api/v2/communication_templates.json
subject, body
Communication Templates
Updates a communication template.
api/v2/communication_templates/{id}.json
id, subject, body
Communication Templates
Deletes a communication template.
api/v2/communication_templates/{id}.json
id
Contacts
Creates a contact
api/v2/contacts.json
first_name, last_name, email, title, company, linked_in, tags, custom_fields
Contacts
Searches for contacts and returns matching results.
api/v2/contacts.json
query
Contacts
Returns a single contact given their unique identifier.
api/v2/contacts/{id}.json
id
Contacts
Updates a contact.
api/v2/contacts/{id}.json
id, first_name, last_name, email, title, company, linked_in, tags, custom_fields
Contacts
Deletes a contact.
api/v2/contacts/{id}.json
id
Custom Fields
Returns a list of custom field definitions.
api/v2/custom_fields.json
Custom Fields
Creates a custom field.
api/v2/custom_fields.json
label, field_type, options
Custom Fields
Updates a custom field.
api/v2/custom_fields/{id}.json
id, label, field_type, options
Custom Fields
Deletes a custom field.
api/v2/custom_fields/{id}.json
id
Email Templates
Returns a list of templates associated with the current user.
api/v2/email_templates.json
Email Templates
Creates an email template.
api/v2/email_templates.json
template_name, subject, body
Email Templates
Deletes an email template.
api/v2/email_templates/{id}.json
id
Inbound Leads
Creates a new inbound lead. Requires a valid "source_id".,api/v2/inbound_leads.json,source_id|name|email|phone|website|company|address|notes|custom_fields|tags
Leads
Creates a new lead.
api/v2/leads.json
pipeline, funnel_stage, name, first_name, last_name, email, title, company, phone, website, linked_in, address, notes, custom_fields, tags
Leads
Searches for leads and returns matching results. Respects pipeline_view
only returns leads associated with the given pipeline.
api/v2/leads.json
Leads
Updates a lead.
api/v2/leads/{id}.json
id, pipeline, funnel_stage, name, first_name, last_name, email, title, company, phone, website, linked_in, address, notes, custom_fields, tags
Leads
Deletes a lead.
api/v2/leads/{id}.json
id
Notes
Creates a new note for a lead or contact.
api/v2/notes.json
subject_type, subject_id, user, body, location, url, formatted_at, archived
Notes
Returns notes for a lead or contact.
api/v2/leads/{id}/notes.json
id, pipeline_view, archived
Notes
Updates a note.
api/v2/notes/{id}.json
id, body, formatted_at, archived
Notes
Deletes a note.
api/v2/notes/{id}.json
id
Opportunities
Creates a new opportunity.
api/v2/opportunities.json
pipeline, funnel_stage, name, currency, amount, close_date, next_step, expected_close_date, archived, tags, custom_fields
Opportunities
Searches for opportunities and returns matching results. Respects pipeline_view
only returns opportunities associated with the given pipeline.
api/v2/opportunities.json
Opportunities
Updates an opportunity.
api/v2/opportunities/{id}.json
id, pipeline, funnel_stage, name, currency, amount, close_date, next_step, expected_close_date, archived, tags, custom_fields
Opportunities
Deletes an opportunity.
api/v2/opportunities/{id}.json
id
Pipelines
Returns a list of all pipelines.
api/v2/pipelines.json
Pipelines
Creates a new pipeline.
api/v2/pipelines.json
name, account_id
Pipelines
Updates a pipeline.
api/v2/pipelines/{id}.json
id, name, account_id
Pipelines
Deletes a pipeline.
api/v2/pipelines/{id}.json
id
Products
Returns a list of products.
api/v2/products.json
Products
Creates a new product.
api/v2/products.json
name, currency, price, sku, description, unit_label, unit_measure, archived, custom_fields
Products
Updates a product.
api/v2/products/{id}.json
id, name, currency, price, sku, description, unit_label, unit_measure, archived, custom_fields
Products
Deletes a product.
api/v2/products/{id}.json
id
Quotes
Creates a new quote.
api/v2/quotes.json
pipeline, funnel_stage, name, discount_type, subtotal, tax, discount_amount, total, po_number, terms, expire_at, currency, next_step, expected_close_date, archived, tags, custom_fields
Quotes
Searches for quotes and returns matching results. Respects pipeline_view
only returns quotes associated with the given pipeline.
api/v2/quotes.json
Quotes
Updates a quote.
api/v2/quotes/{id}.json
id, pipeline, funnel_stage, name, discount_type, subtotal, tax, discount_amount, total, po_number, terms, expire_at, currency, next_step, expected_close_date, archived, tags, custom_fields
Quotes
Deletes a quote.
api/v2/quotes/{id}.json
id
Sales Settings
Returns some settings for the current user.
api/v2/sales_settings.json
Sales Settings
Updates some settings for the current user.
api/v2/sales_settings.json
weekday_start, currency, day_start, day_end
Provider
Country HQ
API Type
Categories
Alternatives
Important URLs
Last Updated on
Created At
Upskill for a better future
Want to start tracking API at scale?
Get updates about your favorite APIs and SDKs
We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.