openapi: 3.0.0 info: title: Salesflare API version: 1.0.0 description: '# Introduction ## Getting Started The Salesflare API allows you to access and build your own applications or integrations that interact with Salesflare. The Salesflare API provides a RESTful interface with JSON-formatted responses to access most Salesflare resources. ## Authentication The Salesflare API uses bearer token based authentication, which means you need to use the key-value pair "Authorization : Bearer APIKEY" in the header to authenticate. You can make an API key in ["Settings" > "API keys"](https://app.salesflare.com/#/settings/apikeys). Click on the large orange "+" button on the bottom right of the screen to create an API key. ![Screenshot API Key Settings](https://lib.salesflare.com/api_docs/screenshot_settings_apikeys.png?v=2) ## Requests All requests must be sent using HTTPS with TLS 1.2 or higher. Please make sure your developer tools support this version of TLS as older versions or SSL are not supported for security reasons. For PUT or POST requests (e.g. create, update), the payload must be provided as JSON in the request body. ## Responses Responses use HTTP status codes, with the most typical ones being: | Code | Meaning | |------------------------|-----------------------| | Successful Responses | | 200 | OK | | Error Responses | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 429 | Too Many Requests | | 500 | Internal Server Error | ## Testing We recommend testing our API with Postman. ### Download specification Our API is documented following the OpenAPI specification. You can download it [here](https://api.salesflare.com/openapi.json) ### Import in Postman To import the collection, open Postman and click Import, then select "Import From Link" Copy & Paste the following link and press the "Import" button: > https://api.salesflare.com/openapi.json ![Screenshot Postman Import](https://lib.salesflare.com/api_docs/screenshot_postman_import.png) ## Support For API questions and support, please email support@salesflare.com or click the chat bubble below.' contact: email: support@salesflare.com x-logo: url: https://lib.salesflare.com/api_docs/sf-logo-inverted.svg backgroundColor: '#0f1528' altText: Salesflare logo x-tagGroups: - name: General tags: - Tasks - Accounts - Contacts - Opportunities - Workflows - Insights - name: Interactions tags: - Calls - Meetings - Internal Notes - name: User Management tags: - Users - Groups - name: Configuration tags: - Regional Settings - Pipelines - Custom Fields - Email Data Sources - Tags - Filter Fields - Persons tags: [] paths: /accounts: get: summary: List accounts operationId: getAccounts description: Request a list of accounts with optional filters and pagination parameters: - x-constraint: single: true name: id in: query explode: true schema: type: array items: type: number - name: details in: query schema: type: boolean default: true - name: search in: query schema: type: string - name: name in: query schema: type: string - name: creation_after in: query schema: type: string format: date-time - name: creation_before in: query schema: type: string format: date-time - name: min_size in: query schema: type: number minimum: 0 - name: max_size in: query schema: type: number - x-constraint: unique: true single: true name: domain in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: tag in: query explode: true schema: type: array items: type: number - x-constraint: single: true name: tag.name in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.country in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.city in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.state_region in: query explode: true schema: type: array items: type: string - description: 'Hotness level. Allowed values: 1 (Room temp), 2 (Hot), 3 (On fire).' name: hotness in: query schema: type: number enum: - 1 - 2 - 3 - name: offset in: query schema: type: number - name: custom in: query x-type: object schema: type: string - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string - name: limit in: query schema: type: number minimum: 1 default: 10 - name: export in: query schema: type: string tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string post: summary: Create an account operationId: postAccounts description: Create an account parameters: - name: update_if_exists in: query schema: type: boolean default: false requestBody: content: application/json: schema: type: object properties: owner: type: number description: The ID of the user who owns the account. name: type: string description: The account name. domain: type: string description: The account domain. picture: type: string description: The account logo URL. size: type: number description: The account employee count. website: type: string description: The account website URL. x-format: uri: allowRelative: true allowQuerySquareBrackets: true description: type: string description: The account description. address: type: object description: The primary address of the account. addresses: type: array description: List of addresses associated with the account. items: type: object properties: city: type: string description: The address city. country: type: string description: The address country. maxLength: 50 region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string description: The address state or region. street: type: string description: The address street. zip: type: string description: The address ZIP/postal code. _dirty: type: boolean description: Deprecated. This field is ignored. email: type: string description: The account email address. maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower trim: true email_addresses: type: array description: List of email addresses associated with the account. items: type: object properties: email: type: string maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower trim: true _dirty: type: boolean description: Deprecated. This field is ignored. required: - email phone_number: type: string description: The primary phone number of the account. phone_numbers: type: array description: List of phone numbers associated with the account. items: type: object properties: number: type: string type: type: string _dirty: type: boolean description: Deprecated. This field is ignored. required: - number social_profiles: type: array description: List of social profiles associated with the account. items: type: string x-alternatives: - type: string - type: object properties: type: type: string url: type: string username: type: string _dirty: type: boolean description: Deprecated. This field is ignored. tags: type: array description: List of tags associated with the account. items: type: string x-alternatives: - type: string - type: object properties: id: type: number name: type: string team: type: number creation_date: type: string modification_date: type: string _deleted: type: boolean _dirty: type: string description: Deprecated. This field is ignored. links: type: string customers: type: array description: List of customers associated with the account. items: type: object properties: id: type: number email: type: string maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower name: type: string required: - id _dirty: type: boolean description: Deprecated. This field is ignored. parent_account: type: number x-alternatives: - type: number - type: object properties: id: type: number custom: type: object description: Custom field values associated with the account. x-alternatives: - type: object properties: owner: type: number description: The ID of the user who owns the account. name: type: string description: The account name. domain: type: string description: The account domain. picture: type: string description: The account logo URL. size: type: number description: The account employee count. website: type: string description: The account website URL. x-format: uri: allowRelative: true allowQuerySquareBrackets: true description: type: string description: The account description. address: type: object description: The primary address of the account. addresses: type: array description: List of addresses associated with the account. items: type: object properties: city: type: string description: The address city. country: type: string description: The address country. maxLength: 50 region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string description: The address state or region. street: type: string description: The address street. zip: type: string description: The address ZIP/postal code. _dirty: type: boolean description: Deprecated. This field is ignored. email: type: string description: The account email address. maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower trim: true email_addresses: type: array description: List of email addresses associated with the account. items: type: object properties: email: type: string maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower trim: true _dirty: type: boolean description: Deprecated. This field is ignored. required: - email phone_number: type: string description: The primary phone number of the account. phone_numbers: type: array description: List of phone numbers associated with the account. items: type: object properties: number: type: string type: type: string _dirty: type: boolean description: Deprecated. This field is ignored. required: - number social_profiles: type: array description: List of social profiles associated with the account. items: type: string x-alternatives: - type: string - type: object properties: type: type: string url: type: string username: type: string _dirty: type: boolean description: Deprecated. This field is ignored. tags: type: array description: List of tags associated with the account. items: type: string x-alternatives: - type: string - type: object properties: id: type: number name: type: string team: type: number creation_date: type: string modification_date: type: string _deleted: type: boolean _dirty: type: string description: Deprecated. This field is ignored. links: type: string customers: type: array description: List of customers associated with the account. items: type: object properties: id: type: number email: type: string maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower name: type: string required: - id _dirty: type: boolean description: Deprecated. This field is ignored. parent_account: type: number x-alternatives: - type: number - type: object properties: id: type: number custom: type: object description: Custom field values associated with the account. - type: array items: type: object properties: id: type: number email: type: string maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower name: type: string required: - id tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string /contacts: get: summary: List contacts operationId: getContacts description: Request a list of contacts with optional filters and pagination parameters: - x-constraint: single: true name: id in: query explode: true schema: type: array items: type: number - name: name in: query schema: type: string - name: email in: query schema: type: string - name: phone_number in: query schema: type: string - name: domain in: query schema: type: string - name: modification_after in: query schema: type: string format: date-time - name: modification_before in: query schema: type: string format: date-time - name: creation_after in: query schema: type: string format: date-time - name: creation_before in: query schema: type: string format: date-time - x-constraint: single: true name: account in: query explode: true schema: type: array items: type: number - x-constraint: single: true name: tag in: query explode: true schema: type: array items: type: number - x-constraint: single: true name: tag.name in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: position.role in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.country in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.state_region in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.city in: query explode: true schema: type: array items: type: string - name: includeArchived in: query schema: type: boolean - name: search in: query schema: type: string - name: type in: query schema: type: string enum: - customer - mycontacts - name: limit in: query schema: type: number minimum: 1 default: 20 - name: offset in: query schema: type: number default: 0 - name: custom in: query x-type: object schema: type: string - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - name: export in: query schema: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string tags: - Contacts responses: default: description: Successful content: '*/*': schema: type: string post: summary: Create a contact operationId: postContacts description: Create a contact. 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. parameters: - description: When `force` is `false`, the contact is not created if a contact with the same email address previously existed. name: force in: query schema: type: boolean default: true requestBody: content: application/json: schema: type: array x-constraint: single: true items: type: object properties: owner: type: number description: The ID of the user who owns the contact. domain: type: string description: The contact domain. email: type: string description: The contact email address. maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower trim: true prefix: type: string description: The contact name prefix. firstname: type: string description: The contact first name. middle: type: string description: The contact middle name. lastname: type: string description: The contact last name. suffix: type: string description: The contact name suffix. name: type: string description: The full name of the contact. picture: type: string description: The profile picture URL of the contact. maxLength: 500 account: type: number description: The Salesflare ID of the account to link to this contact. If you explicitly pass `null`, any existing linked account is removed. birth_date: type: string format: date-time description: The contact birth date (ISO 8601 date-time). opt-out: type: boolean description: Whether the contact has opted out of communications. opt-out_date: type: string format: date-time description: The date and time the contact opted out of communications (ISO 8601 date-time). opt-out_campaign: type: string bounced: type: boolean description: Whether emails to this contact have bounced. bounced_date: type: string format: date-time description: The date and time emails to this contact bounced (ISO 8601 date-time). files: type: array description: List of files associated with the contact. items: type: object tags: type: array description: List of tags associated with the contact. items: type: string x-alternatives: - type: string - type: object properties: id: type: number name: type: string team: type: number creation_date: type: string modification_date: type: string _deleted: type: boolean _dirty: type: string description: Deprecated. This field is ignored. address: type: object description: The primary address of the contact. properties: city: type: string country: type: string maxLength: 50 region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string street: type: string type: type: string zip: type: string addresses: type: array description: List of addresses associated with the contact. items: type: object properties: city: type: string country: type: string maxLength: 50 region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string street: type: string type: type: string zip: type: string phone_number: type: string description: The primary phone number of the contact. mobile_phone_number: type: string description: The mobile phone number of the contact. home_phone_number: type: string description: The home phone number of the contact. fax_number: type: string description: The fax number of the contact. phone_numbers: type: array description: List of phone numbers associated with the contact. items: type: object properties: number: type: string type: type: string required: - number position: type: object description: The primary position of the contact. properties: organisation: type: string role: type: string positions: type: array description: List of positions associated with the contact. items: type: object properties: end_date: type: string format: date-time start_date: type: string format: date-time current: type: boolean primary: type: boolean organisation: type: string role: type: string social_profiles: type: array description: List of social profiles associated with the contact. items: type: string x-alternatives: - type: string - type: object properties: type: type: string url: type: string username: type: string custom: type: object description: Custom field values associated with the contact. tags: - Contacts responses: '200': description: Successful content: '*/*': schema: type: array x-constraint: single: true items: type: object properties: id: type: number /currencies: get: summary: List supported currencies operationId: getCurrencies tags: - Regional Settings responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: id: type: number iso: type: string x-constraint: length: 3 html: type: string /groups: get: summary: List groups operationId: getGroups tags: - Groups responses: default: description: Successful content: '*/*': schema: type: string /me: get: summary: Get current user's details operationId: getMe tags: - Users responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number team: type: object properties: id: type: number name: type: string tracking_token: type: string days_until_account_inactive: type: number total_user_count: type: number enabled_user_count: type: number paid_user_count: type: number free_users: type: number subscribed: type: boolean payment_type: type: string enum: - stripe - free - appstack discount_code: type: string discount_type: type: string promo_description: type: string promo_redeem_by: type: string format: date-time promo_code: type: string plan: type: number currency: type: object properties: id: type: number html: type: string iso: type: string billing_currency: type: object properties: id: type: number html: type: string iso: type: string billing_frequency: type: string enum: - monthly - annually creation_date: type: string format: date-time time_zone: type: string stripe_customer_id: type: string stripe_subscription_date: type: string format: date-time campaign: type: string credit_usage: type: number credit_quota: type: number credit_package: type: string enum: - S - M - L - XL input_token_usage: type: number output_token_usage: type: number ai_inference_usage: type: number ai_inference_quota: type: number email_tracking_subdomain: type: string email_tracking_domain: type: object properties: url: type: string enabled: type: boolean timeZones: type: array items: type: string required: - url - enabled automated_tagging: type: boolean domain: type: string group: type: number amount_of_trial_days_earned: type: number setup_completion_percentage: type: number has_received_account_suggestions: type: boolean has_archived_contacts: type: boolean notification_channel_id: type: string needs_password: type: boolean disabled: type: boolean creation_date: type: string format: date-time modification_date: type: string format: date-time prefix: type: string firstname: type: string middle: type: string lastname: type: string suffix: type: string name: type: string email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 domain: type: string picture: type: string type: type: string is_admin: type: boolean credit_usage: type: number is_importing: type: boolean sync_status: type: string calendar_sync_status: type: string first_calendar_sync_done: type: boolean trial_expired: type: boolean trial_expiry_date: type: string format: date-time trial_extended: type: boolean restricted: type: boolean restricted_reason: type: string team_discount_code: type: string is_delinquent: type: boolean input_token_usage: type: number output_token_usage: type: number ai_inference_usage: type: number social_profiles: type: array items: type: object properties: id: type: number username: type: string url: type: string type: type: string phone_numbers: type: array items: type: object properties: id: type: number number: type: string type: type: string positions: type: array items: type: object properties: id: type: number organisation: type: string role: type: string addresses: type: array items: type: object tags: type: array items: type: object intercom_hash: type: string x-format: hex: byteAligned: false prefix: false first_day_of_week: type: number theme: type: string enum: - system - light - dark language: type: string enum: - en - nl - fr - de - pt - br - it - es am_pm_notation: type: boolean auto_find_email_linkedin: type: boolean data_sources_to_reconnect: type: array items: type: object properties: id: type: number email: type: string type: type: string data_sources: type: array items: type: object properties: id: type: number email: type: string type: type: string sync_status: type: string status: type: string enum: - ERROR - RECONNECT - OK status_message: type: string plan_flags: type: object flags: type: array items: type: object properties: id: type: number flag: type: number name: type: string state: type: boolean user: type: number plan: type: number creation_date: type: string format: date-time modification_date: type: string format: date-time required: - flag - name - state role: type: object properties: id: type: number name: type: string permissions: type: object properties: view: type: string enum: - CED - VIEW ced: type: string enum: - CED - VIEW call_log_sync_date: type: string format: date-time two_fa_enabled: type: boolean has_recently_failed_workflows: type: boolean amount_of_failed_workflows: type: number /opportunities: get: summary: List opportunities operationId: getOpportunities description: Request a list of opportunities with optional filters and pagination

