{ "components": { "requestBodies": { "postReportsDealTimeToClose": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "filters[closed_at][]": { "description": "Filter deals by closed_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[created_at][]": { "description": "Filter deals by created_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[last_touched_at][]": { "description": "Filter deals by last_touched_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[status]": { "description": "Filter deals by status", "enum": [ "", "active", "passive", "won", "lost", "invalid" ], "type": "string" }, "group_by": { "enum": [ "", "sources", "users" ], "type": "string" } }, "required": [ "group_by" ], "type": "object" } } } } }, "schemas": { "Account": { "description": "Account model", "properties": { "accounting_software": { "description": "Accounting software used", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "door_count": { "description": "Number of doors/units managed", "format": "int32", "type": "integer" }, "gclid": { "description": "Google Click ID from ad attribution", "type": "string" }, "how_did_you_hear": { "description": "How the account heard about LeadSimple", "type": "string" }, "how_did_you_hear_other": { "description": "Additional details on how they heard about us", "type": "string" }, "id": { "description": "[Deprecated] Unique account identifier", "format": "int32", "type": "integer" }, "mrr": { "description": "Monthly recurring revenue", "format": "float", "type": "number" }, "name": { "description": "Account name", "type": "string" }, "owner_email": { "description": "Account owner email", "type": "string" }, "owner_name": { "description": "Account owner name", "type": "string" }, "owner_phone": { "description": "Account owner phone", "type": "string" }, "plan_name": { "description": "Subscription plan identifier", "type": "string" }, "spoke_to_sales": { "description": "Whether account spoke to sales team", "type": "boolean" }, "trial_status": { "description": "Whether account is on trial", "type": "boolean" }, "uid": { "description": "Unique account identifier", "type": "string" }, "unit_type": { "description": "Type of units managed", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Address": { "properties": { "country": { "description": "Address Country", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "full_address": { "description": "Prettyfied version of the address, joining all other fields", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "line_1": { "description": "Address Line 1", "type": "string" }, "line_2": { "description": "Address Line 2", "type": "string" }, "line_3": { "description": "Address Line 3", "type": "string" }, "line_4": { "description": "Address Line 4", "type": "string" }, "locality": { "description": "Address Locality (City, in the USA)", "type": "string" }, "postal_code": { "description": "Address Postal Code (ZIP Code, in the USA)", "type": "string" }, "region": { "description": "Address Region (State, in the USA)", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "AssigneeRole": { "description": "AssigneeRole model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "key": { "description": "Assignee role name key", "type": "string" }, "name": { "description": "Assignee role name", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "Call": { "description": "Call model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "deal": { "$ref": "#/components/schemas/Deal" }, "description": { "description": "Call description", "type": "string" }, "direction": { "description": "Whether this call was inbound or outbound", "enum": [ "inbound", "outbound" ], "type": "string" }, "duration": { "description": "The duration of the call in seconds", "format": "int32", "type": "integer" }, "from": { "description": "Call from", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "manually_added": { "description": "Whether a user added this call manually", "type": "boolean" }, "originally_dialed_number": { "description": "First receiving number for a forwarded inbound call", "type": "string" }, "outcome": { "description": "How did the call end up", "enum": [ "answered", "no_answer", "voicemail", "hangup" ], "type": "string" }, "process": { "$ref": "#/components/schemas/Process" }, "recording_url": { "description": "URL of the primary call recording, if any", "type": "string" }, "to": { "description": "Call to", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Contact": { "description": "Contact model", "properties": { "company_name": { "description": "Name of the company associated with the contact", "type": "string" }, "contact_type": { "description": "Contact Type (one of 'owner', 'tenant', 'vendor')", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "custom_fields": { "$ref": "#/components/schemas/CustomField" }, "emails": { "type": "string" }, "first_name": { "description": "Contact first name", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "last_name": { "description": "Contact last name", "type": "string" }, "link": { "description": "Link to contact in LeadSimple", "type": "string" }, "mailing_address": { "$ref": "#/components/schemas/Address" }, "name": { "description": "Contact name", "type": "string" }, "phone_numbers": { "type": "string" }, "tags": { "description": "Contact tags", "items": { }, "type": "array" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "ContactRole": { "description": "ContactRole model", "properties": { "contacts": { "$ref": "#/components/schemas/Contact" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "key": { "description": "Contact role name key", "type": "string" }, "name": { "description": "Contact role name", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Conversation": { "description": "Conversation model", "properties": { "assigned": { "description": "Whether a conversation has been assigned to a user", "type": "boolean" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "first_call": { "$ref": "#/components/schemas/Call" }, "first_email": { "$ref": "#/components/schemas/Email" }, "first_text_message": { "$ref": "#/components/schemas/TextMessage" }, "id": { "description": "Unique identifier", "type": "string" }, "inbox": { "description": "Inbox that this conversation belongs to. It is either a list of emails or a phone number", "type": "string" }, "kind": { "description": "Identifies if a conversation is of type 'phone' or 'email'", "type": "string" }, "last_activity_at": { "description": "Timestamp when the last activity of this conversation happened", "type": "string" }, "link": { "description": "Link to conversation in LeadSimple", "type": "string" }, "snippet": { "description": "Conversation activities snippet", "type": "string" }, "status": { "description": "One of [open, closed, snoozed] identifying the Conversation status", "type": "string" }, "subject": { "description": "Conversation subject", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "ConversationTag": { "description": "ConversationTag model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "id": { "description": "Unique identifier per account", "type": "string" }, "name": { "description": "Tag name", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "CustomField": { "description": "CustomField model", "properties": { "category": { "description": "Whether this field is associated with a Deal, Contact, or Property object", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "data_type": { "description": "Type of data accepted", "type": "string" }, "key": { "description": "Unique identifier, pass this key to set a field", "type": "string" }, "label": { "description": "Friendly name for the field", "type": "string" }, "label_id": { "description": "Unique identifier for custom field label", "type": "string" }, "options": { "description": "Allowed options if multi-select field", "items": { }, "type": "array" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" }, "value": { "description": "The value of this field on the given object", "type": "string" } }, "type": "object" }, "Deal": { "description": "Deal model", "properties": { "assignee": { "$ref": "#/components/schemas/User" }, "closed_at": { "description": "Timestamp when this deal closed (was marked won / lost)", "type": "string" }, "comments": { "description": "Deal comments", "type": "string" }, "contacts": { "$ref": "#/components/schemas/Contact" }, "cost": { "description": "Deal cost", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "custom_fields": { "$ref": "#/components/schemas/CustomField" }, "first_contacted_at": { "description": "Timestamp when someone first made contact with this deal (best estimate)", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "last_assigned_at": { "description": "Timestamp of the last time this deal was assigned to a user", "type": "string" }, "last_called_at": { "description": "Timestamp of the most recent call on this deal", "type": "string" }, "last_emailed_at": { "description": "Timestamp of the most recent email on this deal", "type": "string" }, "last_inbound_touch_at": { "description": "Timestamp of the most recent inbound touch on this deal", "type": "string" }, "link": { "description": "Link to deal in LeadSimple", "type": "string" }, "marketing_gclid": { "description": "The Google Click ID, from a PPC click", "type": "string" }, "marketing_utm_campaign": { "description": "The UTM campaign parameter, ie 'email-campaign-jan-23'", "type": "string" }, "marketing_utm_content": { "description": "The UTM content parameter, ie 'https://my.link'", "type": "string" }, "marketing_utm_id": { "description": "The UTM id parameter, required by GA4", "type": "string" }, "marketing_utm_medium": { "description": "The UTM medium parameter, ie 'search'", "type": "string" }, "marketing_utm_source": { "description": "The UTM source parameter, ie 'google'", "type": "string" }, "marketing_utm_source_platform": { "description": "The UTM source platform parameter, supported by GA4", "type": "string" }, "marketing_utm_term": { "description": "The UTM campaign term parameter, ie 'property management Austin'", "type": "string" }, "name": { "description": "Deal name", "type": "string" }, "next_task_due_at": { "description": "Timestamp of when the next task on this deal is due", "type": "string" }, "next_task_kind": { "description": "Type of the next task that is due on this deal", "format": "int32", "type": "integer" }, "num_outbound_calls": { "description": "Number of outbound calls recorded on this deal", "format": "int32", "type": "integer" }, "num_outbound_emails": { "description": "Number of outbound emails recorded on this deal", "format": "int32", "type": "integer" }, "num_outbound_touches": { "description": "Number of outbound touches recorded on this deal", "format": "int32", "type": "integer" }, "num_units": { "description": "Number of units recorded on this deal", "format": "int32", "type": "integer" }, "pipeline": { "$ref": "#/components/schemas/Pipeline" }, "pipeline_id": { "description": "Unique identifier for parent", "type": "string" }, "properties": { "$ref": "#/components/schemas/Property" }, "source": { "$ref": "#/components/schemas/Source" }, "stage": { "$ref": "#/components/schemas/Stage" }, "tags": { "description": "Deal tags", "items": { }, "type": "array" }, "time_to_close": { "description": "Time (in seconds) between when the deal was created and when it was marked closed", "format": "int32", "type": "integer" }, "time_to_first_call": { "description": "Time (in seconds) between when the deal was created and the first tracked call", "format": "int32", "type": "integer" }, "time_to_first_email": { "description": "Time (in seconds) between when the deal was created and the first tracked email", "format": "int32", "type": "integer" }, "time_to_first_touch": { "description": "Time (in seconds) between when the deal was created and the first tracked touch", "format": "int32", "type": "integer" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" }, "value": { "description": "Deal value", "type": "string" } }, "type": "object" }, "Email": { "properties": { "body": { "description": "Email body", "type": "string" }, "cc": { "description": "Email CC", "items": { }, "type": "array" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "from": { "description": "Email from", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "subject": { "description": "Email subject", "type": "string" }, "to": { "description": "Email to", "items": { }, "type": "array" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Errors_Authorization": { "description": "Errors::Authorization model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "error": { "description": "Your token is invalid.", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Errors_NotFound": { "description": "Errors::NotFound model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "error": { "description": "{Object} not found", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Errors_Validation": { "description": "Errors::Validation model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "error": { "description": "List of field errors. i.e. [{name: ['is too long (maximum is 25 characters)',...]}]", "items": { }, "type": "array" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Note": { "description": "Note model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "deal": { "$ref": "#/components/schemas/Deal" }, "description": { "description": "Note comments", "type": "string" }, "direction": { "description": "Whether this was an inbound/outbound email/call/text note", "enum": [ "inbound", "outbound" ], "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "kind": { "description": "What kind of note is this from", "enum": [ "email", "call", "text" ], "type": "string" }, "process": { "$ref": "#/components/schemas/Process" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "Pipeline": { "description": "Pipeline model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "link": { "description": "Link to pipeline in LeadSimple", "type": "string" }, "name": { "description": "Pipeline name", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Process": { "description": "Process model", "properties": { "assignee_roles": { "type": "string" }, "closed_at": { "description": "Timestamp when this process closed (was marked won / lost)", "type": "string" }, "comments": { "description": "Process comments", "type": "string" }, "contact_roles": { "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "custom_fields": { "$ref": "#/components/schemas/CustomField" }, "due_at": { "description": "Timestamp when this process is due", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "link": { "description": "Link to process in LeadSimple", "type": "string" }, "name": { "description": "Process name", "type": "string" }, "process_type": { "$ref": "#/components/schemas/ProcessType" }, "process_type_id": { "description": "Unique identifier for parent", "type": "string" }, "properties": { "$ref": "#/components/schemas/Property" }, "stage": { "$ref": "#/components/schemas/Stage" }, "tags": { "description": "Process tags", "items": { }, "type": "array" }, "time_to_close": { "description": "Time (in seconds) between when the process was created and when it was marked closed", "format": "int32", "type": "integer" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "ProcessType": { "description": "ProcessType model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "link": { "description": "Link to process type in LeadSimple", "type": "string" }, "name": { "description": "ProcessType name", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Property": { "description": "Property model", "properties": { "address": { "description": "[Deprecated] Property street - Use `full_address.line_1`", "type": "string" }, "city": { "description": "[Deprecated] Property city - Use `full_address.locality`", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "custom_fields": { "$ref": "#/components/schemas/CustomField" }, "full_address": { "$ref": "#/components/schemas/Address" }, "id": { "description": "Unique identifier", "type": "string" }, "link": { "description": "Link to property in LeadSimple", "type": "string" }, "property_groups": { "$ref": "#/components/schemas/PropertyGroup" }, "property_type": { "description": "Type of Property", "type": "string" }, "state": { "description": "[Deprecated] Property state - Use `full_address.region`", "type": "string" }, "tags": { "description": "Property tags", "items": { }, "type": "array" }, "unit": { "properties": { "amount_receivable": { "description": "Amount receivable", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "current_lease_move_in": { "description": "Current lease move in date", "type": "string" }, "current_lease_move_out": { "description": "Current lease move out date", "type": "string" }, "current_rent": { "description": "Current rent rate", "type": "string" }, "custom_fields": { "$ref": "#/components/schemas/CustomField" }, "delinquent_rent": { "description": "Delinquent rent", "type": "string" }, "estimated_rent": { "description": "Estimated rent", "type": "string" }, "future_lease_move_in": { "description": "Future lease move in date", "type": "string" }, "future_lease_move_out": { "description": "Future lease move out date", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "lease_end_date": { "description": "Lease end date", "type": "string" }, "lease_start_date": { "description": "Lease start date", "type": "string" }, "market_rent": { "description": "Market rent rate", "type": "string" }, "num_bathrooms": { "description": "Number of bathrooms", "type": "string" }, "num_bedrooms": { "description": "Number of bedrooms", "type": "string" }, "occupancy": { "description": "Property occupancy", "type": "string" }, "square_feet": { "description": "Property square feet", "type": "string" }, "unit_number": { "description": "Unit number/symbol", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was created", "type": "string" } }, "type": "object" }, "unit_count": { "description": "Number of units in this property", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" }, "zip_code": { "description": "[Deprecated] Property zip code - Use `full_address.postal_code`", "type": "string" } }, "type": "object" }, "PropertyGroup": { "description": "PropertyGroup model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "name": { "description": "Name of property group", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Reports_DealAging": { "description": "Reports::DealAging model", "properties": { "0-7 days": { "description": "Deals created between 0-7 days ago", "format": "int32", "type": "integer" }, "31-90 days": { "description": "Deals created between 31-90 days ago", "format": "int32", "type": "integer" }, "8-30 days": { "description": "Deals created between 8-30 days ago", "format": "int32", "type": "integer" }, "91-365 days": { "description": "Deals created between 91-365 days ago", "format": "int32", "type": "integer" }, "id": { "description": "Unique identifier of the group", "type": "string" }, "name": { "description": "Name of the group.", "type": "string" }, "never": { "description": "Deals with no creation date set", "format": "int32", "type": "integer" }, "older": { "description": "Deals created > 365 days ago", "format": "int32", "type": "integer" }, "total": { "description": "Total deal count.", "format": "int32", "type": "integer" } }, "type": "object" }, "Reports_DealCost": { "description": "Reports::DealCost model", "properties": { "id": { "description": "Unique identifier of the group", "type": "string" }, "name": { "description": "Name of the group.", "type": "string" }, "total": { "description": "Total cost.", "type": "string" } }, "type": "object" }, "Reports_DealCostByMonth": { "description": "Reports::DealCostByMonth model", "properties": { "apr": { "description": "Cost for April.", "type": "string" }, "aug": { "description": "Cost for August.", "type": "string" }, "dec": { "description": "Cost for December.", "type": "string" }, "feb": { "description": "Cost for Feburary.", "type": "string" }, "id": { "description": "Unique identifier of the group", "type": "string" }, "jan": { "description": "Cost for January.", "type": "string" }, "jul": { "description": "Cost for July.", "type": "string" }, "jun": { "description": "Cost for June.", "type": "string" }, "mar": { "description": "Cost for March.", "type": "string" }, "may": { "description": "Cost for May.", "type": "string" }, "name": { "description": "Name of the group.", "type": "string" }, "nov": { "description": "Cost for November.", "type": "string" }, "oct": { "description": "Cost for October.", "type": "string" }, "sep": { "description": "Cost for September.", "type": "string" } }, "type": "object" }, "Reports_DealPersistence": { "description": "Reports::DealPersistence model", "properties": { "1-2": { "description": "Deals touched 1-2 times.", "format": "int32", "type": "integer" }, "11-20": { "description": "Deals touched 11-20 times", "format": "int32", "type": "integer" }, "21+": { "description": "Deals touched 21+ times", "format": "int32", "type": "integer" }, "3-5": { "description": "Deals touched 3-5 times", "format": "int32", "type": "integer" }, "6-10": { "description": "Deals touched 6-10 times", "format": "int32", "type": "integer" }, "id": { "description": "Unique identifier of the group", "type": "string" }, "name": { "description": "Name of the group.", "type": "string" }, "no": { "description": "Deals that haven't been touched.", "format": "int32", "type": "integer" }, "total": { "description": "Total deals.", "format": "int32", "type": "integer" } }, "type": "object" }, "Reports_DealStatus": { "description": "Reports::DealStatus model", "properties": { "active": { "description": "Number of active deals.", "format": "int32", "type": "integer" }, "id": { "description": "Unique identifier of the group", "type": "string" }, "invalid": { "description": "Number of invalid deals.", "format": "int32", "type": "integer" }, "lost": { "description": "Number of deals lost.", "format": "int32", "type": "integer" }, "name": { "description": "Name of the group.", "type": "string" }, "passive": { "description": "Number of passive deals.", "format": "int32", "type": "integer" }, "total": { "description": "Number of deals total.", "format": "int32", "type": "integer" }, "won": { "description": "Number of deals won.", "format": "int32", "type": "integer" } }, "type": "object" }, "Reports_DealTimeToClose": { "description": "Reports::DealTimeToClose model", "properties": { "1-7 days": { "description": "Deals closed within 7 days.", "format": "int32", "type": "integer" }, "30-90 days": { "description": "Deals closed between 30 & 90 days.", "format": "int32", "type": "integer" }, "7-30 days": { "description": "Deals closed between 7 & 30 days.", "format": "int32", "type": "integer" }, "90-180 days": { "description": "Deals closed between 90 & 180 days.", "format": "int32", "type": "integer" }, "id": { "description": "Unique identifier of the group", "type": "string" }, "longer": { "description": "Deals closed over 180 days later.", "format": "int32", "type": "integer" }, "name": { "description": "Name of the group.", "type": "string" }, "never": { "description": "Deals never closed.", "type": "string" }, "total": { "description": "Total deal count.", "format": "int32", "type": "integer" } }, "type": "object" }, "Reports_DealTimeToContact": { "description": "Reports::DealTimeToContact model", "properties": { "0-3 minutes": { "description": "Deals contacted within 3 minutes.", "format": "int32", "type": "integer" }, "1-3 hours": { "description": "Deals contacted between 1 & 3 hours.", "format": "int32", "type": "integer" }, "15 min - 1 hr": { "description": "Deals contacted between 15 minutes & 1 hour.", "format": "int32", "type": "integer" }, "3-15 minutes": { "description": "Deals contacted between 3 & 15 minutes.", "format": "int32", "type": "integer" }, "id": { "description": "Unique identifier of the group", "type": "string" }, "longer": { "description": "Deals contacted over 3 hours later.", "format": "int32", "type": "integer" }, "name": { "description": "Name of the group.", "type": "string" }, "never": { "description": "Deals never contacted.", "type": "string" }, "total": { "description": "Total deal count.", "format": "int32", "type": "integer" } }, "type": "object" }, "Source": { "description": "Source model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "name": { "description": "Name of lead source", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Stage": { "description": "Stage model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "link": { "description": "Link to stage in LeadSimple", "type": "string" }, "name": { "description": "Stage name", "type": "string" }, "status": { "description": "Stage status", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Step": { "description": "Step model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "delay_minutes": { "type": "string" }, "description": { "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "kind": { "type": "string" }, "sort_order": { "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Task": { "description": "Task model", "properties": { "assignee": { "$ref": "#/components/schemas/User" }, "auto_send": { "description": "Whether task will be auto sent", "type": "boolean" }, "auto_send_error": { "description": "Error if auto send fails", "type": "string" }, "completed_at": { "description": "Timestamp of the when the task was completed", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "deal": { "$ref": "#/components/schemas/Deal" }, "description": { "description": "Task description", "type": "string" }, "due_at": { "description": "Timestamp of when the task is due", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "kind": { "description": "Task kind", "type": "string" }, "process": { "$ref": "#/components/schemas/Process" }, "remind_at": { "description": "Timestamp of the reminder", "type": "string" }, "skipped": { "description": "Whether the task has been skipped", "type": "boolean" }, "step": { "$ref": "#/components/schemas/Step" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "TextMessage": { "description": "TextMessage model", "properties": { "body": { "description": "Text message body", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "description": { "description": "Text message description", "type": "string" }, "direction": { "description": "Whether this text message was inbound or outbound", "type": "string" }, "from": { "description": "Text message from", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "manually_added": { "description": "Whether a user added this text message manually", "type": "boolean" }, "to": { "description": "Text message to", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "Unit": { "description": "Unit model", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "amount_receivable": { "description": "Amount receivable", "type": "string" }, "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "current_lease_move_in": { "description": "Current lease move in date", "type": "string" }, "current_lease_move_out": { "description": "Current lease move out date", "type": "string" }, "current_rent": { "description": "Current rent", "type": "string" }, "custom_fields": { "$ref": "#/components/schemas/CustomField" }, "delinquent_rent": { "description": "Delinquent rent", "type": "string" }, "estimated_rent": { "description": "Estimated rent", "type": "string" }, "future_lease_move_in": { "description": "Future lease move out date", "type": "string" }, "future_lease_move_out": { "description": "Future lease move out date", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "lease_end_date": { "description": "Lease end date", "type": "string" }, "lease_start_date": { "description": "Lease start date", "type": "string" }, "link": { "description": "Link to unit in LeadSimple", "type": "string" }, "market_rent": { "description": "Market rent", "type": "string" }, "num_bathrooms": { "description": "Number of bathrooms", "type": "string" }, "num_bedrooms": { "description": "Number of bedrooms", "type": "string" }, "occupancy": { "description": "Unit occupancy", "type": "string" }, "square_feet": { "description": "Unit square feet", "type": "string" }, "unit_number": { "description": "Unit number/symbol", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "UploadedFile": { "description": "UploadedFile model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "filename": { "description": "File name", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "public_access": { "description": "Whether the file can be downloaded by unauthenticated users who know its private URL", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" }, "url": { "description": "the url of the file", "type": "string" } }, "type": "object" }, "User": { "description": "User model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "email": { "description": "Email", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "link": { "description": "Link to user in LeadSimple", "type": "string" }, "name": { "description": "User name", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" } }, "type": "object" }, "WebhookSubscription": { "description": "WebhookSubscription model", "properties": { "created_at": { "description": "Timestamp for when the object was created", "type": "string" }, "event_name": { "description": "What event triggers the webhook", "type": "string" }, "id": { "description": "Unique identifier", "type": "string" }, "target_url": { "description": "URL to notify about events", "type": "string" }, "updated_at": { "description": "Timestamp for when the object was updated", "type": "string" }, "version": { "description": "What version of webhook to receive (currently non-configurable)", "type": "string" } }, "type": "object" } }, "securitySchemes": { "api_key": { "description": "A LeadSimple REST API access token.", "scheme": "bearer", "type": "http" } } }, "info": { "contact": { "email": "support@leadsimple.com", "name": "LeadSimple Support Team" }, "description": "An API for accessing data in LeadSimple accounts.", "title": "LeadSimple REST API", "version": "1.0.0" }, "openapi": "3.0.0", "paths": { "/accounts": { "get": { "description": "ENTERPRISE ONLY: Returns a list of company accounts under your enterprise.", "operationId": "getAccounts", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } }, "description": "ENTERPRISE ONLY: Returns a list of company accounts under your enterprise.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Accounts" ] } }, "/accounts/{account_id}": { "get": { "description": "ENTERPRISE ONLY: Returns an individual company account.", "operationId": "getAccountsAccountId", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } }, "description": "ENTERPRISE ONLY: Returns an individual company account.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Accounts" ] } }, "/calls": { "get": { "description": "Returns a list of calls on the account", "operationId": "getCalls", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filter calls updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "description": "Whether we should or not include custom fields in the returned deals. If true, the `per_page` size is capped to 100. Keep in mind requesting custom fields means this request will take longer.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Call" } } }, "description": "Returns a list of calls on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Calls" ] }, "post": { "description": "Creates a call add associates it with its participants", "operationId": "postCalls", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "created_at": { "description": "When the call was created at", "type": "string" }, "description": { "description": "Call description of the call", "type": "string" }, "duration": { "description": "Call duration in seconds", "format": "int32", "type": "integer" }, "from": { "description": "Number being called from", "type": "string" }, "inbound": { "description": "Whether the call was inbound (if not specified, LeadSimple will try to infer this)", "type": "boolean" }, "outcome": { "enum": [ "no_answer", "answered", "voicemail" ], "type": "string" }, "recording_url": { "description": "Audio call recording URL", "type": "string" }, "to": { "description": "Number being called", "type": "string" }, "user_email": { "description": "Email of the user who participated in the call, if you don't have their LeadSimple ID", "type": "string" }, "user_id": { "description": "LeadSimple ID of the user who participated in the call", "type": "string" } }, "required": [ "from", "to" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Call" } } }, "description": "Creates a call add associates it with its participants", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Calls" ] } }, "/calls/{call_id}": { "patch": { "description": "Updates a call", "operationId": "patchCallsCallId", "parameters": [ { "in": "path", "name": "call_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "description": "Description of the call", "type": "string" } }, "required": [ "description" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Call" } } }, "description": "Updates a call", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Calls" ] } }, "/contacts": { "get": { "description": "Returns a list of contacts on the account", "operationId": "getContacts", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filters contacts by name, email, or phone number", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter contacts updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "description": "Whether we should or not include custom fields in the returned deals. If true, the `per_page` size is capped to 100. Keep in mind requesting custom fields means this request will take longer.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } }, "description": "Returns a list of contacts on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Contacts" ] }, "post": { "description": "Create a contact", "operationId": "postContacts", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "company_name": { "description": "The company name of the contact", "type": "string" }, "email_addresses[]": { "description": "The contact's email addresses", "items": { "type": "string" }, "type": "array" }, "first_name": { "description": "The first name of the contact", "type": "string" }, "last_name": { "description": "The last name of the contact", "type": "string" }, "mailing_address": { "description": "The mailing address line 1", "type": "string" }, "mailing_city": { "description": "The mailing address city", "type": "string" }, "mailing_state": { "description": "The mailing address state", "type": "string" }, "mailing_zip_code": { "description": "The mailing address zip code", "type": "string" }, "phone_numbers[]": { "description": "The contact's phone numbers [{kind: 'mobile', phone: '+13602229999'}]", "items": { "type": "object" }, "type": "array" }, "tags[]": { "description": "Tags to assign to contact", "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } }, "description": "Create a contact", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Contacts" ] } }, "/contacts/{contact_id}": { "put": { "description": "Updates a contact", "operationId": "putContactsContactId", "parameters": [ { "in": "path", "name": "contact_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "company_name": { "description": "The company name of the contact", "type": "string" }, "email_addresses[]": { "description": "The contact's email addresses", "items": { "type": "string" }, "type": "array" }, "first_name": { "description": "The first name of the contact", "type": "string" }, "last_name": { "description": "The last name of the contact", "type": "string" }, "mailing_address": { "description": "The mailing address line 1", "type": "string" }, "mailing_city": { "description": "The mailing address city", "type": "string" }, "mailing_state": { "description": "The mailing address state", "type": "string" }, "mailing_zip_code": { "description": "The mailing address zip code", "type": "string" }, "phone_numbers[]": { "description": "The contact's phone numbers [{kind: 'mobile', phone: '+13602229999'}]", "items": { "type": "object" }, "type": "array" }, "secondary_name": { "description": "The secondary or company name of the contact", "type": "string" }, "tags[]": { "description": "Tags to assign to contact", "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } }, "description": "Updates a contact", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Contacts" ] } }, "/conversations": { "get": { "description": "Returns a list of conversations on the account, respecting User permissions", "operationId": "getConversations", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filter units updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversation" } } }, "description": "Returns a list of conversations on the account, respecting User permissions", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Conversations" ] } }, "/conversations/allowed_tags": { "get": { "description": "Returns a list of available tags for conversations", "operationId": "getConversationsAllowedTags", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationTag" } } }, "description": "Returns a list of available tags for conversations", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Conversations" ] } }, "/conversations/{conversation_id}": { "patch": { "description": "Update a conversation", "operationId": "patchConversationsConversationId", "parameters": [ { "in": "path", "name": "conversation_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "assignee_id": { "description": "User to assign the conversation to", "type": "string" }, "snoozed_until": { "description": "Until when should the conversation be snoozed. Required when status is `snoozed`.", "type": "string" }, "status": { "description": "New status to change the conversation to", "enum": [ "open", "closed", "snoozed" ], "type": "string" } }, "required": [ "snoozed_until" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversation" } } }, "description": "Update a conversation", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Validation" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Conversations" ] } }, "/conversations/{conversation_id}/tag": { "patch": { "description": "Tag a conversation", "operationId": "patchConversationsConversationIdTag", "parameters": [ { "in": "path", "name": "conversation_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "tag": { "description": "Tag to be applied to the conversation. You are only allowed to use whitelisted tags.", "type": "string" } }, "required": [ "tag" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversation" } } }, "description": "Tag a conversation", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Validation" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Conversations" ] } }, "/current_account/custom_fields": { "get": { "description": "List custom_fields available on account optionally filtered by category", "operationId": "getCurrentAccountCustomFields", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filter custom fields by category: `contact`, `property`, `unit`, `deal`, `process`", "in": "query", "name": "category", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } }, "description": "List custom_fields available on account optionally filtered by category", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Current account" ] } }, "/custom_fields": { "get": { "description": "Returns a list of custom fields on the account", "operationId": "getCustomFields", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filter calls created since a certain unix timestamp", "in": "query", "name": "created_since", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } }, "description": "Returns a list of custom fields on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Custom fields" ] }, "post": { "description": "Creates a custom field", "operationId": "postCustomFields", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "category": { "description": "The type of resource this custom field is associated with", "enum": [ "contact", "deal", "process", "property", "unit" ], "type": "string" }, "data_type": { "description": "The type of data this custom field will be storing", "enum": [ "text", "number", "currency", "percentage", "choices", "date", "date_time", "url" ], "type": "string" }, "label": { "description": "The label/name of this custom field", "type": "string" }, "options": { "description": "The default and/or available value(s) for this custom field", "type": "string" }, "pipeline_ids[]": { "description": "The pipelines in which this custom field will be available", "items": { "type": "string" }, "type": "array" }, "process_type_ids[]": { "description": "The process types in which this custom field will be available", "items": { "type": "string" }, "type": "array" } }, "required": [ "label", "data_type", "category" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } }, "description": "Creates a custom field", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Custom fields" ] } }, "/deals": { "get": { "description": "Returns a list of deals on the account filterable by pipeline, name, email, or phone number", "operationId": "getDeals", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Pipeline to filter deals by", "in": "query", "name": "pipeline_id", "required": false, "schema": { "type": "string" } }, { "description": "Filters deals by name, email, or phone number. We'll include custom fields if this is present in the request.", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Whether we should or not include custom fields in the returned deals. If true, the `per_page` size is capped to 100. Keep in mind requesting custom fields means this request will take longer.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Filter deals updated since a certain UNIX timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } }, "description": "Returns a list of deals on the account filterable by pipeline, name, email, or phone number", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Deals" ] }, "post": { "description": "Create a deal", "operationId": "postDeals", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "contact[company_name]": { "description": "The company the contact is associated with", "type": "string" }, "contact[email_addresses][]": { "description": "The contact's email addresses", "items": { "type": "string" }, "type": "array" }, "contact[full_name]": { "description": "The contact's full name (automatically parsed into first_name, last_name, & secondary name)", "type": "string" }, "contact[mailing_address]": { "description": "The mailing address line 1", "type": "string" }, "contact[mailing_city]": { "description": "The mailing address city", "type": "string" }, "contact[mailing_state]": { "description": "The mailing address state", "type": "string" }, "contact[mailing_zip_code]": { "description": "The mailing address zip code", "type": "string" }, "contact[phone_numbers][]": { "description": "The contact's phone numbers [{kind: 'mobile', phone: '+13602229999'}]", "items": { "type": "object" }, "type": "array" }, "deal[accept_duplicates]": { "default": false, "description": "Allow creating duplicate deals based on email or phone", "type": "boolean" }, "deal[assignee_id]": { "description": "User to assign the deal to", "type": "string" }, "deal[closed_at]": { "description": "When the deal was closed at", "type": "string" }, "deal[comments]": { "description": "Comments related to the deal", "type": "string" }, "deal[cost]": { "description": "Cost of the deal", "type": "string" }, "deal[create_source_if_new]": { "description": "Create source by name, if it does not already exist in the pipeline", "type": "boolean" }, "deal[created_at]": { "description": "When the deal was created", "type": "string" }, "deal[marketing_gclid]": { "description": "The Google Click ID, from a PPC click", "type": "string" }, "deal[marketing_utm_campaign]": { "description": "The UTM campaign parameter, ie 'email-campaign-jan-23'", "type": "string" }, "deal[marketing_utm_content]": { "description": "The UTM content parameter", "type": "string" }, "deal[marketing_utm_id]": { "description": "The UTM id parameter, required by GA4", "type": "string" }, "deal[marketing_utm_medium]": { "description": "The UTM medium parameter, ie 'search'", "type": "string" }, "deal[marketing_utm_source]": { "description": "The UTM source parameter, ie 'google'", "type": "string" }, "deal[marketing_utm_source_platform]": { "description": "The UTM source platform parameter, supported by GA4", "type": "string" }, "deal[marketing_utm_term]": { "description": "The UTM campaign term parameter, ie 'property management Austin'", "type": "string" }, "deal[name]": { "description": "The name of the new deal", "type": "string" }, "deal[num_units]": { "description": "The number of units associated with the deal", "type": "string" }, "deal[pipeline_id]": { "description": "Pipeline to create the deal in", "type": "string" }, "deal[source_id_or_name]": { "description": "Source to assign the deal to. Exact name or UID.", "type": "string" }, "deal[stage_id]": { "description": "Stage to create the deal in", "type": "string" }, "deal[tags][]": { "description": "Tags to assign to deal", "items": { "type": "string" }, "type": "array" }, "deal[value]": { "description": "Value of the deal", "type": "string" }, "property[address_city]": { "description": "The property address city", "type": "string" }, "property[address_line_1]": { "description": "The property address line 1", "type": "string" }, "property[address_state]": { "description": "The property address state", "type": "string" }, "property[address_zip_code]": { "description": "The property address zip code", "type": "string" }, "property[estimated_rent]": { "description": "The estimated rent", "type": "string" }, "property[lease_end_date]": { "description": "The lease end date", "type": "string" }, "property[lease_start_date]": { "description": "The lease start date", "type": "string" }, "property[num_bathrooms]": { "description": "The number of bathrooms", "type": "string" }, "property[num_bedrooms]": { "description": "The number of bedrooms", "type": "string" }, "property[occupancy]": { "description": "The number of occupancy", "type": "string" }, "property[property_type]": { "description": "The type of property", "type": "string" }, "property[square_feet]": { "description": "The number of square feet", "type": "string" } }, "required": [ "deal[pipeline_id]" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "description": "Create a deal", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Deals" ] } }, "/deals/{deal_id}": { "get": { "description": "Returns an individual deal.", "operationId": "getDealsDealId", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "type": "string" } }, { "description": "Whether we should or not include custom fields in the returned process.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "description": "Returns an individual deal.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Deals" ] }, "put": { "description": "Updates a deal", "operationId": "putDealsDealId", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "assignee_id": { "description": "User to assign the deal to", "type": "string" }, "closed_at": { "description": "When the deal was closed at", "type": "string" }, "comments": { "description": "Comments related to the deal", "type": "string" }, "contact_ids[]": { "description": "The IDs of the contacts related to this deal", "items": { "type": "string" }, "type": "array" }, "cost": { "description": "Cost of the deal", "type": "string" }, "created_at": { "description": "When the deal was created at", "type": "string" }, "name": { "description": "The name of the new deal", "type": "string" }, "num_units": { "description": "The number of units associated with the deal", "type": "string" }, "pipeline_id": { "description": "Pipeline to update the deal in", "type": "string" }, "property_ids[]": { "description": "The IDs of the properties related to this deal", "items": { "type": "string" }, "type": "array" }, "remove_tags": { "description": "Whether you want to add or remove the tags you're passing", "type": "boolean" }, "stage_id": { "description": "Stage to move the deal into. If empty, the deal will be kept in the same stage.", "type": "string" }, "tags[]": { "description": "Tags to assign to deal", "items": { "type": "string" }, "type": "array" }, "unit_ids[]": { "description": "The IDs of the units on the properties to associate", "items": { "type": "string" }, "type": "array" }, "value": { "description": "Value of the deal", "type": "string" } }, "required": [ "pipeline_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "description": "Updates a deal", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Deals" ] } }, "/info/account": { "get": { "description": "Info about the current account", "operationId": "getInfoAccount", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } }, "description": "Info about the current account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Info" ] } }, "/info/user": { "get": { "description": "Info about the current user", "operationId": "getInfoUser", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "Info about the current user", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Info" ] } }, "/notes": { "post": { "description": "Creates a note for a parent process or deal", "operationId": "postNotes", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "created_at": { "description": "When the note was created at. If empty, we'll assume it was created at the time of the request.", "type": "string" }, "description": { "description": "Note to be added to the deal", "type": "string" }, "direction": { "description": "Whether this note refers to an inbound/outbound email/call/text", "enum": [ "inbound", "outbound" ], "type": "string" }, "kind": { "description": "Kind of note", "enum": [ "email", "call", "text" ], "type": "string" }, "parent_id": { "description": "Deal or Process ID to assign the note activity to", "type": "string" }, "parent_type": { "description": "Whether this note belongs to a Process or a Deal", "enum": [ "Deal", "Process" ], "type": "string" }, "user_id": { "description": "User to assign the note activity to", "type": "string" } }, "required": [ "parent_id", "parent_type", "description" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "Creates a note for a parent process or deal", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Notes" ] } }, "/pipelines": { "get": { "description": "Returns a list of pipelines on the account", "operationId": "getPipelines", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Account to fetch pipelines for", "in": "query", "name": "account_id", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } }, "description": "Returns a list of pipelines on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}": { "get": { "description": "Returns an individual pipeline.", "operationId": "getPipelinesPipelineId", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } }, "description": "Returns an individual pipeline.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}/custom_fields": { "get": { "description": "List custom fields available on a pipeline", "operationId": "getPipelinesPipelineIdCustomFields", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } }, "description": "List custom fields available on a pipeline", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}/deals": { "get": { "description": "List deals under a pipeline", "operationId": "getPipelinesPipelineIdDeals", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filter deals updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "order_field", "required": false, "schema": { "default": "created_at", "enum": [ "created_at", "closed_at", "updated_at", "last_touched_at" ], "type": "string" } }, { "in": "query", "name": "order_direction", "required": false, "schema": { "default": "asc", "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Whether we should or not include custom fields in the returned deals. If true, the `per_page` size is capped to 100. Keep in mind requesting custom fields means this request will take longer.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "description": "List deals under a pipeline", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}/deals/{deal_id}": { "get": { "description": "Returns an individual deal.", "operationId": "getPipelinesPipelineIdDealsDealId", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deal_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "description": "Returns an individual deal.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}/sources": { "get": { "description": "List sources under a pipeline", "operationId": "getPipelinesPipelineIdSources", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Source" } } }, "description": "List sources under a pipeline", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}/stages": { "get": { "description": "List workflow stages under a pipeline", "operationId": "getPipelinesPipelineIdStages", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } } }, "description": "List workflow stages under a pipeline", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}/stages/{stage_id}": { "get": { "description": "Returns an individual stage.", "operationId": "getPipelinesPipelineIdStagesStageId", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "stage_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } } }, "description": "Returns an individual stage.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}/stages/{stage_id}/steps": { "get": { "description": "List steps within an individual stage", "operationId": "getPipelinesPipelineIdStagesStageIdSteps", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "stage_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Step" } } }, "description": "List steps within an individual stage", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{pipeline_id}/users": { "get": { "description": "List users who have access to a pipeline", "operationId": "getPipelinesPipelineIdUsers", "parameters": [ { "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "List users who have access to a pipeline", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Pipelines" ] } }, "/process_types": { "get": { "description": "Returns a list of process type on the account", "operationId": "getProcessTypes", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessType" } } }, "description": "Returns a list of process type on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}": { "get": { "description": "Returns an individual process type.", "operationId": "getProcessTypesProcessTypeId", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessType" } } }, "description": "Returns an individual process type.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/assignee_roles": { "get": { "description": "List assignee roles under a process type", "operationId": "getProcessTypesProcessTypeIdAssigneeRoles", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssigneeRole" } } }, "description": "List assignee roles under a process type", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/contact_roles": { "get": { "description": "List contact roles under a process type", "operationId": "getProcessTypesProcessTypeIdContactRoles", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRole" } } }, "description": "List contact roles under a process type", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/custom_fields": { "get": { "description": "List custom_fields available on a process type", "operationId": "getProcessTypesProcessTypeIdCustomFields", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } }, "description": "List custom_fields available on a process type", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/processes": { "get": { "description": "List processes under a process_type", "operationId": "getProcessTypesProcessTypeIdProcesses", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filter processes updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "order_field", "required": false, "schema": { "default": "created_at", "enum": [ "created_at", "closed_at", "updated_at", "last_touched_at" ], "type": "string" } }, { "in": "query", "name": "order_direction", "required": false, "schema": { "default": "asc", "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Whether we should or not include custom fields in the returned processes. If true, the `per_page` size is capped to 100. Keep in mind requesting custom fields means this request will take longer.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Process" } } }, "description": "List processes under a process_type", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/processes/{process_id}": { "get": { "description": "Returns an individual process.", "operationId": "getProcessTypesProcessTypeIdProcessesProcessId", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "process_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Process" } } }, "description": "Returns an individual process.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/stages": { "get": { "description": "List workflow stages under a process type", "operationId": "getProcessTypesProcessTypeIdStages", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } } }, "description": "List workflow stages under a process type", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/stages/{stage_id}": { "get": { "description": "Returns an individual stage.", "operationId": "getProcessTypesProcessTypeIdStagesStageId", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "stage_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } } }, "description": "Returns an individual stage.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/stages/{stage_id}/steps": { "get": { "description": "List steps within an individual stage", "operationId": "getProcessTypesProcessTypeIdStagesStageIdSteps", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "stage_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Step" } } }, "description": "List steps within an individual stage", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/process_types/{process_type_id}/users": { "get": { "description": "List users who have access to a process type", "operationId": "getProcessTypesProcessTypeIdUsers", "parameters": [ { "in": "path", "name": "process_type_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "List users who have access to a process type", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Process types" ] } }, "/processes": { "get": { "description": "Returns a list of processes on the account filterable by process type", "operationId": "getProcesses", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Process type to filter processes by", "in": "query", "name": "process_type_id", "required": false, "schema": { "type": "string" } }, { "description": "Filters processes by name, email, or phone number. We'll include custom fields if this is present in the request.", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Whether we should or not include custom fields in the returned processes. If true, the `per_page` size is capped to 100. Keep in mind requesting custom fields means this request will take longer.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Whether or not we should include property groups in the returned properties. Keep in mind requesting property groups could mean this request will take longer.", "in": "query", "name": "include_property_groups", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Filter processes updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Process" } } }, "description": "Returns a list of processes on the account filterable by process type", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Processes" ] }, "post": { "description": "Create a process", "operationId": "postProcesses", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "contacts_in_roles[][contact_ids][]": { "description": "The IDs of contacts to add to this role", "items": { "type": "string" }, "type": "array" }, "contacts_in_roles[][role_id]": { "description": "The ID of the role this contact should be added to", "items": { "type": "string" }, "type": "array" }, "process[comments]": { "description": "Comments related to the process", "type": "string" }, "process[due_at]": { "description": "When the process is due", "type": "string" }, "process[name]": { "description": "The name of the new process", "type": "string" }, "process[process_type_id]": { "description": "Pipeline to create the process in", "type": "string" }, "process[stage_id]": { "description": "Stage to create the process in", "type": "string" }, "process[tags][]": { "description": "Tags to assign to process", "items": { "type": "string" }, "type": "array" }, "process[user_id]": { "description": "User to assign the process to", "type": "string" }, "property_ids[]": { "description": "The IDs of the properties related to this process", "items": { "type": "string" }, "type": "array" }, "unit_ids[]": { "description": "The IDs of the units on the properties to associate", "items": { "type": "string" }, "type": "array" }, "users_in_roles[][role_id]": { "description": "The ID of the role this user should be added to", "items": { "type": "string" }, "type": "array" }, "users_in_roles[][user_id]": { "description": "The ID of the user to add to this role", "items": { "type": "string" }, "type": "array" } }, "required": [ "process[process_type_id]", "process[stage_id]" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Process" } } }, "description": "Create a process", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Processes" ] } }, "/processes/{process_id}": { "get": { "description": "Returns an individual process.", "operationId": "getProcessesProcessId", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "type": "string" } }, { "description": "Whether we should or not include custom fields in the returned process.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Whether or not we should include property groups in the returned properties. Keep in mind requesting property groups could mean this request will take longer.", "in": "query", "name": "include_property_groups", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Process" } } }, "description": "Returns an individual process.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Processes" ] }, "put": { "description": "Updates a process", "operationId": "putProcessesProcessId", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "closed_at": { "description": "When the process is closed", "type": "string" }, "comments": { "description": "Comments related to the process", "type": "string" }, "created_at": { "description": "When the process was created at", "type": "string" }, "due_at": { "description": "When the process is due", "type": "string" }, "name": { "description": "The name of the new process", "type": "string" }, "remove_tags": { "description": "Whether you want to add or remove the tags you're passing", "type": "boolean" }, "stage_id": { "description": "Stage to move the process into. If empty, the process will be kept in the same stage.", "type": "string" }, "tags[]": { "description": "Tags to assign to process", "items": { "type": "string" }, "type": "array" }, "user_id": { "description": "User to assign the process to", "type": "string" }, "users_in_roles[][role_id]": { "description": "The ID of the role this user should be added to", "items": { "type": "string" }, "type": "array" }, "users_in_roles[][user_id]": { "description": "The ID of the user to add to this role", "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Process" } } }, "description": "Updates a process", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Processes" ] } }, "/properties": { "get": { "description": "Returns a list of properties on the account", "operationId": "getProperties", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filters properties by name, address line 1, or address city", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter properties updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "description": "Whether or not we should include custom fields in the returned properties. If true, the `per_page` size is capped to 100. Keep in mind requesting custom fields means this request will take longer.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Whether or not we should include property groups in the returned properties. Keep in mind requesting property groups could mean this request will take longer.", "in": "query", "name": "include_property_groups", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property" } } }, "description": "Returns a list of properties on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Properties" ] } }, "/properties/{property_id}": { "get": { "description": "Returns an individual property.", "operationId": "getPropertiesPropertyId", "parameters": [ { "in": "path", "name": "property_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property" } } }, "description": "Returns an individual property.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Properties" ] }, "put": { "description": "Updates a property", "operationId": "putPropertiesPropertyId", "parameters": [ { "in": "path", "name": "property_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "address_city": { "description": "The property address city", "type": "string" }, "address_line_1": { "description": "The property address line 1", "type": "string" }, "address_state": { "description": "The property address state", "type": "string" }, "address_zip_code": { "description": "The property address zip code", "type": "string" }, "property_type": { "description": "The type of property", "type": "string" }, "tags[]": { "description": "Tags to assign to property", "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property" } } }, "description": "Updates a property", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Properties" ] } }, "/properties/{property_id}/units": { "get": { "description": "List units under a property", "operationId": "getPropertiesPropertyIdUnits", "parameters": [ { "in": "path", "name": "property_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Filters units by unit_number", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Filter units updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "List units under a property", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Properties" ] } }, "/properties/{property_id}/units/{unit_id}": { "put": { "description": "Updates a unit", "operationId": "putPropertiesPropertyIdUnitsUnitId", "parameters": [ { "in": "path", "name": "property_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "unit_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "delinquent_rent": { "description": "Delinquent rent", "type": "string" }, "estimated_rent": { "description": "Estimated rent", "type": "string" }, "lease_end_date": { "description": "Lease end date", "type": "string" }, "lease_start_date": { "description": "Lease start date", "type": "string" }, "num_bathrooms": { "description": "Number of bathrooms", "type": "string" }, "num_bedrooms": { "description": "Number of bedrooms", "type": "string" }, "occupancy": { "description": "Property occupancy", "type": "string" }, "square_feet": { "description": "Property square feet", "type": "string" }, "unit_number": { "description": "Unit number/symbol", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "Updates a unit", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Properties" ] } }, "/property_groups": { "get": { "description": "Returns a list of property groups on the account", "operationId": "getPropertyGroups", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroup" } } }, "description": "Returns a list of property groups on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Property groups" ] } }, "/reports/deal_aging": { "post": { "description": "Summarizes the age of the filtered Deals, grouped by User/Source.", "operationId": "postReportsDealAging", "requestBody": { "$ref": "#/components/requestBodies/postReportsDealTimeToClose" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports_DealAging" } } }, "description": "Summarizes the age of the filtered Deals, grouped by User/Source.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Reports" ] } }, "/reports/deal_cost": { "post": { "description": "Shows rollup cost/value stats of deals matching the given filters, grouped by User/Source.", "operationId": "postReportsDealCost", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "filters[closed_at][]": { "description": "Filter deals by closed_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[created_at][]": { "description": "Filter deals by created_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[last_touched_at][]": { "description": "Filter deals by last_touched_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[status]": { "description": "Filter deals by status", "enum": [ "", "active", "passive", "won", "lost", "invalid" ], "type": "string" }, "group_by": { "enum": [ "", "sources", "users" ], "type": "string" }, "metric": { "enum": [ "", "costs", "cost_per_lead", "cost_per_valid_lead", "cost_per_conversion", "values", "value_per_conversion", "profit" ], "type": "string" } }, "required": [ "group_by", "metric" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports_DealCost" } } }, "description": "Shows rollup cost/value stats of deals matching the given filters, grouped by User/Source.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Reports" ] } }, "/reports/deal_cost_by_month": { "post": { "description": "Summarizes the costs of the filtered Deals, grouped by User/Source, for each month of the given year.", "operationId": "postReportsDealCostByMonth", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "filters[closed_at][]": { "description": "Filter deals by closed_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[created_at][]": { "description": "Filter deals by created_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[last_touched_at][]": { "description": "Filter deals by last_touched_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[status]": { "description": "Filter deals by status", "enum": [ "", "active", "passive", "won", "lost", "invalid" ], "type": "string" }, "group_by": { "enum": [ "", "sources", "users" ], "type": "string" }, "year": { "format": "int32", "type": "integer" } }, "required": [ "year", "group_by" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports_DealCostByMonth" } } }, "description": "Summarizes the costs of the filtered Deals, grouped by User/Source, for each month of the given year.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Reports" ] } }, "/reports/deal_persistence": { "post": { "description": "Summarizes the number of followup attempts of the filtered Deals, grouped by User/Source.", "operationId": "postReportsDealPersistence", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "field": { "enum": [ "", "num_touches", "num_outbound_touches", "num_outbound_calls", "num_outbound_emails", "num_outbound_touches_to_close" ], "type": "string" }, "filters[closed_at][]": { "description": "Filter deals by closed_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[created_at][]": { "description": "Filter deals by created_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[last_touched_at][]": { "description": "Filter deals by last_touched_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[status]": { "description": "Filter deals by status", "enum": [ "", "active", "passive", "won", "lost", "invalid" ], "type": "string" }, "group_by": { "enum": [ "", "sources", "users" ], "type": "string" } }, "required": [ "group_by", "field" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports_DealPersistence" } } }, "description": "Summarizes the number of followup attempts of the filtered Deals, grouped by User/Source.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Reports" ] } }, "/reports/deal_status": { "post": { "description": "Shows the count of deals in a given status (active, nurturing, won, lost, invalid), grouped by User/Source/Stage.", "operationId": "postReportsDealStatus", "requestBody": { "$ref": "#/components/requestBodies/postReportsDealTimeToClose" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports_DealStatus" } } }, "description": "Shows the count of deals in a given status (active, nurturing, won, lost, invalid), grouped by User/Source/Stage.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Reports" ] } }, "/reports/deal_time_to_close": { "post": { "description": "Summarizes the time that elapsed for the filtered Deals, grouped by User & Source", "operationId": "postReportsDealTimeToClose", "requestBody": { "$ref": "#/components/requestBodies/postReportsDealTimeToClose" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports_DealTimeToClose" } } }, "description": "Summarizes the time that elapsed for the filtered Deals, grouped by User & Source", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Reports" ] } }, "/reports/deal_time_to_contact": { "post": { "description": "Summarizes the time that elapsed for the filtered Deals, grouped by User & Source", "operationId": "postReportsDealTimeToContact", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "field": { "enum": [ "", "time_to_first_touch", "time_to_first_call", "time_to_first_email" ], "type": "string" }, "filters[closed_at][]": { "description": "Filter deals by closed_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[created_at][]": { "description": "Filter deals by created_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[last_touched_at][]": { "description": "Filter deals by last_touched_at (accepts min/max unix timestamps i.e [1787840307, 1787896800]", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "filters[status]": { "description": "Filter deals by status", "enum": [ "", "active", "passive", "won", "lost", "invalid" ], "type": "string" }, "group_by": { "enum": [ "", "sources", "users" ], "type": "string" } }, "required": [ "field", "group_by" ], "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reports_DealTimeToContact" } } }, "description": "Summarizes the time that elapsed for the filtered Deals, grouped by User & Source", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Reports" ] } }, "/tasks": { "get": { "description": "Returns a list of tasks on the account", "operationId": "getTasks", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "due_type", "required": false, "schema": { "enum": [ "upcoming", "completed" ], "type": "string" } }, { "description": "Filter tasks updated since a certain unix timestamp", "in": "query", "name": "updated_since", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "description": "Whether we should or not include custom fields in the returned deals. If true, the `per_page` size is capped to 100. Keep in mind requesting custom fields means this request will take longer.", "in": "query", "name": "include_custom_fields", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Whether or not we should include property groups in the returned properties. Keep in mind requesting property groups could mean this request will take longer.", "in": "query", "name": "include_property_groups", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "step_ids[]": { "description": "Filter tasks by specified step IDs", "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } }, "description": "Returns a list of tasks on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Tasks" ] } }, "/text_messages": { "get": { "description": "Returns a list of text messages on the account", "operationId": "getTextMessages", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMessage" } } }, "description": "Returns a list of text messages on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Text messages" ] }, "post": { "description": "Creates a text message and associates it with it's participants", "operationId": "postTextMessages", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "created_at": { "description": "When the call was created at", "type": "string" }, "description": { "description": "Description of the text message", "type": "string" }, "from": { "description": "Number being texted from", "type": "string" }, "inbound": { "description": "Whether the text message was inbound (if not specified, LeadSimple will try to infer this)", "type": "boolean" }, "to": { "description": "Number being texted", "type": "string" }, "user_email": { "description": "Email of the user who participated in the text message, if you don't have their LeadSimple ID", "type": "string" }, "user_id": { "description": "LeadSimple ID of the user who participated in the text message", "type": "string" } }, "required": [ "from", "to" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMessage" } } }, "description": "Creates a text message and associates it with it's participants", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Text messages" ] } }, "/text_messages/{text_message_id}": { "get": { "description": "Returns a single text message", "operationId": "getTextMessagesTextMessageId", "parameters": [ { "in": "path", "name": "text_message_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMessage" } } }, "description": "Returns a single text message", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Text messages" ] }, "patch": { "description": "Updates a text message", "operationId": "patchTextMessagesTextMessageId", "parameters": [ { "in": "path", "name": "text_message_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "description": "Description of the text message", "type": "string" } }, "required": [ "description" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextMessage" } } }, "description": "Updates a text message", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Text messages" ] } }, "/uploaded_files": { "post": { "description": "Creates a file for a parent process or deal", "operationId": "postUploadedFiles", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "file": { "description": "File to upload", "format": "binary", "type": "string" }, "public_access": { "description": "Whether the file can be downloaded by unauthenticated users who know its private URL", "type": "boolean" }, "uploadable_id": { "description": "Deal or Process ID to assign the uploaded file to", "type": "string" }, "uploadable_type": { "description": "Whether this uploaded file belongs to a Deal or a Process", "enum": [ "processes", "deals" ], "type": "string" } }, "required": [ "uploadable_id", "uploadable_type", "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadedFile" } } }, "description": "Creates a file for a parent process or deal", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Uploaded files" ] } }, "/users": { "get": { "description": "Returns a list of users on the account", "operationId": "getUsers", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "This is limited to the `[1, 200]` range except where noted otherwise.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Naively filter users by email or name", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "Returns a list of users on the account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Users" ] } }, "/webhook_subscriptions": { "get": { "description": "List all webhook subscriptions for the current account", "operationId": "getWebhookSubscriptions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } }, "description": "List all webhook subscriptions for the current account", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Webhook subscriptions" ] }, "post": { "description": "Create a webhook subscription", "operationId": "postWebhookSubscriptions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "event_name": { "description": "What event to subscribe to", "enum": [ "deal/created", "deal/changed_stage", "deal/changed_pipeline", "deal/changed_tags", "deal/reassigned", "deal/opened_email", "task/created", "task/reminder_due", "task/completed", "task/completed/manually", "task/completed/automatically", "process/created", "process/updated", "process/changed_stage", "process/changed_tags", "process/reassigned", "call/completed", "inbound_conversation/created", "outbound_conversation/created" ], "type": "string" }, "target_url": { "description": "What URL to send the events to", "type": "string" } }, "required": [ "event_name", "target_url" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } }, "description": "Create a webhook subscription", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Validation" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Webhook subscriptions" ] } }, "/webhook_subscriptions/{webhook_subscription_id}": { "delete": { "description": "Deletes a webhook subscription.", "operationId": "deleteWebhookSubscriptionsWebhookSubscriptionId", "parameters": [ { "in": "path", "name": "webhook_subscription_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } }, "description": "Deletes a webhook subscription.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Validation" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Webhook subscriptions" ] }, "get": { "description": "Returns an individual webhook subscription.", "operationId": "getWebhookSubscriptionsWebhookSubscriptionId", "parameters": [ { "in": "path", "name": "webhook_subscription_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } }, "description": "Returns an individual webhook subscription.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } } }, "tags": [ "Webhook subscriptions" ] }, "put": { "description": "Updates a webhook subscription.", "operationId": "putWebhookSubscriptionsWebhookSubscriptionId", "parameters": [ { "in": "path", "name": "webhook_subscription_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "event_name": { "description": "What event to subscribe to", "enum": [ "deal/created", "deal/changed_stage", "deal/changed_pipeline", "deal/changed_tags", "deal/reassigned", "deal/opened_email", "task/created", "task/reminder_due", "task/completed", "task/completed/manually", "task/completed/automatically", "process/created", "process/updated", "process/changed_stage", "process/changed_tags", "process/reassigned", "call/completed", "inbound_conversation/created", "outbound_conversation/created" ], "type": "string" }, "target_url": { "description": "What URL to send the events to", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } }, "description": "Updates a webhook subscription.", "headers": { "X-RateLimit-Metric-Error": { "description": "The metric that was exceeded. It can be one of `[records, requests]`.", "schema": { "type": "string" } }, "X-RateLimit-Metric-Records-Count": { "description": "The number of records used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Records-Limit": { "description": "The number of records allowed in the current period.. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Count": { "description": "The number of requests used in the current period (1 minute).", "schema": { "type": "integer" } }, "X-RateLimit-Metric-Requests-Limit": { "description": "The number of requests allowed in the current period. This limit is per account, not per API Key.", "schema": { "type": "integer" } }, "X-RateLimit-Retry-After": { "description": "The number of seconds to wait before retrying. This is only returned when the rate limit is exceeded.", "schema": { "type": "integer" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Validation" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_Authorization" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors_NotFound" } } }, "description": "Not Found" } }, "tags": [ "Webhook subscriptions" ] } } }, "security": [ { "api_key": [ ] } ], "servers": [ { "url": "https://api.leadsimple.com/rest" } ], "tags": [ { "description": "Operations about custom_fields", "name": "Custom fields" }, { "description": "Operations about property_groups", "name": "Property groups" }, { "description": "Global information about users/accounts", "name": "Info" }, { "description": "Information about the current account", "name": "Current account" }, { "description": "Endpoints about Accounts - including Enterprise-only endpoints", "name": "Accounts" }, { "description": "Endpoints about Users", "name": "Users" }, { "description": "Endpoints about Properties", "name": "Properties" }, { "description": "Endpoints about Contacts", "name": "Contacts" }, { "description": "Endpoints about Tasks", "name": "Tasks" }, { "description": "Endpoints about Process Types", "name": "Process types" }, { "description": "Endpoints about Processes", "name": "Processes" }, { "description": "Endpoints about Pipelines", "name": "Pipelines" }, { "description": "Endpoints about Deals", "name": "Deals" }, { "description": "Endpoints about Conversations", "name": "Conversations" }, { "description": "Endpoints about Text Messages", "name": "Text messages" }, { "description": "Endpoints about Attachments in Deals/Processes", "name": "Uploaded files" }, { "description": "Endpoints about Calls", "name": "Calls" }, { "description": "Endpoints about Notes", "name": "Notes" }, { "description": "Endpoints about available Webhooks", "name": "Webhook subscriptions" }, { "description": "Endpoints about Reports", "name": "Reports" } ] }