Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Revert CRM API

Unified CRM models - contacts, leads, companies, deals, notes, events, tasks, users.

Revert CRM API is one of 6 APIs that Revert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 40 operations across 24 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.revert.dev, http://localhost:4001.

40 operations 24 paths 4 schemas 1 DELETE17 GET7 PATCH15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.revert.dev
Authentication
API Key, API Key
Contact
License
Resource Areas
1

Authentication & Security 2

Revert CRM API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-revert-api-token (revertApiToken). An API key is passed in the header as x-revert-t-id (revertTenantId). By default, every request must be authenticated.

  • revertApiToken — Your Revert API key (private token) for the environment.
  • revertTenantId — The tenant / customer id of the linked connection.

Paths & Operations 40

Across 24 paths, the API surfaces 40 operations — 1 DELETE, 17 GET, 7 PATCH, 15 POST. Each is listed below with its method, path, parameters, and response codes.

CRM 40

Unified CRM models - contacts, leads, companies, deals, notes, events, tasks, users.

GET
/crm/ping
Health check (CRM)
pingCrm → 200401
GET
/crm/contacts
List contacts
getContacts 3 params → 200401
POST
/crm/contacts
Create a contact
createContact body → 200401
GET
/crm/contacts/{id}
Get a contact
getContact 1 param → 200401404
PATCH
/crm/contacts/{id}
Update a contact
updateContact 1 param body → 200401
POST
/crm/contacts/search
Search contacts
searchContacts body → 200401
GET
/crm/leads
List leads
getLeads → 200401
POST
/crm/leads
Create a lead
createLead → 200401
GET
/crm/leads/{id}
Get a lead
getLead 1 param → 200401404
PATCH
/crm/leads/{id}
Update a lead
updateLead 1 param → 200401
POST
/crm/leads/search
Search leads
searchLeads body → 200401
GET
/crm/companies
List companies
getCompanies → 200401
POST
/crm/companies
Create a company
createCompany → 200401
GET
/crm/companies/{id}
Get a company
getCompany 1 param → 200401404
PATCH
/crm/companies/{id}
Update a company
updateCompany 1 param → 200401
POST
/crm/companies/search
Search companies
searchCompanies body → 200401
GET
/crm/deals
List deals
getDeals → 200401
POST
/crm/deals
Create a deal
createDeal → 200401
GET
/crm/deals/{id}
Get a deal
getDeal 1 param → 200401404
PATCH
/crm/deals/{id}
Update a deal
updateDeal 1 param → 200401
POST
/crm/deals/search
Search deals
searchDeals body → 200401
GET
/crm/notes
List notes
getNotes → 200401
POST
/crm/notes
Create a note
createNote → 200401
GET
/crm/notes/{id}
Get a note
getNote 1 param → 200401404
PATCH
/crm/notes/{id}
Update a note
updateNote 1 param → 200401
POST
/crm/notes/search
Search notes
searchNotes body → 200401
GET
/crm/events
List events
getEvents → 200401
POST
/crm/events
Create an event
createEvent → 200401
GET
/crm/events/{id}
Get an event
getEvent 1 param → 200401404
PATCH
/crm/events/{id}
Update an event
updateEvent 1 param → 200401
DELETE
/crm/events/{id}
Delete an event
deleteEvent 1 param → 200401404
POST
/crm/events/search
Search events
searchEvents body → 200401
GET
/crm/tasks
List tasks
getCrmTasks → 200401
POST
/crm/tasks
Create a task
createCrmTask → 200401
GET
/crm/tasks/{id}
Get a task
getCrmTask 1 param → 200401404
PATCH
/crm/tasks/{id}
Update a task
updateCrmTask 1 param → 200401
POST
/crm/tasks/search
Search tasks
searchCrmTasks body → 200401
GET
/crm/users
List users
getCrmUsers → 200401
POST
/crm/users
Create a user
createCrmUser → 200401
GET
/crm/users/{id}
Get a user
getCrmUser 1 param → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ContactWrite (5 properties), CommonUnifiedFields (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Contact
Error
object
3 properties
CommonUnifiedFields
object
5 properties
ContactWrite
object
Modeled from Revert's unified contact fields.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

revert-api-crm-api-openapi.yml Raw ↑

Other APIs Revert publishes across the network.

Revert Chat API
Revert Connection Management API
Revert Metadata API
Revert Proxy API
Revert Ticketing API