Below is a reference to the Endgrate types supported for CRM integrations, and their corresponding default schemas.
crm-activity
crm-activitySchema:
{
"activity_type": {
"enum": [
"CALL",
"MEETING",
"EMAIL",
"NOTE",
"TASK",
"DEADLINE",
"SEND-LETTER",
"SEND-QUOTE",
"OTHER"
],
"title": "Activity Type",
"type": "string"
},
"content": {
"title": "Content",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"modified_at": {
"format": "date-time",
"title": "Modified At",
"type": "string"
},
"subject": {
"title": "Subject",
"type": "string"
}
}
Example Object:
{
"activity_type": "CALL",
"content": "This call contained important content",
"created_at": "2024-01-01 00:00:00",
"modified_at": "2024-01-02 00:00:00",
"subject": "Endgrate Call"
}
crm-company
crm-companySchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"addresses": {
"items": {
"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"
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"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"
},
"website": {
"format": "uri",
"title": "Website",
"type": "string"
}
}
Example Object:
{
"id": "20406724619",
"addresses": [
{
"address_type": "PRIMARY",
"city": "New York",
"country": "United States",
"postal_code": "10001",
"state": "New York",
"street_1": "20 W 34th St",
"street_2": "none"
}
],
"name": "Endgrate",
"description": "Simple integrations with 100+ providers",
"industry": "API Integration",
"number_of_employees": 50,
"website": "https://endgrate.com"
}
crm-contact
crm-contactSchema:
{
"id": {
"type": "string",
"title": "ID",
"description": "The unique identifier of the object."
},
"addresses": {
"items": {
"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"
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"company": {
"title": "Company",
"type": "string"
},
"company_website": {
"format": "uri",
"title": "Company Website",
"type": "string"
},
"creation_date": {
"format": "date-time",
"title": "Creation Date",
"type": "string"
},
"email_addresses": {
"items": {
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string"
},
"email_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Type",
"type": "string"
}
},
"type": "object"
},
"title": "Email Addresses",
"type": "array"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"modification_date": {
"format": "date-time",
"title": "Modification Date",
"type": "string"
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Type",
"type": "string"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
}
}
Example Object:
{
"id": "20406724619",
"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",
"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-deal
crm-dealSchema:
{
"amount": {
"title": "Amount",
"type": "number"
},
"close_date": {
"format": "date-time",
"title": "Close Date",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"enum": [
"OPEN",
"WON",
"LOST"
],
"title": "Status",
"type": "string"
}
}
Example Object:
{
"amount": 1000,
"close_date": "2024-01-02 00:00:00",
"description": "Test Deal",
"name": "Test Deal",
"status": "OPEN"
}
crm-lead
crm-leadSchema:
{
"addresses": {
"items": {
"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"
}
},
"type": "object"
},
"type": "array"
},
"company": {
"title": "Company",
"type": "string"
},
"email_addresses": {
"items": {
"properties": {
"email_address": {
"title": "Email Address",
"type": "string"
},
"email_address_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Address Type",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"lead_source": {
"title": "Lead Source",
"type": "string"
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_number_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Number Type",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"title": {
"title": "Title",
"type": "string"
}
}
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",
"lead_source": "Social Media",
"phone_number": [
{
"phone_number": "+1 631-555-1234",
"phone_number_type": "WORK"
}
],
"title": "title"
}
crm-customer
crm-customer{
"addresses": {
"items": {
"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"
}
},
"type": "object"
},
"title": "Addresses",
"type": "array"
},
"company": {
"title": "Company",
"type": "string"
},
"company_website": {
"format": "uri",
"title": "Company Website",
"type": "string"
},
"creation_date": {
"format": "date-time",
"title": "Creation Date",
"type": "string"
},
"email_addresses": {
"items": {
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string"
},
"email_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Type",
"type": "string"
}
},
"type": "object"
},
"title": "Email Addresses",
"type": "array"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"modification_date": {
"format": "date-time",
"title": "Modification Date",
"type": "string"
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Type",
"type": "string"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
}
}
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",
"lead_source": "Social Media",
"phone_number": [
{
"phone_number": "+1 631-555-1234",
"phone_number_type": "WORK"
}
],
"title": "title"
}
crm-note
crm-note{
"active": {
"title": "Active",
"type": "boolean"
},
"content": {
"title": "Content",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"created_by": {
"title": "Created By",
"type": "string"
},
"modified_at": {
"format": "date-time",
"title": "Modified At",
"type": "string"
},
"modified_by": {
"title": "Modified By",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
}
}
Example Object:
{
"active": true,
"content": "Meeting at 2 PM to discuss project milestones. Don't forget to bring your progress reports.",
"created_at": "2024-02-28 12:00:00",
"created_by": "John Doe",
"modified_at": "2024-02-28 13:30:00",
"modified_by": "Jane Smith",
"title": "Project Meeting Reminder"
}
crm-policy
crm-policySchema:
{
"beneficiaries": {
"items": {
"properties": {
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Type",
"type": "string"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
},
"relationship": {
"title": "Relationship",
"type": "string"
},
"type": "object"
},
"title": "Beneficiaries",
"type": "array"
},
"bill_method": {
"title": "Bill Method",
"type": "string"
},
"customer_info": {
"properties": {
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"line_of_business": {
"title": "Line Of Business",
"type": "string"
},
"phone_numbers": {
"items": {
"properties": {
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"phone_type": {
"enum": [
"HOME",
"WORK",
"PERSONAL",
"MOBILE",
"OTHER"
],
"title": "Phone Type",
"type": "string"
}
},
"type": "object"
},
"title": "Phone Numbers",
"type": "array"
}
},
"title": "Customer",
"type": "object"
},
"issued_state": {
"title": "Issued State",
"type": "string"
},
"policy_active": {
"title": "Policy Active",
"type": "boolean"
},
"policy_description": {
"title": "Policy Description",
"type": "string"
},
"policy_end_date": {
"format": "date",
"title": "Policy End Date",
"type": "string"
},
"policy_number": {
"title": "Policy Number",
"type": "string"
},
"policy_start_date": {
"format": "date",
"title": "Policy Start Date",
"type": "string"
},
"policy_type": {
"title": "Policy Type",
"type": "string"
},
"premium": {
"title": "Premium",
"type": "number"
}
}
Example Object:
{
"beneficiaries": {
"first_name": "Jane",
"last_name": "Doe",
"phone_numbers": [
{
"phone": "631-555-1234",
"phone_type": "CELL"
}
],
"relationship": "Mother"
},
"bill_method": "Monthly",
"customer_info": {
"first_name": "John",
"last_name": "Doe",
"line_of_business": "Construction",
"phone_numbers": [
{
"phone": "631-555-1234",
"phone_type": "WORK"
}
]
},
"issued_state": "MD",
"policy_active": true,
"policy_description": "This policy covers medical expenses",
"policy_end_date": "2027-01-21",
"policy_number": "50",
"policy_start_date": "2024-01-01",
"policy_type": "Health Insurance",
"premium": 1000
}
crm-product
crm-productSchema:
{
"brand_name": {
"title": "Brand Name",
"type": "string"
},
"date_created": {
"format": "date-time",
"title": "Date Created",
"type": "string"
},
"date_updated": {
"format": "date-time",
"title": "Date Updated",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"featured": {
"title": "Featured",
"type": "boolean"
},
"images": {
"items": {
"properties": {
"uri": {
"format": "uri",
"title": "URL",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"inventory_quantity": {
"title": "Inventory Quantity",
"type": "number"
},
"is_free_shipping": {
"title": "Free Shipping",
"type": "boolean"
},
"on_sale": {
"title": "On Sale",
"type": "boolean"
},
"options": {
"items": {
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"price": {
"title": "Price",
"type": "number"
},
"product_name": {
"title": "Product Name",
"type": "string"
},
"purchase_note": {
"title": "Purchase Note",
"type": "string"
},
"sku": {
"title": "SKU",
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"ARCHIVED"
],
"title": "Status",
"type": "string"
},
"total_sold": {
"title": "Total Sold",
"type": "number"
},
"variants": {
"items": {
"properties": {
"inventory_quantity": {
"title": "Inventory Quantity",
"type": "number"
},
"name": {
"title": "Name",
"type": "string"
},
"price": {
"title": "Price",
"type": "number"
},
"sku": {
"title": "SKU",
"type": "string"
},
"weight": {
"title": "Weight",
"type": "number"
},
"weight_unit": {
"title": "Weight Unit",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"warranty": {
"title": "Warranty",
"type": "string"
},
"weight": {
"title": "Weight",
"type": "number"
},
"weight_unit": {
"title": "Weight Unit",
"type": "string"
}
}
Example Object:
{
"brand_name": "Endgrate",
"date_created": "2024-01-01 00:00:00",
"date_updated": "2024-01-02 00:00:00",
"description": "Endgrate is a company which makes seamless integrations.",
"featured": true,
"images": [
{
"uri": "https://endgrate.com"
}
],
"inventory_quantity": 50,
"is_free_shipping": true,
"on_sale": true,
"options": [
{
"name": "Membership Level",
"values": [
"Basic",
"Advanced",
"Enterprise"
]
}
],
"price": 1000,
"product_name": "Endgrate Product",
"purchase_note": "You are purchasing an Endgrate Product",
"sku": "ABC-12345-S-BL",
"status": "ACTIVE",
"total_sold": 50,
"variants": [
{
"inventory_quantity": 50,
"name": "Basic",
"price": 1000,
"sku": "ABC-12345-S-BL",
"weight": 50,
"weight_unit": "kilograms"
}
],
"warranty": "7 Day Guarantee",
"weight": 50,
"weight_unit": "kilograms"
}
crm-task
crm-taskSchema:
{
"completed_date": {
"format": "date-time",
"title": "Completed Date",
"type": "string"
},
"content": {
"title": "Content",
"type": "string"
},
"due_date": {
"format": "date-time",
"title": "Due Date",
"type": "string"
},
"status": {
"enum": [
"CLOSED",
"IN_PROGRESS",
"OPEN"
],
"title": "Status",
"type": "string"
},
"subject": {
"title": "Title",
"type": "string"
}
}
Example Object:
{
"completed_date": "2024-01-01 00:00:00",
"content": "Company wants integration demo.",
"due_date": "2024-01-02 00:00:00",
"status": "OPEN",
"subject": "Integration Demo"
}
crm-ticket
crm-ticket{
"create_date": {
"format": "date-time",
"title": "Create Date",
"type": "string"
},
"creator": {
"title": "Ticket Creator",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"due_date": {
"format": "date-time",
"title": "Due Date",
"type": "string"
},
"name": {
"title": "Ticket Name",
"type": "string"
},
"priority": {
"enum": [
"LOW",
"NORMAL",
"HIGH",
"URGENT"
],
"title": "Priority",
"type": "string"
},
"status": {
"enum": [
"CLOSED",
"IN_PROGRESS",
"OPEN"
],
"title": "Status",
"type": "string"
}
}
Example Object:
{
"create_date": "2024-02-28 15:30:00",
"creator": "John Doe",
"description": "This is a sample ticket description.",
"due_date": "2024-03-05 12:00:00",
"name": "Sample Ticket",
"priority": "NORMAL",
"status": "OPEN"
}
crm-user
crm-userSchema:
{
"email_addresses": {
"items": {
"properties": {
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string"
},
"email_type": {
"enum": [
"WORK",
"PERSONAL",
"OTHER"
],
"title": "Email Type",
"type": "string"
}
},
"type": "object"
},
"title": "Email Addresses",
"type": "array"
},
"is_active": {
"title": "Active",
"type": "boolean"
},
"name": {
"title": "Name",
"type": "string"
}
}
Example Object:
{
"name": "John Doe",
"email_addresses": [
{
"email_address": "[email protected]",
"email_type": "WORK"
}
],
"is_active": true,
"id": "user-12345"
}
Updated 20 days ago