| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://{domain}.agilecrm.com/dev | link | — | — | — |
Actions (54)
Contacts · 19
- Add score to contact by emailPOST /dev/api/contacts/add-score
Adjusts lead score for a contact via email.
documented - Add tags to contact by emailPOST /dev/api/contacts/email/tags/add
Adds tags to a contact found by email.
documented - Change contact ownerPOST /dev/api/contacts/change-owner
Change the owner of a contact by email and contact ID.
documented - Create contactPOST /dev/api/contacts
Creates a new contact (PERSON) or company (COMPANY) depending on the type field.
documented - Delete contactDELETE /dev/api/contacts/{id}
Delete the contact with the given ID.
documented - Delete contact tagsPUT /dev/api/contacts/delete/tags
Delete tags from a contact.
documented - Delete tags from contact by emailPOST /dev/api/contacts/email/tags/delete
Deletes tags from a contact found by email.
documented - Get contact by IDGET /dev/api/contacts/{id}
Returns the contact object for the given ID.
documented - Get contact by emailGET /dev/api/contacts/search/email/{email}
Returns the contact associated with the given email.
documented - Get contact by phone numberGET /dev/api/contacts/search/phonenumber/{phone-number}
Finds a contact by phone number.
documented - Get tasks for contact (sorted)GET /dev/api/contacts/{contact_id}/tasks/sort
Retrieves tasks related to a contact sorted by date.
documented - List contactsGET /dev/api/contacts
Returns a paged list of contacts (and companies) in the domain.
documented - Search contacts by emailPOST /dev/api/contacts/search/email
Search for contacts by email (bulk possible).
documented - Search contacts/companiesGET /dev/api/search
Search for contacts or companies by a query.
documented - Update contact propertiesPUT /dev/api/contacts/edit-properties
Partial update of a contact's properties.
documented - Update contact property (by email)POST /dev/api/contacts/add/property
Add/update a single contact property by email.
documented - Update contact tagsPUT /dev/api/contacts/edit/tags
Update the tags for a contact.
documented - Update lead scorePUT /dev/api/contacts/edit/lead-score
Update the lead score for a contact.
documented - Update star valuePUT /dev/api/contacts/edit/add-star
Update the star value for a contact.
documented
Deals · 13
- Bulk delete dealsPOST /dev/api/opportunity/bulk
Deletes multiple deals by IDs.
documented - Create dealPOST /dev/api/opportunity
Creates a new deal.
documented - Create deal for contact by emailPOST /dev/api/opportunity/email/{email}
Creates a deal for the contact identified by email.
documented - Delete dealDELETE /dev/api/opportunity/{id}
Delete the deal by ID.
documented - Get deal by IDGET /dev/api/opportunity/{id}
Returns the deal with the given ID.
documented - Get deals for a track grouped by milestoneGET /dev/api/opportunity/byPipeline/based
Retrieves deals grouped by milestone for a specific track.
documented - Get deals from a particular trackGET /dev/api/opportunity/based
Retrieves deals from a specific track.
documented - Get deals from default track grouped by milestonesGET /dev/api/opportunity/byMilestone
Retrieves deals grouped by milestone for the default track.
documented - Get deals of current userGET /dev/api/opportunity/my/deals
Retrieves deals owned by the current user.
documented - Get deals related to a specific contactGET /dev/api/contacts/{id}/deals
Retrieves deals related to a specific contact.
documented - List dealsGET /dev/api/opportunity
Returns a list of deals (opportunities) in the domain.
documented - Remove contacts from a dealPUT /dev/api/opportunity/partial-update/delete-contact
Update a deal to remove related contacts.
documented - Update deal (partial)PUT /dev/api/opportunity/partial-update
Partial update of a deal.
documented
Notes · 8
- Add note to a contact by emailPOST /dev/api/contacts/email/note/add
Adds a note to a contact identified by email.
documented - Add note to a dealPOST /dev/api/opportunity/deals/notes
Add a note to a deal.
documented - Create notePOST /dev/api/notes
Create a new note related to contacts.
documented - Delete a note from a contactDELETE /dev/api/contacts/{contact_id}/notes/{note_id}
Delete a note from a contact.
documented - Delete notes from a deal (bulk)POST /dev/api/contacts/notes/bulk
Bulk delete notes from a deal.
documented - Get notes for a dealGET /dev/api/opportunity/{deal-id}/notes
Get notes for a specific deal.
documented - List notes for a contactGET /dev/api/contacts/{contact_id}/notes
Get notes for a specific contact.
documented - Update note on a dealPUT /dev/api/opportunity/deals/notes
Update a note on a deal.
documented
Tickets · 6
- Add note to ticketPOST /dev/api/notes/{ticket-id}
Add a note to a ticket.
documented - Create ticketPOST /dev/api/tickets/new-ticket
Create a new support ticket.
documented - Delete ticketDELETE /dev/api/tickets/{id}
Delete a ticket by ID.
documented - Get all ticket filtersGET /dev/api/tickets/filters
Retrieve ticket filters.
documented - Get all ticketsGET /dev/api/tickets/filter
Retrieve tickets using a filter.
documented - Get ticket notesGET /dev/api/tickets/notes/{ticket-id}
Get all messages within a ticket.
documented
Documents · 3
- Create document for a contactPOST /dev/api/documents
Create a document for a contact.
documented - Get documents for a contactGET /dev/api/documents/contact/{contact_id}/docs
Get documents for a contact.
documented - Update a document for a contactPUT /dev/api/documents
Update a document for a contact.
documented
Dynamic Filters · 3
- Dynamic filterPOST /dev/api/filters/filter/dynamic-filter
Run a dynamic filter to retrieve matching contacts or deals.
documented - Dynamic filterPOST /dev/api/filters/filter/dynamic-filter
Runs a dynamic filter to retrieve contacts or deals.
documented - Dynamic filter (bulk variants)POST /dev/api/filters/filter/dynamic-filter
Variations of the dynamic-filter endpoint for bulk retrieval.
documented