openapi.city
Sign in

Salesflare

Intelligent sales CRM

help.salesflare.com/api ↗
Version
1.0.0
OpenAPI
3.0.0
Endpoints
67
Schemas
86
72
Quality
Updated
3 days ago
Crm crm sales automation
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.salesflare.com

Endpoints

GET POST PUT PATCH DELETE

Accounts 10 endpoints

GET /accounts
operationId: Accounts_listAccounts

Parameters

Name In Required Type Description
id query optional array —
details query optional boolean —
search query optional string —
name query optional string —
creation_after query optional string —
creation_before query optional string —
min_size query optional number —
max_size query optional number —
domain query optional array —
tag query optional array —
tag.name query optional array —
address.country query optional array —
address.city query optional array —
address.state_region query optional array —
hotness query optional number

1: Room temp, 2: Hot, 3: On fire
offset query optional number —
custom query optional string —
order_by query optional array

Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
q query optional string —
limit query optional number —

Responses

200

Successful
GET /accounts
POST /accounts
operationId: Accounts_createAccount

Parameters

Name In Required Type Description
update_if_exists query optional boolean —

Request Body

application/json
schema AccountsCreateAccountRequest
Property Type Required
name string optional
size number optional
tags array optional
email string optional
links string optional
owner number optional
_dirty boolean optional
custom object optional
domain string optional
address object optional
picture string optional
website string optional
addresses array optional
└ zip string optional
└ city string optional
└ _dirty boolean optional
└ region string optional
└ street string optional
└ country string optional
└ state_region string optional
customers array optional
└ id number required
└ name string optional
└ email string optional
description string optional
phone_number string optional
phone_numbers array optional
└ type string optional
└ _dirty boolean optional
└ number string required
parent_account number optional
email_addresses array optional
└ email string required
└ _dirty boolean optional
social_profiles array optional

Responses

default

Successful
POST /accounts
DELETE /accounts/{account_id}
operationId: deleteAccountsAccount_id

Parameters

Name In Required Type Description
account_id path required number —

Responses

default

Successful
DELETE /accounts/{account_id}
GET /accounts/{account_id}
operationId: getAccountsAccount_id

Parameters

Name In Required Type Description
account_id path required number —

Responses

default

Successful
GET /accounts/{account_id}
PUT /accounts/{account_id}
operationId: putAccountsAccount_id

Parameters

Name In Required Type Description
account_id path required number —

Request Body

application/json
schema PutAccountsAccountIdRequest
Property Type Required
q object optional
└ not boolean optional
└ rules array required
└ id string required
└ type string optional
└ input string optional
└ label string optional
└ value array optional
└ entity string optional
└ enabled string required
└ internal boolean optional
└ operator string required
└ pipeline number optional
└ customfield_id string required
└ display_entity string optional
└ query_builder_id string optional
└ valid boolean optional
└ search string optional
└ order_by string optional
└ condition string required
name string optional
size number optional
tags array optional
email string optional
links string optional
_dirty boolean optional
custom object optional
domain string optional
address object optional
└ id number optional
└ zip string optional
└ city string optional
└ _dirty boolean optional
└ region string optional
└ street string optional
└ country string optional
└ archived boolean optional
└ state_region string optional
picture string optional
website string optional
addresses array optional
└ id number optional
└ zip string optional
└ city string optional
└ _dirty boolean optional
└ region string optional
└ street string optional
└ country string optional
└ archived boolean optional
└ state_region string optional
description string optional
phone_number string optional
phone_numbers array optional
└ id number optional
└ type string optional
└ _dirty boolean optional
└ number string optional
└ archived boolean optional
parent_account number optional
email_addresses array optional
└ id number optional
└ email string optional
└ _dirty boolean optional
└ archived boolean optional
social_profiles array optional

Responses

default

Successful
PUT /accounts/{account_id}
POST /accounts/{account_id}/contacts
operationId: postAccountsAccount_idContacts

Parameters

Name In Required Type Description
account_id path required number —

Request Body

#/components/requestBodies/postAccountsAccount_idContactsBody

Responses

default

Successful
POST /accounts/{account_id}/contacts
PUT /accounts/{account_id}/contacts
operationId: putAccountsAccount_idContacts

Parameters

Name In Required Type Description
account_id path required number —

Request Body

#/components/requestBodies/postAccountsAccount_idContactsBody

Responses

default

Successful
PUT /accounts/{account_id}/contacts
GET /accounts/{account_id}/messages
operationId: getAccountsAccount_idMessages

Parameters

