CRM
Below is a reference to the Endgrate types supported for CRM integrations, and their corresponding default schemas.
crm-activity
crm-activity
Schema:
{
"type": {
"enum": [
"CALL",
"MEETING",
"EMAIL",
"NOTE",
"TASK",
"DEADLINE",
"SEND-LETTER",
"SEND-QUOTE",
"OTHER"
],
"title": "Type",
"type": "string",
"description": "The type of the activity."
},
"title": {
"title": "Title",
"type": "string",
"description": "The title of the activity."
},
"description": {
"title": "Description",
"type": "string",
"description": "The description of the activity."
},
"timestamp": {
"title": "Timestamp",
"type": "string",
"format": "date-time",
},
"user_id": {
"title": "User ID",
"type": "string",
"description": "The unique identifier of the user linked to the activity."
},
"contact_id": {
"title": "Contact ID",
"type": "string",
"description": "The unique identifier of the contact linked to the activity."
},
"company_id": {
"title": "Company ID",
"type": "string",
"description": "The unique identifier of the company linked to the activity."
}
}
Example Object:
{
"type": "CALL",
"title": "Call with Endgrate",
"description": "This call contained important information.",
"timestamp": "2024-01-01 00:00:00",
"user_id": "XXX",
"contact_id": "XXX",
"company_id": "XXX
}
crm-company
crm-company
Schema:
{
"addresses": {
"title": "Addresses",
"type": "array",
"items": {
"type": "object",
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string"
},
"city": {
"title": "City",
"type": "string"
},
"country": {
"title": "Country",
"type": "string"
},
"postal_code": {
"title": "Postal Code",
"type": "string"
},
"state": {
"title": "State",
"type": "string"
},
"street_1": {
"title": "Street 1",
"type": "string"
},
"street_2": {
"title": "Street 2",
"type": "string"
}
},
},
},
"name": {
"title": "Company Name",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"industry": {
"title": "Industry",
"description": "The field or industry that the company operates within.",
"type": "string"
},
"number_of_employees": {
"title": "Number of Employees",
"type": "number"
},
"company_url": {
"title": "Company URL",
"type": "string",
"format": "uri",
},
"owner_id": {
"title": "Owner ID",
"type": "string",
"description": "The unique identifier of the owner (user) linked to the company."
}
}
Example Object:
{
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York",
"country": "United States",
"postal_code": "10036",
"state": "New York",
"street_1": "21 W 46th St",
"street_2": null
}
],
"name": "Endgrate",
"description": "Simple integrations with 100+ providers",
"industry": "API Integration",
"number_of_employees": 50,
"company_url": "https://endgrate.com"
}
crm-contact
crm-contact
Schema:
{
"addresses": {
"title": "Addresses",
"type": "array",
"items": {
"type": "object",
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string"
},
"city": {
"title": "City",
"type": "string"
},
"country": {
"title": "Country",
"type": "string"
},
"postal_code": {
"title": "Postal Code",
"type": "string"
},
"state": {
"title": "State",
"type": "string"
},
"street_1": {
"title": "Street 1",
"type": "string"
},
"street_2": {
"title": "Street 2",
"type": "string"
}
},
},
},
"company": {
"title": "Company",
"type": "string"
},
"company_url": {
"title": "Company URL",
"type": "string",
"format": "uri",
},
"email_addresses": {
"items": {
"type": "object",
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string"
},
"email_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Type",
"type": "string"
}
},
},
"title": "Email Addresses",
"type": "array"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"title": {
"title": "Title",
"type": "string",
},
"phone_numbers": {
"title": "Phone Numbers",
"type": "array",
"items": {
"type": "object",
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Type",
"type": "string"
}
},
},
},
"owner_id": {
"title": "Owner ID",
"type": "string",
"description": "The unique identifier of the owner (user) linked to the contact."
}
}
Example Object:
{
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York",
"country": "United States",
"postal_code": "10036",
"state": "NY",
"street_1": "21 W 46th St",
"street_2": null
}
],
"company": "Endgrate",
"company_website": "https://endgrate.com/",
"creation_date": "2024-01-01 00:00:00",
"email_addresses": [
{
"email_address": "[email protected]",
"email_type": "WORK"
}
],
"first_name": "John",
"last_name": "Doe",
"modification_date": "2024-01-01 00:00:00",
"phone_numbers": [
{
"phone_number": "+1 631-555-1234",
"phone_type": "WORK"
}
]
}
crm-lead
crm-lead
Schema:
{
"addresses": {
"title": "Addresses",
"type": "array",
"items": {
"type": "object",
"properties": {
"address_type": {
"enum": [
"PRIMARY",
"SECONDARY",
"OFFICE",
"SHIPPING",
"BILLING",
"OTHER"
],
"title": "Address Type",
"type": "string"
},
"city": {
"title": "City",
"type": "string"
},
"country": {
"title": "Country",
"type": "string"
},
"postal_code": {
"title": "Postal Code",
"type": "string"
},
"state": {
"title": "State",
"type": "string"
},
"street_1": {
"title": "Street 1",
"type": "string"
},
"street_2": {
"title": "Street 2",
"type": "string"
}
},
},
},
"company": {
"title": "Company",
"type": "string"
},
"company_url": {
"title": "Company URL",
"type": "string",
"format": "uri",
},
"email_addresses": {
"items": {
"type": "object",
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string"
},
"email_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Type",
"type": "string"
}
},
},
"title": "Email Addresses",
"type": "array"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"phone_numbers": {
"title": "Phone Numbers",
"type": "array",
"items": {
"type": "object",
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Type",
"type": "string"
}
},
},
},
"owner_id": {
"title": "Owner ID",
"type": "string",
"description": "The unique identifier of the owner (user) linked to the lead."
}
}
Example Object:
{
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York",
"country": "United States",
"postal_code": "10001",
"state": "NY",
"street_1": "20 W 34th St",
"street_2": "Apt 101"
}
],
"company": "Endgrate",
"email_addresses": [
{
"email_address": "[email protected]",
"email_address_type": "WORK"
}
],
"first_name": "John",
"last_name": "Doe",
"phone_numbers": [
{
"phone_number": "+1 631-555-1234",
"phone_number_type": "WORK"
}
],
"title": "Assistant Manager"
}
crm-opportunity
crm-opportunity
{
"name": {
"title": "Name",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"amount": {
"title": "Amount",
"type": "number"
},
"close_date": {
"format": "date-time",
"description": "The close date of the opportunity.",
"title": "Close Date",
"type": "string"
},
"status": {
"enum": [
"OPEN",
"WON",
"LOST"
],
"title": "Status",
"description": "The status of the opportunity.",
"type": "string"
},
"owner_id": {
"title": "Owner ID",
"type": "string",
"description": "The unique identifier of the owner (user) linked to the opportunity."
},
"contact_id": {
"title": "Owner ID",
"type": "string",
"description": "The unique identifier of the contact linked to the opportunity."
},
"company_id": {
"title": "Company ID",
"type": "string",
"description": "The unique identifier of the company linked to the opportunity."
}
}
Example Object:
{
"name": "New Enterprise Deal",
"description": "A new deal with megacorp.",
"status": "WON",
"amount": 1000000,
}
crm-task
crm-task
{
"title": {
"title": "Title",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"status": {
"enum": [
"CLOSED",
"IN_PROGRESS",
"OPEN"
],
"title": "Status",
"type": "string"
},
"due_date": {
"format": "date-time",
"title": "Due Date",
"type": "string"
},
"completed_date": {
"format": "date-time",
"title": "Completed Date",
"type": "string"
},
"owner_id": {
"title": "Owner ID",
"type": "string",
"description": "The unique identifier of the owner (user) linked to the task."
}
}
Example Object:
{
"title": "Demo",
"description": "Integration demo.",
"status": "OPEN"
}
crm-user
crm-user
Schema:
{
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"display_name": {
"title": "Display Name",
"type": "string"
},
"email": {
"title": "Email",
"type": "string",
"format": "email",
}
}
Example Object:
{
"display_name": "John Doe",
"email": "[email protected]"
}
Updated 3 months ago