Account Request URL
-Base Endpoint
-
Deals
Gets all of the deals in a given status. Can limit the results to a specific user
or include inactive deals.
deals
Deals
Gets a single deal.
deals/{deal_id}
deal_id
Deals
Creates a new deal.
deals
name, users, contacts, organizations, tags, description, pipeline_id, status, value, tax_rate, invoice_id, expected_close_date, notes, currency, custom_fields, creator_id
Deals
Updates an existing deal.
deals/{deal_id}
deal_id, name, users, contacts, organizations, tags, description, pipeline_id, status, value, tax_rate, invoice_id, expected_close_date, notes, currency, custom_fields
Deals
Deletes an existing deal.
deals/{deal_id}
deal_id
Contacts
Gets all of the contacts in a given account.
contacts
account_id
Contacts
Gets a single contact.
contacts/{contact_id}
contact_id
Contacts
Creates a new contact.
contacts
first_name, last_name, job_title, email, phone, mobile, fax, website, address_one, address_two, city, state, postcode, country, notes, custom_fields, creator_id
Contacts
Updates an existing contact.
contacts/{contact_id}
contact_id, first_name, last_name, job_title, email, phone, mobile, fax, website, address_one, address_two, city, state, postcode, country, notes, custom_fields
Contacts
Deletes an existing contact.
contacts/{contact_id}
contact_id
Projects
Gets all of the projects in a given account.
projects
account_id
Projects
Gets a single project.
projects/{project_id}
project_id
Projects
Creates a new project.
projects
name, company, project_type, description, rate, budget, start_date, due_date, invoice_rate, invoice_budget, status, private, creator_id
Projects
Updates an existing project.
projects/{project_id}
project_id, name, company, project_type, description, rate, budget, start_date, due_date, invoice_rate, invoice_budget, status, private
Projects
Deletes an existing project.
projects/{project_id}
project_id
Tasks
Gets all of the tasks in a given project.
tasks
project_id
Tasks
Gets a single task.
tasks/{task_id}
task_id
Tasks
Creates a new task.
tasks
name, description, project_id, start_date, due_date, assigned_by, assigned_to, priority, status, estimated_hours, tags, custom_fields, creator_id
Tasks
Updates an existing task.
tasks/{task_id}
task_id, name, description, project_id, start_date, due_date, assigned_by, assigned_to, priority, status, estimated_hours, tags, custom_fields
Tasks
Deletes an existing task.
tasks/{task_id}
task_id
Events
Gets all of the events in a given account.
events
account_id
Events
Gets a single event.
events/{event_id}
event_id
Events
Creates a new event.
events
name, start_date, end_date, all_day, location, description, attending, notes, custom_fields, creator_id
Events
Updates an existing event.
events/{event_id}
event_id, name, start_date, end_date, all_day, location, description, attending, notes, custom_fields
Events
Deletes an existing event.
events/{event_id}
event_id
Invoices
Gets all of the invoices in a given account.
invoices
account_id
Invoices
Gets a single invoice.
invoices/{invoice_id}
invoice_id
Invoices
Creates a new invoice.
invoices
client_id, date, due_date, line_items, sub_total, tax_total, discount_total, amount_due, notes, terms, currency, custom_fields, creator_id
Invoices
Updates an existing invoice.
invoices/{invoice_id}
invoice_id, client_id, date, due_date, line_items, sub_total, tax_total, discount_total, amount_due, notes, terms, currency, custom_fields
Invoices
Deletes an existing invoice.
invoices/{invoice_id}
invoice_id
Milestones
Gets all of the milestones in a given project.
milestones
project_id
Milestones
Gets a single milestone.
milestones/{milestone_id}
milestone_id
Milestones
Creates a new milestone.
milestones
name, description, project_id, start_date, due_date, status, creator_id
Milestones
Updates an existing milestone.
milestones/{milestone_id}
milestone_id, name, description, project_id, start_date, due_date, status
Milestones
Deletes an existing milestone.
milestones/{milestone_id}
milestone_id
Opportunities
Gets all of the opportunities in a given account.
opportunities
account_id
Opportunities
Gets a single opportunity.
opportunities/{opportunity_id}
opportunity_id
Opportunities
Creates a new opportunity.
opportunities
name, company, stage, description, value, expected_close_date, notes, custom_fields, creator_id
Opportunities
Updates an existing opportunity.
opportunities/{opportunity_id}
opportunity_id, name, company, stage, description, value, expected_close_date, notes, custom_fields
Opportunities
Deletes an existing opportunity.
opportunities/{opportunity_id}
opportunity_id
Pipelines
Gets all of the pipelines in a given account.
pipelines
account_id
Pipelines
Gets a single pipeline.
pipelines/{pipeline_id}
pipeline_id
Pipelines
Creates a new pipeline.
pipelines
name, description, stages, creator_id
Pipelines
Updates an existing pipeline.
pipelines/{pipeline_id}
pipeline_id, name, description, stages
Pipelines
Deletes an existing pipeline.
pipelines/{pipeline_id}
pipeline_id
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.