Name In Required Type Description
account_id path required number —
before query optional string —
after query optional string —
limit query optional number —

Responses

default

Successful
GET /accounts/{account_id}/messages
POST /accounts/{account_id}/users
operationId: postAccountsAccount_idUsers

Parameters

Name In Required Type Description
account_id path required number —

Request Body

#/components/requestBodies/postAccountsAccount_idContactsBody

Responses

default

Successful
POST /accounts/{account_id}/users
PUT /accounts/{account_id}/users
operationId: putAccountsAccount_idUsers

Parameters

Name In Required Type Description
account_id path required number —

Request Body

#/components/requestBodies/postAccountsAccount_idContactsBody

Responses

default

Successful
PUT /accounts/{account_id}/users

Calls 2 endpoints

POST /calls
operationId: Calls_createCall

Request Body

application/json
schema CallsCreateCallRequest
array of object
Property Type Required
date string required
notes string optional
minutes string optional
subject string optional
end_date string optional
phone_type string optional
description string optional
participants array required
phone_number_hash string optional

Responses

default

Successful
POST /calls
PUT /calls/{meeting_id}
operationId: putCallsMeeting_id

Parameters

Name In Required Type Description
meeting_id path required number —

Request Body

#/components/requestBodies/putMeetingsMeeting_idBody

Responses

default

Successful
PUT /calls/{meeting_id}

Contacts 5 endpoints

GET /contacts
operationId: Contacts_listContacts

Parameters

Name In Required Type Description
id query optional array —
name query optional string —
email query optional string —
phone_number query optional string —
domain query optional string —
modification_after query optional string —
modification_before query optional string —
creation_after query optional string —
creation_before query optional string —
account query optional array —
tag query optional array —
tag.name query optional array —
position.role query optional array —
address.country query optional array —
address.state_region query optional array —
address.city query optional array —
includeArchived query optional boolean —
search query optional string —
type query optional string —
limit query optional number —
offset query optional number —
custom query optional string —
order_by query optional array

Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
q query optional string —

Responses

200

Successful
GET /contacts
POST /contacts

When payload is an array you will get an array back, if just an object or an array with 1 item you get an object back

operationId: Contacts_createContact

Parameters

Name In Required Type Description
force query optional boolean

When force is false, the contact will not be created if a contact with the same email address used to exist.

Request Body

application/json
schema ContactsCreateContactRequest
array of object
Property Type Required
name string optional
tags array optional
email string optional
files array optional
owner number optional
custom object optional
middle string optional
prefix string optional
suffix string optional
account number optional
address object optional
└ zip string optional
└ city string optional
└ type string optional
└ region string optional
└ street string optional
└ country string optional
└ state_region string optional
bounced boolean optional
opt-out boolean optional
picture string optional
lastname string optional
position object optional
└ role string optional
└ organisation string optional
addresses array optional
└ zip string optional
└ city string optional
└ type string optional
└ region string optional
└ street string optional
└ country string optional
└ state_region string optional
firstname string optional
positions array optional
└ role string optional
└ organisation string optional
birth_date string optional
…9 more object optional

Responses

200

Successful
POST /contacts
DELETE /contacts/{contact_id}
operationId: deleteContactsContact_id

Parameters

Name In Required Type Description
contact_id path required number —

Responses

default

Successful
DELETE /contacts/{contact_id}
GET /contacts/{contact_id}
operationId: getContactsContact_id

Parameters

Name In Required Type Description
contact_id path required number —

Responses

default

Successful
GET /contacts/{contact_id}
PUT /contacts/{contact_id}
operationId: putContactsContact_id

Parameters

Name In Required Type Description
contact_id path required number —
force query optional boolean

When force is false, the contact’s name will not be updated if the name in the update is just the first part of the email address.

Request Body

application/json
schema PutContactsContactIdRequest
Property Type Required
name string optional
role string optional
tags array optional
email string optional
files array optional
owner number optional
_dirty boolean optional
custom object optional
middle string optional
prefix string optional
suffix string optional
account number optional
address object optional
└ id number optional
└ zip string optional
└ city string optional
└ type string optional
└ _dirty boolean optional
└ region string optional
└ street string optional
└ country string optional
└ archived boolean optional
└ state_region string optional
bounced boolean optional
opt-out boolean optional
picture string optional
archived boolean optional
lastname string optional
position object optional
└ id number optional
└ role string optional
└ _dirty boolean optional
└ archived boolean optional
└ organisation string optional
addresses array optional
└ id number optional
└ zip string optional
└ city string optional
└ type string optional
└ _dirty boolean optional
└ region string optional
└ street string optional
└ country string optional
└ archived boolean optional
└ state_region string optional
…12 more object optional

