Channels
Get Channels
GET
/
chat
/
channels

Get all the channels

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 3 properties
Messages
Create Message
POST
/
chat
/
message

Create a new message

Request
This endpoint expects an object.
text
string

Message sent by user

channelId
string

Id of channel to which message was sent

Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 2 properties
Users
Get Users
GET
/
chat
/
users

Get all the users

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 3 properties
Connection
Get Connection
GET
/
connection

Get details of a connection for a specific tenant.

Response
This endpoint returns an object.
error
optional string
tp_id
enum
Show 5 enum values
tp_access_token
string
tp_refresh_token
optional string
tp_customer_id
string
t_id
string
tp_account_url
optional string
owner_account_public_token
string
app_client_id
optional string
app_client_secret
optional string
app
optional object
Show 9 properties
Connection
Delete Connection
DEL
/
connection

Delete a connection for a specific tenant.

Response
This endpoint returns an object.
status
enum
Show 2 enum values
deleted
object
Show 10 properties
Connection
Get All Connections
GET
/
connection
/
all

Get details of all the connection for a specific account at Revert.

Response
This endpoint returns a list of objects.
tp_id
enum
Show 5 enum values
tp_access_token
string
tp_refresh_token
optional string
tp_customer_id
string
t_id
string
tp_account_url
optional string
owner_account_public_token
string
app_client_id
optional string
app_client_secret
optional string
app
optional object
Show 9 properties
Connection
Create Webhook
POST
/
connection
/
webhook

Create a webhook endpoint that listens to a connection events of a specific tenant.

Request
This endpoint expects an object.
webhookUrl
string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
webhookUrl
string
createdAt
string
secret
string
error
optional string
errorMessage
optional any
Connection
Get Webhook
GET
/
connection
/
webhook

Get details of a connection webhook for a specific tenant.

Response
This endpoint returns an object.
status
enum
Show 2 enum values
webhook
any
error
optional string
errorMessage
optional any
Connection
Delete Webhook
DEL
/
connection
/
webhook

Delete the connection webhook for a specific tenant.

Response
This endpoint returns an object.
status
enum
Show 2 enum values
error
optional string
errorMessage
optional any
Company
Get Company
GET
/
crm
/
companies
/
:id

Get details of a company

Path parameters
id
string

The unique id of the company in the CRM.

Query parameters
fields
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 12 properties
Company
Get Companies
GET
/
crm
/
companies

Get all the companies

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 12 properties
Company
Create Company
POST
/
crm
/
companies

Create a new company

Request
This endpoint expects an object.
associations
optional object
Show property
name
string

Name of the company in a CRM.

industry
string

Industry associated with this company. (not supported by pipedrive)

description
string

Description of the company. (not supported by pipedrive)

annualRevenue
integer

Annual revenue of the company. (not supported by pipedrive)

size
integer

Number of employees or size of the company.

phone
string

Phone number of the company. (not supported by pipedrive)

address
object

Company address.

Show 6 properties
id
string

The unique id of this object in Revert

remoteId
string

The unique id of this object in the downstream CRM.

createdTimestamp
any

Creation timestamp of the object.

updatedTimestamp
any

The last updated timestamp of the object.

additional
any

Any fields that are not unified yet/non-unifiable come inside this json object.

Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Company
Update Company
PATCH
/
crm
/
companies
/
:id

Update a company

Path parameters
id
string
Request
This endpoint expects an object.
name
string

Name of the company in a CRM.

industry
string

Industry associated with this company. (not supported by pipedrive)

description
string

Description of the company. (not supported by pipedrive)

annualRevenue
integer

Annual revenue of the company. (not supported by pipedrive)

size
integer

Number of employees or size of the company.

phone
string

Phone number of the company. (not supported by pipedrive)

address
object

Company address.

Show 6 properties
id
string

The unique id of this object in Revert

remoteId
string

The unique id of this object in the downstream CRM.