default date filter (from/to) is on close_date

setting scope to user gives back all opportunities from the user parameters: - name: search in: query schema: type: string - x-alternatives: - type: number - type: array items: type: number collectionFormat: multi name: id name: id in: query schema: type: number - name: name in: query schema: type: string - description: Deprecated. Do not use this field. name: status in: query schema: type: string - x-alternatives: - type: number - type: array items: type: number collectionFormat: multi name: stage name: stage in: query schema: type: number - x-alternatives: - type: string - type: array items: type: string collectionFormat: multi name: stage.name name: stage.name in: query schema: type: string - name: owner in: query schema: type: number - name: team_member in: query schema: type: number - name: owner_group in: query schema: type: number - name: assignee_group in: query schema: type: number - name: team_member_group in: query schema: type: number - name: account in: query schema: type: number - name: assignee in: query schema: type: number - name: min_value in: query schema: type: number minimum: 0 - name: max_value in: query schema: type: number - name: close_after in: query schema: type: string format: date-time - name: close_before in: query schema: type: string format: date-time - name: creation_after in: query schema: type: string format: date-time - name: creation_before in: query schema: type: string format: date-time - name: closed in: query schema: type: boolean - name: done in: query schema: type: boolean - x-constraint: single: true name: tag in: query explode: true schema: type: array items: type: number - x-alternatives: - type: string - type: array items: type: string collectionFormat: multi name: tag.name name: tag.name in: query schema: type: string - description: 'Hotness level. Allowed values: 1 (Room temp), 2 (Hot), 3 (On fire).' name: hotness in: query schema: type: number enum: - 1 - 2 - 3 - name: limit in: query schema: type: number - name: offset in: query schema: type: number - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - name: pipeline in: query schema: type: number - name: custom in: query x-type: object schema: type: string - name: details in: query schema: type: boolean - name: export in: query schema: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string tags: - Opportunities responses: default: description: Successful content: '*/*': schema: type: string post: summary: Create an opportunity operationId: postOpportunities description: Create an opportunity requestBody: content: application/json: schema: type: object properties: owner: type: number description: The ID of the user who owns the opportunity. x-alternatives: - type: number description: The ID of the user who owns the opportunity. - type: object description: The user object for the opportunity owner. - type: string account: type: number x-alternatives: - type: number - type: object stage: type: number description: The Salesflare ID of the stage. x-alternatives: - type: number description: The Salesflare ID of the stage. - type: object description: The current stage of the opportunity. properties: id: type: number description: The Salesflare ID of the stage. x-constraint: sign: positive order: type: number description: The order of the stage within the pipeline. probability: type: number description: The probability that the opportunity will be won. fixed_stage: type: number description: The Salesflare ID of the fixed/default stage. required: - id - order - probability - type: string lost_reason: type: number description: The reason the opportunity was lost. x-alternatives: - type: number description: The reason the opportunity was lost. - type: object description: The reason the opportunity was lost. properties: id: type: number name: type: string - type: string files: type: array description: List of files associated with the opportunity. items: type: object lead_source: type: number description: The source of the opportunity. x-alternatives: - type: number description: The source of the opportunity. - type: object description: The source of the opportunity. properties: id: type: number name: type: string start_date: type: string format: date-time description: The start date of the opportunity (ISO 8601 date-time). probability: type: number description: The probability that the opportunity will be won. minimum: 0 assignee: type: number description: The ID of the user assigned to the opportunity. x-alternatives: - type: number description: The ID of the user assigned to the opportunity. - type: object description: The user object for the opportunity assignee. - type: string creator: type: number description: The ID of the user who created the opportunity. x-alternatives: - type: number description: The ID of the user who created the opportunity. - type: object description: The user object for the opportunity creator. - type: string status: type: string description: Deprecated. Do not use this field. name: type: string description: The opportunity name. value: type: number description: The monetary value of the opportunity. minimum: 0 currency: type: number description: The currency ID of the opportunity. status_date: type: string description: Deprecated. Do not use this field. close_date: type: string format: date-time description: The date the opportunity was closed (ISO 8601 date-time). closed: type: boolean description: Whether the opportunity is closed. tags: type: array description: List of tags associated with the opportunity. items: type: string x-alternatives: - type: string - type: object properties: id: type: number name: type: string team: type: number creation_date: type: string modification_date: type: string _deleted: type: boolean _dirty: type: string description: Deprecated. This field is ignored. recurring_price_per_unit: type: number description: The recurring price per unit of the opportunity. frequency: type: string description: 'The recurrence frequency of the opportunity. Allowed values: annually, weekly, monthly, daily.' enum: - annually - weekly - monthly - daily x-convert: case: lower units: type: number description: The number of units for the opportunity. contract_start_date: type: string format: date-time description: The contract start date (ISO 8601 date-time). contract_end_date: type: string format: date-time description: The contract end date (ISO 8601 date-time). main_contact: type: number x-alternatives: - type: number - type: object properties: id: type: number custom: type: object description: Custom field values associated with the opportunity. required: - account tags: - Opportunities responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number /persons: get: summary: List persons operationId: getPersons parameters: - x-constraint: single: true name: id in: query explode: true schema: type: array items: type: number - name: name in: query schema: type: string - name: email in: query schema: type: string - name: search in: query schema: type: string tags: - Persons responses: default: description: Successful content: '*/*': schema: type: string /pipelines: get: summary: List pipelines operationId: getPipelines description: Request a list of pipelines with optional filters and pagination parameters: - name: search in: query schema: type: string - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string tags: - Pipelines responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: id: type: number team: type: number name: type: string currency: type: object properties: id: type: number html: type: string iso: type: string follows_default_team_currency: type: boolean order: type: number stages: type: array items: type: object properties: id: type: number color: type: string probability: type: number name: type: string fixed_stage: type: number days_until_account_inactive: type: number order: type: number required: - name groups: type: array items: type: object properties: id: type: number name: type: string recurring: type: boolean default: false default_pipeline: type: boolean expected_customer_lifetime_months: type: number standard_price_per_unit_annually: type: number standard_price_per_unit_monthly: type: number standard_price_per_unit_weekly: type: number standard_price_per_unit_daily: type: number archived: type: boolean creation_date: type: string format: date-time modification_date: type: string format: date-time /stages: get: summary: List stages operationId: getStages parameters: - name: id in: query schema: type: number - name: name in: query schema: type: string - name: pipeline.id in: query schema: type: number - name: pipeline.name in: query schema: type: string - x-alternatives: - type: string - type: array items: type: string collectionFormat: multi name: order_by name: order_by in: query schema: type: string tags: - Pipelines responses: default: description: Successful content: '*/*': schema: type: string /tags: get: summary: List tags operationId: getTags description: Request a list of tags with optional filters and pagination parameters: - x-constraint: single: true name: id in: query explode: true schema: type: array items: type: number - description: Deprecated. Use `q.search` instead. When both are provided, `q.search` is used. name: name in: query schema: type: string - name: limit in: query schema: type: number minimum: 1 default: 20 - name: offset in: query schema: type: number minimum: 0 default: 0 - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string tags: - Tags responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: id: type: number team: type: number name: type: string modification_date: type: string format: date-time creation_date: type: string format: date-time account_count: type: number person_count: type: number opportunity_count: type: number total_count: type: number automated: type: boolean post: summary: Create a tag operationId: postTags requestBody: $ref: '#/components/requestBodies/postTagsBody' tags: - Tags responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number required: - id /tasks: get: summary: List tasks operationId: getTasks description: Request a list of tasks with optional filters and pagination parameters: - x-constraint: single: true name: id in: query explode: true schema: type: array items: type: number - description: Search tasks by name or description. name: search in: query schema: type: string - description: List of user IDs from the team. Defaults to the authenticated user's ID. x-constraint: single: true name: assignees in: query explode: true schema: type: array items: type: number - description: A list of task type ids. x-constraint: single: true name: type in: query explode: true schema: type: array items: type: number - description: A list of account ids. x-constraint: single: true name: account in: query explode: true schema: type: array items: type: number - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - description: The number of tasks to return. Defaults to 20. name: limit in: query schema: type: number - description: The number of tasks to skip. name: offset in: query schema: type: number - name: export in: query schema: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string tags: - Tasks responses: default: description: Successful content: '*/*': schema: type: string post: summary: Create a task operationId: postTasks description: Create a task requestBody: content: application/json: schema: type: array x-constraint: single: true items: type: object properties: account: type: number description: The ID of the account linked to the task. description: type: string description: The task description. reminder_date: type: string format: date description: The task due date and time (ISO 8601 date-time). default: '2026-06-12T18:22:56.098Z' assignees: type: array description: List of user IDs assigned to the task. x-constraint: single: true items: type: number required: - description tags: - Tasks responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number /users: get: summary: List users operationId: getUsers description: Request a list of users with optional filters and pagination parameters: - x-constraint: single: true name: id in: query explode: true schema: type: array items: type: number - name: name in: query schema: type: string - name: email in: query schema: type: string - name: search in: query schema: type: string - name: limit in: query schema: type: number minimum: 1 - name: offset in: query schema: type: number - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - name: onlyEnabled in: query schema: type: boolean tags: - Users responses: default: description: Successful content: '*/*': schema: type: string /workflows: get: summary: List workflows operationId: getWorkflows parameters: - name: limit in: query schema: type: number minimum: 1 default: 20 - name: offset in: query schema: type: number minimum: 0 default: 0 - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - name: search in: query schema: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: id: type: number name: type: string filter: x-alternatives: - type: object properties: ids: type: array x-constraint: single: true items: type: number - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules type: object properties: ids: type: array x-constraint: single: true items: type: number individual_record_filter: type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules team: type: number status: type: string enum: - draft - live - paused - finished - failed - scheduled status_message: type: string record_type: type: string enum: - contact goal: type: string enum: - opened - clicked - replied continuous: type: boolean exit_after_days: type: number schedule_date: type: string format: date-time schedule_time_start: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_time_end: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_days: type: array items: type: number minimum: 0 maximum: 6 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage in: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage exited: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage met_goal: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage archived: type: boolean steps: type: array items: type: object properties: name: type: string order: type: number filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules trigger_step: type: number trigger_step_index: type: number trigger_after_days: type: number trigger: type: string enum: - sent - opened - clicked - replied - not_opened - not_replied - not_clicked action_type: type: string enum: - send_email action_config: type: object action_status: type: string action_source: type: number action_source_email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage sent: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage interacted: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage replied: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage failed: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage metrics_data: type: object id: type: number workflow: type: number team: type: number archived: type: boolean archived_by: type: number archived_date: type: string format: date-time created_by: type: object properties: id: type: number name: type: string email: type: string picture: type: string required: - id last_modified_by: type: number creation_date: type: string format: date-time modification_date: type: string format: date-time required: - order - id creator_name: type: string created_by: type: number last_modified_by: type: number can_edit: type: boolean creation_date: type: string format: date-time modification_date: type: string format: date-time step_amount: type: number multi_step_before_pro_release: type: boolean scheduled_before_pro_release: type: boolean required: - id - team post: summary: Create a workflow operationId: postWorkflows requestBody: $ref: '#/components/requestBodies/postWorkflowsBody' tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number /accounts/{account_id}: get: summary: Get account details operationId: getAccountsAccount_id parameters: - name: account_id in: path required: true schema: type: number tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string put: summary: Update an account operationId: putAccountsAccount_id description: Update an account parameters: - name: account_id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object properties: name: type: string description: The account name. domain: type: string description: The account domain. picture: type: string description: The account logo URL. size: type: number description: The account employee count. website: type: string description: The account website URL. x-format: uri: allowRelative: true allowQuerySquareBrackets: true description: type: string description: The account description. address: type: object description: The primary address of the account. properties: id: type: number description: The address ID. city: type: string description: The address city. country: type: string description: The address country. maxLength: 50 region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string description: The address state or region. street: type: string description: The address street. zip: type: string description: The address ZIP/postal code. archived: type: boolean description: Whether this address is archived. _dirty: type: boolean description: Deprecated. This field is ignored. addresses: type: array items: type: object description: List of addresses associated with the account. properties: id: type: number city: type: string country: type: string maxLength: 50 region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string street: type: string zip: type: string archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. email: type: string description: The account email address. maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower trim: true email_addresses: type: array description: List of email addresses associated with the account. items: type: object properties: id: type: number email: type: string maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower trim: true archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. phone_number: type: string description: The primary phone number of the account. phone_numbers: type: array description: List of phone numbers associated with the account. items: type: object properties: id: type: number number: type: string type: type: string archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. social_profiles: type: array description: List of social profiles associated with the account. items: type: string x-alternatives: - type: string - type: object properties: id: type: number type: type: string url: type: string username: type: string archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. tags: type: array description: List of tags associated with the account. items: type: string x-alternatives: - type: string - type: object properties: id: type: number name: type: string team: type: number creation_date: type: string modification_date: type: string _deleted: type: boolean _dirty: type: string description: Deprecated. This field is ignored. links: type: string description: Account links. _dirty: type: boolean description: Deprecated. This field is ignored. parent_account: type: number required: - parent_account x-alternatives: - type: number - type: object properties: id: type: number required: - id custom: type: object description: Custom field values associated with the account. q: type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string delete: summary: Delete an account operationId: deleteAccountsAccount_id parameters: - name: account_id in: path required: true schema: type: number tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string /campaigns/mergefields: get: summary: Get a workflow's merge fields operationId: getCampaignsMergefields description: Note that this route is currently still under `/campaigns` but might be moved in the future. tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: entity_type: type: string enum: - account - contact display_name: type: string api_field: type: string is_custom: type: boolean custom_type: type: string required: - entity_type - display_name /conferences/{conference_id}: get: summary: Get meeting details by conference id operationId: getConferencesConference_id parameters: - name: conference_id in: path required: true schema: type: string tags: - Meetings responses: default: description: Successful content: '*/*': schema: type: string /contacts/{contact_id}: get: summary: Get contact details operationId: getContactsContact_id parameters: - name: contact_id in: path required: true schema: type: number tags: - Contacts responses: default: description: Successful content: '*/*': schema: type: string put: summary: Update a contact operationId: putContactsContact_id description: Update a contact parameters: - name: contact_id in: path required: true schema: type: number - description: When `force` is `false`, the contact name is not updated if the provided name only matches the first part of the email address. name: force in: query schema: type: boolean default: true requestBody: content: application/json: schema: type: object properties: prefix: type: string description: The contact name prefix. firstname: type: string description: The contact first name. middle: type: string description: The contact middle name. lastname: type: string description: The contact last name. suffix: type: string description: The contact name suffix. email: type: string description: The contact email address. maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower trim: true role: type: string description: The contact role at their organization. name: type: string description: The full name of the contact. owner: type: number description: The ID of the user who owns the contact. x-alternatives: - type: number description: The ID of the user who owns the contact. - type: object properties: id: type: number description: The ID of the user who owns the contact. required: - id - type: string picture: type: string description: The profile picture URL of the contact. account: type: number description: The Salesflare ID of the account linked to this contact. If you explicitly pass `null`, any existing linked account is removed. birth_date: type: string format: date-time description: The contact birth date (ISO 8601 date-time). opt-out: type: boolean description: Whether the contact has opted out of communications. opt-out_date: type: string format: date-time description: The date and time the contact opted out of communications (ISO 8601 date-time). opt-out_campaign: type: string description: The campaign from which the contact opted out. bounced: type: boolean description: Whether emails to this contact have bounced. bounced_date: type: string format: date-time description: The date and time emails to this contact bounced (ISO 8601 date-time). files: type: array description: List of files associated with the contact. items: type: object tags: type: array description: List of tags associated with the contact. items: type: string x-alternatives: - type: string - type: object properties: id: type: number name: type: string team: type: number creation_date: type: string modification_date: type: string _deleted: type: boolean _dirty: type: string description: Deprecated. This field is ignored. address: type: object properties: id: type: number description: The address ID. city: type: string description: The address city. country: type: string description: The address country. maxLength: 50 region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string description: The address state or region. street: type: string description: The address street. type: type: string zip: type: string description: The address ZIP/postal code. archived: type: boolean description: Whether this address is archived. _dirty: type: boolean description: Deprecated. This field is ignored. addresses: type: array description: List of addresses associated with the contact. items: type: object properties: id: type: number city: type: string country: type: string maxLength: 50 region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string street: type: string type: type: string zip: type: string archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. phone_number: type: string description: The primary phone number of the contact. mobile_phone_number: type: string description: The mobile phone number of the contact. home_phone_number: type: string description: The home phone number of the contact. fax_number: type: string description: The fax number of the contact. phone_numbers: type: array description: List of phone numbers associated with the contact. items: type: object properties: id: type: number number: type: string type: type: string archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. position: type: object description: The primary position of the contact. properties: id: type: number organisation: type: string role: type: string archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. positions: type: array description: List of positions associated with the contact. items: type: object properties: id: type: number organisation: type: string role: type: string archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. social_profiles: type: array description: List of social profiles associated with the contact. items: type: string x-alternatives: - type: string - type: object properties: id: type: number type: type: string url: type: string username: type: string archived: type: boolean _dirty: type: boolean description: Deprecated. This field is ignored. custom: type: object description: Custom field values associated with the contact. _dirty: type: boolean description: Deprecated. This field is ignored. archived: type: boolean tags: - Contacts responses: default: description: Successful content: '*/*': schema: type: string delete: summary: Delete a contact operationId: deleteContactsContact_id parameters: - name: contact_id in: path required: true schema: type: number tags: - Contacts responses: default: description: Successful content: '*/*': schema: type: string /customfields/types: get: summary: List custom field types operationId: getCustomfieldsTypes tags: - Custom Fields responses: default: description: Successful content: '*/*': schema: type: string /customfields/{itemClass}: get: summary: List custom fields of a type operationId: getCustomfieldsItemclass parameters: - name: itemClass in: path required: true schema: type: string enum: - accounts - contacts - opportunities - name: includeDisabled in: query schema: type: boolean - name: pipeline in: query schema: type: number - name: name in: query schema: type: string tags: - Custom Fields responses: default: description: Successful content: '*/*': schema: type: string post: summary: Create a custom field of a type operationId: postCustomfieldsItemclass parameters: - name: itemClass in: path required: true schema: type: string enum: - accounts - contacts - opportunities requestBody: content: application/json: schema: type: object properties: type: type: number name: type: string enabled: type: boolean archived: type: boolean required: type: boolean pipeline: type: number predefined_customfield: type: number users_can_add_options: type: boolean options: type: array items: type: object properties: id: type: number order: type: number archived: type: boolean name: type: string required: - name order_alphabetically: type: boolean default: false min_number: type: number max_number: type: number min_date: type: string format: date-time max_date: type: string format: date-time default_boolean_value: type: boolean tags: - Custom Fields responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number /datasources/email: get: summary: List email data sources operationId: getDatasourcesEmail parameters: - description: Team data sources will only be included when the session user is an admin. name: includeTeamDataSources in: query schema: type: boolean default: false tags: - Email Data Sources responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: id: type: number aliases: type: array items: type: object properties: email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower display_name: type: string required: - email - display_name email: type: string type: type: string enum: - google - office365 - nylas - imap name: type: string team: type: number user: type: number email_signature: type: string add_signature_to_campaign: type: boolean add_signature_to_replies: type: boolean max_emails_day: type: number max_emails_hour: type: number primary: type: boolean host: type: string port: type: number smtp_host: type: string smtp_port: type: number store_sent_emails: type: boolean status: type: string enum: - OK - RECONNECT - ERROR sync_status: type: string enum: - initial - cache - sync - enrich - done 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 /filterfields/{entity}: get: summary: List filter fields for an entity operationId: getFilterfieldsEntity parameters: - name: entity in: path required: true schema: type: string - name: pipeline in: query schema: type: number - name: includePipelineSpecificPredefinedFilterFields in: query schema: type: boolean default: true tags: - Filter Fields responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string name: type: string type: type: string input: type: string values: type: object validation: type: object operators: type: array items: type: string 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 fixed_operator: type: string 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 group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead options: type: array items: type: object properties: id: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number order: type: number name: type: string required: - name sortable: type: boolean pipeline: type: number enabled: type: string param_less: type: boolean required: - id - customfield_id - label - type - enabled /groups/{id}: get: summary: Get a group operationId: getGroupsId tags: - Groups responses: default: description: Successful content: '*/*': schema: type: string parameters: - name: id in: path required: true schema: &id001 type: integer /me/contacts: get: summary: List current user's contacts operationId: getMeContacts parameters: - x-constraint: single: true name: id in: query explode: true schema: type: array items: type: number - name: name in: query schema: type: string - name: email in: query schema: type: string - name: phone_number in: query schema: type: string - name: domain in: query schema: type: string - name: modification_after in: query schema: type: string format: date-time - name: modification_before in: query schema: type: string format: date-time - name: creation_after in: query schema: type: string format: date-time - name: creation_before in: query schema: type: string format: date-time - x-constraint: single: true name: account in: query explode: true schema: type: array items: type: number - x-constraint: single: true name: tag in: query explode: true schema: type: array items: type: number - x-constraint: single: true name: tag.name in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: position.role in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.country in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.state_region in: query explode: true schema: type: array items: type: string - x-constraint: single: true name: address.city in: query explode: true schema: type: array items: type: string - name: includeArchived in: query schema: type: boolean - name: search in: query schema: type: string - name: type in: query schema: type: string enum: - customer - mycontacts - name: limit in: query schema: type: number minimum: 1 default: 20 - name: offset in: query schema: type: number default: 0 - name: custom in: query x-type: object schema: type: string - description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. x-constraint: single: true name: order_by in: query explode: true schema: type: array items: type: string - name: export in: query schema: type: string - x-alternatives: - type: object required: - condition - rules x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string - type: array items: type: object required: - condition x-alternatives: - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean collectionFormat: multi name: q name: q in: query x-type: object x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean - type: object required: - id - operator - value - raw_value x-properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean collectionFormat: multi name: value raw_value: type: array items: type: object collectionFormat: multi name: raw_value pipeline: type: number - type: object required: - condition x-properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. required: - id - customfield_id - operator - enabled x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules not: type: boolean valid: type: boolean x-properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object x-properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number collectionFormat: multi name: value entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean collectionFormat: multi name: rules order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string schema: type: string tags: - Users responses: '200': description: Successful content: '*/*': schema: type: array items: type: object properties: account: type: object properties: id: type: number picture: type: string name: type: string domain: type: string required: - id id: type: number prefix: type: string firstname: type: string middle: type: string lastname: type: string suffix: type: string name: type: string email: type: string maxLength: 1000 x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 x-convert: case: lower domain: type: string birth_date: type: string opt-out: type: boolean opt-out_date: type: string format: date-time opt-out_campaign: type: string bounced: type: boolean bounced_date: type: string format: date-time files: type: array items: type: object owner: type: object properties: id: type: number name: type: string email: type: string picture: type: string required: - id picture: type: string archived: type: boolean not_viewed: type: boolean can_edit: type: boolean creation_date: type: string format: date-time modification_date: type: string format: date-time type: type: string tags: type: array items: type: object properties: id: type: number name: type: string required: - id addresses: type: array items: type: object properties: id: type: number city: type: string country: type: string region: type: string description: Deprecated. Use `state_region` instead. state_region: type: string street: type: string type: type: string zip: type: string required: - id phone_number: type: string mobile_phone_number: type: string home_phone_number: type: string fax_number: type: string phone_numbers: type: array items: type: object properties: id: type: number number: type: string type: type: string required: - id positions: type: array items: type: object properties: id: type: number organisation: type: string role: type: string social_profiles: type: array items: type: object properties: id: type: number type: type: string url: type: string username: type: string required: - id organisation: type: string role: type: string custom: type: object last_email_date: type: string format: date-time last_meeting_date: type: string format: date-time connection_strength: type: number required: - id /meetings/{meeting_id}: get: summary: Get meeting details operationId: getMeetingsMeeting_id parameters: - name: meeting_id in: path required: true schema: type: number tags: - Meetings responses: default: description: Successful content: '*/*': schema: type: string put: summary: Update a meeting operationId: putMeetingsMeeting_id parameters: - name: meeting_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/putMeetingsMeeting_idBody' tags: - Meetings responses: default: description: Successful content: '*/*': schema: type: string delete: summary: Delete a meeting operationId: deleteMeetingsMeeting_id parameters: - name: meeting_id in: path required: true schema: type: number tags: - Meetings responses: default: description: Successful content: '*/*': schema: type: string /opportunities/{id}: get: summary: Get opportunity details operationId: getOpportunitiesId parameters: - name: id in: path required: true schema: type: number tags: - Opportunities responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number owner: type: object properties: id: type: number name: type: string email: type: string picture: type: string disabled: type: boolean required: - id account: type: object properties: id: type: number picture: type: string name: type: string hotness: type: number owner: type: number required: - id name: type: string stage: type: object properties: id: type: number name: type: string color: type: string fixed_stage: type: number order: type: number probability: type: number pipeline: type: number required: - id assignee: type: object properties: id: type: number name: type: string email: type: string picture: type: string required: - id value: type: number calculated_value: type: number frequency: type: string units: type: number contract_start_date: type: string contract_end_date: type: string recurring_price_per_unit: type: number currency: type: object properties: id: type: number iso: type: string html: type: string required: - id close_date: type: string done: type: boolean creator: type: number last_modified_by: type: number can_edit: type: boolean modification_date: type: string format: date-time creation_date: type: string format: date-time pipeline: type: object properties: id: type: number name: type: string last_interaction: type: object properties: type: type: string description: type: string date: type: string format: date-time person: type: object properties: id: type: number picture: type: string name: type: string stage_updates: type: array items: type: object properties: duration_in_seconds: type: number stage: type: object properties: id: type: number order: type: number name: type: string color: type: string required: - id - order - name - color required: - duration_in_seconds tags: type: array items: type: object properties: id: type: number name: type: string required: - id probability: type: number lost_reason: type: object properties: id: type: number name: type: string order: type: number required: - id files: type: array items: type: object lead_source: type: object properties: id: type: number name: type: string required: - id start_date: type: string custom: type: object main_contact: type: object properties: id: type: number name: type: string email: type: string picture: type: string entity: type: string enum: - contact required: - id required: - id put: summary: Update an opportunity operationId: putOpportunitiesId description: Update an opportunity parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object properties: owner: type: number description: The ID of the user who owns the opportunity. x-alternatives: - type: number description: The ID of the user who owns the opportunity. - type: object description: The user object for the opportunity owner. account: type: number description: The Salesflare ID of the account linked to the opportunity. x-alternatives: - type: number description: The Salesflare ID of the account linked to the opportunity. - type: object description: The account object linked to the opportunity. stage: type: number description: The Salesflare ID of the stage. x-constraint: sign: positive x-alternatives: - type: number description: The Salesflare ID of the stage. x-constraint: sign: positive - type: object description: The current stage of the opportunity. properties: id: type: number description: The Salesflare ID of the stage. order: type: number description: The order of the stage within the pipeline. probability: type: number description: The probability that the opportunity will be won. fixed_stage: type: number description: The Salesflare ID of the fixed/default stage. required: - id - order - probability lost_reason: type: number description: The reason the opportunity was lost. x-alternatives: - type: number description: The reason the opportunity was lost. - type: object description: The reason the opportunity was lost. properties: id: type: number name: type: string files: type: array description: List of files associated with the opportunity. items: type: object lead_source: type: number description: The source of the opportunity. x-alternatives: - type: number description: The source of the opportunity. - type: object description: The source of the opportunity. properties: id: type: number name: type: string start_date: type: string format: date-time description: The start date of the opportunity (ISO 8601 date-time). probability: type: number description: The probability that the opportunity will be won. minimum: 0 assignee: type: number description: The ID of the user assigned to the opportunity. x-alternatives: - type: number description: The ID of the user assigned to the opportunity. - type: object description: The user object for the opportunity assignee. - type: string creator: type: number description: The ID of the user who created the opportunity. x-alternatives: - type: number description: The ID of the user who created the opportunity. - type: object description: The user object for the opportunity creator. - type: string name: type: string description: The opportunity name. value: type: number description: The monetary value of the opportunity. minimum: 0 close_date: type: string format: date-time description: The date the opportunity was closed (ISO 8601 date-time). closed: type: boolean description: Whether the opportunity is closed. done: type: boolean description: Whether the opportunity is marked as done. tags: type: array description: List of tags associated with the opportunity. items: type: string x-alternatives: - type: string - type: object properties: id: type: number name: type: string team: type: number creation_date: type: string modification_date: type: string _deleted: type: boolean _dirty: type: string description: Deprecated. This field is ignored. recurring_price_per_unit: type: number description: The recurring price per unit of the opportunity. frequency: type: string description: 'The recurrence frequency of the opportunity. Allowed values: annually, weekly, monthly, daily.' enum: - annually - weekly - monthly - daily x-convert: case: lower units: type: number description: The number of units for the opportunity. contract_start_date: type: string format: date-time description: The contract start date (ISO 8601 date-time). contract_end_date: type: string format: date-time description: The contract end date (ISO 8601 date-time). main_contact: type: number description: The Salesflare ID of the main contact associated with the opportunity. x-alternatives: - type: number description: The Salesflare ID of the main contact associated with the opportunity. - type: object properties: id: type: number custom: type: object description: Custom field values associated with the opportunity. tags: - Opportunities responses: default: description: Successful content: '*/*': schema: type: string delete: summary: Delete an opportunity operationId: deleteOpportunitiesId parameters: - name: id in: path required: true schema: type: number tags: - Opportunities responses: default: description: Successful content: '*/*': schema: type: string /settings/ai: get: summary: Get AI Settings operationId: getSettingsAi tags: - AISetings responses: '200': description: Successful content: '*/*': schema: type: object properties: company: type: object properties: name: type: string summary: type: string generated: type: boolean user: type: object properties: name: type: string summary: type: string put: summary: Update AI Settings operationId: putSettingsAi requestBody: content: application/json: schema: type: object properties: company: type: object properties: name: type: string summary: type: string generated: type: boolean user: type: object properties: name: type: string summary: type: string tags: - AISettings responses: default: description: Successful content: '*/*': schema: type: string /stages/{stage_id}: get: summary: Get stage details operationId: getStagesStage_id parameters: - name: stage_id in: path required: true schema: type: number tags: - Pipelines responses: default: description: Successful content: '*/*': schema: type: string /tags/{tag_id}: get: summary: Get tag details operationId: getTagsTag_id parameters: - name: tag_id in: path required: true schema: type: number tags: - Tags responses: default: description: Successful content: '*/*': schema: type: string put: summary: Update a tag operationId: putTagsTag_id parameters: - name: tag_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postTagsBody' tags: - Tags responses: '200': description: Successful content: '*/*': schema: type: object properties: success: type: boolean delete: summary: Delete a tag operationId: deleteTagsTag_id parameters: - name: tag_id in: path required: true schema: type: number tags: - Tags responses: '200': description: Successful content: '*/*': schema: type: object properties: success: type: string enum: - true /users/{id}: get: summary: Get user details operationId: getUsersId parameters: - name: id in: path required: true schema: type: number tags: - Users responses: default: description: Successful content: '*/*': schema: type: string /workflows/{id}: get: summary: Get workflow details operationId: getWorkflowsId parameters: - name: id in: path required: true schema: type: number tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: object properties: id: type: number name: type: string filter: x-alternatives: - type: object properties: ids: type: array x-constraint: single: true items: type: number - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules type: object properties: ids: type: array x-constraint: single: true items: type: number individual_record_filter: type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean archived: type: boolean options: type: array items: type: object group: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead raw_value: type: array items: type: object search_entity: type: string enum: - account - contact - user - tag - pipeline - workflow - lead required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules team: type: number status: type: string enum: - draft - live - paused - finished - failed - scheduled status_message: type: string record_type: type: string enum: - contact goal: type: string enum: - opened - clicked - replied continuous: type: boolean exit_after_days: type: number schedule_date: type: string format: date-time schedule_time_start: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_time_end: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_days: type: array items: type: number minimum: 0 maximum: 6 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage in: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage exited: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage met_goal: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage archived: type: boolean steps: type: array items: type: object properties: name: type: string order: type: number filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules trigger_step: type: number trigger_step_index: type: number trigger_after_days: type: number trigger: type: string enum: - sent - opened - clicked - replied - not_opened - not_replied - not_clicked action_type: type: string enum: - send_email action_config: type: object action_status: type: string action_source: type: number action_source_email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage sent: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage interacted: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage replied: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage failed: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage metrics_data: type: object id: type: number workflow: type: number team: type: number archived: type: boolean archived_by: type: number archived_date: type: string format: date-time created_by: type: object properties: id: type: number name: type: string email: type: string picture: type: string required: - id last_modified_by: type: number creation_date: type: string format: date-time modification_date: type: string format: date-time required: - order - id creator_name: type: string created_by: type: number last_modified_by: type: number can_edit: type: boolean creation_date: type: string format: date-time modification_date: type: string format: date-time step_amount: type: number multi_step_before_pro_release: type: boolean scheduled_before_pro_release: type: boolean workflow_steps: type: array items: type: object properties: name: type: string order: type: number filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules trigger_step: type: number trigger_step_index: type: number trigger_after_days: type: number trigger: type: string enum: - sent - opened - clicked - replied - not_opened - not_replied - not_clicked action_type: type: string enum: - send_email action_config: type: object action_status: type: string action_source: type: number action_source_email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage sent: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage interacted: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage replied: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage failed: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage metrics_data: type: object id: type: number workflow: type: number team: type: number archived: type: boolean archived_by: type: number archived_date: type: string format: date-time created_by: type: object properties: id: type: number name: type: string email: type: string picture: type: string required: - id last_modified_by: type: number creation_date: type: string format: date-time modification_date: type: string format: date-time required: - order - id required: - id - team put: summary: Update a workflow operationId: putWorkflowsId parameters: - name: id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postWorkflowsBody' tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: object properties: success: type: boolean /accounts/{account_id}/messages: get: summary: List an account's messages operationId: getAccountsAccount_idMessages parameters: - name: account_id in: path required: true schema: type: number - name: before in: query schema: type: string format: date-time - name: after in: query schema: type: string format: date-time default: '1970-01-01T00:00:00.000Z' - name: limit in: query schema: type: number minimum: 1 default: 10 tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string /accounts/{account_id}/feed: get: summary: Get an account's feed operationId: getAccountsAccount_idFeed description: Get an account's feed which includes emails, messages, meetings, and other activities parameters: - name: account_id in: path required: true schema: type: number - name: before in: query schema: type: string format: date-time - name: after in: query schema: type: string format: date-time default: '1970-01-01T00:00:00.000Z' - name: limit in: query schema: type: number minimum: 1 default: 10 - x-constraint: single: true name: types in: query explode: true schema: type: array items: type: string enum: - email - message - meeting-live - meeting-phone - forward - webpage - user_added - user_removed - account_created - description: List of contacts to filter the account feed on. Empty array means no contacts and if key not present then all contacts will be used. x-constraint: single: true name: contacts in: query explode: true schema: type: array items: type: number tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string /customfields/{itemClass}/{id}: get: summary: Get custom field details operationId: getCustomfieldsItemclassId parameters: - name: itemClass in: path required: true schema: type: string enum: - accounts - contacts - opportunities - name: id in: path required: true schema: type: number tags: - Custom Fields responses: default: description: Successful content: '*/*': schema: type: string put: summary: Update a custom field operationId: putCustomfieldsItemclassId parameters: - name: itemClass in: path required: true schema: type: string enum: - accounts - contacts - opportunities - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object properties: id: type: number type: type: number description: Deprecated. Do not use this field. name: type: string enabled: type: boolean archived: type: boolean required: type: boolean pipeline: type: number pipelineName: type: string order: type: number predefined_customfield: type: number users_can_add_options: type: boolean options: type: array items: type: object properties: id: type: number order: type: number archived: type: boolean name: type: string required: - name order_alphabetically: type: boolean min_number: type: number max_number: type: number min_date: type: string format: date-time max_date: type: string format: date-time required: - id tags: - Custom Fields responses: default: description: Successful content: '*/*': schema: type: string delete: summary: Delete a custom field operationId: deleteCustomfieldsItemclassId parameters: - name: itemClass in: path required: true schema: type: string enum: - accounts - contacts - opportunities - name: id in: path required: true schema: type: number tags: - Custom Fields responses: default: description: Successful content: '*/*': schema: type: string /tags/{tag_id}/usage: get: summary: Get tag details on usage in workflows, saved filters & reports operationId: getTagsTag_idUsage parameters: - name: tag_id in: path required: true schema: type: number tags: - Tags responses: default: description: Successful content: '*/*': schema: type: string /customfields/{itemClass}/{customFieldApiField}/options: get: summary: List a custom field's options operationId: getCustomfieldsItemclassCustomfieldapifieldOptions parameters: - name: itemClass in: path required: true schema: type: string enum: - accounts - contacts - opportunities - name: customFieldApiField in: path required: true schema: type: string - name: searchString in: query schema: type: string tags: - Custom Fields responses: default: description: Successful content: '*/*': schema: type: string /calls: post: summary: Create a call operationId: postCalls requestBody: content: application/json: schema: type: array x-constraint: single: true items: type: object properties: date: type: string format: date-time end_date: type: string format: date-time subject: type: string maxLength: 200 description: type: string minutes: type: string description: Deprecated. Use the `notes` property instead. notes: type: string phone_type: type: string phone_number_hash: type: string participants: type: array description: No participants are possible for call log sync. items: type: number required: - date - participants tags: - Calls responses: default: description: Successful content: '*/*': schema: type: string /meetings: post: summary: Create a meeting operationId: postMeetings requestBody: content: application/json: schema: type: array x-constraint: single: true items: type: object properties: date: type: string format: date-time end_date: type: string format: date-time subject: type: string maxLength: 200 description: type: string minutes: type: string description: Deprecated. Use the `notes` property instead. notes: type: string phone_type: type: string phone_number_hash: type: string participants: type: array description: No participants are possible for call log sync. items: type: number type: type: string default: meeting-live enum: - meeting-live - meeting-phone required: - date - participants tags: - Meetings responses: default: description: Successful content: '*/*': schema: type: string /messages: post: summary: Create an internal note operationId: postMessages requestBody: $ref: '#/components/requestBodies/postMessagesBody' tags: - Internal Notes responses: default: description: Successful content: '*/*': schema: type: string /accounts/{account_id}/users: post: summary: Update an account's users operationId: postAccountsAccount_idUsers parameters: - name: account_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postAccountsAccount_idUsersBody' tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string put: summary: Update an account's users operationId: putAccountsAccount_idUsers parameters: - name: account_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postAccountsAccount_idUsersBody' tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string /accounts/{account_id}/contacts: post: summary: Update an account's contacts operationId: postAccountsAccount_idContacts parameters: - name: account_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postAccountsAccount_idUsersBody' tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string put: summary: Update an account's contacts operationId: putAccountsAccount_idContacts parameters: - name: account_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postAccountsAccount_idUsersBody' tags: - Accounts responses: default: description: Successful content: '*/*': schema: type: string /message/{message_id}/feedback: post: summary: Create an internal note operationId: postMessageMessage_idFeedback parameters: - name: message_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postMessageMessage_idFeedbackBody' tags: - AI Message Feedbacks responses: default: description: Successful content: '*/*': schema: type: string /messages/{message_id}/feedback: post: summary: Create an internal note operationId: postMessagesMessage_idFeedback parameters: - name: message_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postMessageMessage_idFeedbackBody' tags: - AI Message Feedbacks responses: default: description: Successful content: '*/*': schema: type: string /calls/{meeting_id}: put: summary: Update a call operationId: putCallsMeeting_id parameters: - name: meeting_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/putMeetingsMeeting_idBody' tags: - Calls responses: default: description: Successful content: '*/*': schema: type: string /messages/{message_id}: put: summary: Update an internal note operationId: putMessagesMessage_id parameters: - name: message_id in: path required: true schema: type: number requestBody: $ref: '#/components/requestBodies/postMessagesBody' tags: - Internal Notes responses: default: description: Successful content: '*/*': schema: type: string delete: summary: Delete an internal note operationId: deleteMessagesMessage_id parameters: - name: message_id in: path required: true schema: type: number tags: - Internal Notes responses: default: description: Successful content: '*/*': schema: type: string /tasks/{id}: put: summary: Update a task operationId: putTasksId description: Update a task requestBody: content: application/json: schema: type: object properties: account: type: number description: The ID of the account linked to the task. description: type: string description: The task description. reminder_date: type: string format: date description: The task due date and time (ISO 8601 date-time). assignees: type: array description: List of user IDs assigned to the task. x-constraint: single: true items: type: number completed: type: boolean description: Whether the task is completed. tags: - Tasks responses: '200': description: Successful content: '*/*': schema: type: object properties: success: type: boolean parameters: - name: id in: path required: true schema: *id001 delete: summary: Delete a task operationId: deleteTasksId tags: - Tasks responses: '200': description: Successful content: '*/*': schema: type: object properties: success: type: boolean parameters: - name: id in: path required: true schema: *id001 /datasources/email/{id}: put: summary: Update an email data source operationId: putDatasourcesEmailId parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object properties: email_signature: type: string add_signature_to_campaign: type: boolean add_signature_to_replies: type: boolean max_emails_day: type: number minimum: 0 maximum: 2000 max_emails_hour: type: number minimum: 0 maximum: 200 tags: - Email Data Sources responses: default: description: Successful content: '*/*': schema: type: string /workflows/{id}/audience/{record_id}: put: summary: Re-enter or exit an entity from a workflow operationId: putWorkflowsIdAudienceRecord_id parameters: - name: id in: path required: true schema: type: number - description: This is the entity id. For email workflows this should be the contact id. name: record_id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object properties: exited: type: boolean description: Setting `exited` to `true` will exit the entity from the workflow. Setting `exited` to `false` will re-enter the entity into the workflow. met_goal: type: boolean description: Setting `met_goal` of a workflow record to `false` is currently not possible. tags: - Workflows responses: '200': description: Successful content: '*/*': schema: type: object properties: success: type: boolean servers: - url: https://api.salesflare.com components: requestBodies: postAccountsAccount_idUsersBody: content: application/json: schema: type: array minItems: 1 x-constraint: single: true items: type: object properties: id: type: number _dirty: type: boolean _deleted: type: boolean postMessagesBody: content: application/json: schema: type: object properties: account: type: number body: type: string mentions: type: array items: type: number date: type: string format: date-time required: - account - body postTagsBody: content: application/json: schema: type: object properties: name: type: string required: - name postWorkflowsBody: content: application/json: schema: type: object properties: name: type: string filter: x-alternatives: - type: object description: When you provide `ids`, all other filter options are ignored. properties: ids: type: array x-constraint: single: true items: type: number - x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules type: object description: When you provide `ids`, all other filter options are ignored. properties: ids: type: array x-constraint: single: true items: type: number individual_record_filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules status: type: string enum: - live - paused - scheduled - draft status_message: type: string record_type: type: string enum: - contact goal: type: string enum: - opened - clicked - replied continuous: type: boolean exit_after_days: type: number schedule_date: type: string format: date-time schedule_time_start: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_time_end: type: string pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:\d{2}$ schedule_days: type: array items: type: number minimum: 0 maximum: 6 steps: type: array items: type: object properties: id: type: number name: type: string order: type: number filter: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules - type: array items: x-alternatives: - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object properties: condition: type: string enum: - AND - OR rules: type: array items: x-alternatives: - type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled - type: object properties: id: type: string operator: type: string description: '`is_empty`, `is_not_empty`, `is_null`, `is_not_null`, `true` and `false` are Deprecated. Do not use this field. and should not be used.' 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean raw_value: type: array items: type: object pipeline: type: number required: - id - operator - value - raw_value - type: object properties: condition: type: string enum: - AND - OR rules: type: array items: type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled not: type: boolean valid: type: boolean required: - condition type: object description: Deprecated. Use the slim version with only `id`, `operator`, and `value`. properties: id: type: string query_builder_id: type: string customfield_id: type: string label: type: string type: type: string enum: - integer - double - boolean - tri_state_boolean - string - long_string - select - date - datetime - file input: type: string operator: type: string 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 value: type: array x-constraint: single: true items: type: string x-alternatives: - type: string - type: number - type: string format: date-time - type: boolean - type: object properties: value1: type: string x-alternatives: - type: string - type: number value2: type: string x-alternatives: - type: string - type: number entity: type: string enum: - account - person - opportunity - campaign - tag - task - workflow - workflow_record - workflow_step_record - lead display_entity: type: string enum: - Account - Contact - Opportunity - Campaign - Tag - Task - Workflow - Lead pipeline: type: number enabled: type: string internal: type: boolean required: - id - customfield_id - operator - enabled order_by: type: string description: Sort instructions. Provide either 'key' (ascending) or 'key desc' (descending). Default sort order is ascending. You can fetch available sort keys via a discover mode call. not: type: boolean valid: type: boolean search: type: string required: - condition - rules trigger_step: type: number trigger_step_index: type: number trigger_after_days: type: number trigger: type: string enum: - sent - opened - clicked - replied - not_opened - not_replied - not_clicked action_type: type: string enum: - send_email action_config: type: object action_status: type: string action_source: type: number action_source_email: type: string x-format: email: ignoreLength: true tlds: allow: false minDomainSegments: 1 analytics: type: object properties: total: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage sent: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage interacted: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage replied: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage failed: type: object properties: name: type: string value: type: number type: type: string enum: - absolute - percentage metrics_data: type: object required: - order required: - name putMeetingsMeeting_idBody: content: application/json: schema: type: object properties: calendar_id: type: string external_id: type: string minutes: type: string description: Deprecated. Use the `notes` property instead. notes: type: string description: The only property you can modify on calendar meetings. edited_by: type: number required: - calendar_id - external_id - notes x-alternatives: - type: object properties: calendar_id: type: string external_id: type: string minutes: type: string description: Deprecated. Use the `notes` property instead. notes: type: string description: The only property you can modify on calendar meetings. edited_by: type: number required: - calendar_id - external_id - notes - type: object properties: date: type: string format: date-time end_date: type: string format: date-time subject: type: string maxLength: 200 description: type: string minutes: type: string description: Deprecated. Use the `notes` property instead. notes: type: string edited_by: type: number type: type: string enum: - meeting-live - meeting-phone phone_type: type: string participants: type: array minItems: 1 items: type: number required: - participants postMessageMessage_idFeedbackBody: content: application/json: schema: type: object properties: feedback: type: string required: - feedback