Responses

default

Successful
PUT /contacts/{contact_id}

Customfields 7 endpoints

GET /customfields/types
operationId: CustomFields_listTypes

Responses

default

Successful
GET /customfields/types
GET /customfields/{itemClass}
operationId: CustomFields_listTypeCustomFields

Parameters

Name In Required Type Description
itemClass path required string —
includeDisabled query optional boolean —
pipeline query optional number —
name query optional string —

Responses

default

Successful
GET /customfields/{itemClass}
POST /customfields/{itemClass}
operationId: CustomFields_createFieldType

Parameters

Name In Required Type Description
itemClass path required string —

Request Body

application/json
schema CustomFieldsCreateFieldTypeRequest
Property Type Required
name string optional
type number optional
enabled boolean optional
options array optional
└ id number optional
└ name string required
└ order number optional
└ archived boolean optional
archived boolean optional
max_date string optional
min_date string optional
pipeline number optional
required boolean optional
max_number number optional
min_number number optional
order_alphabetically boolean optional
default_boolean_value boolean optional
users_can_add_options boolean optional
predefined_customfield number optional

Responses

200

Successful
POST /customfields/{itemClass}
GET /customfields/{itemClass}/{customFieldApiField}/options
operationId: CustomFields_listOptions

Parameters

Name In Required Type Description
itemClass path required string —
customFieldApiField path required string —
searchString query optional string —

Responses

default

Successful
GET /customfields/{itemClass}/{customFieldApiField}/options
DELETE /customfields/{itemClass}/{id}
operationId: CustomFields_deleteCustomField

Parameters

Name In Required Type Description
itemClass path required string —
id path required number —

Responses

default

Successful
DELETE /customfields/{itemClass}/{id}
GET /customfields/{itemClass}/{id}
operationId: CustomFields_getDetails

Parameters

Name In Required Type Description
itemClass path required string —
id path required number —

Responses

default

Successful
GET /customfields/{itemClass}/{id}
PUT /customfields/{itemClass}/{id}
operationId: CustomFields_updateField

Parameters

Name In Required Type Description
itemClass path required string —
id path required number —

Request Body

application/json
schema CustomFieldsUpdateFieldRequest
Property Type Required
id number required
name string optional
type number optional
order number optional
enabled boolean optional
options array optional
└ id number optional
└ name string required
└ order number optional
└ archived boolean optional
archived boolean optional
max_date string optional
min_date string optional
pipeline number optional
required boolean optional
max_number number optional
min_number number optional
pipelineName string optional
order_alphabetically boolean optional
users_can_add_options boolean optional
predefined_customfield number optional

Responses

default

Successful
PUT /customfields/{itemClass}/{id}

Emaildatasources 2 endpoints

GET /datasources/email
operationId: EmailDataSources_list

Parameters

Name In Required Type Description
includeTeamDataSources query optional boolean

Team data sources will only be included when the session user is an admin.

Responses

200

Successful
GET /datasources/email
PUT /datasources/email/{id}
operationId: EmailDataSources_updateDataSource

Parameters

Name In Required Type Description
id path required number —

Request Body

application/json
schema EmailDataSourcesUpdateDataSourceRequest
Property Type Required
max_emails_day number optional
email_signature string optional
max_emails_hour number optional
add_signature_to_replies boolean optional
add_signature_to_campaign boolean optional

Responses

default

Successful
PUT /datasources/email/{id}

Filterfields 1 endpoints

GET /filterfields/{entity}
operationId: FilterFields_listForEntity

Parameters

Name In Required Type Description
entity path required string —
pipeline query optional number —
includePipelineSpecificPredefinedFilterFields query optional boolean —

Responses

200

Successful
GET /filterfields/{entity}

Groups 2 endpoints

GET /groups
operationId: Groups_list

Responses

default

Successful
GET /groups
GET /groups/{id}
operationId: Groups_getById

Responses

default

Successful
GET /groups/{id}

Internalnotes 3 endpoints

POST /messages
operationId: InternalNotes_createNote

Request Body

#/components/requestBodies/postMessagesBody

Responses

default

Successful
POST /messages
DELETE /messages/{message_id}
operationId: deleteMessagesMessage_id

Parameters

Name In Required Type Description
message_id path required number —

Responses

default

Successful
DELETE /messages/{message_id}
PUT /messages/{message_id}
operationId: putMessagesMessage_id