createdTimestamp
any

Creation timestamp of the object.

updatedTimestamp
any

The last updated timestamp of the object.

additional
any

Any fields that are not unified yet/non-unifiable come inside this json object.

Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Company
Search Companies
POST
/
crm
/
companies
/
search

Search for companies

Query parameters
fields
optional string
Request
This endpoint expects an object.
searchCriteria
any
Response
This endpoint returns an object.
status
enum
Show 2 enum values
results
list of objects
Show 12 properties
Contact
Get Contact
GET
/
crm
/
contacts
/
:id

Get details of a contact

Path parameters
id
string
Query parameters
fields
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 10 properties
Contact
Get Contacts
GET
/
crm
/
contacts

Get all the contacts

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 10 properties
Contact
Create Contact
POST
/
crm
/
contacts

Create a new contact

Request
This endpoint expects an object.
firstName
string

The first name of the contact in a CRM.

lastName
string

The last name of the contact in a CRM.

phone
string

The phone number of the contact in a CRM.

email
string

The email of the contact in a CRM.

associations
optional object
Show 2 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Contact
Update Contact
PATCH
/
crm
/
contacts
/
:id

Update a contact

Path parameters
id
string
Request
This endpoint expects an object.
firstName
string

The first name of the contact in a CRM.

lastName
string

The last name of the contact in a CRM.

phone
string

The phone number of the contact in a CRM.

email
string

The email of the contact in a CRM.

associations
optional object
Show 2 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Contact
Search Contacts
POST
/
crm
/
contacts
/
search

Search for contacts

Query parameters
fields
optional string
Request
This endpoint expects an object.
searchCriteria
any
Response
This endpoint returns an object.
status
enum
Show 2 enum values
results
list of objects
Show 10 properties
Deal
Get Deal
GET
/
crm
/
deals
/
:id

Get details of a deal

Path parameters
id
string
Query parameters
fields
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 13 properties
Deal
Get Deals
GET
/
crm
/
deals

Get all the deals

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 13 properties
Deal
Create Deal
POST
/
crm
/
deals

Create a new deal

Request
This endpoint expects an object.
amount
integer

The deal amount mentioned in the CRM for this deal.

priority
optional string

The priority attached to this deal. (not supported by pipedrive)

stage
string

Deal stage in the CRM.

name
string

The name of the deal in a CRM.

expectedCloseDate
any

Expected close date for this deal. (not supported by pipedrive search api)

isWon
boolean

Is true if the deal is closed (won).

probability
integer

Probability of the deal getting closed, a decimal number between 0 to 1 (inclusive).

associations
optional object
Show 2 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Deal
Update Deal
PATCH
/
crm
/
deals
/
:id

Update a deal

Path parameters
id
string
Request
This endpoint expects an object.
amount
integer

The deal amount mentioned in the CRM for this deal.

priority
optional string

The priority attached to this deal. (not supported by pipedrive)

stage
string

Deal stage in the CRM.

name
string

The name of the deal in a CRM.

expectedCloseDate
any

Expected close date for this deal. (not supported by pipedrive search api)

isWon
boolean

Is true if the deal is closed (won).

probability
integer

Probability of the deal getting closed, a decimal number between 0 to 1 (inclusive).

associations
optional object
Show 2 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Deal
Search Deals
POST
/
crm
/
deals
/
search

Search for deals

Query parameters
fields
optional string
Request
This endpoint expects an object.
searchCriteria
any
Response
This endpoint returns an object.
status
enum
Show 2 enum values
results
list of objects
Show 13 properties
Event
Get Event
GET
/
crm
/
events
/
:id

Get details of a event

Path parameters
id
string
Query parameters
fields
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 13 properties
Event
Get Events
GET
/
crm
/
events

Get all the events

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 13 properties
Event
Create Event
POST
/
crm
/
events

Create a new event

Request
This endpoint expects an object.
type
string

The type of the event in the CRM.

