Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.salesflare.com
/accounts/{account_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| account_id | path | required | number | — |
Successful
DELETE /accounts/{account_id}
/contacts/{contact_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| contact_id | path | required | number | — |
Successful
DELETE /contacts/{contact_id}
/customfields/{itemClass}/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| itemClass | path | required | string | — |
| id | path | required | number | — |
Successful
DELETE /customfields/{itemClass}/{id}
/messages/{message_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| message_id | path | required | number | — |
Successful
DELETE /messages/{message_id}
/meetings/{meeting_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| meeting_id | path | required | number | — |
Successful
DELETE /meetings/{meeting_id}
/opportunities/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | number | — |
Successful
DELETE /opportunities/{id}
/tags/{tag_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tag_id | path | required | number | — |
Successful
DELETE /tags/{tag_id}
/tasks/{id}
Successful
DELETE /tasks/{id}
AccountsCreateAccountRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"links": {
"type": "string"
},
"owner": {
"type": "number"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"custom": {
"type": "object"
},
"domain": {
"type": "string"
},
"address": {
"type": "object"
},
"picture": {
"type": "string"
},
"website": {
"type": "string",
"x-format": {
"uri": {
"allowRelative": true,
"allowQuerySquareBrackets": true
}
}
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"customers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower"
}
}
}
}
},
"description": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number"
],
"properties": {
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"number": {
"type": "string"
}
}
}
},
"parent_account": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
]
},
"email_addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
}
}
}
},
"social_profiles": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"_dirty": {
"type": "boolean",
"description": "Deprecated, will be ignored"
},
"username": {
"type": "string"
}
}
}
]
}
}
}
}
AccountsCreateAccountResponse
{
"type": "string"
}
AccountsListAccountsResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"size": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"custom": {
"type": "object"
},
"domain": {
"type": "string"
},
"hotness": {
"type": "number"
},
"part_of": {
"type": "boolean"
},
"picture": {
"type": "string"
},
"website": {
"type": "string"
},
"can_edit": {
"type": "boolean"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"description": {
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"number": {
"type": "string"
}
}
}
},
"parent_account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"domain": {
"type": "string"
},
"entity": {
"enum": [
"account"
],
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"email_addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"email": {
"type": "string"
}
}
}
},
"last_email_date": {
"type": "string",
"format": "date-time"
},
"social_profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"last_interaction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string"
},
"person": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"description": {
"type": "string"
}
}
},
"last_meeting_date": {
"type": "string",
"format": "date-time"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"last_interaction_date": {
"type": "string",
"format": "date-time"
}
}
}
}
CallsCreateCallRequest
{
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"participants"
],
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"notes": {
"type": "string"
},
"minutes": {
"type": "string",
"description": "The use of this property is deprecated. Use the notes property instead."
},
"subject": {
"type": "string",
"maxLength": 200
},
"end_date": {
"type": "string",
"format": "date-time"
},
"phone_type": {
"type": "string"
},
"description": {
"type": "string"
},
"participants": {
"type": "array",
"items": {
"type": "number"
},
"description": "No participants is possible for call log sync"
},
"phone_number_hash": {
"type": "string"
}
}
},
"x-constraint": {
"single": true
}
}
CallsCreateCallResponse
{
"type": "string"
}
ContactsCreateContactRequest
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower",
"trim": true
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "number"
},
"custom": {
"type": "object"
},
"middle": {
"type": "string"
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"account": {
"type": "number",
"description": "Any existing account will be removed from the contact when specifically passing `null`!"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
},
"bounced": {
"type": "boolean"
},
"opt-out": {
"type": "boolean"
},
"picture": {
"type": "string",
"maxLength": 500
},
"lastname": {
"type": "string"
},
"position": {
"type": "object",
"properties": {
"role": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"firstname": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
}
},
"birth_date": {
"type": "string",
"format": "date-time"
},
"fax_number": {
"type": "string"
},
"bounced_date": {
"type": "string",
"format": "date-time"
},
"opt-out_date": {
"type": "string",
"format": "date-time"
},
"phone_number": {
"type": "string"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number"
],
"properties": {
"type": {
"type": "string"
},
"number": {
"type": "string"
}
}
}
},
"social_profiles": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
]
}
},
"opt-out_campaign": {
"type": "string"
},
"home_phone_number": {
"type": "string"
},
"mobile_phone_number": {
"type": "string"
}
}
},
"x-constraint": {
"single": true
}
}
ContactsCreateContactResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
},
"x-constraint": {
"single": true
}
}
ContactsListContactsResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"type": {
"type": "string"
},
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"maxLength": 1000,
"x-convert": {
"case": "lower"
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"custom": {
"type": "object"
},
"domain": {
"type": "string"
},
"middle": {
"type": "string"
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"domain": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"bounced": {
"type": "boolean"
},
"opt-out": {
"type": "boolean"
},
"picture": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"lastname": {
"type": "string"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"type": {
"type": "string"
},
"region": {
"type": "string",
"description": "Deprecated property. Use state_region instead."
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"state_region": {
"type": "string"
}
}
}
},
"firstname": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"role": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
}
},
"birth_date": {
"type": "string"
},
"fax_number": {
"type": "string"
},
"not_viewed": {
"type": "boolean"
},
"bounced_date": {
"type": "string",
"format": "date-time"
},
"opt-out_date": {
"type": "string",
"format": "date-time"
},
"organisation": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string"
},
"number": {
"type": "string"
}
}
}
},
"last_email_date": {
"type": "string",
"format": "date-time"
},
"social_profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
},
"opt-out_campaign": {
"type": "string"
},
"home_phone_number": {
"type": "string"
},
"last_meeting_date": {
"type": "string",
"format": "date-time"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"mobile_phone_number": {
"type": "string"
}
}
}
}
CustomFieldsCreateFieldTypeRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
},
"archived": {
"type": "boolean"
}
}
}
},
"archived": {
"type": "boolean"
},
"max_date": {
"type": "string",
"format": "date-time"
},
"min_date": {
"type": "string",
"format": "date-time"
},
"pipeline": {
"type": "number"
},
"required": {
"type": "boolean"
},
"max_number": {
"type": "number"
},
"min_number": {
"type": "number"
},
"order_alphabetically": {
"type": "boolean",
"default": false
},
"default_boolean_value": {
"type": "boolean"
},
"users_can_add_options": {
"type": "boolean"
},
"predefined_customfield": {
"type": "number"
}
}
}
CustomFieldsCreateFieldTypeResponse
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
CustomFieldsDeleteCustomFieldResponse
{
"type": "string"
}
CustomFieldsGetDetailsResponse
{
"type": "string"
}
CustomFieldsListOptionsResponse
{
"type": "string"
}
CustomFieldsListTypeCustomFieldsResponse
{
"type": "string"
}
CustomFieldsListTypesResponse
{
"type": "string"
}
CustomFieldsUpdateFieldRequest
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "number",
"description": "DEPRECATED"
},
"order": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
},
"archived": {
"type": "boolean"
}
}
}
},
"archived": {
"type": "boolean"
},
"max_date": {
"type": "string",
"format": "date-time"
},
"min_date": {
"type": "string",
"format": "date-time"
},
"pipeline": {
"type": "number"
},
"required": {
"type": "boolean"
},
"max_number": {
"type": "number"
},
"min_number": {
"type": "number"
},
"pipelineName": {
"type": "string"
},
"order_alphabetically": {
"type": "boolean"
},
"users_can_add_options": {
"type": "boolean"
},
"predefined_customfield": {
"type": "number"
}
}
}
CustomFieldsUpdateFieldResponse
{
"type": "string"
}
DeleteAccountsAccountIdResponse
{
"type": "string"
}
DeleteContactsContactIdResponse
{
"type": "string"
}
DeleteMeetingsMeetingIdResponse
{
"type": "string"
}
DeleteMessagesMessageIdResponse
{
"type": "string"
}
DeleteTagsTagIdResponse
{
"type": "object",
"properties": {
"success": {
"enum": [
true
],
"type": "boolean"
}
}
}
EmailDataSourcesListResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"aliases",
"email",
"type",
"name",
"team",
"user",
"add_signature_to_campaign",
"add_signature_to_replies",
"max_emails_day",
"max_emails_hour",
"primary",
"status",
"sync_status"
],
"properties": {
"id": {
"type": "number"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "number"
},
"team": {
"type": "number"
},
"type": {
"enum": [
"google",
"office365",
"nylas"
],
"type": "string"
},
"user": {
"type": "number"
},
"email": {
"type": "string"
},
"status": {
"enum": [
"OK",
"RECONNECT",
"ERROR"
],
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "object",
"required": [
"email",
"display_name"
],
"properties": {
"email": {
"type": "string",
"x-format": {
"email": {
"tlds": {
"allow": false
},
"ignoreLength": true,
"minDomainSegments": 1
}
},
"x-convert": {
"case": "lower"
}
},
"display_name": {
"type": "string"
}
}
}
},
"primary": {
"type": "boolean"
},
"smtp_host": {
"type": "string"
},
"smtp_port": {
"type": "number"
},
"sync_status": {
"enum": [
"initial",
"cache",
"sync",
"enrich",
"done"
],
"type": "string"
},
"max_emails_day": {
"type": "number"
},
"email_signature": {
"type": "string"
},
"max_emails_hour": {
"type": "number"
},
"store_sent_emails": {
"type": "boolean"
},
"add_signature_to_replies": {
"type": "boolean"
},
"add_signature_to_campaign": {
"type": "boolean"
}
}
}
}
EmailDataSourcesUpdateDataSourceRequest
{
"type": "object",
"properties": {
"max_emails_day": {
"type": "number",
"maximum": 2000,
"minimum": 0
},
"email_signature": {
"type": "string"
},
"max_emails_hour": {
"type": "number",
"maximum": 200,
"minimum": 0
},
"add_signature_to_replies": {
"type": "boolean"
},
"add_signature_to_campaign": {
"type": "boolean"
}
}
}
EmailDataSourcesUpdateDataSourceResponse
{
"type": "string"
}
FilterFieldsListForEntityResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"customfield_id",
"label",
"type",
"enabled"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"group": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"input": {
"type": "string"
},
"label": {
"type": "string"
},
"entity": {
"enum": [
"account",
"person",
"opportunity",
"campaign",
"tag",
"task",
"workflow",
"workflow_record",
"workflow_step_record"
],
"type": "string"
},
"values": {
"type": "object"
},
"enabled": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"x-constraint": {
"single": true
}
},
"name": {
"type": "string"
},
"order": {
"type": "number"
}
}
}
},
"pipeline": {
"type": "number"
},
"operators": {
"type": "array",
"items": {
"enum": [
"equal",
"not_equal",
"in",
"not_in",
"less",
"less_or_equal",
"greater",
"greater_or_equal",
"between",
"not_between",
"begins_with",
"not_begins_with",
"contains",
"not_contains",
"ends_with",
"not_ends_with",
"is_empty",
"is_not_empty",
"is_null",
"is_not_null",
"true",
"false",
"past_less",
"past_exactly",
"past_more_than",
"future_less",
"future_exactly",
"future_more_than",
"after",
"on",
"before",
"is",
"is_not"
],
"type": "string"
}
},
"param_less": {
"type": "boolean"
},
"validation": {
"type": "object"
},
"search_entity": {
"enum": [
"account",
"contact",
"user",
"tag",
"pipeline"
],
"type": "string"
},
"customfield_id": {
"type": "string"
},
"display_entity": {
"enum": [
"Account",
"Contact",
"Opportunity",
"Campaign",
"Tag",
"Task",
"Workflow"
],
"type": "string"
},
"query_builder_id": {
"type": "string"
}
}
}
}
GetAccountsAccountIdMessagesResponse
{
"type": "string"
}
GetAccountsAccountIdResponse
{
"type": "string"
}
GetConferencesConferenceIdResponse
{
"type": "string"
}
GetContactsContactIdResponse
{
"type": "string"
}
GetMeetingsMeetingIdResponse
{
"type": "string"
}
GetStagesStageIdResponse
{
"type": "string"
}
GetTagsTagIdResponse
{
"type": "string"
}
GetTagsTagIdUsageResponse
{
"type": "string"
}
GroupsGetByIdResponse
{
"type": "string"
}
GroupsListResponse
{
"type": "string"
}
InternalNotesCreateNoteRequest
{
"type": "object",
"required": [
"account",
"body"
],
"properties": {
"body": {
"type": "string"
},
"date": {
"type": "string",
"format": "date-time"
},
"account": {
"type": "number"
},
"mentions": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
InternalNotesCreateNoteResponse
{
"type": "string"
}
MeetingsCreateMeetingRequest
{
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"participants"
],
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"type": {
"enum": [
"meeting-live",
"meeting-phone"
],
"type": "string",
"default": "meeting-live"
},
"notes": {
"type": "string"
},
"minutes": {
"type": "string",
"description": "The use of this property is deprecated. Use the notes property instead."
},
"subject": {
"type": "string",
"maxLength": 200
},
"end_date": {
"type": "string",
"format": "date-time"
},
"phone_type": {
"type": "string"
},
"description": {
"type": "string"
},
"participants": {
"type": "array",
"items": {
"type": "number"
},
"description": "No participants is possible for call log sync"
},
"phone_number_hash": {
"type": "string"
}
}
},
"x-constraint": {
"single": true
}
}
MeetingsCreateMeetingResponse
{
"type": "string"
}
OpportunitiesCreateOpportunityRequest
{
"type": "object",
"required": [
"account"
],
"properties": {
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"stage": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"required": [
"id",
"order",
"probability"
],
"properties": {
"id": {
"type": "number",
"x-constraint": {
"sign": "positive"
}
},
"order": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
}
}
},
{
"type": "string"
}
]
},
"units": {
"type": "number"
},
"value": {
"type": "number",
"minimum": 0
},
"closed": {
"type": "boolean"
},
"custom": {
"type": "object"
},
"status": {
"type": "string",
"description": "DEPRECATED"
},
"account": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"creator": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"assignee": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"currency": {
"type": "number"
},
"frequency": {
"enum": [
"annually",
"weekly",
"monthly",
"daily"
],
"type": "string",
"x-convert": {
"case": "lower"
}
},
"close_date": {
"type": "string",
"format": "date-time"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"lead_source": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
]
},
"lost_reason": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
{
"type": "string"
}
]
},
"probability": {
"type": "number",
"minimum": 0
},
"status_date": {
"type": "string",
"description": "DEPRECATED"
},
"main_contact": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
]
},
"contract_end_date": {
"type": "string",
"format": "date-time"
},
"contract_start_date": {
"type": "string",
"format": "date-time"
},
"recurring_price_per_unit": {
"type": "number"
}
}
}
OpportunitiesCreateOpportunityResponse
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
OpportunitiesGetDetailsResponse
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"done": {
"type": "boolean"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
},
"disabled": {
"type": "boolean"
}
}
},
"stage": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"order": {
"type": "number"
},
"pipeline": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
}
}
},
"units": {
"type": "number"
},
"value": {
"type": "number"
},
"closed": {
"type": "boolean"
},
"custom": {
"type": "object"
},
"account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"owner": {
"type": "number"
},
"hotness": {
"type": "number"
},
"picture": {
"type": "string"
}
}
},
"creator": {
"type": "number"
},
"assignee": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"can_edit": {
"type": "boolean"
},
"currency": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"iso": {
"type": "string"
},
"html": {
"type": "string"
}
}
},
"pipeline": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"frequency": {
"type": "string"
},
"close_date": {
"type": "string"
},
"start_date": {
"type": "string"
},
"lead_source": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"lost_reason": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
}
}
},
"probability": {
"type": "number"
},
"main_contact": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"entity": {
"enum": [
"contact"
],
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"stage_updates": {
"type": "array",
"items": {
"type": "object",
"required": [
"duration_in_seconds"
],
"properties": {
"stage": {
"type": "object",
"required": [
"id",
"order",
"name",
"color"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"order": {
"type": "number"
}
}
},
"duration_in_seconds": {
"type": "number"
}
}
}
},
"calculated_value": {
"type": "number"
},
"last_interaction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string"
},
"person": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"description": {
"type": "string"
}
}
},
"last_modified_by": {
"type": "number"
},
"contract_end_date": {
"type": "string"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"contract_start_date": {
"type": "string"
},
"recurring_price_per_unit": {
"type": "number"
}
}
}
OpportunitiesListResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"done": {
"type": "boolean"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
},
"disabled": {
"type": "boolean"
}
}
},
"stage": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"order": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
}
}
},
"units": {
"type": "number"
},
"value": {
"type": "number"
},
"closed": {
"type": "boolean"
},
"custom": {
"type": "object"
},
"account": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"hotness": {
"type": "number"
},
"picture": {
"type": "string"
}
}
},
"creator": {
"type": "number"
},
"assignee": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"can_edit": {
"type": "boolean"
},
"currency": {
"type": "object",
"required": [
"iso"
],
"properties": {
"iso": {
"type": "string"
}
}
},
"pipeline": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"frequency": {
"type": "string"
},
"close_date": {
"type": "string"
},
"start_date": {
"type": "string"
},
"lead_source": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"lost_reason": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"order": {
"type": "number"
}
}
},
"probability": {
"type": "number"
},
"main_contact": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"entity": {
"enum": [
"contact"
],
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"calculated_value": {
"type": "number"
},
"last_interaction": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string"
},
"person": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"picture": {
"type": "string"
}
}
},
"description": {
"type": "string"
}
}
},
"last_modified_by": {
"type": "number"
},
"contract_end_date": {
"type": "string"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"contract_start_date": {
"type": "string"
},
"last_stage_change_date": {
"type": "string",
"format": "date"
},
"recurring_price_per_unit": {
"type": "number"
}
}
}
}
OpportunitiesRemoveOpportunityResponse
{
"type": "string"
}
OpportunitiesUpdateOpportunityRequest
{
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"_dirty": {
"type": "string",
"description": "Deprecated, will be ignored"
},
"_deleted": {
"type": "boolean"
},
"creation_date": {
"type": "string"
},
"modification_date": {
"type": "string"
}
}
}
]
}
},
"files": {
"type": "array",
"items": {
"type": "object"
}
},
"owner": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"stage": {
"type": "number",
"x-constraint": {
"sign": "positive"
},
"x-alternatives": [
{
"type": "number",
"x-constraint": {
"sign": "positive"
}
},
{
"type": "object",
"required": [
"id",
"order",
"probability"
],
"properties": {
"id": {
"type": "number"
},
"order": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
}
}
}
]
},
"units": {
"type": "number"
},
"value": {
"type": "number",
"minimum": 0
},
"closed": {
"type": "boolean"
},
"custom": {
"type": "object"
},
"account": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"creator": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"assignee": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"frequency": {
"enum": [
"annually",
"weekly",
"monthly",
"daily"
],
"type": "string",
"x-convert": {
"case": "lower"
}
},
"close_date": {
"type": "string",
"format": "date-time"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"lead_source": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
]
},
"lost_reason": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
]
},
"probability": {
"type": "number",
"minimum": 0
},
"main_contact": {
"type": "number",
"x-alternatives": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}
]
},
"contract_end_date": {
"type": "string",
"format": "date-time"
},
"contract_start_date": {
"type": "string",
"format": "date-time"
},
"recurring_price_per_unit": {
"type": "number"
}
}
}
OpportunitiesUpdateOpportunityResponse
{
"type": "string"
}
PersonsListResponse
{
"type": "string"
}
PipelinesListResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"team": {
"type": "number"
},
"order": {
"type": "number"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
}
},
"stages": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"order": {
"type": "number"
},
"fixed_stage": {
"type": "number"
},
"probability": {
"type": "number"
},
"days_until_account_inactive": {
"type": "number"
}
}
}
},
"archived": {
"type": "boolean"
},
"currency": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"iso": {
"type": "string"
},
"html": {
"type": "string"
}
}
},
"recurring": {
"type": "boolean",
"default": false
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"default_pipeline": {
"type": "boolean"
},
"modification_date": {
"type": "string",
"format": "date-time"
},
"follows_default_team_currency": {
"type": "boolean"
},
"standard_price_per_unit_daily": {
"type": "number"
},
"standard_price_per_unit_weekly": {
"type": "number"
},
"standard_price_per_unit_monthly": {
"type": "number"
},
"standard_price_per_unit_annually": {
"type": "number"
},
"expected_customer_lifetime_months": {
"type": "number"
}
}
}
}
PipelinesListStagesResponse
{
"type": "string"
}