Parameters

Name In Required Type Description
message_id path required number —

Request Body

#/components/requestBodies/postMessagesBody

Responses

default

Successful
PUT /messages/{message_id}

Meetings 5 endpoints

GET /conferences/{conference_id}
operationId: getConferencesConference_id

Parameters

Name In Required Type Description
conference_id path required string —

Responses

default

Successful
GET /conferences/{conference_id}
POST /meetings
operationId: Meetings_createMeeting

Request Body

application/json
schema MeetingsCreateMeetingRequest
array of object
Property Type Required
date string required
type string optional
notes string optional
minutes string optional
subject string optional
end_date string optional
phone_type string optional
description string optional
participants array required
phone_number_hash string optional

Responses

default

Successful
POST /meetings
DELETE /meetings/{meeting_id}
operationId: deleteMeetingsMeeting_id

Parameters

Name In Required Type Description
meeting_id path required number —

Responses

default

Successful
DELETE /meetings/{meeting_id}
GET /meetings/{meeting_id}
operationId: getMeetingsMeeting_id

Parameters

Name In Required Type Description
meeting_id path required number —

Responses

default

Successful
GET /meetings/{meeting_id}
PUT /meetings/{meeting_id}
operationId: putMeetingsMeeting_id

Parameters

Name In Required Type Description
meeting_id path required number —

Request Body

#/components/requestBodies/putMeetingsMeeting_idBody

Responses

default

Successful
PUT /meetings/{meeting_id}

Opportunities 5 endpoints

GET /opportunities

default date filter (from/to) is on close_date

setting scope to user gives back all opportunities from the user

operationId: Opportunities_list

Parameters

Name In Required Type Description
search query optional string —
id query optional number —
name query optional string —
status query optional string

DEPRECATED
stage query optional number —
stage.name query optional string —
owner query optional number —
team_member query optional number —
owner_group query optional number —
assignee_group query optional number —
team_member_group query optional number —
account query optional number —
assignee query optional number —
min_value query optional number —
max_value query optional number —
close_after query optional string —
close_before query optional string —
creation_after query optional string —
creation_before query optional string —
closed query optional boolean —
done query optional boolean —
tag query optional array —
tag.name query optional string —
hotness query optional number

1: Room temp, 2: Hot, 3: On fire
limit query optional number —
offset query optional number —
order_by query optional array

Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
pipeline query optional number —
custom query optional string —
details query optional boolean —
q query optional string —

Responses

200

Successful
GET /opportunities
POST /opportunities
operationId: Opportunities_createOpportunity

Request Body

application/json
schema OpportunitiesCreateOpportunityRequest
Property Type Required
name string optional
tags array optional
files array optional
owner number optional
stage number optional
units number optional
value number optional
closed boolean optional
custom object optional
status string optional
account number required
creator number optional
assignee number optional
currency number optional
frequency string optional
close_date string optional
start_date string optional
lead_source number optional
lost_reason number optional
probability number optional
…5 more object optional

Responses

200

Successful
POST /opportunities
DELETE /opportunities/{id}
operationId: Opportunities_removeOpportunity

Parameters

Name In Required Type Description
id path required number —

Responses

default

Successful
DELETE /opportunities/{id}
GET /opportunities/{id}
operationId: Opportunities_getDetails

Parameters

Name In Required Type Description
id path required number —

Responses

200

Successful
GET /opportunities/{id}
PUT /opportunities/{id}
operationId: Opportunities_updateOpportunity

Parameters

Name In Required Type Description
id path required number —

Request Body

application/json
schema OpportunitiesUpdateOpportunityRequest
Property Type Required
done boolean optional
name string optional
tags array optional
files array optional
owner number optional
stage number optional
units number optional
value number optional
closed boolean optional
custom object optional
account number optional
creator number optional
assignee number optional
frequency string optional
close_date string optional
start_date string optional
lead_source number optional
lost_reason number optional
probability number optional
main_contact number optional
…3 more object optional

Responses

default

Successful
PUT /opportunities/{id}

Persons 1 endpoints

GET /persons
operationId: Persons_list

Parameters

Name In Required Type Description
id query optional array —
name query optional string —
email query optional string —
search query optional string —

Responses

default

Successful
GET /persons

Pipelines 3 endpoints

GET /pipelines
operationId: Pipelines_list

Parameters

Name In Required Type Description
search query optional string —
order_by query optional array

Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
q query optional string —

Responses

200

Successful
GET /pipelines
GET /stages
operationId: Pipelines_listStages