subject
string

The Subject of the event/meeting in the CRM.

startDateTime
string

Event start date time.

endDateTime
string

Event end date time.

isAllDayEvent
boolean

Is true if the event is an all day event.

description
string

Description of the event/meeting.

location
string

The location of the event/meeting.

associations
optional object
Show 2 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Event
Update Event
PATCH
/
crm
/
events
/
:id

Update a event

Path parameters
id
string
Request
This endpoint expects an object.
type
string

The type of the event in the CRM.

subject
string

The Subject of the event/meeting in the CRM.

startDateTime
string

Event start date time.

endDateTime
string

Event end date time.

isAllDayEvent
boolean

Is true if the event is an all day event.

description
string

Description of the event/meeting.

location
string

The location of the event/meeting.

associations
optional object
Show 2 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Event
Search Events
POST
/
crm
/
events
/
search

Search for events

Query parameters
fields
optional string
Request
This endpoint expects an object.
searchCriteria
any
Response
This endpoint returns an object.
status
enum
Show 2 enum values
results
list of objects
Show 13 properties
Event
Delete Event
DEL
/
crm
/
events
/
:id

Delete details of an event in a CRM

Path parameters
id
string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
Field Mapping
Get Field Mapping
GET
/
crm
/
field-mapping

Get field mappings for a connection

Response
This endpoint returns an object.
canAddCustomMapping
boolean
mappableFields
list of objects
Show 2 properties
fieldList
any
Field Mapping
Create Field Mapping
POST
/
crm
/
field-mapping

Create field mappings for a connection

Request
This endpoint expects an object.
standardMappings
list of objects
Show 3 properties
customMappings
list of objects
Show 3 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
Lead
Get Lead
GET
/
crm
/
leads
/
:id

Get details of a lead

Path parameters
id
string
Query parameters
fields
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 10 properties
Lead
Get Leads
GET
/
crm
/
leads

Get all the leads

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 10 properties
Lead
Create Lead
POST
/
crm
/
leads

Create a new lead

Request
This endpoint expects an object.
firstName
string

The first name of the lead in a CRM.

lastName
string

The last name of the lead in a CRM.

phone
string

The phone number of the lead in a CRM.

email
string

The email of the lead in a CRM.

associations
optional object
Show 3 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Lead
Update Lead
PATCH
/
crm
/
leads
/
:id

Update a lead

Path parameters
id
string
Request
This endpoint expects an object.
firstName
string

The first name of the lead in a CRM.

lastName
string

The last name of the lead in a CRM.

phone
string

The phone number of the lead in a CRM.

email
string

The email of the lead in a CRM.

associations
optional object
Show 3 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Lead
Search Leads
POST
/
crm
/
leads
/
search

Search for leads

Query parameters
fields
optional string
Request
This endpoint expects an object.
searchCriteria
any
Response
This endpoint returns an object.
status
enum
Show 2 enum values
results
list of objects
Show 10 properties
Note
Get Note
GET
/
crm
/
notes
/
:id

Get details of a note

Path parameters
id
string
Query parameters
fields
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 7 properties
Note
Get Notes
GET
/
crm
/
notes

Get all the notes

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 7 properties
Note
Create Note
POST
/
crm
/
notes

Create a new note

Request
This endpoint expects an object.
content
string

The contents of the note in plain text or HTML.

associations
optional object
Show 2 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Note
Update Note
PATCH
/
crm
/
notes
/
:id

Update a note

Path parameters
id
string
Request
This endpoint expects an object.
content
string

The contents of the note in plain text or HTML.

associations
optional object
Show 2 properties
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Note
Search Notes
POST
/
crm
/
notes
/
search

Search for notes

Query parameters
fields
optional string
Request
This endpoint expects an object.
searchCriteria
any
Response
This endpoint returns an object.
status
enum
Show 2 enum values
results
list of objects
Show 7 properties
Properties
Get Object Properties
GET
/
crm
/
properties
/
:objectName