Parameters

Name In Required Type Description
id query optional number —
name query optional string —
pipeline.id query optional number —
pipeline.name query optional string —
order_by query optional string —

Responses

default

Successful
GET /stages
GET /stages/{stage_id}
operationId: getStagesStage_id

Parameters

Name In Required Type Description
stage_id path required number —

Responses

default

Successful
GET /stages/{stage_id}

Regionalsettings 1 endpoints

GET /currencies
operationId: RegionalSettings_listSupportedCurrencies

Responses

200

Successful
GET /currencies

Tags 3 endpoints

GET /tags
operationId: Tags_list

Parameters

Name In Required Type Description
id query optional array —
name query optional string

This property is deprecated, use q.search instead. When both are provided, q.search will be used.
limit query optional number —
offset query optional number —
order_by query optional array

Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
q query optional string —

Responses

200

Successful
GET /tags
POST /tags
operationId: Tags_createTag

Request Body

#/components/requestBodies/postTagsBody

Responses

200

Successful
POST /tags
DELETE /tags/{tag_id}
operationId: deleteTagsTag_id

Parameters

Name In Required Type Description
tag_id path required number —

Responses

200

Successful
DELETE /tags/{tag_id}
Load more endpoints

Schemas

object 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"
              }
            }
          }
        ]
      }
    }
  }
}
string AccountsCreateAccountResponse 
{
  "type": "string"
}
array 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"
      }
    }
  }
}
array 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
  }
}
string CallsCreateCallResponse 
{
  "type": "string"
}
array 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
  }
}
array ContactsCreateContactResponse 
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number"
      }
    }
  },
  "x-constraint": {
    "single": true
  }
}
array 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"
      }
    }
  }
}
object 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"
    }
  }
}
object CustomFieldsCreateFieldTypeResponse 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    }
  }
}
string CustomFieldsDeleteCustomFieldResponse 
{
  "type": "string"
}
string CustomFieldsGetDetailsResponse 
{
  "type": "string"
}
string CustomFieldsListOptionsResponse 
{
  "type": "string"
}
string CustomFieldsListTypeCustomFieldsResponse 
{
  "type": "string"
}
string CustomFieldsListTypesResponse 
{
  "type": "string"
}
object 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"
    }
  }
}
string CustomFieldsUpdateFieldResponse 
{
  "type": "string"
}
string DeleteAccountsAccountIdResponse 
{
  "type": "string"
}
string DeleteContactsContactIdResponse 
{
  "type": "string"
}
string DeleteMeetingsMeetingIdResponse 
{
  "type": "string"
}
string DeleteMessagesMessageIdResponse 
{
  "type": "string"
}
object DeleteTagsTagIdResponse 
{
  "type": "object",
  "properties": {
    "success": {
      "enum": [
        true
      ],
      "type": "boolean"
    }
  }
}
array 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"
      }
    }
  }
}
object 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"
    }
  }
}
string EmailDataSourcesUpdateDataSourceResponse 
{
  "type": "string"
}
array 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"
      }
    }
  }
}
string GetAccountsAccountIdMessagesResponse 
{
  "type": "string"
}
string GetAccountsAccountIdResponse 
{
  "type": "string"
}
string GetConferencesConferenceIdResponse 
{
  "type": "string"
}
string GetContactsContactIdResponse 
{
  "type": "string"
}
string GetMeetingsMeetingIdResponse 
{
  "type": "string"
}
string GetStagesStageIdResponse 
{
  "type": "string"
}
string GetTagsTagIdResponse 
{
  "type": "string"
}
string GetTagsTagIdUsageResponse 
{
  "type": "string"
}
string GroupsGetByIdResponse 
{
  "type": "string"
}
string GroupsListResponse 
{
  "type": "string"
}
object 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"
      }
    }
  }
}
string InternalNotesCreateNoteResponse 
{
  "type": "string"
}
array 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
  }
}
string MeetingsCreateMeetingResponse 
{
  "type": "string"
}
object 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"
    }
  }
}
object OpportunitiesCreateOpportunityResponse 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    }
  }
}
object 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"
    }
  }
}
array 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"
      }
    }
  }
}
string OpportunitiesRemoveOpportunityResponse 
{
  "type": "string"
}
object 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"
    }
  }
}
string OpportunitiesUpdateOpportunityResponse 
{
  "type": "string"
}
string PersonsListResponse 
{
  "type": "string"
}
array 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"
      }
    }
  }
}
string PipelinesListStagesResponse 
{
  "type": "string"
}
Load more schemas