Get object properties for connection

Path parameters
objectName
enum
Show 8 enum values
Response
This endpoint returns any.
Properties
Set Custom Properties
POST
/
crm
/
properties
/
:objectName

Set custom properties on an object for a given connection

Path parameters
objectName
enum
Show 8 enum values
Request
This endpoint expects an object.
additional
any

Any fields that are not unified yet/non-unifiable come inside this json object.

name
string
type
string
description
string
Response
This endpoint returns any.
Proxy
Tunnel
POST
/
crm
/
proxy

Call the native CRM api for a specific connection

Request
This endpoint expects an object.
path
string
body
optional any
method
string
queryParams
optional any
Response
This endpoint returns an object.
result
any
Task
Get Task
GET
/
crm
/
tasks
/
:id

Get details of a task

Path parameters
id
string
Query parameters
fields
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 11 properties
Task
Get Tasks
GET
/
crm
/
tasks

Get all the tasks

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 11 properties
Task
Create Task
POST
/
crm
/
tasks

Create a new task

Request
This endpoint expects an object.
subject
string

Subject of the task.

body
string

Body of the task description.

priority
string

The priority of the task in hand. (not supported by pipedrive)

status
string

Completion status of the task.

dueDate
any

The date when this task is due.

associations
optional object
Show property
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Task
Update Task
PATCH
/
crm
/
tasks
/
:id

Update a task

Path parameters
id
string
Request
This endpoint expects an object.
subject
string

Subject of the task.

body
string

Body of the task description.

priority
string

The priority of the task in hand. (not supported by pipedrive)

status
string

Completion status of the task.

dueDate
any

The date when this task is due.

associations
optional object
Show property
Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Task
Search Tasks
POST
/
crm
/
tasks
/
search

Search for tasks

Query parameters
fields
optional string
Request
This endpoint expects an object.
searchCriteria
any
Response
This endpoint returns an object.
status
enum
Show 2 enum values
results
list of objects
Show 11 properties
User
Get User
GET
/
crm
/
users
/
:id

Get details of a user

Path parameters
id
string
Query parameters
fields
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
result
object
Show 9 properties
User
Get Users
GET
/
crm
/
users

Get all the users

Query parameters
fields
optional string
pageSize
optional string
cursor
optional string
Response
This endpoint returns an object.
status
enum
Show 2 enum values
next
optional string
previous
optional string
results
list of objects
Show 9 properties
User
Create User
POST
/
crm
/
users

Create a new user

Request
This endpoint expects an object.
firstName
string

The first name of a user in a CRM.

lastName
string

The last name of a user in a CRM.

phone
string

The phone number of a user in a CRM.

email
string

The email of a user in a CRM.

Response
This endpoint returns an object.
status
enum
Show 2 enum values
message
string
result
any
Account
Get Account Details
POST
/
internal
/
account

Get details of a revert user account

Request
This endpoint expects an object.
userId
string
Response
This endpoint returns an object.
account
object
Show 8 properties
Account
Update Account Credentials
POST
/
internal
/
account
/
credentials

Update account credentials (customer app token, secret, scope)

Request
This endpoint expects an object.
clientId
optional string
clientSecret
optional string
scopes
optional list of strings
tpId
enum
Show 5 enum values
isRevertApp
boolean
appId
string
botToken
optional string
Response
This endpoint returns an object.
id
string
tp_id
enum
Show 5 enum values
scope
optional list of strings
app_client_id
optional string
app_client_secret
optional string
owner_account_public_token
string
account
optional object
Show 8 properties
connections
optional list of objects
Show 10 properties
is_revert_app
boolean
Metadata
Get Crms
GET
/
metadata
/
crms

Retrieve a list of CRMs available for this account from the database based on the public token.

Response
This endpoint returns an object.
status
string
data
list of objects
Show 6 properties
error
optional string
API Reference
API Reference