diff --git a/sdks/db/browser-downloads/apidocs.launchdarkly.com/swagger.json b/sdks/db/browser-downloads/apidocs.launchdarkly.com/swagger.json index 7909abc53c..0fba75b915 100644 --- a/sdks/db/browser-downloads/apidocs.launchdarkly.com/swagger.json +++ b/sdks/db/browser-downloads/apidocs.launchdarkly.com/swagger.json @@ -34087,7 +34087,7 @@ }, "unitAggregationType": { "type": "string", - "description": "The method in which multiple unit event values are aggregated", + "description": "The method by which multiple unit event values are aggregated", "example": "average", "enum": [ "average", @@ -34096,7 +34096,7 @@ }, "analysisType": { "type": "string", - "description": "The strategy for analyzing metric events", + "description": "The method for analyzing metric events", "example": "mean", "enum": [ "mean", @@ -34105,7 +34105,7 @@ }, "percentileValue": { "type": "integer", - "description": "The percentile, an integer denoting the target percentile between 0 and 100. Only present when analysisType is percentile.", + "description": "The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile.", "example": 95 }, "eventDefault": { @@ -34209,12 +34209,25 @@ }, "unitAggregationType": { "type": "string", - "description": "The method in which multiple unit event values are aggregated", + "description": "The method by which multiple unit event values are aggregated", "example": "average", "enum": [ "average", "sum" ] + }, + "analysisType": { + "type": "string", + "description": "The method for analyzing metric events", + "example": "mean" + }, + "percentileValue": { + "type": "integer", + "description": "The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile.", + "example": 95 + }, + "eventDefault": { + "$ref": "#/components/schemas/MetricEventDefaultRep" } } }, @@ -34365,7 +34378,7 @@ }, "unitAggregationType": { "type": "string", - "description": "The method in which multiple unit event values are aggregated", + "description": "The method by which multiple unit event values are aggregated", "example": "average", "enum": [ "average", @@ -34374,7 +34387,7 @@ }, "analysisType": { "type": "string", - "description": "The strategy for analyzing metric events", + "description": "The method for analyzing metric events", "example": "mean", "enum": [ "mean", @@ -34383,7 +34396,7 @@ }, "percentileValue": { "type": "integer", - "description": "The percentile, an integer denoting the target percentile between 0 and 100. Only present when analysisType is percentile.", + "description": "The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile.", "example": 95 }, "eventDefault": { diff --git a/sdks/db/cached-method-objects/from-custom-request_circleci.com.yaml b/sdks/db/cached-method-objects/from-custom-request_circleci.com.yaml index 312d8756b8..8d3303d6e9 100644 --- a/sdks/db/cached-method-objects/from-custom-request_circleci.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_circleci.com.yaml @@ -1,4 +1,4 @@ -hash: 69a8e8f9b4a1582756b56cc8843cef2d001fd3ff7598ceed3fbb7b2a9161809d +hash: cf9c4bbd6256c37b5300ad688a145fb95b10206e31086e54c1ad8b90f79d6679 methodObjects: - url: /context method: listOwnerContexts diff --git a/sdks/db/cached-method-objects/from-custom-request_elevenlabs.com.yaml b/sdks/db/cached-method-objects/from-custom-request_elevenlabs.com.yaml index 0a47fe4657..ece21561de 100644 --- a/sdks/db/cached-method-objects/from-custom-request_elevenlabs.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_elevenlabs.com.yaml @@ -1,4 +1,4 @@ -hash: 0de48380d307900bdea4f896696c854adb86b804a7d774ad9500412ef6d41ace +hash: 38bb51fd39e9351643e299aab0aba4f64cd30749c33617eb1a92eea4d1fd4a6f methodObjects: - url: /v1/history method: getGeneratedAudioMetadata diff --git a/sdks/db/cached-method-objects/from-custom-request_gitlab.com.yaml b/sdks/db/cached-method-objects/from-custom-request_gitlab.com.yaml index 30df06a4e3..c39975eb76 100644 --- a/sdks/db/cached-method-objects/from-custom-request_gitlab.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_gitlab.com.yaml @@ -1,6 +1,6 @@ -hash: 7e8f06a6332849bdfd6870161ffd5aa49fc1292ef3cd7c78d5d5acba38f1dbbf +hash: 42490a562d8eef4c9cc37b948036f9879492b040fb602c1e3a782c96ed39174d methodObjects: - - url: /api/v4/groups/{id}/badges/{badge_id} + - url: /groups/{id}/badges/{badge_id} method: removeFromGroup httpMethod: delete tag: badges @@ -20,7 +20,7 @@ methodObjects: description: The badge ID example: 0 responses: [] - - url: /api/v4/groups/{id}/badges/{badge_id} + - url: /groups/{id}/badges/{badge_id} method: getGroupBadge httpMethod: get tag: badges @@ -42,7 +42,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Badge model - - url: /api/v4/groups/{id}/badges/{badge_id} + - url: /groups/{id}/badges/{badge_id} method: updateGroupBadge httpMethod: put tag: badges @@ -73,8 +73,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Badge model - - url: /api/v4/groups/{id}/badges - method: getList + - url: /groups/{id}/badges + method: listViewableByAuthenticatedUser httpMethod: get tag: badges typeScriptTag: badges @@ -101,8 +101,8 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/groups/{id}/badges - method: addBadgeToGroup + - url: /groups/{id}/badges + method: addToGroup httpMethod: post tag: badges typeScriptTag: badges @@ -132,8 +132,8 @@ methodObjects: responses: - statusCode: '201' description: API_Entities_Badge model - - url: /api/v4/groups/{id}/badges/render - method: previewBadgeFromGroup + - url: /groups/{id}/badges/render + method: previewFromGroup httpMethod: get tag: badges typeScriptTag: badges @@ -159,8 +159,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BasicBadgeDetails model - - url: /api/v4/groups/{id}/access_requests/{user_id} - method: denyAccessToUser + - url: /groups/{id}/access_requests/{user_id} + method: denyAccessRequest httpMethod: delete tag: access_requests typeScriptTag: accessRequests @@ -179,8 +179,8 @@ methodObjects: description: The user ID of the access requester example: 0 responses: [] - - url: /api/v4/groups/{id}/access_requests/{user_id}/approve - method: approveForUser + - url: /groups/{id}/access_requests/{user_id}/approve + method: approveUserAccess httpMethod: put tag: access_requests typeScriptTag: accessRequests @@ -205,8 +205,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_AccessRequester model - - url: /api/v4/groups/{id}/access_requests - method: getList + - url: /groups/{id}/access_requests + method: getListForGroup httpMethod: get tag: access_requests typeScriptTag: accessRequests @@ -230,8 +230,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_AccessRequester model - - url: /api/v4/groups/{id}/access_requests - method: requestAccessToGroup + - url: /groups/{id}/access_requests + method: authenticateUserToGroup httpMethod: post tag: access_requests typeScriptTag: accessRequests @@ -247,8 +247,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_AccessRequester model - - url: /api/v4/projects/{id}/repository/merged_branches - method: deleteMerged + - url: /projects/{id}/repository/merged_branches + method: removeMergedBranches httpMethod: delete tag: branches typeScriptTag: branches @@ -260,7 +260,7 @@ methodObjects: description: The ID or URL-encoded path of the project example: ID responses: [] - - url: /api/v4/projects/{id}/repository/branches/{branch} + - url: /projects/{id}/repository/branches/{branch} method: deleteBranch httpMethod: delete tag: branches @@ -278,7 +278,7 @@ methodObjects: description: The name of the branch example: BRANCH responses: [] - - url: /api/v4/projects/{id}/repository/branches/{branch} + - url: /projects/{id}/repository/branches/{branch} method: getSingleBranch httpMethod: get tag: branches @@ -298,8 +298,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Branch model - - url: /api/v4/projects/{id}/repository/branches/{branch} - method: checkIfExists + - url: /projects/{id}/repository/branches/{branch} + method: checkExistence httpMethod: head tag: branches typeScriptTag: branches @@ -316,8 +316,8 @@ methodObjects: description: The name of the branch example: BRANCH responses: [] - - url: /api/v4/projects/{id}/repository/branches - method: getAll + - url: /projects/{id}/repository/branches + method: getProjectRepository httpMethod: get tag: branches typeScriptTag: branches @@ -351,7 +351,7 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/projects/{id}/repository/branches + - url: /projects/{id}/repository/branches method: createBranch httpMethod: post tag: branches @@ -376,7 +376,7 @@ methodObjects: responses: - statusCode: '201' description: API_Entities_Branch model - - url: /api/v4/projects/{id}/repository/branches/{branch}/unprotect + - url: /projects/{id}/repository/branches/{branch}/unprotect method: unprotectBranch httpMethod: put tag: branches @@ -396,7 +396,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Branch model - - url: /api/v4/projects/{id}/repository/branches/{branch}/protect + - url: /projects/{id}/repository/branches/{branch}/protect method: protectBranch httpMethod: put tag: branches @@ -422,7 +422,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Branch model - - url: /api/v4/projects/{id}/badges/{badge_id} + - url: /projects/{id}/badges/{badge_id} method: removeFromProject httpMethod: delete tag: badges @@ -442,7 +442,7 @@ methodObjects: description: The badge ID example: 0 responses: [] - - url: /api/v4/projects/{id}/badges/{badge_id} + - url: /projects/{id}/badges/{badge_id} method: getProjectBadge httpMethod: get tag: badges @@ -464,7 +464,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Badge model - - url: /api/v4/projects/{id}/badges/{badge_id} + - url: /projects/{id}/badges/{badge_id} method: updateProjectBadge httpMethod: put tag: badges @@ -495,7 +495,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Badge model - - url: /api/v4/projects/{id}/badges + - url: /projects/{id}/badges method: listViewableByAuthenticatedUser httpMethod: get tag: badges @@ -523,8 +523,8 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/projects/{id}/badges - method: addProjectBadge + - url: /projects/{id}/badges + method: addToProject httpMethod: post tag: badges typeScriptTag: badges @@ -554,8 +554,8 @@ methodObjects: responses: - statusCode: '201' description: API_Entities_Badge model - - url: /api/v4/projects/{id}/badges/render - method: renderPreviewFromProject + - url: /projects/{id}/badges/render + method: previewFromProject httpMethod: get tag: badges typeScriptTag: badges @@ -581,8 +581,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BasicBadgeDetails model - - url: /api/v4/projects/{id}/access_requests/{user_id} - method: denyAccessToUser + - url: /projects/{id}/access_requests/{user_id} + method: denyAccessRequest httpMethod: delete tag: access_requests typeScriptTag: accessRequests @@ -601,8 +601,8 @@ methodObjects: description: The user ID of the access requester example: 0 responses: [] - - url: /api/v4/projects/{id}/access_requests/{user_id}/approve - method: approveForUser + - url: /projects/{id}/access_requests/{user_id}/approve + method: approveUserAccess httpMethod: put tag: access_requests typeScriptTag: accessRequests @@ -627,8 +627,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_AccessRequester model - - url: /api/v4/projects/{id}/access_requests - method: getList + - url: /projects/{id}/access_requests + method: listForProject httpMethod: get tag: access_requests typeScriptTag: accessRequests @@ -652,7 +652,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_AccessRequester model - - url: /api/v4/projects/{id}/access_requests + - url: /projects/{id}/access_requests method: requestAccessToProject httpMethod: post tag: access_requests @@ -670,7 +670,7 @@ methodObjects: - statusCode: '200' description: API_Entities_AccessRequester model - url: >- - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} method: removeMetricImage httpMethod: delete tag: alert_management @@ -696,8 +696,8 @@ methodObjects: - statusCode: '204' description: API_Entities_MetricImage model - url: >- - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} - method: updateMetricImage + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} + method: updateMetricImageForAlert httpMethod: put tag: alert_management typeScriptTag: alertManagement @@ -727,8 +727,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_MetricImage model - - url: /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images - method: getMetricImagesForAlert + - url: /projects/{id}/alert_management_alerts/{alert_iid}/metric_images + method: getMetricImages httpMethod: get tag: alert_management typeScriptTag: alertManagement @@ -747,8 +747,8 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images - method: uploadMetricImage + - url: /projects/{id}/alert_management_alerts/{alert_iid}/metric_images + method: uploadMetricImageForAlert httpMethod: post tag: alert_management typeScriptTag: alertManagement @@ -780,9 +780,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_MetricImage model - - url: >- - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize - method: authorizeMetricImageUpload + - url: /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize + method: authorizeMetricImageFileUpload httpMethod: post tag: alert_management typeScriptTag: alertManagement @@ -799,7 +798,7 @@ methodObjects: description: The IID of the Alert example: 0 responses: [] - - url: /api/v4/admin/batched_background_migrations/{id} + - url: /admin/batched_background_migrations/{id} method: getMigration httpMethod: get tag: batched_background_migrations @@ -818,8 +817,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BatchedBackgroundMigration model - - url: /api/v4/admin/batched_background_migrations - method: list + - url: /admin/batched_background_migrations + method: listMigrations httpMethod: get tag: batched_background_migrations typeScriptTag: batchedBackgroundMigrations @@ -832,7 +831,7 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/admin/batched_background_migrations/{id}/resume + - url: /admin/batched_background_migrations/{id}/resume method: resumeMigration httpMethod: put tag: batched_background_migrations @@ -851,7 +850,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BatchedBackgroundMigration model - - url: /api/v4/admin/batched_background_migrations/{id}/pause + - url: /admin/batched_background_migrations/{id}/pause method: pauseMigration httpMethod: put tag: batched_background_migrations @@ -870,7 +869,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BatchedBackgroundMigration model - - url: /api/v4/admin/ci/variables/{key} + - url: /admin/ci/variables/{key} method: deleteInstanceVariable httpMethod: delete tag: ci_variables @@ -885,8 +884,8 @@ methodObjects: responses: - statusCode: '204' description: API_Entities_Ci_Variable model - - url: /api/v4/admin/ci/variables/{key} - method: getSpecificInstanceVariable + - url: /admin/ci/variables/{key} + method: getInstanceVariableDetails httpMethod: get tag: ci_variables typeScriptTag: ciVariables @@ -900,7 +899,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Ci_Variable model - - url: /api/v4/admin/ci/variables/{key} + - url: /admin/ci/variables/{key} method: updateInstanceVariable httpMethod: put tag: ci_variables @@ -930,8 +929,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Ci_Variable model - - url: /api/v4/admin/ci/variables - method: listInstanceVariables + - url: /admin/ci/variables + method: listAllInstanceVariables httpMethod: get tag: ci_variables typeScriptTag: ciVariables @@ -948,8 +947,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Ci_Variable model - - url: /api/v4/admin/ci/variables - method: createNewInstanceVariable + - url: /admin/ci/variables + method: createNewInstanceLevelVariable httpMethod: post tag: ci_variables typeScriptTag: ciVariables @@ -984,7 +983,7 @@ methodObjects: responses: - statusCode: '201' description: API_Entities_Ci_Variable model - - url: /api/v4/admin/databases/{database_name}/dictionary/tables/{table_name} + - url: /admin/databases/{database_name}/dictionary/tables/{table_name} method: getDictionaryDetails httpMethod: get tag: admin @@ -1004,7 +1003,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Dictionary_Table model - - url: /api/v4/admin/clusters/{cluster_id} + - url: /admin/clusters/{cluster_id} method: deleteInstanceCluster httpMethod: delete tag: clusters @@ -1019,8 +1018,8 @@ methodObjects: responses: - statusCode: '204' description: API_Entities_Cluster model - - url: /api/v4/admin/clusters/{cluster_id} - method: getSingleInstanceCluster + - url: /admin/clusters/{cluster_id} + method: getSingleInstance httpMethod: get tag: clusters typeScriptTag: clusters @@ -1034,7 +1033,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Cluster model - - url: /api/v4/admin/clusters/{cluster_id} + - url: /admin/clusters/{cluster_id} method: updateInstanceCluster httpMethod: put tag: clusters @@ -1083,8 +1082,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Cluster model - - url: /api/v4/admin/clusters/add - method: addExistingKubernetesInstanceCluster + - url: /admin/clusters/add + method: addExistingInstance httpMethod: post tag: clusters typeScriptTag: clusters @@ -1149,7 +1148,7 @@ methodObjects: responses: - statusCode: '201' description: API_Entities_Cluster model - - url: /api/v4/admin/clusters + - url: /admin/clusters method: listInstanceClusters httpMethod: get tag: clusters @@ -1159,7 +1158,7 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/admin/migrations/{timestamp}/mark + - url: /admin/migrations/{timestamp}/mark method: markAsExecuted httpMethod: post tag: migrations @@ -1176,8 +1175,8 @@ methodObjects: description: '' default: main responses: [] - - url: /api/v4/applications/{id} - method: deleteSpecificApplication + - url: /applications/{id} + method: removeSpecificApplication httpMethod: delete tag: applications typeScriptTag: applications @@ -1189,7 +1188,7 @@ methodObjects: description: The ID of the application (not the application_id) example: 0 responses: [] - - url: /api/v4/applications + - url: /applications method: listAllRegistered httpMethod: get tag: applications @@ -1199,7 +1198,7 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/applications + - url: /applications method: createNewApplication httpMethod: post tag: applications @@ -1229,8 +1228,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_ApplicationWithSecret model - - url: /api/v4/avatar - method: getUrlForUser + - url: /avatar + method: getUserAvatarUrl httpMethod: get tag: avatar typeScriptTag: avatar @@ -1247,7 +1246,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Avatar model - - url: /api/v4/broadcast_messages/{id} + - url: /broadcast_messages/{id} method: deleteMessage httpMethod: delete tag: broadcast_messages @@ -1262,7 +1261,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BroadcastMessage model - - url: /api/v4/broadcast_messages/{id} + - url: /broadcast_messages/{id} method: getSpecificMessage httpMethod: get tag: broadcast_messages @@ -1277,8 +1276,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BroadcastMessage model - - url: /api/v4/broadcast_messages/{id} - method: updateMessage + - url: /broadcast_messages/{id} + method: updateMessageById httpMethod: put tag: broadcast_messages typeScriptTag: broadcastMessages @@ -1319,8 +1318,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BroadcastMessage model - - url: /api/v4/broadcast_messages - method: listAll + - url: /broadcast_messages + method: getAllMessages httpMethod: get tag: broadcast_messages typeScriptTag: broadcastMessages @@ -1337,7 +1336,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BroadcastMessage model - - url: /api/v4/broadcast_messages + - url: /broadcast_messages method: createMessage httpMethod: post tag: broadcast_messages @@ -1384,7 +1383,7 @@ methodObjects: responses: - statusCode: '201' description: API_Entities_BroadcastMessage model - - url: /api/v4/bulk_imports/{import_id}/entities/{entity_id} + - url: /bulk_imports/{import_id}/entities/{entity_id} method: getEntityDetails httpMethod: get tag: bulk_imports @@ -1404,7 +1403,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BulkImports model - - url: /api/v4/bulk_imports/{import_id}/entities + - url: /bulk_imports/{import_id}/entities method: listEntities httpMethod: get tag: bulk_imports @@ -1430,7 +1429,7 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/bulk_imports/{import_id} + - url: /bulk_imports/{import_id} method: getMigrationDetails httpMethod: get tag: bulk_imports @@ -1445,7 +1444,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BulkImport model - - url: /api/v4/bulk_imports/entities + - url: /bulk_imports/entities method: listEntities httpMethod: get tag: bulk_imports @@ -1470,7 +1469,7 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/bulk_imports + - url: /bulk_imports method: listMigrations httpMethod: get tag: bulk_imports @@ -1495,8 +1494,8 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/bulk_imports - method: startNewMigration + - url: /bulk_imports + method: startMigration httpMethod: post tag: bulk_imports typeScriptTag: bulkImports @@ -1539,7 +1538,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_BulkImport model - - url: /api/v4/application/appearance + - url: /application/appearance method: getCurrentAppearance httpMethod: get tag: application @@ -1549,7 +1548,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Appearance model - - url: /api/v4/application/appearance + - url: /application/appearance method: modifyAppearance httpMethod: put tag: application @@ -1607,7 +1606,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Appearance model - - url: /api/v4/application/plan_limits + - url: /application/plan_limits method: getCurrentLimits httpMethod: get tag: plan_limits @@ -1621,8 +1620,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_PlanLimit model - - url: /api/v4/application/plan_limits - method: modifyLimits + - url: /application/plan_limits + method: modifyPlanLimits httpMethod: put tag: plan_limits typeScriptTag: planLimits @@ -1712,7 +1711,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_PlanLimit model - - url: /api/v4/metadata + - url: /metadata method: getInformation httpMethod: get tag: metadata @@ -1722,8 +1721,8 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Metadata model - - url: /api/v4/version - method: getVersionInformation + - url: /version + method: getVersionInfo httpMethod: get tag: metadata typeScriptTag: metadata @@ -1732,7 +1731,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Metadata model - - url: /api/v4/projects/{id}/jobs + - url: /projects/{id}/jobs method: listForProject httpMethod: get tag: jobs @@ -1751,8 +1750,8 @@ methodObjects: responses: - statusCode: '200' description: '' - - url: /api/v4/projects/{id}/jobs/{job_id} - method: getSingleById + - url: /projects/{id}/jobs/{job_id} + method: getById httpMethod: get tag: jobs typeScriptTag: jobs @@ -1771,7 +1770,7 @@ methodObjects: responses: - statusCode: '200' description: API_Entities_Job model - - url: /api/v4/projects/{id}/jobs/{job_id}/play + - url: /projects/{id}/jobs/{job_id}/play method: runManualJob httpMethod: post tag: jobs diff --git a/sdks/db/cached-method-objects/from-custom-request_launchdarkly.com.yaml b/sdks/db/cached-method-objects/from-custom-request_launchdarkly.com.yaml index b4dcf3e6c2..d2d2840062 100644 --- a/sdks/db/cached-method-objects/from-custom-request_launchdarkly.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_launchdarkly.com.yaml @@ -1,4 +1,4 @@ -hash: a1e2aff2a620787a6730de89cf0ae324fcb11641463ed654d5a9cf27a1eebe56 +hash: 100361398b778345c2f2f9f931af664ba8c87fe36e3ad9c0b4b6a9d21b1433a4 methodObjects: - url: /api/v2 method: getResourceCategories @@ -3299,6 +3299,20 @@ methodObjects: required: false description: '' example: average + - name: analysisType + schema: string + required: false + description: '' + example: mean + - name: percentileValue + schema: integer + required: false + description: '' + example: 95 + - name: eventDefault + schema: object + required: false + description: '' responses: - statusCode: '201' description: '' diff --git a/sdks/db/cached-method-objects/from-custom-request_posthog.com.yaml b/sdks/db/cached-method-objects/from-custom-request_posthog.com.yaml index a46cb72b8e..36429351da 100644 --- a/sdks/db/cached-method-objects/from-custom-request_posthog.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_posthog.com.yaml @@ -1,4 +1,4 @@ -hash: 0a830122db902dbd45e34a12aca3bf900b01798bcadd7f998abd491e4c0b5484 +hash: 004c1a12a8084dc9d3aeca8a75a57a4169c4f83327e8ae1d27d4c78b722a31d6 methodObjects: - url: /api/organizations method: list diff --git a/sdks/db/cached-method-objects/from-custom-request_salesflare.com.yaml b/sdks/db/cached-method-objects/from-custom-request_salesflare.com.yaml new file mode 100644 index 0000000000..cb653ca1a8 --- /dev/null +++ b/sdks/db/cached-method-objects/from-custom-request_salesflare.com.yaml @@ -0,0 +1,2238 @@ +hash: ec2c294dee25eaa12e5567011b7458002bc54347a41522ff185dac22446dd2ba +methodObjects: + - url: /accounts + method: listAccounts + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: List accounts + parameters: + - name: id + schema: array + description: '' + - name: details + schema: boolean + description: '' + default: true + - name: search + schema: string + description: '' + - name: name + schema: string + description: '' + - name: creationAfter + schema: string + description: '' + - name: creationBefore + schema: string + description: '' + - name: minSize + schema: number + description: '' + - name: maxSize + schema: number + description: '' + - name: domain + schema: array + description: '' + - name: tag + schema: array + description: '' + - name: tagName + schema: array + description: '' + - name: addressCountry + schema: array + description: '' + - name: addressCity + schema: array + description: '' + - name: addressStateRegion + schema: array + description: '' + - name: hotness + schema: number + description: '1: Room temp, 2: Hot, 3: On fire' + - name: offset + schema: number + description: '' + - name: custom + schema: string + description: '' + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: q + schema: string + description: '' + - name: limit + schema: number + description: '' + default: 10 + responses: + - statusCode: '200' + description: '' + - url: /accounts + method: createAccount + httpMethod: post + tag: Accounts + typeScriptTag: accounts + description: Create an account + parameters: + - name: updateIfExists + schema: boolean + description: '' + default: false + - name: tags + schema: array + description: '' + - name: description + schema: string + description: '' + - name: owner + schema: number + description: '' + - name: name + schema: string + description: '' + - name: domain + schema: string + description: '' + - name: picture + schema: string + description: '' + - name: size + schema: number + description: '' + - name: website + schema: string + description: '' + - name: address + schema: object + description: '' + - name: addresses + schema: array + description: '' + - name: email + schema: string + description: '' + - name: email_addresses + schema: array + description: '' + - name: phone_number + schema: string + description: '' + - name: phone_numbers + schema: array + description: '' + - name: social_profiles + schema: array + description: '' + - name: links + schema: string + description: '' + - name: customers + schema: array + description: '' + - name: _dirty + schema: boolean + description: '' + - name: parent_account + schema: number + description: '' + - name: custom + schema: object + description: '' + responses: + - statusCode: default + description: '' + - url: /contacts + method: listContacts + httpMethod: get + tag: Contacts + typeScriptTag: contacts + description: List contacts + parameters: + - name: id + schema: array + description: '' + - name: name + schema: string + description: '' + - name: email + schema: string + description: '' + - name: phoneNumber + schema: string + description: '' + - name: domain + schema: string + description: '' + - name: modificationAfter + schema: string + description: '' + - name: modificationBefore + schema: string + description: '' + - name: creationAfter + schema: string + description: '' + - name: creationBefore + schema: string + description: '' + - name: account + schema: array + description: '' + - name: tag + schema: array + description: '' + - name: tagName + schema: array + description: '' + - name: positionRole + schema: array + description: '' + - name: addressCountry + schema: array + description: '' + - name: addressStateRegion + schema: array + description: '' + - name: addressCity + schema: array + description: '' + - name: includeArchived + schema: boolean + description: '' + - name: search + schema: string + description: '' + - name: type + schema: string + description: '' + - name: limit + schema: number + description: '' + default: 20 + - name: offset + schema: number + description: '' + default: 0 + - name: custom + schema: string + description: '' + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: q + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - url: /contacts + method: createContact + httpMethod: post + tag: Contacts + typeScriptTag: contacts + description: Create a contact + parameters: + - name: force + schema: boolean + description: >- + When force is false, the contact will not be created if a contact with + the same email address used to exist. + default: true + responses: + - statusCode: '200' + description: '' + - url: /currencies + method: listSupportedCurrencies + httpMethod: get + tag: Regional Settings + typeScriptTag: regionalSettings + description: List supported currencies + parameters: [] + responses: + - statusCode: '200' + description: '' + - url: /groups + method: list + httpMethod: get + tag: Groups + typeScriptTag: groups + description: List groups + parameters: [] + responses: + - statusCode: default + description: '' + - url: /me + method: getCurrentUserDetails + httpMethod: get + tag: Users + typeScriptTag: users + description: Get current user's details + parameters: [] + responses: + - statusCode: '200' + description: '' + - url: /opportunities + method: list + httpMethod: get + tag: Opportunities + typeScriptTag: opportunities + description: List opportunities + parameters: + - name: search + schema: string + description: '' + - name: id + schema: number + description: '' + - name: name + schema: string + description: '' + - name: status + schema: string + description: DEPRECATED + - name: stage + schema: number + description: '' + - name: stageName + schema: string + description: '' + - name: owner + schema: number + description: '' + - name: teamMember + schema: number + description: '' + - name: ownerGroup + schema: number + description: '' + - name: assigneeGroup + schema: number + description: '' + - name: teamMemberGroup + schema: number + description: '' + - name: account + schema: number + description: '' + - name: assignee + schema: number + description: '' + - name: minValue + schema: number + description: '' + - name: maxValue + schema: number + description: '' + - name: closeAfter + schema: string + description: '' + - name: closeBefore + schema: string + description: '' + - name: creationAfter + schema: string + description: '' + - name: creationBefore + schema: string + description: '' + - name: closed + schema: boolean + description: '' + - name: done + schema: boolean + description: '' + - name: tag + schema: array + description: '' + - name: tagName + schema: string + description: '' + - name: hotness + schema: number + description: '1: Room temp, 2: Hot, 3: On fire' + - name: limit + schema: number + description: '' + - name: offset + schema: number + description: '' + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: pipeline + schema: number + description: '' + - name: custom + schema: string + description: '' + - name: details + schema: boolean + description: '' + - name: q + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - url: /opportunities + method: createOpportunity + httpMethod: post + tag: Opportunities + typeScriptTag: opportunities + description: Create an opportunity + parameters: + - name: tags + schema: array + required: false + description: '' + - name: owner + schema: number + required: false + description: '' + - name: account + schema: number + required: true + description: '' + example: 0 + - name: stage + schema: number + required: false + description: '' + - name: lost_reason + schema: number + required: false + description: '' + - name: files + schema: array + required: false + description: '' + - name: lead_source + schema: number + required: false + description: '' + - name: start_date + schema: string + required: false + description: '' + - name: probability + schema: number + required: false + description: '' + - name: assignee + schema: number + required: false + description: '' + - name: creator + schema: number + required: false + description: '' + - name: status + schema: string + required: false + description: '' + - name: name + schema: string + required: false + description: '' + - name: value + schema: number + required: false + description: '' + - name: currency + schema: number + required: false + description: '' + - name: status_date + schema: string + required: false + description: '' + - name: close_date + schema: string + required: false + description: '' + - name: closed + schema: boolean + required: false + description: '' + - name: recurring_price_per_unit + schema: number + required: false + description: '' + - name: frequency + schema: string + required: false + description: '' + - name: units + schema: number + required: false + description: '' + - name: contract_start_date + schema: string + required: false + description: '' + - name: contract_end_date + schema: string + required: false + description: '' + - name: main_contact + schema: number + required: false + description: '' + - name: custom + schema: object + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - url: /persons + method: list + httpMethod: get + tag: Persons + typeScriptTag: persons + description: List persons + parameters: + - name: id + schema: array + description: '' + - name: name + schema: string + description: '' + - name: email + schema: string + description: '' + - name: search + schema: string + description: '' + responses: + - statusCode: default + description: '' + - url: /pipelines + method: list + httpMethod: get + tag: Pipelines + typeScriptTag: pipelines + description: List pipelines + parameters: + - name: search + schema: string + description: '' + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: q + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - url: /stages + method: listStages + httpMethod: get + tag: Pipelines + typeScriptTag: pipelines + description: List stages + parameters: + - name: id + schema: number + description: '' + - name: name + schema: string + description: '' + - name: pipelineId + schema: number + description: '' + - name: pipelineName + schema: string + description: '' + - name: orderBy + schema: string + description: '' + responses: + - statusCode: default + description: '' + - url: /tags + method: list + httpMethod: get + tag: Tags + typeScriptTag: tags + description: List tags + parameters: + - name: id + schema: array + description: '' + - name: name + schema: string + description: >- + This property is deprecated, use q.search instead. When both are + provided, q.search will be used. + - name: limit + schema: number + description: '' + default: 20 + - name: offset + schema: number + description: '' + default: 0 + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: q + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - url: /tags + method: createTag + httpMethod: post + tag: Tags + typeScriptTag: tags + description: Create a tag + parameters: + - name: name + schema: string + required: true + description: '' + example: NAME + responses: + - statusCode: '200' + description: '' + - url: /tasks + method: listTasks + httpMethod: get + tag: Tasks + typeScriptTag: tasks + description: List tasks + parameters: + - name: id + schema: array + description: '' + - name: search + schema: string + description: '' + - name: assignees + schema: array + description: Defaults to the user + - name: type + schema: array + description: '' + - name: account + schema: array + description: '' + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: limit + schema: number + description: '' + - name: offset + schema: number + description: '' + - name: q + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - url: /tasks + method: createTask + httpMethod: post + tag: Tasks + typeScriptTag: tasks + description: Create a task + parameters: [] + responses: + - statusCode: '200' + description: '' + - url: /users + method: list + httpMethod: get + tag: Users + typeScriptTag: users + description: List users + parameters: + - name: id + schema: array + description: '' + - name: name + schema: string + description: '' + - name: email + schema: string + description: '' + - name: search + schema: string + description: '' + - name: limit + schema: number + description: '' + - name: offset + schema: number + description: '' + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: onlyEnabled + schema: boolean + description: '' + responses: + - statusCode: default + description: '' + - url: /workflows + method: list + httpMethod: get + tag: Workflows + typeScriptTag: workflows + description: List workflows + parameters: + - name: limit + schema: number + description: '' + default: 20 + - name: offset + schema: number + description: '' + default: 0 + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: search + schema: string + description: '' + - name: q + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - url: /workflows + method: createWorkflow + httpMethod: post + tag: Workflows + typeScriptTag: workflows + description: Create a workflow + parameters: + - name: name + schema: string + required: true + description: '' + example: NAME + - name: filter + schema: object + required: false + description: '' + - name: individual_record_filter + schema: object + required: false + description: '' + - name: status + schema: string + required: false + description: '' + - name: status_message + schema: string + required: false + description: '' + - name: record_type + schema: string + required: false + description: '' + - name: goal + schema: string + required: false + description: '' + - name: continuous + schema: boolean + required: false + description: '' + - name: exit_after_days + schema: number + required: false + description: '' + - name: schedule_date + schema: string + required: false + description: '' + - name: schedule_time_start + schema: string + required: false + description: '' + - name: schedule_time_end + schema: string + required: false + description: '' + - name: schedule_days + schema: array + required: false + description: '' + - name: steps + schema: array + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - url: /accounts/{account_id} + method: id + httpMethod: delete + tag: Accounts + typeScriptTag: accounts + description: Delete an account + parameters: + - name: accountId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /accounts/{account_id} + method: id + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: Get account details + parameters: + - name: accountId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /accounts/{account_id} + method: id + httpMethod: put + tag: Accounts + typeScriptTag: accounts + description: Update an account + parameters: + - name: accountId + schema: number + required: true + description: '' + example: 0 + - name: tags + schema: array + description: '' + - name: description + schema: string + description: '' + - name: name + schema: string + description: '' + - name: domain + schema: string + description: '' + - name: picture + schema: string + description: '' + - name: size + schema: number + description: '' + - name: website + schema: string + description: '' + - name: address + schema: object + description: '' + - name: addresses + schema: array + description: '' + - name: email + schema: string + description: '' + - name: email_addresses + schema: array + description: '' + - name: phone_number + schema: string + description: '' + - name: phone_numbers + schema: array + description: '' + - name: social_profiles + schema: array + description: '' + - name: links + schema: string + description: '' + - name: _dirty + schema: boolean + description: '' + - name: parent_account + schema: number + description: '' + - name: custom + schema: object + description: '' + - name: q + schema: object + description: '' + responses: + - statusCode: default + description: '' + - url: /campaigns/mergefields + method: getMergeFields + httpMethod: get + tag: Workflows + typeScriptTag: workflows + description: Get a workflow's merge fields + parameters: [] + responses: + - statusCode: '200' + description: '' + - url: /conferences/{conference_id} + method: id + httpMethod: get + tag: Meetings + typeScriptTag: meetings + description: Get meeting details by conference id + parameters: + - name: conferenceId + schema: string + required: true + description: '' + example: CONFERENCE_ID + responses: + - statusCode: default + description: '' + - url: /contacts/{contact_id} + method: id + httpMethod: delete + tag: Contacts + typeScriptTag: contacts + description: Delete a contact + parameters: + - name: contactId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /contacts/{contact_id} + method: id + httpMethod: get + tag: Contacts + typeScriptTag: contacts + description: Get contact details + parameters: + - name: contactId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /contacts/{contact_id} + method: id + httpMethod: put + tag: Contacts + typeScriptTag: contacts + description: Update a contact + parameters: + - name: contactId + schema: number + required: true + description: '' + example: 0 + - name: force + schema: boolean + description: >- + When force is false, the contact's name will not be updated if the + name in the update is just the first part of the email address. + default: true + - name: tags + schema: array + description: '' + - name: prefix + schema: string + description: '' + - name: firstname + schema: string + description: '' + - name: middle + schema: string + description: '' + - name: lastname + schema: string + description: '' + - name: suffix + schema: string + description: '' + - name: email + schema: string + description: '' + - name: role + schema: string + description: '' + - name: name + schema: string + description: '' + - name: owner + schema: number + description: '' + - name: picture + schema: string + description: '' + - name: account + schema: number + description: '' + - name: birth_date + schema: string + description: '' + - name: opt-out + schema: boolean + description: '' + - name: opt-out_date + schema: string + description: '' + - name: opt-out_campaign + schema: string + description: '' + - name: bounced + schema: boolean + description: '' + - name: bounced_date + schema: string + description: '' + - name: files + schema: array + description: '' + - name: address + schema: object + description: '' + - name: addresses + schema: array + description: '' + - name: phone_number + schema: string + description: '' + - name: mobile_phone_number + schema: string + description: '' + - name: home_phone_number + schema: string + description: '' + - name: fax_number + schema: string + description: '' + - name: phone_numbers + schema: array + description: '' + - name: position + schema: object + description: '' + - name: positions + schema: array + description: '' + - name: social_profiles + schema: array + description: '' + - name: custom + schema: object + description: '' + - name: _dirty + schema: boolean + description: '' + - name: archived + schema: boolean + description: '' + responses: + - statusCode: default + description: '' + - url: /customfields/types + method: listTypes + httpMethod: get + tag: Custom Fields + typeScriptTag: customFields + description: List custom field types + parameters: [] + responses: + - statusCode: default + description: '' + - url: /customfields/{itemClass} + method: listTypeCustomFields + httpMethod: get + tag: Custom Fields + typeScriptTag: customFields + description: List custom fields of a type + parameters: + - name: itemClass + schema: string + required: true + description: '' + example: ITEMCLASS + - name: includeDisabled + schema: boolean + description: '' + - name: pipeline + schema: number + description: '' + - name: name + schema: string + description: '' + responses: + - statusCode: default + description: '' + - url: /customfields/{itemClass} + method: createFieldType + httpMethod: post + tag: Custom Fields + typeScriptTag: customFields + description: Create a custom field of a type + parameters: + - name: itemClass + schema: string + required: true + description: '' + example: ITEMCLASS + - name: type + schema: number + description: '' + - name: name + schema: string + description: '' + - name: enabled + schema: boolean + description: '' + - name: archived + schema: boolean + description: '' + - name: required + schema: boolean + description: '' + - name: pipeline + schema: number + description: '' + - name: predefined_customfield + schema: number + description: '' + - name: users_can_add_options + schema: boolean + description: '' + - name: options + schema: array + description: '' + - name: order_alphabetically + schema: boolean + description: '' + default: false + - name: min_number + schema: number + description: '' + - name: max_number + schema: number + description: '' + - name: min_date + schema: string + description: '' + - name: max_date + schema: string + description: '' + - name: default_boolean_value + schema: boolean + description: '' + responses: + - statusCode: '200' + description: '' + - url: /datasources/email + method: list + httpMethod: get + tag: Email Data Sources + typeScriptTag: emailDataSources + description: List email data sources + parameters: + - name: includeTeamDataSources + schema: boolean + description: >- + Team data sources will only be included when the session user is an + admin. + default: false + responses: + - statusCode: '200' + description: '' + - url: /filterfields/{entity} + method: listForEntity + httpMethod: get + tag: Filter Fields + typeScriptTag: filterFields + description: List filter fields for an entity + parameters: + - name: entity + schema: string + required: true + description: '' + example: ENTITY + - name: pipeline + schema: number + description: '' + - name: includePipelineSpecificPredefinedFilterFields + schema: boolean + description: '' + default: true + responses: + - statusCode: '200' + description: '' + - url: /groups/{id} + method: getById + httpMethod: get + tag: Groups + typeScriptTag: groups + description: Get a group + parameters: [] + responses: + - statusCode: default + description: '' + - url: /me/contacts + method: listContacts + httpMethod: get + tag: Users + typeScriptTag: users + description: List current user's contacts + parameters: + - name: id + schema: array + description: '' + - name: name + schema: string + description: '' + - name: email + schema: string + description: '' + - name: phoneNumber + schema: string + description: '' + - name: domain + schema: string + description: '' + - name: modificationAfter + schema: string + description: '' + - name: modificationBefore + schema: string + description: '' + - name: creationAfter + schema: string + description: '' + - name: creationBefore + schema: string + description: '' + - name: account + schema: array + description: '' + - name: tag + schema: array + description: '' + - name: tagName + schema: array + description: '' + - name: positionRole + schema: array + description: '' + - name: addressCountry + schema: array + description: '' + - name: addressStateRegion + schema: array + description: '' + - name: addressCity + schema: array + description: '' + - name: includeArchived + schema: boolean + description: '' + - name: search + schema: string + description: '' + - name: type + schema: string + description: '' + - name: limit + schema: number + description: '' + default: 20 + - name: offset + schema: number + description: '' + default: 0 + - name: custom + schema: string + description: '' + - name: orderBy + schema: array + description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + - name: q + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - url: /meetings/{meeting_id} + method: id + httpMethod: delete + tag: Meetings + typeScriptTag: meetings + description: Delete a meeting + parameters: + - name: meetingId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /meetings/{meeting_id} + method: id + httpMethod: get + tag: Meetings + typeScriptTag: meetings + description: Get meeting details + parameters: + - name: meetingId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /meetings/{meeting_id} + method: id + httpMethod: put + tag: Meetings + typeScriptTag: meetings + description: Update a meeting + parameters: + - name: meetingId + schema: number + required: true + description: '' + example: 0 + - name: calendar_id + schema: string + required: true + description: '' + example: CALENDAR_ID + - name: external_id + schema: string + required: true + description: '' + example: EXTERNAL_ID + - name: minutes + schema: string + required: false + description: '' + - name: notes + schema: string + required: true + description: '' + example: NOTES + - name: edited_by + schema: number + required: false + description: '' + responses: + - statusCode: default + description: '' + - url: /opportunities/{id} + method: removeOpportunity + httpMethod: delete + tag: Opportunities + typeScriptTag: opportunities + description: Delete an opportunity + parameters: + - name: id + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /opportunities/{id} + method: getDetails + httpMethod: get + tag: Opportunities + typeScriptTag: opportunities + description: Get opportunity details + parameters: + - name: id + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: '200' + description: '' + - url: /opportunities/{id} + method: updateOpportunity + httpMethod: put + tag: Opportunities + typeScriptTag: opportunities + description: Update an opportunity + parameters: + - name: id + schema: number + required: true + description: '' + example: 0 + - name: tags + schema: array + description: '' + - name: owner + schema: number + description: '' + - name: account + schema: number + description: '' + - name: stage + schema: number + description: '' + - name: lost_reason + schema: number + description: '' + - name: files + schema: array + description: '' + - name: lead_source + schema: number + description: '' + - name: start_date + schema: string + description: '' + - name: probability + schema: number + description: '' + - name: assignee + schema: number + description: '' + - name: creator + schema: number + description: '' + - name: name + schema: string + description: '' + - name: value + schema: number + description: '' + - name: close_date + schema: string + description: '' + - name: closed + schema: boolean + description: '' + - name: done + schema: boolean + description: '' + - name: recurring_price_per_unit + schema: number + description: '' + - name: frequency + schema: string + description: '' + - name: units + schema: number + description: '' + - name: contract_start_date + schema: string + description: '' + - name: contract_end_date + schema: string + description: '' + - name: main_contact + schema: number + description: '' + - name: custom + schema: object + description: '' + responses: + - statusCode: default + description: '' + - url: /stages/{stage_id} + method: id + httpMethod: get + tag: Pipelines + typeScriptTag: pipelines + description: Get stage details + parameters: + - name: stageId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /tags/{tag_id} + method: id + httpMethod: delete + tag: Tags + typeScriptTag: tags + description: Delete a tag + parameters: + - name: tagId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: '200' + description: '' + - url: /tags/{tag_id} + method: id + httpMethod: get + tag: Tags + typeScriptTag: tags + description: Get tag details + parameters: + - name: tagId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /tags/{tag_id} + method: id + httpMethod: put + tag: Tags + typeScriptTag: tags + description: Update a tag + parameters: + - name: tagId + schema: number + required: true + description: '' + example: 0 + - name: name + schema: string + required: true + description: '' + example: NAME + responses: + - statusCode: '200' + description: '' + - url: /users/{id} + method: getUserDetails + httpMethod: get + tag: Users + typeScriptTag: users + description: Get user details + parameters: + - name: id + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /workflows/{id} + method: getDetails + httpMethod: get + tag: Workflows + typeScriptTag: workflows + description: Get workflow details + parameters: + - name: id + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: '200' + description: '' + - url: /workflows/{id} + method: updateWorkflow + httpMethod: put + tag: Workflows + typeScriptTag: workflows + description: Update a workflow + parameters: + - name: id + schema: number + required: true + description: '' + example: 0 + - name: name + schema: string + required: true + description: '' + example: NAME + - name: filter + schema: object + required: false + description: '' + - name: individual_record_filter + schema: object + required: false + description: '' + - name: status + schema: string + required: false + description: '' + - name: status_message + schema: string + required: false + description: '' + - name: record_type + schema: string + required: false + description: '' + - name: goal + schema: string + required: false + description: '' + - name: continuous + schema: boolean + required: false + description: '' + - name: exit_after_days + schema: number + required: false + description: '' + - name: schedule_date + schema: string + required: false + description: '' + - name: schedule_time_start + schema: string + required: false + description: '' + - name: schedule_time_end + schema: string + required: false + description: '' + - name: schedule_days + schema: array + required: false + description: '' + - name: steps + schema: array + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - url: /accounts/{account_id}/messages + method: idMessages + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: List an account's messages + parameters: + - name: accountId + schema: number + required: true + description: '' + example: 0 + - name: before + schema: string + description: '' + - name: after + schema: string + description: '' + default: '1970-01-01T00:00:00.000Z' + - name: limit + schema: number + description: '' + default: 10 + responses: + - statusCode: default + description: '' + - url: /customfields/{itemClass}/{id} + method: deleteCustomField + httpMethod: delete + tag: Custom Fields + typeScriptTag: customFields + description: Delete a custom field + parameters: + - name: itemClass + schema: string + required: true + description: '' + example: ITEMCLASS + - name: id + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /customfields/{itemClass}/{id} + method: getDetails + httpMethod: get + tag: Custom Fields + typeScriptTag: customFields + description: Get custom field details + parameters: + - name: itemClass + schema: string + required: true + description: '' + example: ITEMCLASS + - name: id + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /customfields/{itemClass}/{id} + method: updateField + httpMethod: put + tag: Custom Fields + typeScriptTag: customFields + description: Update a custom field + parameters: + - name: itemClass + schema: string + required: true + description: '' + example: ITEMCLASS + - name: id + schema: number + required: true + description: '' + example: 0 + - name: id + schema: number + required: true + description: '' + example: 0 + - name: type + schema: number + required: false + description: '' + - name: name + schema: string + required: false + description: '' + - name: enabled + schema: boolean + required: false + description: '' + - name: archived + schema: boolean + required: false + description: '' + - name: required + schema: boolean + required: false + description: '' + - name: pipeline + schema: number + required: false + description: '' + - name: pipelineName + schema: string + required: false + description: '' + - name: order + schema: number + required: false + description: '' + - name: predefined_customfield + schema: number + required: false + description: '' + - name: users_can_add_options + schema: boolean + required: false + description: '' + - name: options + schema: array + required: false + description: '' + - name: order_alphabetically + schema: boolean + required: false + description: '' + - name: min_number + schema: number + required: false + description: '' + - name: max_number + schema: number + required: false + description: '' + - name: min_date + schema: string + required: false + description: '' + - name: max_date + schema: string + required: false + description: '' + responses: + - statusCode: default + description: '' + - url: /tags/{tag_id}/usage + method: idUsage + httpMethod: get + tag: Tags + typeScriptTag: tags + description: Get tag details on usage in workflows, saved filters & reports + parameters: + - name: tagId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /customfields/{itemClass}/{customFieldApiField}/options + method: listOptions + httpMethod: get + tag: Custom Fields + typeScriptTag: customFields + description: List a custom field's options + parameters: + - name: itemClass + schema: string + required: true + description: '' + example: ITEMCLASS + - name: customFieldApiField + schema: string + required: true + description: '' + example: CUSTOMFIELDAPIFIELD + - name: searchString + schema: string + description: '' + responses: + - statusCode: default + description: '' + - url: /calls + method: createCall + httpMethod: post + tag: Calls + typeScriptTag: calls + description: Create a call + parameters: [] + responses: + - statusCode: default + description: '' + - url: /meetings + method: createMeeting + httpMethod: post + tag: Meetings + typeScriptTag: meetings + description: Create a meeting + parameters: [] + responses: + - statusCode: default + description: '' + - url: /messages + method: createNote + httpMethod: post + tag: Internal Notes + typeScriptTag: internalNotes + description: Create an internal note + parameters: + - name: account + schema: number + required: true + description: '' + example: 0 + - name: body + schema: string + required: true + description: '' + example: BODY + - name: mentions + schema: array + required: false + description: '' + - name: date + schema: string + required: false + description: '' + responses: + - statusCode: default + description: '' + - url: /accounts/{account_id}/users + method: idUsers + httpMethod: post + tag: Accounts + typeScriptTag: accounts + description: Update an account's users + parameters: + - name: accountId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /accounts/{account_id}/users + method: idUsers + httpMethod: put + tag: Accounts + typeScriptTag: accounts + description: Update an account's users + parameters: + - name: accountId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /accounts/{account_id}/contacts + method: idContacts + httpMethod: post + tag: Accounts + typeScriptTag: accounts + description: Update an account's contacts + parameters: + - name: accountId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /accounts/{account_id}/contacts + method: idContacts + httpMethod: put + tag: Accounts + typeScriptTag: accounts + description: Update an account's contacts + parameters: + - name: accountId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /calls/{meeting_id} + method: id + httpMethod: put + tag: Calls + typeScriptTag: calls + description: Update a call + parameters: + - name: meetingId + schema: number + required: true + description: '' + example: 0 + - name: calendar_id + schema: string + required: true + description: '' + example: CALENDAR_ID + - name: external_id + schema: string + required: true + description: '' + example: EXTERNAL_ID + - name: minutes + schema: string + required: false + description: '' + - name: notes + schema: string + required: true + description: '' + example: NOTES + - name: edited_by + schema: number + required: false + description: '' + responses: + - statusCode: default + description: '' + - url: /messages/{message_id} + method: id + httpMethod: delete + tag: Internal Notes + typeScriptTag: internalNotes + description: Delete an internal note + parameters: + - name: messageId + schema: number + required: true + description: '' + example: 0 + responses: + - statusCode: default + description: '' + - url: /messages/{message_id} + method: id + httpMethod: put + tag: Internal Notes + typeScriptTag: internalNotes + description: Update an internal note + parameters: + - name: messageId + schema: number + required: true + description: '' + example: 0 + - name: account + schema: number + required: true + description: '' + example: 0 + - name: body + schema: string + required: true + description: '' + example: BODY + - name: mentions + schema: array + required: false + description: '' + - name: date + schema: string + required: false + description: '' + responses: + - statusCode: default + description: '' + - url: /tasks/{id} + method: deleteTask + httpMethod: delete + tag: Tasks + typeScriptTag: tasks + description: Delete a task + parameters: [] + responses: + - statusCode: '200' + description: '' + - url: /tasks/{id} + method: updateTask + httpMethod: put + tag: Tasks + typeScriptTag: tasks + description: Update a task + parameters: + - name: description + schema: string + description: '' + - name: account + schema: number + description: '' + - name: reminder_date + schema: string + description: '' + - name: assignees + schema: array + description: '' + - name: completed + schema: boolean + description: '' + responses: + - statusCode: '200' + description: '' + - url: /datasources/email/{id} + method: updateDataSource + httpMethod: put + tag: Email Data Sources + typeScriptTag: emailDataSources + description: Update an email data source + parameters: + - name: id + schema: number + required: true + description: '' + example: 0 + - name: email_signature + schema: string + description: '' + - name: add_signature_to_campaign + schema: boolean + description: '' + - name: add_signature_to_replies + schema: boolean + description: '' + - name: max_emails_day + schema: number + description: '' + - name: max_emails_hour + schema: number + description: '' + responses: + - statusCode: default + description: '' + - url: /workflows/{id}/audience/{record_id} + method: id + httpMethod: put + tag: Workflows + typeScriptTag: workflows + description: Exit an entity from a workflow + parameters: + - name: id + schema: number + required: true + description: '' + example: 0 + - name: recordId + schema: number + required: true + description: >- + This is the entity id. For email workflows this should be the contact + id. + example: 0 + - name: exited + schema: boolean + description: '' + - name: met_goal + schema: boolean + description: '' + responses: + - statusCode: '200' + description: '' +numberOfSchemas: 86 +apiDescription: >- + # 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) + + + ## 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. diff --git a/sdks/db/cached-method-objects/from-custom-request_vimeo.com.yaml b/sdks/db/cached-method-objects/from-custom-request_vimeo.com.yaml index f51bb7dea2..bf6b1cec48 100644 --- a/sdks/db/cached-method-objects/from-custom-request_vimeo.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_vimeo.com.yaml @@ -1,4 +1,4 @@ -hash: 93c0b65d7822710dba19df1c5f925ecee4ff3844583a4441e88f0127fbbed6cf +hash: 413518c009768ca68d544131b78ec56909d00fbda07452340d13c55b7546c555 methodObjects: - url: / method: endpoints diff --git a/sdks/db/cached-method-objects/from-custom-request_withterminal.com.yaml b/sdks/db/cached-method-objects/from-custom-request_withterminal.com.yaml index 5e7dade745..f1edd58335 100644 --- a/sdks/db/cached-method-objects/from-custom-request_withterminal.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_withterminal.com.yaml @@ -1,4 +1,4 @@ -hash: 23dd72edda1dbe614b950266b7a97123f2ae882b3f363a69beec0299578f41df +hash: 8c52ea206a758cc06c6cd8a9516f0f8b04c5deb6997041df045115cf725f1556 methodObjects: - url: /public-token/exchange method: exchangeToken @@ -40,7 +40,7 @@ methodObjects: - name: tag schema: string description: Filter connections by tag - example: sunt do est sit + example: non mollit reprehenderit - name: updatedAfter schema: string description: Filter connections that were last updated on or after a given time. @@ -77,7 +77,7 @@ methodObjects: - name: externalId schema: string description: '' - example: ipsum enim + example: elit commodo in sunt - name: provider schema: string description: '' @@ -122,19 +122,19 @@ methodObjects: schema: array description: '' example: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu - name: company schema: object description: '' - name: externalId schema: string description: '' - example: Excepteur enim irure + example: pariatur dolor minim - name: status schema: string description: '' - example: mollit sunt aliquip + example: do - name: syncMode schema: string description: '' @@ -465,11 +465,11 @@ methodObjects: - name: startDate schema: string description: Only include daily logs from on or after a specific date - example: '1984-11-05' + example: '1992-10-05' - name: endDate schema: string description: Only include daily logs from on or before a specific date - example: '1984-11-05' + example: '1992-10-05' - name: modifiedAfter schema: string description: Only include records that were last modified after a provided date. @@ -565,11 +565,11 @@ methodObjects: - name: lastReportedAfter schema: string description: Timestamp to start when the issue was last observed - example: '1957-08-03' + example: '1999-09-28' - name: lastReportedBefore schema: string description: Timestamp to end when the issue was last observed - example: '1957-08-03' + example: '1999-09-28' - name: expand schema: string description: Expand related resources to see all details @@ -581,7 +581,7 @@ methodObjects: - name: errorCode schema: string description: Filter issues to a specific error code - example: unknown_device_type + example: missing_permissions - name: status schema: string description: Filter issues to a specific status diff --git a/sdks/db/cached-method-objects/from-custom-request_ynab.com.yaml b/sdks/db/cached-method-objects/from-custom-request_ynab.com.yaml index ce60742543..8c43896914 100644 --- a/sdks/db/cached-method-objects/from-custom-request_ynab.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_ynab.com.yaml @@ -1,4 +1,4 @@ -hash: 704f841505e2ea9ab0b86b694195226c01bcf89e2f7405c9c2b8780be2f420c6 +hash: 77b92fbc10253ba1b8c608d72bc5eccd7f83ba63dcb6349e56a3efb814649c8c methodObjects: - url: /user method: infoGet @@ -734,7 +734,7 @@ methodObjects: httpMethod: get tag: Transactions typeScriptTag: transactions - description: List category transactions + description: List category transactions, excluding any pending transactions parameters: - name: budgetId schema: string @@ -776,7 +776,7 @@ methodObjects: httpMethod: get tag: Transactions typeScriptTag: transactions - description: List payee transactions + description: List payee transactions, excluding any pending transactions parameters: - name: budgetId schema: string diff --git a/sdks/db/category-cache.yaml b/sdks/db/category-cache.yaml index b9fd91ea02..95037cb236 100644 --- a/sdks/db/category-cache.yaml +++ b/sdks/db/category-cache.yaml @@ -197,3 +197,4 @@ apis: Pipedrive-undefined: CRM (Customer Relationship Management) Pipeliner-undefined: CRM (Customer Relationship Management) Echelon-undefined: Payment Processing + Salesflare-undefined: CRM (Customer Relationship Management) diff --git a/sdks/db/custom-request-last-fetched.yaml b/sdks/db/custom-request-last-fetched.yaml index 97afab7d45..c8a0cb5ea7 100644 --- a/sdks/db/custom-request-last-fetched.yaml +++ b/sdks/db/custom-request-last-fetched.yaml @@ -1,30 +1,30 @@ lastUpdated: - multiwoven.com: 2024-03-26T20:35:38.271Z - clickup.com: 2024-03-26T20:35:39.038Z - baseten.co: 2024-03-26T20:35:39.857Z - dev.to: 2024-03-26T20:35:40.102Z - gitlab.com: 2024-03-26T20:35:40.783Z - mailchimp.com: 2024-03-26T20:35:42.202Z - docusign.com: 2024-03-26T20:35:44.247Z - discourse.org: 2024-03-26T20:36:21.147Z - elevenlabs.com: 2024-03-26T20:36:21.569Z - finicity.com: 2024-03-26T20:36:22.304Z - meilisearch.com: 2024-03-26T20:36:24.404Z - nasa.gov_TechPort: 2024-03-26T20:36:24.820Z - lob.com: 2024-03-26T20:36:25.389Z - vimeo.com: 2024-03-26T20:36:32.217Z - svix.com: 2024-03-26T20:36:34.126Z - ynab.com: 2024-03-26T20:36:34.749Z - nytimes.com_books: 2024-03-26T20:36:35.141Z - zapier.com_actions: 2024-03-26T20:36:57.223Z - httpbin.org: 2024-03-26T20:36:59.119Z - paylocity.com_weblink: 2024-03-26T20:36:59.427Z - soundcloud.com: 2024-03-26T20:37:02.165Z - qualtrics.com_survey: 2024-03-26T20:37:02.452Z - slack.com_web: 2024-03-26T20:37:03.182Z - walmart.com_content: 2024-03-26T20:37:06.866Z - zuora.com: 2024-03-26T20:37:07.979Z - launchdarkly.com: 2024-03-26T20:37:13.231Z + multiwoven.com: 2024-03-27T20:38:02.646Z + clickup.com: 2024-03-27T20:38:03.331Z + baseten.co: 2024-03-27T20:38:04.019Z + dev.to: 2024-03-27T20:38:04.203Z + gitlab.com: 2024-03-27T20:38:05.049Z + mailchimp.com: 2024-03-27T20:38:06.917Z + docusign.com: 2024-03-27T20:38:09.107Z + discourse.org: 2024-03-27T20:38:45.926Z + elevenlabs.com: 2024-03-27T20:38:46.208Z + finicity.com: 2024-03-27T20:38:46.917Z + meilisearch.com: 2024-03-27T20:39:42.495Z + nasa.gov_TechPort: 2024-03-27T20:39:43.009Z + lob.com: 2024-03-27T20:39:44.075Z + vimeo.com: 2024-03-27T20:39:50.490Z + svix.com: 2024-03-27T20:39:52.797Z + ynab.com: 2024-03-27T20:39:53.400Z + nytimes.com_books: 2024-03-27T20:39:53.761Z + zapier.com_actions: 2024-03-27T20:40:15.284Z + httpbin.org: 2024-03-27T20:40:26.505Z + paylocity.com_weblink: 2024-03-27T20:40:26.782Z + soundcloud.com: 2024-03-27T20:40:29.559Z + qualtrics.com_survey: 2024-03-27T20:40:29.848Z + slack.com_web: 2024-03-27T20:40:30.585Z + walmart.com_content: 2024-03-27T20:40:35.231Z + zuora.com: 2024-03-27T20:40:36.322Z + launchdarkly.com: 2024-03-27T20:40:42.620Z klarna.com_payments: 2024-03-26T21:21:31.882Z klarna.com_checkout: 2024-03-26T21:23:00.854Z justeattakeaway.com: 2024-03-26T21:23:03.038Z @@ -35,52 +35,52 @@ lastUpdated: clever.com: 2024-03-26T21:23:19.327Z digitalocean.com: 2024-03-26T21:23:20.159Z spotify.com_1.0.0: 2024-03-26T21:23:20.812Z - circleci.com: 2024-03-26T20:35:40.413Z - brex.com_Team: 2024-03-26T20:37:19.153Z - brex.com_Onboarding: 2024-03-26T20:37:54.719Z - brex.com_Payments: 2024-03-26T20:38:09.382Z - brex.com_Transactions: 2024-03-26T20:38:23.390Z - brex.com_Expenses: 2024-03-26T20:38:37.432Z - brex.com_Webhooks: 2024-03-26T20:38:50.560Z - brex.com_Budgets: 2024-03-26T20:39:04.560Z - resend.com: 2024-03-26T20:39:06.980Z - griffin.com: 2024-03-26T20:39:06.619Z - onedoc.com: 2024-03-26T20:35:39.643Z + circleci.com: 2024-03-27T20:38:04.606Z + brex.com_Team: 2024-03-27T20:40:48.359Z + brex.com_Onboarding: 2024-03-27T20:41:02.415Z + brex.com_Payments: 2024-03-27T20:41:16.350Z + brex.com_Transactions: 2024-03-27T20:41:30.341Z + brex.com_Expenses: 2024-03-27T20:41:44.303Z + brex.com_Webhooks: 2024-03-27T20:42:19.797Z + brex.com_Budgets: 2024-03-27T20:42:33.928Z + resend.com: 2024-03-27T20:42:36.374Z + griffin.com: 2024-03-27T20:42:35.968Z + onedoc.com: 2024-03-27T20:38:03.710Z box.com: 2024-03-26T21:23:05.294Z asana.com: 2024-03-26T21:23:07.420Z appwrite.io_Client: 2024-03-26T21:23:06.118Z appwrite.io_Server: 2024-03-26T21:23:06.355Z appwrite.io_Console: 2024-03-26T21:23:06.700Z api.video: 2024-03-26T21:23:05.853Z - 1password.com_Connect: 2024-03-26T20:36:31.569Z - 1password.com_Partnership: 2024-03-26T20:36:26.254Z - zapier.com_Embed: 2024-03-26T20:36:57.599Z - synclabs.so: 2024-03-26T20:36:56.806Z + 1password.com_Connect: 2024-03-27T20:39:49.954Z + 1password.com_Partnership: 2024-03-27T20:39:44.936Z + zapier.com_Embed: 2024-03-27T20:40:15.669Z + synclabs.so: 2024-03-27T20:40:14.868Z uploadthing.com: 2024-03-26T21:23:19.730Z crowdsec.net: 2024-03-26T21:23:21.031Z crowd4cash.ch: 2024-03-26T21:23:23.768Z - posthog.com: 2024-03-26T20:36:30.358Z - visier.com_Authentication: 2024-03-26T20:36:59.626Z - visier.com_ConsolidatedAnalytics: 2024-03-26T20:36:59.797Z - visier.com_DataHandling: 2024-03-26T20:36:59.984Z - visier.com_DataIntake: 2024-03-26T20:37:00.179Z - visier.com_DocumentSearch: 2024-03-26T20:37:00.409Z - visier.com_ModelQuery: 2024-03-26T20:37:00.426Z - visier.com_ObjectConfiguration: 2024-03-26T20:37:00.599Z - visier.com_PermissionManagement: 2024-03-26T20:37:00.755Z - visier.com_ProfileManagement: 2024-03-26T20:37:00.947Z - visier.com_TenantManagement: 2024-03-26T20:37:01.132Z - visier.com_UserManagement: 2024-03-26T20:37:01.324Z - shipengine.com: 2024-03-26T20:37:02.739Z + posthog.com: 2024-03-27T20:39:48.847Z + visier.com_Authentication: 2024-03-27T20:40:26.997Z + visier.com_ConsolidatedAnalytics: 2024-03-27T20:40:27.218Z + visier.com_DataHandling: 2024-03-27T20:40:27.394Z + visier.com_DataIntake: 2024-03-27T20:40:27.576Z + visier.com_DocumentSearch: 2024-03-27T20:40:27.771Z + visier.com_ModelQuery: 2024-03-27T20:40:27.785Z + visier.com_ObjectConfiguration: 2024-03-27T20:40:28.006Z + visier.com_PermissionManagement: 2024-03-27T20:40:28.175Z + visier.com_ProfileManagement: 2024-03-27T20:40:28.348Z + visier.com_TenantManagement: 2024-03-27T20:40:28.529Z + visier.com_UserManagement: 2024-03-27T20:40:28.719Z + shipengine.com: 2024-03-27T20:40:30.214Z unstructured.io: 2024-03-26T21:24:11.383Z - vantage.sh: 2024-03-26T20:36:49.927Z - baremetrics.com: 2024-03-26T20:36:49.407Z + vantage.sh: 2024-03-27T20:40:08.873Z + baremetrics.com: 2024-03-27T20:40:08.363Z nvidia.com_NIM: 2024-03-26T21:24:02.569Z nvidia.com_CloudFunctions: 2024-03-26T21:24:11.244Z - langfuse.com: 2024-03-26T20:36:22.671Z - dots.dev: 2024-03-26T20:36:25.097Z - retellai.com: 2024-03-26T20:36:22.919Z - seel.com: 2024-03-26T20:36:56.003Z + langfuse.com: 2024-03-27T20:38:47.287Z + dots.dev: 2024-03-27T20:39:43.284Z + retellai.com: 2024-03-27T20:38:47.494Z + seel.com: 2024-03-27T20:40:14.664Z pay.com: 2024-03-26T21:24:30.697Z agrimetrics.co.uk: 2024-03-26T21:23:54.823Z tremendous.com: 2024-03-26T21:23:35.664Z @@ -102,7 +102,7 @@ lastUpdated: front.com_Core: 2024-03-27T17:16:12.830Z front.com_Channel: 2024-03-27T17:16:13.095Z 7shifts.com: 2024-03-27T19:13:20.217Z - withterminal.com: 2024-03-26T20:36:25.765Z + withterminal.com: 2024-03-27T20:39:44.466Z revenium.io: 2024-03-27T19:15:21.361Z adp.com_WorkforceNow: 2024-03-26T21:21:21.599Z alexishr.com: 2024-03-26T21:21:26.979Z @@ -138,9 +138,9 @@ lastUpdated: lucca-hr.com_TimmiTimesheet: 2024-03-27T20:07:44.489Z lucca-hr.com_CleemyExpenses: 2024-03-27T20:07:44.777Z namely.com: 2024-03-27T20:07:45.204Z - suprsend.com: 2024-03-27T20:33:06.399Z - officient.io: 2024-03-27T20:33:06.607Z - okta.com: 2024-03-26T20:36:57.661Z + suprsend.com: 2024-03-27T20:40:24.504Z + officient.io: 2024-03-27T20:40:25.530Z + okta.com: 2024-03-27T20:40:24.772Z onelogin.com: 2024-03-26T21:23:49.030Z sqala.tech: 2024-03-26T21:24:39.177Z peachpayments.com: 2024-03-26T22:27:57.293Z @@ -178,3 +178,4 @@ lastUpdated: pipedrive.com: 2024-03-27T20:22:58.885Z pipelinersales.com: 2024-03-27T20:27:06.725Z echelonpro.io: 2024-03-27T20:33:08.238Z + salesflare.com: 2024-03-27T20:40:15.978Z diff --git a/sdks/db/custom-request-specs/circleci.com.yaml b/sdks/db/custom-request-specs/circleci.com.yaml index 19199058e8..102a5ff35c 100644 --- a/sdks/db/custom-request-specs/circleci.com.yaml +++ b/sdks/db/custom-request-specs/circleci.com.yaml @@ -27,96 +27,6 @@ tags: description: '[__EXPERIMENTAL__] Endpoints related to creating and managing a project.' paths: /context: - get: - summary: List contexts - description: List all contexts for an owner. - tags: - - Context - operationId: listContexts - responses: - '200': - description: A paginated list of contexts - content: - application/json: - schema: - type: object - properties: - items: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: The unique ID of the context. - name: - type: string - description: The user defined name of the context. - created_at: - type: string - format: date-time - description: The date and time the context was created. - example: '2015-09-21T17:29:21.042Z' - required: - - id - - name - - created_at - title: Context - next_page_token: - type: string - x-nullable: true - description: >- - A token to pass as a `page-token` query parameter to - return the next page of results. - required: - - items - - next_page_token - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: query - name: owner-id - description: >- - The unique ID of the owner of the context. Specify either this or - owner-slug. - schema: - type: string - format: uuid - required: false - - in: query - name: owner-slug - description: >- - A string that represents an organization. Specify either this or - owner-id. Cannot be used for accounts. - schema: - type: string - required: false - - in: query - name: owner-type - description: >- - The type of the owner. Defaults to "organization". Accounts are only - used as context owners in server. - schema: - type: string - enum: - - account - - organization - required: false - - in: query - name: page-token - description: A token to retrieve the next page of results. - schema: - type: string - required: false - allowEmptyValue: true post: summary: Create a new context description: Creates a new context. @@ -207,27 +117,51 @@ paths: required: - name - owner - /context/{context-id}: - delete: - summary: Delete a context + get: + summary: List contexts + description: List all contexts for an owner. tags: - Context - operationId: deleteContext + operationId: listContexts responses: '200': - description: A confirmation message + description: A paginated list of contexts content: application/json: schema: type: object properties: - message: + items: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + description: The unique ID of the context. + name: + type: string + description: The user defined name of the context. + created_at: + type: string + format: date-time + description: The date and time the context was created. + example: '2015-09-21T17:29:21.042Z' + required: + - id + - name + - created_at + title: Context + next_page_token: type: string - description: A human-readable message + x-nullable: true + description: >- + A token to pass as a `page-token` query parameter to + return the next page of results. required: - - message - description: message response - title: MessageResponse + - items + - next_page_token default: content: application/json: @@ -238,13 +172,42 @@ paths: type: string description: Error response. parameters: - - in: path - name: context-id - description: ID of the context (UUID) + - in: query + name: owner-id + description: >- + The unique ID of the owner of the context. Specify either this or + owner-slug. schema: type: string format: uuid - required: true + required: false + - in: query + name: owner-slug + description: >- + A string that represents an organization. Specify either this or + owner-id. Cannot be used for accounts. + schema: + type: string + required: false + - in: query + name: owner-type + description: >- + The type of the owner. Defaults to "organization". Accounts are only + used as context owners in server. + schema: + type: string + enum: + - account + - organization + required: false + - in: query + name: page-token + description: A token to retrieve the next page of results. + schema: + type: string + required: false + allowEmptyValue: true + /context/{context-id}: get: summary: Get a context description: Returns basic information about a context. @@ -293,6 +256,43 @@ paths: type: string format: uuid required: true + delete: + summary: Delete a context + tags: + - Context + operationId: deleteContext + responses: + '200': + description: A confirmation message + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: context-id + description: ID of the context (UUID) + schema: + type: string + format: uuid + required: true /context/{context-id}/environment-variable: get: summary: List environment variables @@ -3839,83 +3839,30 @@ paths: - md5 required: false /project/{project-slug}/checkout-key/{fingerprint}: - delete: - summary: Delete a checkout key + get: + summary: Get a checkout key description: >- - Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys - should be url-encoded. + Returns an individual checkout key via md5 or sha256 fingerprint. sha256 + keys should be url-encoded. tags: - Project - operationId: deleteCheckoutKey + operationId: getCheckoutKey responses: '200': - description: A confirmation message. + description: The checkout key. content: application/json: schema: type: object properties: - message: + public-key: type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: project-slug - description: >- - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` - characters may be URL-escaped. For projects that use GitLab or - GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` - with the organization ID (found in Organization Settings), and - replace `repo-name` with the project ID (found in Project Settings). - schema: - type: string - required: true - example: gh/CircleCI-Public/api-preview-docs - allowReserved: true - - in: path - name: fingerprint - description: An SSH key fingerprint. - schema: - type: string - required: true - example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f - get: - summary: Get a checkout key - description: >- - Returns an individual checkout key via md5 or sha256 fingerprint. sha256 - keys should be url-encoded. - tags: - - Project - operationId: getCheckoutKey - responses: - '200': - description: The checkout key. - content: - application/json: - schema: - type: object - properties: - public-key: - type: string - description: A public SSH key. - example: ssh-rsa ... - type: - enum: - - deploy-key - - github-user-key + description: A public SSH key. + example: ssh-rsa ... + type: + enum: + - deploy-key + - github-user-key type: string description: >- The type of checkout key. This may be either `deploy-key` @@ -3973,6 +3920,59 @@ paths: type: string required: true example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f + delete: + summary: Delete a checkout key + description: >- + Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys + should be url-encoded. + tags: + - Project + operationId: deleteCheckoutKey + responses: + '200': + description: A confirmation message. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: project-slug + description: >- + Project slug in the form `vcs-slug/org-name/repo-name`. The `/` + characters may be URL-escaped. For projects that use GitLab or + GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` + with the organization ID (found in Organization Settings), and + replace `repo-name` with the project ID (found in Project Settings). + schema: + type: string + required: true + example: gh/CircleCI-Public/api-preview-docs + allowReserved: true + - in: path + name: fingerprint + description: An SSH key fingerprint. + schema: + type: string + required: true + example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f /project/{project-slug}/envvar: post: summary: Create an environment variable @@ -4124,39 +4124,27 @@ paths: example: gh/CircleCI-Public/api-preview-docs allowReserved: true /project/{project-slug}/envvar/{name}: - get: - summary: Get a masked environment variable - description: Returns the masked value of environment variable :name. + delete: + summary: Delete an environment variable + description: Deletes the environment variable named :name. tags: - Project - operationId: getEnvVar + operationId: deleteEnvVar responses: '200': - description: The environment variable. + description: A confirmation message. content: application/json: schema: type: object properties: - name: - type: string - description: The name of the environment variable. - example: foo - value: + message: type: string - description: The value of the environment variable. - example: xxxx1234 - created-at: - x-nullable: true - description: The creation timestamp of the environment variable. - example: '#joda/inst 2023-04-14T21:20:14+0000' + description: A human-readable message required: - - name - - value - description: >- - An environment variable is a map containing a value and an - optional timestamp. - title: EnvironmentVariable + - message + description: message response + title: MessageResponse default: content: application/json: @@ -4187,27 +4175,39 @@ paths: type: string required: true example: foo - delete: - summary: Delete an environment variable - description: Deletes the environment variable named :name. + get: + summary: Get a masked environment variable + description: Returns the masked value of environment variable :name. tags: - Project - operationId: deleteEnvVar + operationId: getEnvVar responses: '200': - description: A confirmation message. + description: The environment variable. content: application/json: schema: type: object properties: - message: + name: type: string - description: A human-readable message + description: The name of the environment variable. + example: foo + value: + type: string + description: The value of the environment variable. + example: xxxx1234 + created-at: + x-nullable: true + description: The creation timestamp of the environment variable. + example: '#joda/inst 2023-04-14T21:20:14+0000' required: - - message - description: message response - title: MessageResponse + - name + - value + description: >- + An environment variable is a map containing a value and an + optional timestamp. + title: EnvironmentVariable default: content: application/json: @@ -6255,6 +6255,46 @@ paths: example: gh/CircleCI-Public/api-preview-docs allowReserved: true /schedule/{schedule-id}: + delete: + summary: Delete a schedule + description: >- + Not yet available to projects that use GitLab or GitHub App. Deletes the + schedule by id. + tags: + - Schedule + operationId: deleteScheduleById + responses: + '200': + description: A confirmation message. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: schedule-id + description: The unique ID of the schedule. + schema: + type: string + format: uuid + required: true patch: summary: Update a schedule description: >- @@ -6807,46 +6847,6 @@ paths: type: string format: uuid required: true - delete: - summary: Delete a schedule - description: >- - Not yet available to projects that use GitLab or GitHub App. Deletes the - schedule by id. - tags: - - Schedule - operationId: deleteScheduleById - responses: - '200': - description: A confirmation message. - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: schedule-id - description: The unique ID of the schedule. - schema: - type: string - format: uuid - required: true /user/{id}: get: summary: User Information @@ -7177,44 +7177,6 @@ paths: - scope description: The parameters for a create webhook request /webhook/{webhook-id}: - delete: - summary: Delete an outbound webhook - description: Deletes an outbound webhook - tags: - - Webhook - operationId: deleteWebhook - responses: - '200': - description: A confirmation message - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: webhook-id - description: ID of the webhook (UUID) - schema: - type: string - format: uuid - required: true get: summary: Get a webhook description: Get an outbound webhook by id. @@ -7315,6 +7277,44 @@ paths: type: string format: uuid required: true + delete: + summary: Delete an outbound webhook + description: Deletes an outbound webhook + tags: + - Webhook + operationId: deleteWebhook + responses: + '200': + description: A confirmation message + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: webhook-id + description: ID of the webhook (UUID) + schema: + type: string + format: uuid + required: true put: summary: Update an outbound webhook description: Updates an outbound webhook. diff --git a/sdks/db/custom-request-specs/elevenlabs.com.yaml b/sdks/db/custom-request-specs/elevenlabs.com.yaml index 4168c6f5bc..735fee629a 100644 --- a/sdks/db/custom-request-specs/elevenlabs.com.yaml +++ b/sdks/db/custom-request-specs/elevenlabs.com.yaml @@ -5128,6 +5128,12 @@ components: title: Safety Control voice_verification: $ref: '#/components/schemas/VoiceVerificationResponseModel' + owner_id: + type: string + title: Owner Id + permission_on_resource: + type: string + title: Permission On Resource type: object required: - voice_id diff --git a/sdks/db/custom-request-specs/gitlab.com.yaml b/sdks/db/custom-request-specs/gitlab.com.yaml index 2a0c961bd2..d126989602 100644 --- a/sdks/db/custom-request-specs/gitlab.com.yaml +++ b/sdks/db/custom-request-specs/gitlab.com.yaml @@ -31,7 +31,7 @@ info: name: CC BY-SA 4.0 url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE servers: - - url: https://www.gitlab.com/api/ + - url: https://www.gitlab.com/api/v4 security: - ApiKeyAuth: [] tags: @@ -188,7 +188,7 @@ tags: - name: unleash_api description: Operations related to Unleash API paths: - /api/v4/groups/{id}/badges/{badge_id}: + /groups/{id}/badges/{badge_id}: get: tags: - badges @@ -286,7 +286,7 @@ paths: '204': description: Removes a badge from the group. content: {} - /api/v4/groups/{id}/badges: + /groups/{id}/badges: get: tags: - badges @@ -370,7 +370,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Badge' - /api/v4/groups/{id}/badges/render: + /groups/{id}/badges/render: get: tags: - badges @@ -405,7 +405,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BasicBadgeDetails' - /api/v4/groups/{id}/access_requests/{user_id}: + /groups/{id}/access_requests/{user_id}: delete: tags: - access_requests @@ -432,7 +432,7 @@ paths: '204': description: Denies an access request for the given user. content: {} - /api/v4/groups/{id}/access_requests/{user_id}/approve: + /groups/{id}/access_requests/{user_id}/approve: put: tags: - access_requests @@ -480,7 +480,7 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/groups/{id}/access_requests: + /groups/{id}/access_requests: get: tags: - access_requests @@ -547,7 +547,7 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/repository/merged_branches: + /projects/{id}/repository/merged_branches: delete: tags: - branches @@ -567,7 +567,7 @@ paths: '404': description: 404 Project Not Found content: {} - /api/v4/projects/{id}/repository/branches/{branch}: + /projects/{id}/repository/branches/{branch}: get: tags: - branches @@ -646,7 +646,7 @@ paths: '404': description: Not Found content: {} - /api/v4/projects/{id}/repository/branches: + /projects/{id}/repository/branches: get: tags: - branches @@ -743,7 +743,7 @@ paths: '400': description: Failed to create branch content: {} - /api/v4/projects/{id}/repository/branches/{branch}/unprotect: + /projects/{id}/repository/branches/{branch}/unprotect: put: tags: - branches @@ -772,7 +772,7 @@ paths: '404': description: 404 Project Not Found content: {} - /api/v4/projects/{id}/repository/branches/{branch}/protect: + /projects/{id}/repository/branches/{branch}/protect: put: tags: - branches @@ -812,7 +812,7 @@ paths: '404': description: 404 Branch Not Found content: {} - /api/v4/projects/{id}/badges/{badge_id}: + /projects/{id}/badges/{badge_id}: get: tags: - badges @@ -910,7 +910,7 @@ paths: '204': description: Removes a badge from the project. content: {} - /api/v4/projects/{id}/badges: + /projects/{id}/badges: get: tags: - badges @@ -994,7 +994,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Badge' - /api/v4/projects/{id}/badges/render: + /projects/{id}/badges/render: get: tags: - badges @@ -1029,7 +1029,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BasicBadgeDetails' - /api/v4/projects/{id}/access_requests/{user_id}: + /projects/{id}/access_requests/{user_id}: delete: tags: - access_requests @@ -1056,7 +1056,7 @@ paths: '204': description: Denies an access request for the given user. content: {} - /api/v4/projects/{id}/access_requests/{user_id}/approve: + /projects/{id}/access_requests/{user_id}/approve: put: tags: - access_requests @@ -1104,7 +1104,7 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/access_requests: + /projects/{id}/access_requests: get: tags: - access_requests @@ -1171,7 +1171,7 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: put: tags: - alert_management @@ -1262,7 +1262,7 @@ paths: '422': description: Unprocessable entity content: {} - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images: get: tags: - alert_management @@ -1341,7 +1341,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: post: tags: - alert_management @@ -1368,7 +1368,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/admin/batched_background_migrations/{id}: + /admin/batched_background_migrations/{id}: get: tags: - batched_background_migrations @@ -1410,7 +1410,7 @@ paths: '404': description: 404 Not found content: {} - /api/v4/admin/batched_background_migrations: + /admin/batched_background_migrations: get: tags: - batched_background_migrations @@ -1444,7 +1444,7 @@ paths: '403': description: 403 Forbidden content: {} - /api/v4/admin/batched_background_migrations/{id}/resume: + /admin/batched_background_migrations/{id}/resume: put: tags: - batched_background_migrations @@ -1492,7 +1492,7 @@ paths: '422': description: You can resume only `paused` batched background migrations. content: {} - /api/v4/admin/batched_background_migrations/{id}/pause: + /admin/batched_background_migrations/{id}/pause: put: tags: - batched_background_migrations @@ -1540,7 +1540,7 @@ paths: '422': description: You can pause only `active` batched background migrations. content: {} - /api/v4/admin/ci/variables/{key}: + /admin/ci/variables/{key}: get: tags: - ci_variables @@ -1632,7 +1632,7 @@ paths: '404': description: Instance Variable Not Found content: {} - /api/v4/admin/ci/variables: + /admin/ci/variables: get: tags: - ci_variables @@ -1707,7 +1707,7 @@ paths: '400': description: 400 Bad Request content: {} - /api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}: + /admin/databases/{database_name}/dictionary/tables/{table_name}: get: tags: - admin @@ -1745,7 +1745,7 @@ paths: '404': description: 404 Not found content: {} - /api/v4/admin/clusters/{cluster_id}: + /admin/clusters/{cluster_id}: get: tags: - clusters @@ -1883,7 +1883,7 @@ paths: '404': description: Not found content: {} - /api/v4/admin/clusters/add: + /admin/clusters/add: post: tags: - clusters @@ -1968,7 +1968,7 @@ paths: '404': description: Not found content: {} - /api/v4/admin/clusters: + /admin/clusters: get: tags: - clusters @@ -1989,7 +1989,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/admin/migrations/{timestamp}/mark: + /admin/migrations/{timestamp}/mark: post: tags: - migrations @@ -2034,7 +2034,7 @@ paths: '422': description: You can mark only pending migrations content: {} - /api/v4/applications/{id}: + /applications/{id}: delete: tags: - applications @@ -2053,7 +2053,7 @@ paths: '204': description: Delete an application content: {} - /api/v4/applications: + /applications: get: tags: - applications @@ -2111,7 +2111,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_ApplicationWithSecret' - /api/v4/avatar: + /avatar: get: tags: - avatar @@ -2137,7 +2137,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Avatar' - /api/v4/broadcast_messages/{id}: + /broadcast_messages/{id}: get: tags: - broadcast_messages @@ -2247,7 +2247,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BroadcastMessage' - /api/v4/broadcast_messages: + /broadcast_messages: get: tags: - broadcast_messages @@ -2338,7 +2338,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BroadcastMessage' - /api/v4/bulk_imports/{import_id}/entities/{entity_id}: + /bulk_imports/{import_id}/entities/{entity_id}: get: tags: - bulk_imports @@ -2376,7 +2376,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/{import_id}/entities: + /bulk_imports/{import_id}/entities: get: tags: - bulk_imports @@ -2434,7 +2434,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/{import_id}: + /bulk_imports/{import_id}: get: tags: - bulk_imports @@ -2465,7 +2465,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/entities: + /bulk_imports/entities: get: tags: - bulk_imports @@ -2525,7 +2525,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports: + /bulk_imports: get: tags: - bulk_imports @@ -2666,7 +2666,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/application/appearance: + /application/appearance: get: tags: - application @@ -2748,7 +2748,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Appearance' - /api/v4/application/plan_limits: + /application/plan_limits: get: tags: - plan_limits @@ -2914,7 +2914,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/metadata: + /metadata: get: tags: - metadata @@ -2931,7 +2931,7 @@ paths: '401': description: Unauthorized content: {} - /api/v4/version: + /version: get: tags: - metadata @@ -2950,7 +2950,7 @@ paths: '401': description: Unauthorized content: {} - /api/v4/projects/{id}/jobs: + /projects/{id}/jobs: get: tags: - jobs @@ -2980,7 +2980,7 @@ paths: type: array items: $ref: '#/components/schemas/API_Entities_Job' - /api/v4/projects/{id}/jobs/{job_id}: + /projects/{id}/jobs/{job_id}: get: tags: - jobs @@ -3006,7 +3006,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Job' - /api/v4/projects/{id}/jobs/{job_id}/play: + /projects/{id}/jobs/{job_id}/play: post: tags: - jobs diff --git a/sdks/db/custom-request-specs/launchdarkly.com.yaml b/sdks/db/custom-request-specs/launchdarkly.com.yaml index 7427d9da2b..3e5157c56f 100644 --- a/sdks/db/custom-request-specs/launchdarkly.com.yaml +++ b/sdks/db/custom-request-specs/launchdarkly.com.yaml @@ -31585,14 +31585,14 @@ components: - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum analysisType: type: string - description: The strategy for analyzing metric events + description: The method for analyzing metric events example: mean enum: - mean @@ -31600,9 +31600,9 @@ components: percentileValue: type: integer description: >- - The percentile, an integer denoting the target percentile between 0 - and 100. Only present when analysisType is - percentile. + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. example: 95 eventDefault: $ref: '#/components/schemas/MetricEventDefaultRep' @@ -31692,11 +31692,24 @@ components: - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum + analysisType: + type: string + description: The method for analyzing metric events + example: mean + percentileValue: + type: integer + description: >- + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. + example: 95 + eventDefault: + $ref: '#/components/schemas/MetricEventDefaultRep' MetricRep: type: object required: @@ -31816,14 +31829,14 @@ components: - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum analysisType: type: string - description: The strategy for analyzing metric events + description: The method for analyzing metric events example: mean enum: - mean @@ -31831,9 +31844,9 @@ components: percentileValue: type: integer description: >- - The percentile, an integer denoting the target percentile between 0 - and 100. Only present when analysisType is - percentile. + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. example: 95 eventDefault: $ref: '#/components/schemas/MetricEventDefaultRep' diff --git a/sdks/db/custom-request-specs/posthog.com.yaml b/sdks/db/custom-request-specs/posthog.com.yaml index f8b95160d6..0d068e339e 100644 --- a/sdks/db/custom-request-specs/posthog.com.yaml +++ b/sdks/db/custom-request-specs/posthog.com.yaml @@ -14096,6 +14096,14 @@ components: format: date-time readOnly: true description: The timestamp at which this BatchExportRun was last updated. + records_total_count: + type: integer + maximum: 2147483647 + minimum: -2147483648 + nullable: true + description: >- + The total count of records that should be exported in this + BatchExportRun. batch_export: type: string format: uuid diff --git a/sdks/db/custom-request-specs/salesflare.com.yaml b/sdks/db/custom-request-specs/salesflare.com.yaml new file mode 100644 index 0000000000..5e8f48c0b1 --- /dev/null +++ b/sdks/db/custom-request-specs/salesflare.com.yaml @@ -0,0 +1,30639 @@ +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) + + + ## 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/api_logo.png + backgroundColor: '#3d4d65' + 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 + 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: '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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + - name: limit + in: query + schema: + type: number + minimum: 1 + default: 10 + tags: + - Accounts + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + type: object + properties: + id: + type: number + owner: + type: object + properties: + id: + type: number + name: + type: string + email: + type: string + picture: + type: string + required: + - id + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + description: + type: string + last_interaction_date: + type: string + format: date-time + creation_date: + type: string + format: date-time + modification_date: + type: string + format: date-time + part_of: + type: boolean + hotness: + type: number + can_edit: + type: boolean + 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 + last_email_date: + type: string + format: date-time + last_meeting_date: + type: string + format: date-time + social_profiles: + type: array + items: + type: object + properties: + id: + type: number + type: + type: string + url: + type: string + username: + 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 property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + required: + - id + email_addresses: + type: array + items: + type: object + properties: + id: + type: number + email: + type: string + phone_numbers: + type: array + items: + type: object + properties: + id: + type: number + number: + type: string + type: + type: string + tags: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + required: + - id + parent_account: + type: object + properties: + id: + type: number + name: + type: string + domain: + type: string + picture: + type: string + entity: + type: string + enum: + - account + required: + - id + custom: + type: object + required: + - id + - domain + post: + summary: Create an account + operationId: postAccounts + parameters: + - name: update_if_exists + in: query + schema: + type: boolean + default: false + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + type: array + 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, will be ignored + required: + - email + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + number: + type: string + type: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + required: + - number + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + customers: + 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 + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + x-alternatives: + - type: object + properties: + owner: + type: number + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + type: array + 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, will be ignored + required: + - email + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + number: + type: string + type: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + required: + - number + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + customers: + 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 + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + - 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 + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Contacts + 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 property. 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 + required: + - id + post: + summary: Create a contact + operationId: postContacts + description: >- + 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 will not be created if a contact + with the same email address used to exist. + 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 + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + prefix: + type: string + firstname: + type: string + middle: + type: string + lastname: + type: string + suffix: + type: string + name: + type: string + picture: + type: string + maxLength: 500 + account: + type: number + description: >- + Any existing account will be removed from the contact when + specifically passing `null`! + birth_date: + type: string + format: date-time + 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 + tags: + type: array + 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, will be ignored + address: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + 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: + number: + type: string + type: + type: string + required: + - number + position: + type: object + properties: + organisation: + type: string + role: + type: string + positions: + type: array + items: + type: object + properties: + organisation: + type: string + role: + type: string + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + custom: + type: object + 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 + campaign: + type: string + is_referred: + type: boolean + credit_usage: + type: number + credit_quota: + type: number + credit_package: + type: string + enum: + - S + - M + - L + - XL + 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 + 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 + referral_code: + type: string + referral_reward: + type: number + is_delinquent: + type: boolean + 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 + first_day_of_week: + type: number + 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 + /opportunities: + get: + summary: List opportunities + operationId: getOpportunities + description: >- + 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 + 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: '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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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 + - x-alternatives: + - type: object + required: + - condition + - rules + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Opportunities + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + 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 + 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 + 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: + iso: + type: string + required: + - iso + close_date: + type: string + closed: + type: boolean + 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 + 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 + main_contact: + type: object + properties: + id: + type: number + name: + type: string + email: + type: string + picture: + type: string + entity: + type: string + enum: + - contact + required: + - id + custom: + type: object + last_stage_change_date: + type: string + format: date + required: + - id + post: + summary: Create an opportunity + operationId: postOpportunities + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + x-alternatives: + - type: number + - type: object + - type: string + account: + type: number + x-alternatives: + - type: number + - type: object + stage: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + x-constraint: + sign: positive + order: + type: number + probability: + type: number + fixed_stage: + type: number + required: + - id + - order + - probability + - type: string + lost_reason: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + - type: string + files: + type: array + items: + type: object + lead_source: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + start_date: + type: string + format: date-time + probability: + type: number + minimum: 0 + assignee: + type: number + x-alternatives: + - type: number + - type: object + - type: string + creator: + type: number + x-alternatives: + - type: number + - type: object + - type: string + status: + type: string + description: DEPRECATED + name: + type: string + value: + type: number + minimum: 0 + currency: + type: number + status_date: + type: string + description: DEPRECATED + close_date: + type: string + format: date-time + closed: + type: boolean + tags: + type: array + 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, will be ignored + recurring_price_per_unit: + type: number + frequency: + type: string + enum: + - annually + - weekly + - monthly + - daily + x-convert: + case: lower + units: + type: number + contract_start_date: + type: string + format: date-time + contract_end_date: + type: string + format: date-time + main_contact: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + 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 + parameters: + - name: search + in: query + schema: + type: string + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 + parameters: + - x-constraint: + single: true + name: id + in: query + explode: true + schema: + type: array + items: + type: number + - description: >- + This property is deprecated, use q.search instead. When both are + provided, q.search will be 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 + parameters: + - x-constraint: + single: true + name: id + in: query + explode: true + schema: + type: array + items: + type: number + - name: search + in: query + schema: + type: string + - description: Defaults to the user + x-constraint: + single: true + name: assignees + in: query + explode: true + schema: + type: array + items: + type: number + - x-constraint: + single: true + name: type + in: query + explode: true + schema: + type: array + items: + type: number + - x-constraint: + single: true + name: account + in: query + explode: true + schema: + type: array + items: + type: number + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + x-constraint: + single: true + name: order_by + in: query + explode: true + schema: + type: array + items: + type: string + - name: limit + in: query + schema: + type: number + - name: offset + in: query + schema: + type: number + - x-alternatives: + - type: object + required: + - condition + - rules + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + type: object + properties: + id: + type: number + type: + type: string + enum: + - meeting_notes + - email_reply + - account_inactive + - suggested_contact + - suggested_account + - manual_task + - meeting + meeting_type: + type: boolean + account: + type: object + properties: + id: + type: number + name: + type: string + picture: + type: string + creator: + type: number + description: + type: string + reminder_date: + type: string + format: date-time + company: + type: number + meeting: + type: object + properties: + id: + type: number + subject: + type: string + conference_url: + type: string + required: + - id + email: + type: object + properties: + id: + type: number + email_message_id: + type: string + subject: + type: string + data_source: + type: number + service_message_id: + type: string + required: + - id + - email_message_id + - subject + completed: + type: boolean + completion_date: + type: string + format: date-time + completor: + type: number + archived: + type: boolean + archive_date: + type: string + format: date-time + archivor: + 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 + assignees: + type: array + items: + type: object + properties: + id: + type: number + email: + type: string + picture: + type: string + name: + type: string + disabled: + type: boolean + post: + summary: Create a task + operationId: postTasks + requestBody: + content: + application/json: + schema: + type: array + x-constraint: + single: true + items: + type: object + properties: + account: + type: number + description: + type: string + reminder_date: + type: string + format: date + default: '2024-03-27T13:03:17.281Z' + assignees: + type: array + 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 + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + parameters: + - name: account_id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + 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 + trim: true + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + id: + type: number + number: + type: string + type: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + social_profiles: + type: array + 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, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + required: + - parent_account + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + required: + - id + custom: + type: object + q: + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + parameters: + - name: contact_id + in: path + required: true + schema: + type: number + - description: >- + When force is false, the contact's name will not be updated if the + name in the update is just the first part of the email address. + name: force + in: query + schema: + type: boolean + default: true + requestBody: + content: + application/json: + schema: + type: object + properties: + prefix: + type: string + firstname: + type: string + middle: + type: string + lastname: + type: string + suffix: + type: string + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + role: + type: string + name: + type: string + owner: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + required: + - id + - type: string + picture: + type: string + account: + type: number + description: >- + Any existing account will be removed from the contact when + specifically passing `null`! + birth_date: + type: string + format: date-time + 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 + tags: + type: array + 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, will be ignored + address: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. 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, will be ignored + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. 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, will be ignored + 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 + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + position: + type: object + properties: + id: + type: number + organisation: + type: string + role: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + positions: + type: array + items: + type: object + properties: + id: + type: number + organisation: + type: string + role: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + social_profiles: + type: array + 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, will be ignored + custom: + type: object + _dirty: + type: boolean + description: Deprecated, will be 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 + 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 + group: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + entity: + type: string + enum: + - account + - person + - opportunity + - campaign + - tag + - task + - workflow + - workflow_record + - workflow_step_record + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + 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 + 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 + /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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 property. 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 + 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 + closed: + type: boolean + 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 + parameters: + - name: id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + x-alternatives: + - type: number + - type: object + account: + type: number + x-alternatives: + - type: number + - type: object + stage: + type: number + x-constraint: + sign: positive + x-alternatives: + - type: number + x-constraint: + sign: positive + - type: object + properties: + id: + type: number + order: + type: number + probability: + type: number + fixed_stage: + type: number + required: + - id + - order + - probability + lost_reason: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + files: + type: array + items: + type: object + lead_source: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + start_date: + type: string + format: date-time + probability: + type: number + minimum: 0 + assignee: + type: number + x-alternatives: + - type: number + - type: object + - type: string + creator: + type: number + x-alternatives: + - type: number + - type: object + - type: string + name: + type: string + value: + type: number + minimum: 0 + close_date: + type: string + format: date-time + closed: + type: boolean + done: + type: boolean + tags: + type: array + 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, will be ignored + recurring_price_per_unit: + type: number + frequency: + type: string + enum: + - annually + - weekly + - monthly + - daily + x-convert: + case: lower + units: + type: number + contract_start_date: + type: string + format: date-time + contract_end_date: + type: string + format: date-time + main_contact: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + 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 + /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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + /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 + 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: >- + The use of this property is deprecated. Use the notes + property instead. + notes: + type: string + phone_type: + type: string + phone_number_hash: + type: string + participants: + type: array + description: No participants is 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: >- + The use of this property is deprecated. Use the notes + property instead. + notes: + type: string + phone_type: + type: string + phone_number_hash: + type: string + participants: + type: array + description: No participants is 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 + /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 + requestBody: + content: + application/json: + schema: + type: object + properties: + account: + type: number + description: + type: string + reminder_date: + type: string + format: date + assignees: + type: array + x-constraint: + single: true + items: + type: number + completed: + type: boolean + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: object + properties: + success: + type: boolean + delete: + summary: Delete a task + operationId: deleteTasksId + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: object + properties: + success: + type: boolean + /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: 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` of a workflow record to `false` is + currently not possible. + 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 + putMeetingsMeeting_idBody: + content: + application/json: + schema: + type: object + properties: + calendar_id: + type: string + external_id: + type: string + minutes: + type: string + description: >- + The use of this property is 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: >- + The use of this property is 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: >- + The use of this property is 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 + postWorkflowsBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + filter: + x-alternatives: + - type: object + description: >- + When you pass `ids` all other filter options will be + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + required: + - condition + - rules + type: object + description: When you pass `ids` all other filter options will be 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + postTagsBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + required: + - name diff --git a/sdks/db/custom-request-specs/vimeo.com.yaml b/sdks/db/custom-request-specs/vimeo.com.yaml index 10f15ee556..e59a9c6c46 100644 --- a/sdks/db/custom-request-specs/vimeo.com.yaml +++ b/sdks/db/custom-request-specs/vimeo.com.yaml @@ -34456,30 +34456,50 @@ components: connections: properties: video: - description: The associated video object. + description: >- + The associated video object. This data requires a bearer + token with the `private` scope. properties: created_time: - description: The time in ISO 8601 format when the video was created. + description: >- + The time in ISO 8601 format when the video was created. + This data requires a bearer token with the `private` + scope. example: '2018-03-05T21:04:47+00:00' type: string duration: - description: The duration of the associated video. + description: >- + The duration of the associated video. This data requires + a bearer token with the `private` scope. type: number + manage_link: + description: >- + The link to the video management page. This data + requires a bearer token with the `private` scope. + example: /manage/videos/258684937 + type: string options: - description: An array of HTTP methods permitted on this URI. + description: >- + An array of HTTP methods permitted on this URI. This + data requires a bearer token with the `private` scope. items: type: string type: array title: - description: The title of the associated video. + description: >- + The title of the associated video. This data requires a + bearer token with the `private` scope. type: string uri: - description: The API URI that resolves to the connection data. + description: >- + The API URI that resolves to the connection data. This + data requires a bearer token with the `private` scope. example: /videos/152184 type: string required: - created_time - duration + - manage_link - options - title - uri @@ -43572,6 +43592,10 @@ components: description: The translated display name of the role. example: Admin type: string + is_disabled: + description: Whether the role is disabled for certain team members. + example: false + type: boolean permission_level: description: | The untranslated role of the user who made the request. diff --git a/sdks/db/custom-request-specs/withterminal.com.yaml b/sdks/db/custom-request-specs/withterminal.com.yaml index e444dfd9b1..be18aab266 100644 --- a/sdks/db/custom-request-specs/withterminal.com.yaml +++ b/sdks/db/custom-request-specs/withterminal.com.yaml @@ -76,7 +76,7 @@ paths: in: query schema: type: string - example: sunt do est sit + example: non mollit reprehenderit description: Filter connections by tag - name: updatedAfter in: query @@ -116,7 +116,7 @@ paths: properties: days: type: number - example: 18640422.26015696 + example: 5757343.118591592 startFrom: type: string example: '2021-01-06T03:24:53.000Z' @@ -127,28 +127,28 @@ paths: type: array items: type: string - example: do pariatur non + example: pariatur est example: - - do pariatur non - - adi + - pariatur est + - voluptate qui dolor name: type: string - example: est aute + example: aute ut qui en credentials: type: object properties: database: type: string - example: ut incididunt + example: nisi c password: type: string - example: esse consequat + example: minim labore incididunt deserunt username: type: string - example: ipsum quis eiusmod Ut + example: aute in laboris externalId: type: string - example: ipsum enim + example: elit commodo in sunt provider: type: string example: geotab @@ -167,18 +167,18 @@ paths: Create Connection: value: backfill: - days: 18640422.26015696 + days: 5757343.118591592 startFrom: '2021-01-06T03:24:53.000Z' company: dotNumbers: - - do pariatur non - - adi - name: est aute + - pariatur est + - voluptate qui dolor + name: aute ut qui en credentials: - database: ut incididunt - password: esse consequat - username: ipsum quis eiusmod Ut - externalId: ipsum enim + database: nisi c + password: minim labore incididunt deserunt + username: aute in laboris + externalId: elit commodo in sunt provider: geotab syncMode: automatic tags: @@ -239,10 +239,10 @@ paths: example: Acme Inc. externalId: type: string - example: Excepteur enim irure + example: pariatur dolor minim status: type: string - example: mollit sunt aliquip + example: do syncMode: type: string example: automatic @@ -250,21 +250,21 @@ paths: type: array items: type: string - example: laboris s + example: Excepteur Ut example: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu examples: Update Current Connection: value: company: name: Acme Inc. - externalId: Excepteur enim irure - status: mollit sunt aliquip + externalId: pariatur dolor minim + status: do syncMode: automatic tags: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu responses: '200': description: '' @@ -757,13 +757,13 @@ paths: in: query schema: type: string - example: '1984-11-05' + example: '1992-10-05' description: Only include daily logs from on or after a specific date - name: endDate in: query schema: type: string - example: '1984-11-05' + example: '1992-10-05' description: Only include daily logs from on or before a specific date - name: modifiedAfter in: query @@ -909,13 +909,13 @@ paths: in: query schema: type: string - example: '1957-08-03' + example: '1999-09-28' description: Timestamp to start when the issue was last observed - name: lastReportedBefore in: query schema: type: string - example: '1957-08-03' + example: '1999-09-28' description: Timestamp to end when the issue was last observed - name: expand in: query @@ -933,7 +933,7 @@ paths: in: query schema: type: string - example: unknown_device_type + example: missing_permissions description: Filter issues to a specific error code - name: status in: query @@ -960,7 +960,7 @@ paths: required: true schema: type: string - example: sunt do est sit + example: non mollit reprehenderit description: '(Required) ' /providers: get: diff --git a/sdks/db/custom-request-specs/ynab.com.yaml b/sdks/db/custom-request-specs/ynab.com.yaml index 1cb83b4c03..f14073672c 100644 --- a/sdks/db/custom-request-specs/ynab.com.yaml +++ b/sdks/db/custom-request-specs/ynab.com.yaml @@ -845,7 +845,7 @@ paths: tags: - Transactions summary: List transactions - description: Returns budget transactions + description: Returns budget transactions, excluding any pending transactions operationId: getTransactions parameters: - name: budget_id @@ -1178,7 +1178,9 @@ paths: tags: - Transactions summary: List account transactions - description: Returns all transactions for a specified account + description: >- + Returns all transactions for a specified account, excluding any pending + transactions operationId: getTransactionsByAccount parameters: - name: budget_id @@ -1245,7 +1247,7 @@ paths: get: tags: - Transactions - summary: List category transactions + summary: List category transactions, excluding any pending transactions description: Returns all transactions for a specified category operationId: getTransactionsByCategory parameters: @@ -1313,7 +1315,7 @@ paths: get: tags: - Transactions - summary: List payee transactions + summary: List payee transactions, excluding any pending transactions description: Returns all transactions for a specified payee operationId: getTransactionsByPayee parameters: diff --git a/sdks/db/fixed-specs-cache/circle-ci-fixed-spec.yaml b/sdks/db/fixed-specs-cache/circle-ci-fixed-spec.yaml index 1ae5720161..6e649b6d01 100644 --- a/sdks/db/fixed-specs-cache/circle-ci-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/circle-ci-fixed-spec.yaml @@ -79,96 +79,6 @@ rawSpecString: | description: '[__EXPERIMENTAL__] Endpoints related to creating and managing a project.' paths: /context: - get: - summary: List contexts - description: List all contexts for an owner. - tags: - - Context - operationId: listContexts - responses: - '200': - description: A paginated list of contexts - content: - application/json: - schema: - type: object - properties: - items: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: The unique ID of the context. - name: - type: string - description: The user defined name of the context. - created_at: - type: string - format: date-time - description: The date and time the context was created. - example: '2015-09-21T17:29:21.042Z' - required: - - id - - name - - created_at - title: Context - next_page_token: - type: string - x-nullable: true - description: >- - A token to pass as a `page-token` query parameter to - return the next page of results. - required: - - items - - next_page_token - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: query - name: owner-id - description: >- - The unique ID of the owner of the context. Specify either this or - owner-slug. - schema: - type: string - format: uuid - required: false - - in: query - name: owner-slug - description: >- - A string that represents an organization. Specify either this or - owner-id. Cannot be used for accounts. - schema: - type: string - required: false - - in: query - name: owner-type - description: >- - The type of the owner. Defaults to "organization". Accounts are only - used as context owners in server. - schema: - type: string - enum: - - account - - organization - required: false - - in: query - name: page-token - description: A token to retrieve the next page of results. - schema: - type: string - required: false - allowEmptyValue: true post: summary: Create a new context description: Creates a new context. @@ -259,27 +169,51 @@ rawSpecString: | required: - name - owner - /context/{context-id}: - delete: - summary: Delete a context + get: + summary: List contexts + description: List all contexts for an owner. tags: - Context - operationId: deleteContext + operationId: listContexts responses: '200': - description: A confirmation message + description: A paginated list of contexts content: application/json: schema: type: object properties: - message: + items: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + description: The unique ID of the context. + name: + type: string + description: The user defined name of the context. + created_at: + type: string + format: date-time + description: The date and time the context was created. + example: '2015-09-21T17:29:21.042Z' + required: + - id + - name + - created_at + title: Context + next_page_token: type: string - description: A human-readable message + x-nullable: true + description: >- + A token to pass as a `page-token` query parameter to + return the next page of results. required: - - message - description: message response - title: MessageResponse + - items + - next_page_token default: content: application/json: @@ -290,13 +224,42 @@ rawSpecString: | type: string description: Error response. parameters: - - in: path - name: context-id - description: ID of the context (UUID) + - in: query + name: owner-id + description: >- + The unique ID of the owner of the context. Specify either this or + owner-slug. schema: type: string format: uuid - required: true + required: false + - in: query + name: owner-slug + description: >- + A string that represents an organization. Specify either this or + owner-id. Cannot be used for accounts. + schema: + type: string + required: false + - in: query + name: owner-type + description: >- + The type of the owner. Defaults to "organization". Accounts are only + used as context owners in server. + schema: + type: string + enum: + - account + - organization + required: false + - in: query + name: page-token + description: A token to retrieve the next page of results. + schema: + type: string + required: false + allowEmptyValue: true + /context/{context-id}: get: summary: Get a context description: Returns basic information about a context. @@ -345,6 +308,43 @@ rawSpecString: | type: string format: uuid required: true + delete: + summary: Delete a context + tags: + - Context + operationId: deleteContext + responses: + '200': + description: A confirmation message + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: context-id + description: ID of the context (UUID) + schema: + type: string + format: uuid + required: true /context/{context-id}/environment-variable: get: summary: List environment variables @@ -3891,83 +3891,30 @@ rawSpecString: | - md5 required: false /project/{project-slug}/checkout-key/{fingerprint}: - delete: - summary: Delete a checkout key + get: + summary: Get a checkout key description: >- - Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys - should be url-encoded. + Returns an individual checkout key via md5 or sha256 fingerprint. sha256 + keys should be url-encoded. tags: - Project - operationId: deleteCheckoutKey + operationId: getCheckoutKey responses: '200': - description: A confirmation message. + description: The checkout key. content: application/json: schema: type: object properties: - message: + public-key: type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: project-slug - description: >- - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` - characters may be URL-escaped. For projects that use GitLab or - GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` - with the organization ID (found in Organization Settings), and - replace `repo-name` with the project ID (found in Project Settings). - schema: - type: string - required: true - example: gh/CircleCI-Public/api-preview-docs - allowReserved: true - - in: path - name: fingerprint - description: An SSH key fingerprint. - schema: - type: string - required: true - example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f - get: - summary: Get a checkout key - description: >- - Returns an individual checkout key via md5 or sha256 fingerprint. sha256 - keys should be url-encoded. - tags: - - Project - operationId: getCheckoutKey - responses: - '200': - description: The checkout key. - content: - application/json: - schema: - type: object - properties: - public-key: - type: string - description: A public SSH key. - example: ssh-rsa ... - type: - enum: - - deploy-key - - github-user-key + description: A public SSH key. + example: ssh-rsa ... + type: + enum: + - deploy-key + - github-user-key type: string description: >- The type of checkout key. This may be either `deploy-key` @@ -4025,6 +3972,59 @@ rawSpecString: | type: string required: true example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f + delete: + summary: Delete a checkout key + description: >- + Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys + should be url-encoded. + tags: + - Project + operationId: deleteCheckoutKey + responses: + '200': + description: A confirmation message. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: project-slug + description: >- + Project slug in the form `vcs-slug/org-name/repo-name`. The `/` + characters may be URL-escaped. For projects that use GitLab or + GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` + with the organization ID (found in Organization Settings), and + replace `repo-name` with the project ID (found in Project Settings). + schema: + type: string + required: true + example: gh/CircleCI-Public/api-preview-docs + allowReserved: true + - in: path + name: fingerprint + description: An SSH key fingerprint. + schema: + type: string + required: true + example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f /project/{project-slug}/envvar: post: summary: Create an environment variable @@ -4176,39 +4176,27 @@ rawSpecString: | example: gh/CircleCI-Public/api-preview-docs allowReserved: true /project/{project-slug}/envvar/{name}: - get: - summary: Get a masked environment variable - description: Returns the masked value of environment variable :name. + delete: + summary: Delete an environment variable + description: Deletes the environment variable named :name. tags: - Project - operationId: getEnvVar + operationId: deleteEnvVar responses: '200': - description: The environment variable. + description: A confirmation message. content: application/json: schema: type: object properties: - name: - type: string - description: The name of the environment variable. - example: foo - value: + message: type: string - description: The value of the environment variable. - example: xxxx1234 - created-at: - x-nullable: true - description: The creation timestamp of the environment variable. - example: '#joda/inst 2023-04-14T21:20:14+0000' + description: A human-readable message required: - - name - - value - description: >- - An environment variable is a map containing a value and an - optional timestamp. - title: EnvironmentVariable + - message + description: message response + title: MessageResponse default: content: application/json: @@ -4239,27 +4227,39 @@ rawSpecString: | type: string required: true example: foo - delete: - summary: Delete an environment variable - description: Deletes the environment variable named :name. + get: + summary: Get a masked environment variable + description: Returns the masked value of environment variable :name. tags: - Project - operationId: deleteEnvVar + operationId: getEnvVar responses: '200': - description: A confirmation message. + description: The environment variable. content: application/json: schema: type: object properties: - message: + name: type: string - description: A human-readable message + description: The name of the environment variable. + example: foo + value: + type: string + description: The value of the environment variable. + example: xxxx1234 + created-at: + x-nullable: true + description: The creation timestamp of the environment variable. + example: '#joda/inst 2023-04-14T21:20:14+0000' required: - - message - description: message response - title: MessageResponse + - name + - value + description: >- + An environment variable is a map containing a value and an + optional timestamp. + title: EnvironmentVariable default: content: application/json: @@ -6307,6 +6307,46 @@ rawSpecString: | example: gh/CircleCI-Public/api-preview-docs allowReserved: true /schedule/{schedule-id}: + delete: + summary: Delete a schedule + description: >- + Not yet available to projects that use GitLab or GitHub App. Deletes the + schedule by id. + tags: + - Schedule + operationId: deleteScheduleById + responses: + '200': + description: A confirmation message. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: schedule-id + description: The unique ID of the schedule. + schema: + type: string + format: uuid + required: true patch: summary: Update a schedule description: >- @@ -6859,46 +6899,6 @@ rawSpecString: | type: string format: uuid required: true - delete: - summary: Delete a schedule - description: >- - Not yet available to projects that use GitLab or GitHub App. Deletes the - schedule by id. - tags: - - Schedule - operationId: deleteScheduleById - responses: - '200': - description: A confirmation message. - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: schedule-id - description: The unique ID of the schedule. - schema: - type: string - format: uuid - required: true /user/{id}: get: summary: User Information @@ -7229,44 +7229,6 @@ rawSpecString: | - scope description: The parameters for a create webhook request /webhook/{webhook-id}: - delete: - summary: Delete an outbound webhook - description: Deletes an outbound webhook - tags: - - Webhook - operationId: deleteWebhook - responses: - '200': - description: A confirmation message - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: webhook-id - description: ID of the webhook (UUID) - schema: - type: string - format: uuid - required: true get: summary: Get a webhook description: Get an outbound webhook by id. @@ -7367,6 +7329,44 @@ rawSpecString: | type: string format: uuid required: true + delete: + summary: Delete an outbound webhook + description: Deletes an outbound webhook + tags: + - Webhook + operationId: deleteWebhook + responses: + '200': + description: A confirmation message + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: webhook-id + description: ID of the webhook (UUID) + schema: + type: string + format: uuid + required: true put: summary: Update an outbound webhook description: Updates an outbound webhook. diff --git a/sdks/db/fixed-specs-cache/eleven-labs-fixed-spec.yaml b/sdks/db/fixed-specs-cache/eleven-labs-fixed-spec.yaml index 796497cc5c..740562a587 100644 --- a/sdks/db/fixed-specs-cache/eleven-labs-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/eleven-labs-fixed-spec.yaml @@ -5148,6 +5148,12 @@ rawSpecString: | title: Safety Control voice_verification: $ref: '#/components/schemas/VoiceVerificationResponseModel' + owner_id: + type: string + title: Owner Id + permission_on_resource: + type: string + title: Permission On Resource type: object required: - voice_id diff --git a/sdks/db/fixed-specs-cache/git-lab-fixed-spec.yaml b/sdks/db/fixed-specs-cache/git-lab-fixed-spec.yaml index 0e42ee50bb..6e49d492b6 100644 --- a/sdks/db/fixed-specs-cache/git-lab-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/git-lab-fixed-spec.yaml @@ -51,7 +51,7 @@ rawSpecString: | name: CC BY-SA 4.0 url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE servers: - - url: https://www.gitlab.com/api/ + - url: https://www.gitlab.com/api/v4 security: - ApiKeyAuth: [] tags: @@ -208,7 +208,7 @@ rawSpecString: | - name: unleash_api description: Operations related to Unleash API paths: - /api/v4/groups/{id}/badges/{badge_id}: + /groups/{id}/badges/{badge_id}: get: tags: - badges @@ -306,7 +306,7 @@ rawSpecString: | '204': description: Removes a badge from the group. content: {} - /api/v4/groups/{id}/badges: + /groups/{id}/badges: get: tags: - badges @@ -390,7 +390,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_Badge' - /api/v4/groups/{id}/badges/render: + /groups/{id}/badges/render: get: tags: - badges @@ -425,7 +425,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_BasicBadgeDetails' - /api/v4/groups/{id}/access_requests/{user_id}: + /groups/{id}/access_requests/{user_id}: delete: tags: - access_requests @@ -452,7 +452,7 @@ rawSpecString: | '204': description: Denies an access request for the given user. content: {} - /api/v4/groups/{id}/access_requests/{user_id}/approve: + /groups/{id}/access_requests/{user_id}/approve: put: tags: - access_requests @@ -500,7 +500,7 @@ rawSpecString: | state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/groups/{id}/access_requests: + /groups/{id}/access_requests: get: tags: - access_requests @@ -567,7 +567,7 @@ rawSpecString: | state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/repository/merged_branches: + /projects/{id}/repository/merged_branches: delete: tags: - branches @@ -587,7 +587,7 @@ rawSpecString: | '404': description: 404 Project Not Found content: {} - /api/v4/projects/{id}/repository/branches/{branch}: + /projects/{id}/repository/branches/{branch}: get: tags: - branches @@ -666,7 +666,7 @@ rawSpecString: | '404': description: Not Found content: {} - /api/v4/projects/{id}/repository/branches: + /projects/{id}/repository/branches: get: tags: - branches @@ -763,7 +763,7 @@ rawSpecString: | '400': description: Failed to create branch content: {} - /api/v4/projects/{id}/repository/branches/{branch}/unprotect: + /projects/{id}/repository/branches/{branch}/unprotect: put: tags: - branches @@ -792,7 +792,7 @@ rawSpecString: | '404': description: 404 Project Not Found content: {} - /api/v4/projects/{id}/repository/branches/{branch}/protect: + /projects/{id}/repository/branches/{branch}/protect: put: tags: - branches @@ -832,7 +832,7 @@ rawSpecString: | '404': description: 404 Branch Not Found content: {} - /api/v4/projects/{id}/badges/{badge_id}: + /projects/{id}/badges/{badge_id}: get: tags: - badges @@ -930,7 +930,7 @@ rawSpecString: | '204': description: Removes a badge from the project. content: {} - /api/v4/projects/{id}/badges: + /projects/{id}/badges: get: tags: - badges @@ -1014,7 +1014,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_Badge' - /api/v4/projects/{id}/badges/render: + /projects/{id}/badges/render: get: tags: - badges @@ -1049,7 +1049,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_BasicBadgeDetails' - /api/v4/projects/{id}/access_requests/{user_id}: + /projects/{id}/access_requests/{user_id}: delete: tags: - access_requests @@ -1076,7 +1076,7 @@ rawSpecString: | '204': description: Denies an access request for the given user. content: {} - /api/v4/projects/{id}/access_requests/{user_id}/approve: + /projects/{id}/access_requests/{user_id}/approve: put: tags: - access_requests @@ -1124,7 +1124,7 @@ rawSpecString: | state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/access_requests: + /projects/{id}/access_requests: get: tags: - access_requests @@ -1191,7 +1191,7 @@ rawSpecString: | state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: put: tags: - alert_management @@ -1282,7 +1282,7 @@ rawSpecString: | '422': description: Unprocessable entity content: {} - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images: get: tags: - alert_management @@ -1361,7 +1361,7 @@ rawSpecString: | '403': description: Forbidden content: {} - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: post: tags: - alert_management @@ -1388,7 +1388,7 @@ rawSpecString: | '403': description: Forbidden content: {} - /api/v4/admin/batched_background_migrations/{id}: + /admin/batched_background_migrations/{id}: get: tags: - batched_background_migrations @@ -1430,7 +1430,7 @@ rawSpecString: | '404': description: 404 Not found content: {} - /api/v4/admin/batched_background_migrations: + /admin/batched_background_migrations: get: tags: - batched_background_migrations @@ -1464,7 +1464,7 @@ rawSpecString: | '403': description: 403 Forbidden content: {} - /api/v4/admin/batched_background_migrations/{id}/resume: + /admin/batched_background_migrations/{id}/resume: put: tags: - batched_background_migrations @@ -1512,7 +1512,7 @@ rawSpecString: | '422': description: You can resume only `paused` batched background migrations. content: {} - /api/v4/admin/batched_background_migrations/{id}/pause: + /admin/batched_background_migrations/{id}/pause: put: tags: - batched_background_migrations @@ -1560,7 +1560,7 @@ rawSpecString: | '422': description: You can pause only `active` batched background migrations. content: {} - /api/v4/admin/ci/variables/{key}: + /admin/ci/variables/{key}: get: tags: - ci_variables @@ -1652,7 +1652,7 @@ rawSpecString: | '404': description: Instance Variable Not Found content: {} - /api/v4/admin/ci/variables: + /admin/ci/variables: get: tags: - ci_variables @@ -1727,7 +1727,7 @@ rawSpecString: | '400': description: 400 Bad Request content: {} - /api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}: + /admin/databases/{database_name}/dictionary/tables/{table_name}: get: tags: - admin @@ -1765,7 +1765,7 @@ rawSpecString: | '404': description: 404 Not found content: {} - /api/v4/admin/clusters/{cluster_id}: + /admin/clusters/{cluster_id}: get: tags: - clusters @@ -1903,7 +1903,7 @@ rawSpecString: | '404': description: Not found content: {} - /api/v4/admin/clusters/add: + /admin/clusters/add: post: tags: - clusters @@ -1988,7 +1988,7 @@ rawSpecString: | '404': description: Not found content: {} - /api/v4/admin/clusters: + /admin/clusters: get: tags: - clusters @@ -2009,7 +2009,7 @@ rawSpecString: | '403': description: Forbidden content: {} - /api/v4/admin/migrations/{timestamp}/mark: + /admin/migrations/{timestamp}/mark: post: tags: - migrations @@ -2054,7 +2054,7 @@ rawSpecString: | '422': description: You can mark only pending migrations content: {} - /api/v4/applications/{id}: + /applications/{id}: delete: tags: - applications @@ -2073,7 +2073,7 @@ rawSpecString: | '204': description: Delete an application content: {} - /api/v4/applications: + /applications: get: tags: - applications @@ -2131,7 +2131,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_ApplicationWithSecret' - /api/v4/avatar: + /avatar: get: tags: - avatar @@ -2157,7 +2157,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_Avatar' - /api/v4/broadcast_messages/{id}: + /broadcast_messages/{id}: get: tags: - broadcast_messages @@ -2267,7 +2267,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_BroadcastMessage' - /api/v4/broadcast_messages: + /broadcast_messages: get: tags: - broadcast_messages @@ -2358,7 +2358,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_BroadcastMessage' - /api/v4/bulk_imports/{import_id}/entities/{entity_id}: + /bulk_imports/{import_id}/entities/{entity_id}: get: tags: - bulk_imports @@ -2396,7 +2396,7 @@ rawSpecString: | '503': description: Service unavailable content: {} - /api/v4/bulk_imports/{import_id}/entities: + /bulk_imports/{import_id}/entities: get: tags: - bulk_imports @@ -2454,7 +2454,7 @@ rawSpecString: | '503': description: Service unavailable content: {} - /api/v4/bulk_imports/{import_id}: + /bulk_imports/{import_id}: get: tags: - bulk_imports @@ -2485,7 +2485,7 @@ rawSpecString: | '503': description: Service unavailable content: {} - /api/v4/bulk_imports/entities: + /bulk_imports/entities: get: tags: - bulk_imports @@ -2545,7 +2545,7 @@ rawSpecString: | '503': description: Service unavailable content: {} - /api/v4/bulk_imports: + /bulk_imports: get: tags: - bulk_imports @@ -2686,7 +2686,7 @@ rawSpecString: | '503': description: Service unavailable content: {} - /api/v4/application/appearance: + /application/appearance: get: tags: - application @@ -2768,7 +2768,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_Appearance' - /api/v4/application/plan_limits: + /application/plan_limits: get: tags: - plan_limits @@ -2934,7 +2934,7 @@ rawSpecString: | '403': description: Forbidden content: {} - /api/v4/metadata: + /metadata: get: tags: - metadata @@ -2951,7 +2951,7 @@ rawSpecString: | '401': description: Unauthorized content: {} - /api/v4/version: + /version: get: tags: - metadata @@ -2970,7 +2970,7 @@ rawSpecString: | '401': description: Unauthorized content: {} - /api/v4/projects/{id}/jobs: + /projects/{id}/jobs: get: tags: - jobs @@ -3000,7 +3000,7 @@ rawSpecString: | type: array items: $ref: '#/components/schemas/API_Entities_Job' - /api/v4/projects/{id}/jobs/{job_id}: + /projects/{id}/jobs/{job_id}: get: tags: - jobs @@ -3026,7 +3026,7 @@ rawSpecString: | application/json: schema: $ref: '#/components/schemas/API_Entities_Job' - /api/v4/projects/{id}/jobs/{job_id}/play: + /projects/{id}/jobs/{job_id}/play: post: tags: - jobs diff --git a/sdks/db/fixed-specs-cache/launch-darkly-fixed-spec.yaml b/sdks/db/fixed-specs-cache/launch-darkly-fixed-spec.yaml index a2d62218cc..66a8478a9a 100644 --- a/sdks/db/fixed-specs-cache/launch-darkly-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/launch-darkly-fixed-spec.yaml @@ -31606,14 +31606,14 @@ rawSpecString: | - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum analysisType: type: string - description: The strategy for analyzing metric events + description: The method for analyzing metric events example: mean enum: - mean @@ -31621,9 +31621,9 @@ rawSpecString: | percentileValue: type: integer description: >- - The percentile, an integer denoting the target percentile between 0 - and 100. Only present when analysisType is - percentile. + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. example: 95 eventDefault: $ref: '#/components/schemas/MetricEventDefaultRep' @@ -31713,11 +31713,24 @@ rawSpecString: | - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum + analysisType: + type: string + description: The method for analyzing metric events + example: mean + percentileValue: + type: integer + description: >- + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. + example: 95 + eventDefault: + $ref: '#/components/schemas/MetricEventDefaultRep' MetricRep: type: object required: @@ -31837,14 +31850,14 @@ rawSpecString: | - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum analysisType: type: string - description: The strategy for analyzing metric events + description: The method for analyzing metric events example: mean enum: - mean @@ -31852,9 +31865,9 @@ rawSpecString: | percentileValue: type: integer description: >- - The percentile, an integer denoting the target percentile between 0 - and 100. Only present when analysisType is - percentile. + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. example: 95 eventDefault: $ref: '#/components/schemas/MetricEventDefaultRep' diff --git a/sdks/db/fixed-specs-cache/post-hog-fixed-spec.yaml b/sdks/db/fixed-specs-cache/post-hog-fixed-spec.yaml index 13c5775ddf..b942d0a457 100644 --- a/sdks/db/fixed-specs-cache/post-hog-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/post-hog-fixed-spec.yaml @@ -14137,6 +14137,14 @@ rawSpecString: | format: date-time readOnly: true description: The timestamp at which this BatchExportRun was last updated. + records_total_count: + type: integer + maximum: 2147483647 + minimum: -2147483648 + nullable: true + description: >- + The total count of records that should be exported in this + BatchExportRun. batch_export: type: string format: uuid diff --git a/sdks/db/fixed-specs-cache/salesflare-fixed-spec.yaml b/sdks/db/fixed-specs-cache/salesflare-fixed-spec.yaml new file mode 100644 index 0000000000..40e2e89538 --- /dev/null +++ b/sdks/db/fixed-specs-cache/salesflare-fixed-spec.yaml @@ -0,0 +1,30680 @@ +publishJson: + company: Salesflare + serviceName: false + sdkName: salesflare-{language}-sdk + clientName: Salesflare + metaDescription: >- + Salesflare is the intelligent CRM startups and small businesses love to use. + It's a zero-input sales pipeline tool that thinks and works for its user, + not the other way around. + + + No more manual data entry. Salesflare fills out your address book and keeps + track of all interactions with the people you're in contact with. It takes + data from social media, company databases, phone, email, calendar and hands + it to you in automated customer timelines that tell you everything you need + to know. You just have to write the emails, make the calls, and have the + coffee. + + + Never miss a deal again. Salesflare will tell and remind you what to do + about leads so deals can't fall through the cracks anymore. Visual pipelines + and powerful insights put you in full control of your sales funnel. + Intuitive and easy-to-use, Salesflare turns complexity into simplicity so + you can turn leads into customers. + + + Salesflare works wherever you work and with whatever you are working with. + Use it on desktop, mobile or just from a sidebar in your email inbox (Gmail + and Outlook). Get even more out of Salesflare by integrating with 5000+ + other productivity tools, such as Google Apps, MailChimp, Trello and Slack. + + + There's a free trial available from salesflare.com. + apiStatusUrls: inherit + homepage: salesflare.com + developerDocumentation: api.salesflare.com/docs + categories: + - crm + - sales +rawSpecString: | + 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) + + + ## 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/api_logo.png + backgroundColor: '#3d4d65' + 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 + 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: '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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + - name: limit + in: query + schema: + type: number + minimum: 1 + default: 10 + tags: + - Accounts + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + type: object + properties: + id: + type: number + owner: + type: object + properties: + id: + type: number + name: + type: string + email: + type: string + picture: + type: string + required: + - id + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + description: + type: string + last_interaction_date: + type: string + format: date-time + creation_date: + type: string + format: date-time + modification_date: + type: string + format: date-time + part_of: + type: boolean + hotness: + type: number + can_edit: + type: boolean + 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 + last_email_date: + type: string + format: date-time + last_meeting_date: + type: string + format: date-time + social_profiles: + type: array + items: + type: object + properties: + id: + type: number + type: + type: string + url: + type: string + username: + 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 property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + required: + - id + email_addresses: + type: array + items: + type: object + properties: + id: + type: number + email: + type: string + phone_numbers: + type: array + items: + type: object + properties: + id: + type: number + number: + type: string + type: + type: string + tags: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + required: + - id + parent_account: + type: object + properties: + id: + type: number + name: + type: string + domain: + type: string + picture: + type: string + entity: + type: string + enum: + - account + required: + - id + custom: + type: object + required: + - id + - domain + post: + summary: Create an account + operationId: postAccounts + parameters: + - name: update_if_exists + in: query + schema: + type: boolean + default: false + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + type: array + 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, will be ignored + required: + - email + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + number: + type: string + type: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + required: + - number + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + customers: + 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 + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + x-alternatives: + - type: object + properties: + owner: + type: number + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + type: array + 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, will be ignored + required: + - email + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + number: + type: string + type: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + required: + - number + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + customers: + 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 + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + - 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 + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Contacts + 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 property. 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 + required: + - id + post: + summary: Create a contact + operationId: postContacts + description: >- + 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 will not be created if a contact + with the same email address used to exist. + 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 + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + prefix: + type: string + firstname: + type: string + middle: + type: string + lastname: + type: string + suffix: + type: string + name: + type: string + picture: + type: string + maxLength: 500 + account: + type: number + description: >- + Any existing account will be removed from the contact when + specifically passing `null`! + birth_date: + type: string + format: date-time + 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 + tags: + type: array + 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, will be ignored + address: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + 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: + number: + type: string + type: + type: string + required: + - number + position: + type: object + properties: + organisation: + type: string + role: + type: string + positions: + type: array + items: + type: object + properties: + organisation: + type: string + role: + type: string + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + custom: + type: object + 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 + campaign: + type: string + is_referred: + type: boolean + credit_usage: + type: number + credit_quota: + type: number + credit_package: + type: string + enum: + - S + - M + - L + - XL + 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 + 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 + referral_code: + type: string + referral_reward: + type: number + is_delinquent: + type: boolean + 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 + first_day_of_week: + type: number + 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 + /opportunities: + get: + summary: List opportunities + operationId: getOpportunities + description: >- + 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 + 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: '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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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 + - x-alternatives: + - type: object + required: + - condition + - rules + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Opportunities + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + 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 + 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 + 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: + iso: + type: string + required: + - iso + close_date: + type: string + closed: + type: boolean + 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 + 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 + main_contact: + type: object + properties: + id: + type: number + name: + type: string + email: + type: string + picture: + type: string + entity: + type: string + enum: + - contact + required: + - id + custom: + type: object + last_stage_change_date: + type: string + format: date + required: + - id + post: + summary: Create an opportunity + operationId: postOpportunities + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + x-alternatives: + - type: number + - type: object + - type: string + account: + type: number + x-alternatives: + - type: number + - type: object + stage: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + x-constraint: + sign: positive + order: + type: number + probability: + type: number + fixed_stage: + type: number + required: + - id + - order + - probability + - type: string + lost_reason: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + - type: string + files: + type: array + items: + type: object + lead_source: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + start_date: + type: string + format: date-time + probability: + type: number + minimum: 0 + assignee: + type: number + x-alternatives: + - type: number + - type: object + - type: string + creator: + type: number + x-alternatives: + - type: number + - type: object + - type: string + status: + type: string + description: DEPRECATED + name: + type: string + value: + type: number + minimum: 0 + currency: + type: number + status_date: + type: string + description: DEPRECATED + close_date: + type: string + format: date-time + closed: + type: boolean + tags: + type: array + 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, will be ignored + recurring_price_per_unit: + type: number + frequency: + type: string + enum: + - annually + - weekly + - monthly + - daily + x-convert: + case: lower + units: + type: number + contract_start_date: + type: string + format: date-time + contract_end_date: + type: string + format: date-time + main_contact: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + 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 + parameters: + - name: search + in: query + schema: + type: string + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 + parameters: + - x-constraint: + single: true + name: id + in: query + explode: true + schema: + type: array + items: + type: number + - description: >- + This property is deprecated, use q.search instead. When both are + provided, q.search will be 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 + parameters: + - x-constraint: + single: true + name: id + in: query + explode: true + schema: + type: array + items: + type: number + - name: search + in: query + schema: + type: string + - description: Defaults to the user + x-constraint: + single: true + name: assignees + in: query + explode: true + schema: + type: array + items: + type: number + - x-constraint: + single: true + name: type + in: query + explode: true + schema: + type: array + items: + type: number + - x-constraint: + single: true + name: account + in: query + explode: true + schema: + type: array + items: + type: number + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + x-constraint: + single: true + name: order_by + in: query + explode: true + schema: + type: array + items: + type: string + - name: limit + in: query + schema: + type: number + - name: offset + in: query + schema: + type: number + - x-alternatives: + - type: object + required: + - condition + - rules + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + type: object + properties: + id: + type: number + type: + type: string + enum: + - meeting_notes + - email_reply + - account_inactive + - suggested_contact + - suggested_account + - manual_task + - meeting + meeting_type: + type: boolean + account: + type: object + properties: + id: + type: number + name: + type: string + picture: + type: string + creator: + type: number + description: + type: string + reminder_date: + type: string + format: date-time + company: + type: number + meeting: + type: object + properties: + id: + type: number + subject: + type: string + conference_url: + type: string + required: + - id + email: + type: object + properties: + id: + type: number + email_message_id: + type: string + subject: + type: string + data_source: + type: number + service_message_id: + type: string + required: + - id + - email_message_id + - subject + completed: + type: boolean + completion_date: + type: string + format: date-time + completor: + type: number + archived: + type: boolean + archive_date: + type: string + format: date-time + archivor: + 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 + assignees: + type: array + items: + type: object + properties: + id: + type: number + email: + type: string + picture: + type: string + name: + type: string + disabled: + type: boolean + post: + summary: Create a task + operationId: postTasks + requestBody: + content: + application/json: + schema: + type: array + x-constraint: + single: true + items: + type: object + properties: + account: + type: number + description: + type: string + reminder_date: + type: string + format: date + default: '2024-03-27T13:03:17.281Z' + assignees: + type: array + 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 + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + parameters: + - name: account_id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + 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 + trim: true + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + id: + type: number + number: + type: string + type: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + social_profiles: + type: array + 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, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + required: + - parent_account + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + required: + - id + custom: + type: object + q: + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + parameters: + - name: contact_id + in: path + required: true + schema: + type: number + - description: >- + When force is false, the contact's name will not be updated if the + name in the update is just the first part of the email address. + name: force + in: query + schema: + type: boolean + default: true + requestBody: + content: + application/json: + schema: + type: object + properties: + prefix: + type: string + firstname: + type: string + middle: + type: string + lastname: + type: string + suffix: + type: string + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + role: + type: string + name: + type: string + owner: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + required: + - id + - type: string + picture: + type: string + account: + type: number + description: >- + Any existing account will be removed from the contact when + specifically passing `null`! + birth_date: + type: string + format: date-time + 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 + tags: + type: array + 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, will be ignored + address: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. 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, will be ignored + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. 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, will be ignored + 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 + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + position: + type: object + properties: + id: + type: number + organisation: + type: string + role: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + positions: + type: array + items: + type: object + properties: + id: + type: number + organisation: + type: string + role: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + social_profiles: + type: array + 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, will be ignored + custom: + type: object + _dirty: + type: boolean + description: Deprecated, will be 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 + 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 + group: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + entity: + type: string + enum: + - account + - person + - opportunity + - campaign + - tag + - task + - workflow + - workflow_record + - workflow_step_record + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + 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 + 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 + /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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 property. 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 + 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 + closed: + type: boolean + 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 + parameters: + - name: id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + x-alternatives: + - type: number + - type: object + account: + type: number + x-alternatives: + - type: number + - type: object + stage: + type: number + x-constraint: + sign: positive + x-alternatives: + - type: number + x-constraint: + sign: positive + - type: object + properties: + id: + type: number + order: + type: number + probability: + type: number + fixed_stage: + type: number + required: + - id + - order + - probability + lost_reason: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + files: + type: array + items: + type: object + lead_source: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + start_date: + type: string + format: date-time + probability: + type: number + minimum: 0 + assignee: + type: number + x-alternatives: + - type: number + - type: object + - type: string + creator: + type: number + x-alternatives: + - type: number + - type: object + - type: string + name: + type: string + value: + type: number + minimum: 0 + close_date: + type: string + format: date-time + closed: + type: boolean + done: + type: boolean + tags: + type: array + 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, will be ignored + recurring_price_per_unit: + type: number + frequency: + type: string + enum: + - annually + - weekly + - monthly + - daily + x-convert: + case: lower + units: + type: number + contract_start_date: + type: string + format: date-time + contract_end_date: + type: string + format: date-time + main_contact: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + 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 + /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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + /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 + 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: >- + The use of this property is deprecated. Use the notes + property instead. + notes: + type: string + phone_type: + type: string + phone_number_hash: + type: string + participants: + type: array + description: No participants is 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: >- + The use of this property is deprecated. Use the notes + property instead. + notes: + type: string + phone_type: + type: string + phone_number_hash: + type: string + participants: + type: array + description: No participants is 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 + /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 + requestBody: + content: + application/json: + schema: + type: object + properties: + account: + type: number + description: + type: string + reminder_date: + type: string + format: date + assignees: + type: array + x-constraint: + single: true + items: + type: number + completed: + type: boolean + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: object + properties: + success: + type: boolean + delete: + summary: Delete a task + operationId: deleteTasksId + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: object + properties: + success: + type: boolean + /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: 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` of a workflow record to `false` is + currently not possible. + 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 + putMeetingsMeeting_idBody: + content: + application/json: + schema: + type: object + properties: + calendar_id: + type: string + external_id: + type: string + minutes: + type: string + description: >- + The use of this property is 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: >- + The use of this property is 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: >- + The use of this property is 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 + postWorkflowsBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + filter: + x-alternatives: + - type: object + description: >- + When you pass `ids` all other filter options will be + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + required: + - condition + - rules + type: object + description: When you pass `ids` all other filter options will be 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + postTagsBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + required: + - name +konfigCliVersion: 1.38.34 diff --git a/sdks/db/fixed-specs-cache/terminal-fixed-spec.yaml b/sdks/db/fixed-specs-cache/terminal-fixed-spec.yaml index 0a02b90b6d..0bd24e5d14 100644 --- a/sdks/db/fixed-specs-cache/terminal-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/terminal-fixed-spec.yaml @@ -98,7 +98,7 @@ rawSpecString: | in: query schema: type: string - example: sunt do est sit + example: non mollit reprehenderit description: Filter connections by tag - name: updatedAfter in: query @@ -138,7 +138,7 @@ rawSpecString: | properties: days: type: number - example: 18640422.26015696 + example: 5757343.118591592 startFrom: type: string example: '2021-01-06T03:24:53.000Z' @@ -149,28 +149,28 @@ rawSpecString: | type: array items: type: string - example: do pariatur non + example: pariatur est example: - - do pariatur non - - adi + - pariatur est + - voluptate qui dolor name: type: string - example: est aute + example: aute ut qui en credentials: type: object properties: database: type: string - example: ut incididunt + example: nisi c password: type: string - example: esse consequat + example: minim labore incididunt deserunt username: type: string - example: ipsum quis eiusmod Ut + example: aute in laboris externalId: type: string - example: ipsum enim + example: elit commodo in sunt provider: type: string example: geotab @@ -189,18 +189,18 @@ rawSpecString: | Create Connection: value: backfill: - days: 18640422.26015696 + days: 5757343.118591592 startFrom: '2021-01-06T03:24:53.000Z' company: dotNumbers: - - do pariatur non - - adi - name: est aute + - pariatur est + - voluptate qui dolor + name: aute ut qui en credentials: - database: ut incididunt - password: esse consequat - username: ipsum quis eiusmod Ut - externalId: ipsum enim + database: nisi c + password: minim labore incididunt deserunt + username: aute in laboris + externalId: elit commodo in sunt provider: geotab syncMode: automatic tags: @@ -261,10 +261,10 @@ rawSpecString: | example: Acme Inc. externalId: type: string - example: Excepteur enim irure + example: pariatur dolor minim status: type: string - example: mollit sunt aliquip + example: do syncMode: type: string example: automatic @@ -272,21 +272,21 @@ rawSpecString: | type: array items: type: string - example: laboris s + example: Excepteur Ut example: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu examples: Update Current Connection: value: company: name: Acme Inc. - externalId: Excepteur enim irure - status: mollit sunt aliquip + externalId: pariatur dolor minim + status: do syncMode: automatic tags: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu responses: '200': description: '' @@ -779,13 +779,13 @@ rawSpecString: | in: query schema: type: string - example: '1984-11-05' + example: '1992-10-05' description: Only include daily logs from on or after a specific date - name: endDate in: query schema: type: string - example: '1984-11-05' + example: '1992-10-05' description: Only include daily logs from on or before a specific date - name: modifiedAfter in: query @@ -931,13 +931,13 @@ rawSpecString: | in: query schema: type: string - example: '1957-08-03' + example: '1999-09-28' description: Timestamp to start when the issue was last observed - name: lastReportedBefore in: query schema: type: string - example: '1957-08-03' + example: '1999-09-28' description: Timestamp to end when the issue was last observed - name: expand in: query @@ -955,7 +955,7 @@ rawSpecString: | in: query schema: type: string - example: unknown_device_type + example: missing_permissions description: Filter issues to a specific error code - name: status in: query @@ -982,7 +982,7 @@ rawSpecString: | required: true schema: type: string - example: sunt do est sit + example: non mollit reprehenderit description: '(Required) ' /providers: get: diff --git a/sdks/db/fixed-specs-cache/vimeo-fixed-spec.yaml b/sdks/db/fixed-specs-cache/vimeo-fixed-spec.yaml index 9ab344d53a..790373f356 100644 --- a/sdks/db/fixed-specs-cache/vimeo-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/vimeo-fixed-spec.yaml @@ -34467,30 +34467,50 @@ rawSpecString: | connections: properties: video: - description: The associated video object. + description: >- + The associated video object. This data requires a bearer + token with the `private` scope. properties: created_time: - description: The time in ISO 8601 format when the video was created. + description: >- + The time in ISO 8601 format when the video was created. + This data requires a bearer token with the `private` + scope. example: '2018-03-05T21:04:47+00:00' type: string duration: - description: The duration of the associated video. + description: >- + The duration of the associated video. This data requires + a bearer token with the `private` scope. type: number + manage_link: + description: >- + The link to the video management page. This data + requires a bearer token with the `private` scope. + example: /manage/videos/258684937 + type: string options: - description: An array of HTTP methods permitted on this URI. + description: >- + An array of HTTP methods permitted on this URI. This + data requires a bearer token with the `private` scope. items: type: string type: array title: - description: The title of the associated video. + description: >- + The title of the associated video. This data requires a + bearer token with the `private` scope. type: string uri: - description: The API URI that resolves to the connection data. + description: >- + The API URI that resolves to the connection data. This + data requires a bearer token with the `private` scope. example: /videos/152184 type: string required: - created_time - duration + - manage_link - options - title - uri @@ -43583,6 +43603,10 @@ rawSpecString: | description: The translated display name of the role. example: Admin type: string + is_disabled: + description: Whether the role is disabled for certain team members. + example: false + type: boolean permission_level: description: | The untranslated role of the user who made the request. diff --git a/sdks/db/fixed-specs-cache/ynab-fixed-spec.yaml b/sdks/db/fixed-specs-cache/ynab-fixed-spec.yaml index a43d6ef725..222b31d14a 100644 --- a/sdks/db/fixed-specs-cache/ynab-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/ynab-fixed-spec.yaml @@ -856,7 +856,7 @@ rawSpecString: | tags: - Transactions summary: List transactions - description: Returns budget transactions + description: Returns budget transactions, excluding any pending transactions operationId: getTransactions parameters: - name: budget_id @@ -1189,7 +1189,9 @@ rawSpecString: | tags: - Transactions summary: List account transactions - description: Returns all transactions for a specified account + description: >- + Returns all transactions for a specified account, excluding any pending + transactions operationId: getTransactionsByAccount parameters: - name: budget_id @@ -1256,7 +1258,7 @@ rawSpecString: | get: tags: - Transactions - summary: List category transactions + summary: List category transactions, excluding any pending transactions description: Returns all transactions for a specified category operationId: getTransactionsByCategory parameters: @@ -1324,7 +1326,7 @@ rawSpecString: | get: tags: - Transactions - summary: List payee transactions + summary: List payee transactions, excluding any pending transactions description: Returns all transactions for a specified payee operationId: getTransactionsByPayee parameters: diff --git a/sdks/db/fixed-specs/circle-ci-fixed-spec.yaml b/sdks/db/fixed-specs/circle-ci-fixed-spec.yaml index 3b33147b0d..84e9bcfba2 100644 --- a/sdks/db/fixed-specs/circle-ci-fixed-spec.yaml +++ b/sdks/db/fixed-specs/circle-ci-fixed-spec.yaml @@ -26,6 +26,30 @@ tags: - name: User paths: /context: + post: + tags: + - Context + summary: Create a new context + operationId: Context_createNewContext + description: Creates a new context. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContextCreateNewContextRequest' + responses: + '200': + description: The new context + content: + application/json: + schema: + $ref: '#/components/schemas/ContextCreateNewContextResponse' + default: + description: Error response. + content: + application/json: + schema: + $ref: '#/components/schemas/ContextCreateNewContextdefaultResponse' get: tags: - Context @@ -81,36 +105,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ContextListOwnerContextsdefaultResponse' - post: - tags: - - Context - summary: Create a new context - operationId: Context_createNewContext - description: Creates a new context. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ContextCreateNewContextRequest' - responses: - '200': - description: The new context - content: - application/json: - schema: - $ref: '#/components/schemas/ContextCreateNewContextResponse' - default: - description: Error response. - content: - application/json: - schema: - $ref: '#/components/schemas/ContextCreateNewContextdefaultResponse' /context/{context-id}: - delete: + get: tags: - Context - summary: Delete a context - operationId: Context_removeContext + summary: Get a context + operationId: Context_getInformation + description: Returns basic information about a context. parameters: - description: ID of the context (UUID) in: path @@ -121,23 +122,22 @@ paths: required: true responses: '200': - description: A confirmation message + description: The context content: application/json: schema: - $ref: '#/components/schemas/ContextRemoveContextResponse' + $ref: '#/components/schemas/ContextGetInformationResponse' default: description: Error response. content: application/json: schema: - $ref: '#/components/schemas/ContextRemoveContextdefaultResponse' - get: + $ref: '#/components/schemas/ContextGetInformationdefaultResponse' + delete: tags: - Context - summary: Get a context - operationId: Context_getInformation - description: Returns basic information about a context. + summary: Delete a context + operationId: Context_removeContext parameters: - description: ID of the context (UUID) in: path @@ -148,17 +148,17 @@ paths: required: true responses: '200': - description: The context + description: A confirmation message content: application/json: schema: - $ref: '#/components/schemas/ContextGetInformationResponse' + $ref: '#/components/schemas/ContextRemoveContextResponse' default: description: Error response. content: application/json: schema: - $ref: '#/components/schemas/ContextGetInformationdefaultResponse' + $ref: '#/components/schemas/ContextRemoveContextdefaultResponse' /context/{context-id}/environment-variable: get: tags: @@ -1339,14 +1339,14 @@ paths: schema: $ref: '#/components/schemas/ProjectListCheckoutKeysdefaultResponse' /project/{project-slug}/checkout-key/{fingerprint}: - delete: + get: tags: - Project - summary: Delete a checkout key - operationId: Project_deleteCheckoutKeyByFingerprint + summary: Get a checkout key + operationId: Project_getCheckoutKeyByFingerprint description: >- - Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys - should be url-encoded. + Returns an individual checkout key via md5 or sha256 fingerprint. sha256 + keys should be url-encoded. parameters: - description: >- Project slug in the form `vcs-slug/org-name/repo-name`. The `/` @@ -1370,27 +1370,27 @@ paths: example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f responses: '200': - description: A confirmation message. + description: The checkout key. content: application/json: schema: $ref: >- - #/components/schemas/ProjectDeleteCheckoutKeyByFingerprintResponse + #/components/schemas/ProjectGetCheckoutKeyByFingerprintResponse default: description: Error response. content: application/json: schema: $ref: >- - #/components/schemas/ProjectDeleteCheckoutKeyByFingerprintdefaultResponse - get: + #/components/schemas/ProjectGetCheckoutKeyByFingerprintdefaultResponse + delete: tags: - Project - summary: Get a checkout key - operationId: Project_getCheckoutKeyByFingerprint + summary: Delete a checkout key + operationId: Project_deleteCheckoutKeyByFingerprint description: >- - Returns an individual checkout key via md5 or sha256 fingerprint. sha256 - keys should be url-encoded. + Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys + should be url-encoded. parameters: - description: >- Project slug in the form `vcs-slug/org-name/repo-name`. The `/` @@ -1414,19 +1414,19 @@ paths: example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f responses: '200': - description: The checkout key. + description: A confirmation message. content: application/json: schema: $ref: >- - #/components/schemas/ProjectGetCheckoutKeyByFingerprintResponse + #/components/schemas/ProjectDeleteCheckoutKeyByFingerprintResponse default: description: Error response. content: application/json: schema: $ref: >- - #/components/schemas/ProjectGetCheckoutKeyByFingerprintdefaultResponse + #/components/schemas/ProjectDeleteCheckoutKeyByFingerprintdefaultResponse /project/{project-slug}/envvar: post: tags: @@ -1503,12 +1503,12 @@ paths: schema: $ref: '#/components/schemas/ProjectListEnvVarValuesdefaultResponse' /project/{project-slug}/envvar/{name}: - get: + delete: tags: - Project - summary: Get a masked environment variable - operationId: Project_getMaskedEnvVar - description: Returns the masked value of environment variable :name. + summary: Delete an environment variable + operationId: Project_deleteEnvironmentVariable + description: Deletes the environment variable named :name. parameters: - description: >- Project slug in the form `vcs-slug/org-name/repo-name`. The `/` @@ -1532,23 +1532,24 @@ paths: example: foo responses: '200': - description: The environment variable. + description: A confirmation message. content: application/json: schema: - $ref: '#/components/schemas/ProjectGetMaskedEnvVarResponse' + $ref: '#/components/schemas/ProjectDeleteEnvironmentVariableResponse' default: description: Error response. content: application/json: schema: - $ref: '#/components/schemas/ProjectGetMaskedEnvVardefaultResponse' - delete: + $ref: >- + #/components/schemas/ProjectDeleteEnvironmentVariabledefaultResponse + get: tags: - Project - summary: Delete an environment variable - operationId: Project_deleteEnvironmentVariable - description: Deletes the environment variable named :name. + summary: Get a masked environment variable + operationId: Project_getMaskedEnvVar + description: Returns the masked value of environment variable :name. parameters: - description: >- Project slug in the form `vcs-slug/org-name/repo-name`. The `/` @@ -1572,18 +1573,17 @@ paths: example: foo responses: '200': - description: A confirmation message. + description: The environment variable. content: application/json: schema: - $ref: '#/components/schemas/ProjectDeleteEnvironmentVariableResponse' + $ref: '#/components/schemas/ProjectGetMaskedEnvVarResponse' default: description: Error response. content: application/json: schema: - $ref: >- - #/components/schemas/ProjectDeleteEnvironmentVariabledefaultResponse + $ref: '#/components/schemas/ProjectGetMaskedEnvVardefaultResponse' /project/{project-slug}/job/{job-number}: get: tags: @@ -2016,14 +2016,14 @@ paths: schema: $ref: '#/components/schemas/JobGetTestMetadatadefaultResponse' /schedule/{schedule-id}: - patch: + delete: tags: - Schedule - summary: Update a schedule - operationId: Schedule_updateSchedule + summary: Delete a schedule + operationId: Schedule_removeById description: >- - Not yet available to projects that use GitLab or GitHub App. Updates a - schedule and returns the updated schedule. + Not yet available to projects that use GitLab or GitHub App. Deletes the + schedule by id. parameters: - description: The unique ID of the schedule. in: path @@ -2032,30 +2032,27 @@ paths: type: string format: uuid required: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ScheduleUpdateScheduleRequest' responses: '200': - description: A schedule object. + description: A confirmation message. content: application/json: schema: - $ref: '#/components/schemas/ScheduleUpdateScheduleResponse' + $ref: '#/components/schemas/ScheduleRemoveByIdResponse' default: description: Error response. content: application/json: schema: - $ref: '#/components/schemas/ScheduleUpdateScheduledefaultResponse' - get: + $ref: '#/components/schemas/ScheduleRemoveByIddefaultResponse' + patch: tags: - Schedule - summary: Get a schedule - operationId: Schedule_getById - description: Get a schedule by id. + summary: Update a schedule + operationId: Schedule_updateSchedule + description: >- + Not yet available to projects that use GitLab or GitHub App. Updates a + schedule and returns the updated schedule. parameters: - description: The unique ID of the schedule. in: path @@ -2064,27 +2061,30 @@ paths: type: string format: uuid required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleUpdateScheduleRequest' responses: '200': description: A schedule object. content: application/json: schema: - $ref: '#/components/schemas/ScheduleGetByIdResponse' + $ref: '#/components/schemas/ScheduleUpdateScheduleResponse' default: description: Error response. content: application/json: schema: - $ref: '#/components/schemas/ScheduleGetByIddefaultResponse' - delete: + $ref: '#/components/schemas/ScheduleUpdateScheduledefaultResponse' + get: tags: - Schedule - summary: Delete a schedule - operationId: Schedule_removeById - description: >- - Not yet available to projects that use GitLab or GitHub App. Deletes the - schedule by id. + summary: Get a schedule + operationId: Schedule_getById + description: Get a schedule by id. parameters: - description: The unique ID of the schedule. in: path @@ -2095,17 +2095,17 @@ paths: required: true responses: '200': - description: A confirmation message. + description: A schedule object. content: application/json: schema: - $ref: '#/components/schemas/ScheduleRemoveByIdResponse' + $ref: '#/components/schemas/ScheduleGetByIdResponse' default: description: Error response. content: application/json: schema: - $ref: '#/components/schemas/ScheduleRemoveByIddefaultResponse' + $ref: '#/components/schemas/ScheduleGetByIddefaultResponse' /user/{id}: get: tags: @@ -2200,12 +2200,12 @@ paths: $ref: >- #/components/schemas/WebhookCreateOutboundWebhookdefaultResponse /webhook/{webhook-id}: - delete: + get: tags: - Webhook - summary: Delete an outbound webhook - operationId: Webhook_deleteOutboundWebhook - description: Deletes an outbound webhook + summary: Get a webhook + operationId: Webhook_getById + description: Get an outbound webhook by id. parameters: - description: ID of the webhook (UUID) in: path @@ -2216,24 +2216,23 @@ paths: required: true responses: '200': - description: A confirmation message + description: A webhook content: application/json: schema: - $ref: '#/components/schemas/WebhookDeleteOutboundWebhookResponse' + $ref: '#/components/schemas/WebhookGetByIdResponse' default: description: Error response. content: application/json: schema: - $ref: >- - #/components/schemas/WebhookDeleteOutboundWebhookdefaultResponse - get: + $ref: '#/components/schemas/WebhookGetByIddefaultResponse' + delete: tags: - Webhook - summary: Get a webhook - operationId: Webhook_getById - description: Get an outbound webhook by id. + summary: Delete an outbound webhook + operationId: Webhook_deleteOutboundWebhook + description: Deletes an outbound webhook parameters: - description: ID of the webhook (UUID) in: path @@ -2244,17 +2243,18 @@ paths: required: true responses: '200': - description: A webhook + description: A confirmation message content: application/json: schema: - $ref: '#/components/schemas/WebhookGetByIdResponse' + $ref: '#/components/schemas/WebhookDeleteOutboundWebhookResponse' default: description: Error response. content: application/json: schema: - $ref: '#/components/schemas/WebhookGetByIddefaultResponse' + $ref: >- + #/components/schemas/WebhookDeleteOutboundWebhookdefaultResponse put: tags: - Webhook diff --git a/sdks/db/fixed-specs/eleven-labs-fixed-spec.yaml b/sdks/db/fixed-specs/eleven-labs-fixed-spec.yaml index 59dd7e4030..4563758434 100644 --- a/sdks/db/fixed-specs/eleven-labs-fixed-spec.yaml +++ b/sdks/db/fixed-specs/eleven-labs-fixed-spec.yaml @@ -5173,6 +5173,12 @@ components: - CAPTCHA_AND_MODERATION voice_verification: $ref: '#/components/schemas/VoiceVerificationResponseModel' + owner_id: + title: Owner Id + type: string + permission_on_resource: + title: Permission On Resource + type: string type: object required: - voice_id diff --git a/sdks/db/fixed-specs/git-lab-fixed-spec.yaml b/sdks/db/fixed-specs/git-lab-fixed-spec.yaml index 2feb3661fa..65212ad7a3 100644 --- a/sdks/db/fixed-specs/git-lab-fixed-spec.yaml +++ b/sdks/db/fixed-specs/git-lab-fixed-spec.yaml @@ -33,7 +33,7 @@ info: x-konfig-ignore: potential-incorrect-type: true servers: - - url: https://www.gitlab.com/api + - url: https://www.gitlab.com/api/v4 tags: - description: Operations about badges name: badges @@ -188,7 +188,7 @@ tags: - description: Operations related to Unleash API name: unleash_api paths: - /api/v4/groups/{id}/badges/{badge_id}: + /groups/{id}/badges/{badge_id}: get: tags: - badges @@ -277,12 +277,12 @@ paths: '204': description: Removes a badge from the group. content: {} - /api/v4/groups/{id}/badges: + /groups/{id}/badges: get: tags: - badges summary: Gets a list of group badges viewable by the authenticated user. - operationId: Badges_getList + operationId: Badges_listViewableByAuthenticatedUser description: This feature was introduced in GitLab 10.6. parameters: - description: >- @@ -318,12 +318,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BadgesGetListResponse' + $ref: >- + #/components/schemas/BadgesListViewableByAuthenticatedUserResponse post: tags: - badges summary: Adds a badge to a group. - operationId: Badges_addBadgeToGroup + operationId: Badges_addToGroup description: This feature was introduced in GitLab 10.6. parameters: - description: >- @@ -338,7 +339,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BadgesAddBadgeToGroupRequest' + $ref: '#/components/schemas/BadgesAddToGroupRequest' required: true responses: '201': @@ -347,12 +348,12 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Badge' - /api/v4/groups/{id}/badges/render: + /groups/{id}/badges/render: get: tags: - badges summary: Preview a badge from a group. - operationId: Badges_previewBadgeFromGroup + operationId: Badges_previewFromGroup description: This feature was introduced in GitLab 10.6. parameters: - description: >- @@ -382,12 +383,12 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BasicBadgeDetails' - /api/v4/groups/{id}/access_requests/{user_id}: + /groups/{id}/access_requests/{user_id}: delete: tags: - access_requests summary: Denies an access request for the given user. - operationId: Accessrequests_denyAccessToUser + operationId: Accessrequests_denyAccessRequest description: This feature was introduced in GitLab 8.11. parameters: - description: >- @@ -409,12 +410,12 @@ paths: '204': description: Denies an access request for the given user. content: {} - /api/v4/groups/{id}/access_requests/{user_id}/approve: + /groups/{id}/access_requests/{user_id}/approve: put: tags: - access_requests summary: Approves an access request for the given user. - operationId: Accessrequests_approveForUser + operationId: Accessrequests_approveUserAccess description: This feature was introduced in GitLab 8.11. parameters: - description: >- @@ -436,7 +437,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AccessrequestsApproveForUserRequest' + $ref: '#/components/schemas/AccessrequestsApproveUserAccessRequest' responses: '200': description: successful operation @@ -452,12 +453,12 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/groups/{id}/access_requests: + /groups/{id}/access_requests: get: tags: - access_requests summary: Gets a list of access requests for a group. - operationId: Accessrequests_getList + operationId: Accessrequests_getListForGroup description: This feature was introduced in GitLab 8.11. parameters: - description: >- @@ -493,7 +494,7 @@ paths: tags: - access_requests summary: Requests access for the authenticated user to a group. - operationId: Accessrequests_requestAccessToGroup + operationId: Accessrequests_authenticateUserToGroup description: This feature was introduced in GitLab 8.11. parameters: - description: >- @@ -519,11 +520,11 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/repository/merged_branches: + /projects/{id}/repository/merged_branches: delete: tags: - branches - operationId: Branches_deleteMerged + operationId: Branches_removeMergedBranches description: Delete all merged branches parameters: - description: The ID or URL-encoded path of the project @@ -539,7 +540,7 @@ paths: '404': description: 404 Project Not Found content: {} - /api/v4/projects/{id}/repository/branches/{branch}: + /projects/{id}/repository/branches/{branch}: get: tags: - branches @@ -596,7 +597,7 @@ paths: head: tags: - branches - operationId: Branches_checkIfExists + operationId: Branches_checkExistence description: Check if a branch exists parameters: - description: The ID or URL-encoded path of the project @@ -618,11 +619,11 @@ paths: '404': description: Not Found content: {} - /api/v4/projects/{id}/repository/branches: + /projects/{id}/repository/branches: get: tags: - branches - operationId: Branches_getAll + operationId: Branches_getProjectRepository description: Get a project repository branches parameters: - description: The ID or URL-encoded path of the project @@ -675,7 +676,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BranchesGetAllResponse' + $ref: '#/components/schemas/BranchesGetProjectRepositoryResponse' '404': description: 404 Project Not Found content: {} @@ -713,7 +714,7 @@ paths: '400': description: Failed to create branch content: {} - /api/v4/projects/{id}/repository/branches/{branch}/unprotect: + /projects/{id}/repository/branches/{branch}/unprotect: put: tags: - branches @@ -742,7 +743,7 @@ paths: '404': description: 404 Project Not Found content: {} - /api/v4/projects/{id}/repository/branches/{branch}/protect: + /projects/{id}/repository/branches/{branch}/protect: put: tags: - branches @@ -776,7 +777,7 @@ paths: '404': description: 404 Branch Not Found content: {} - /api/v4/projects/{id}/badges/{badge_id}: + /projects/{id}/badges/{badge_id}: get: tags: - badges @@ -865,7 +866,7 @@ paths: '204': description: Removes a badge from the project. content: {} - /api/v4/projects/{id}/badges: + /projects/{id}/badges: get: tags: - badges @@ -907,12 +908,12 @@ paths: application/json: schema: $ref: >- - #/components/schemas/BadgesListViewableByAuthenticatedUserResponse + #/components/schemas/BadgesListViewableByAuthenticatedUser200Response post: tags: - badges summary: Adds a badge to a project. - operationId: Badges_addProjectBadge + operationId: Badges_addToProject description: This feature was introduced in GitLab 10.6. parameters: - description: >- @@ -927,7 +928,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BadgesAddProjectBadgeRequest' + $ref: '#/components/schemas/BadgesAddToProjectRequest' required: true responses: '201': @@ -936,12 +937,12 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Badge' - /api/v4/projects/{id}/badges/render: + /projects/{id}/badges/render: get: tags: - badges summary: Preview a badge from a project. - operationId: Badges_renderPreviewFromProject + operationId: Badges_previewFromProject description: This feature was introduced in GitLab 10.6. parameters: - description: >- @@ -971,12 +972,12 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BasicBadgeDetails' - /api/v4/projects/{id}/access_requests/{user_id}: + /projects/{id}/access_requests/{user_id}: delete: tags: - access_requests summary: Denies an access request for the given user. - operationId: Accessrequests_denyAccessToUser + operationId: Accessrequests_denyAccessRequest description: This feature was introduced in GitLab 8.11. parameters: - description: >- @@ -998,12 +999,12 @@ paths: '204': description: Denies an access request for the given user. content: {} - /api/v4/projects/{id}/access_requests/{user_id}/approve: + /projects/{id}/access_requests/{user_id}/approve: put: tags: - access_requests summary: Approves an access request for the given user. - operationId: Accessrequests_approveForUser + operationId: Accessrequests_approveUserAccess description: This feature was introduced in GitLab 8.11. parameters: - description: >- @@ -1025,7 +1026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AccessrequestsApproveForUserRequest1' + $ref: '#/components/schemas/AccessrequestsApproveUserAccessRequest1' responses: '200': description: successful operation @@ -1041,12 +1042,12 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/access_requests: + /projects/{id}/access_requests: get: tags: - access_requests summary: Gets a list of access requests for a project. - operationId: Accessrequests_getList + operationId: Accessrequests_listForProject description: This feature was introduced in GitLab 8.11. parameters: - description: >- @@ -1108,11 +1109,11 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: put: tags: - alert_management - operationId: Alertmanagement_updateMetricImage + operationId: Alertmanagement_updateMetricImageForAlert description: Update a metric image for an alert parameters: - description: The ID or URL-encoded path of the project @@ -1139,7 +1140,8 @@ paths: content: multipart/form-data: schema: - $ref: '#/components/schemas/AlertmanagementUpdateMetricImageRequest' + $ref: >- + #/components/schemas/AlertmanagementUpdateMetricImageForAlertRequest responses: '200': description: Update a metric image for an alert @@ -1192,11 +1194,11 @@ paths: '422': description: Unprocessable entity content: {} - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images: get: tags: - alert_management - operationId: Alertmanagement_getMetricImagesForAlert + operationId: Alertmanagement_getMetricImages description: Metric Images for alert parameters: - description: The ID or URL-encoded path of the project @@ -1218,15 +1220,14 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/AlertmanagementGetMetricImagesForAlertResponse + $ref: '#/components/schemas/AlertmanagementGetMetricImagesResponse' '404': description: Not found content: {} post: tags: - alert_management - operationId: Alertmanagement_uploadMetricImage + operationId: Alertmanagement_uploadMetricImageForAlert description: Upload a metric image for an alert parameters: - description: The ID or URL-encoded path of the project @@ -1246,7 +1247,8 @@ paths: content: multipart/form-data: schema: - $ref: '#/components/schemas/AlertmanagementUploadMetricImageRequest' + $ref: >- + #/components/schemas/AlertmanagementUploadMetricImageForAlertRequest required: true responses: '200': @@ -1258,11 +1260,11 @@ paths: '403': description: Forbidden content: {} - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: post: tags: - alert_management - operationId: Alertmanagement_authorizeMetricImageUpload + operationId: Alertmanagement_authorizeMetricImageFileUpload description: Workhorse authorize metric image file upload parameters: - description: The ID or URL-encoded path of the project @@ -1285,7 +1287,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/admin/batched_background_migrations/{id}: + /admin/batched_background_migrations/{id}: get: tags: - batched_background_migrations @@ -1327,11 +1329,11 @@ paths: '404': description: 404 Not found content: {} - /api/v4/admin/batched_background_migrations: + /admin/batched_background_migrations: get: tags: - batched_background_migrations - operationId: Batchedbackgroundmigrations_list + operationId: Batchedbackgroundmigrations_listMigrations description: Get the list of batched background migrations parameters: - description: The name of the database, the default `main` @@ -1352,14 +1354,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchedbackgroundmigrationsListResponse' + $ref: >- + #/components/schemas/BatchedbackgroundmigrationsListMigrationsResponse '401': description: 401 Unauthorized content: {} '403': description: 403 Forbidden content: {} - /api/v4/admin/batched_background_migrations/{id}/resume: + /admin/batched_background_migrations/{id}/resume: put: tags: - batched_background_migrations @@ -1398,7 +1401,7 @@ paths: '422': description: You can resume only `paused` batched background migrations. content: {} - /api/v4/admin/batched_background_migrations/{id}/pause: + /admin/batched_background_migrations/{id}/pause: put: tags: - batched_background_migrations @@ -1437,11 +1440,11 @@ paths: '422': description: You can pause only `active` batched background migrations. content: {} - /api/v4/admin/ci/variables/{key}: + /admin/ci/variables/{key}: get: tags: - ci_variables - operationId: Civariables_getSpecificInstanceVariable + operationId: Civariables_getInstanceVariableDetails description: Get the details of a specific instance-level variable parameters: - description: The key of a variable @@ -1509,11 +1512,11 @@ paths: '404': description: Instance Variable Not Found content: {} - /api/v4/admin/ci/variables: + /admin/ci/variables: get: tags: - ci_variables - operationId: Civariables_listInstanceVariables + operationId: Civariables_listAllInstanceVariables description: List all instance-level variables parameters: - description: Current page number @@ -1540,13 +1543,14 @@ paths: post: tags: - ci_variables - operationId: Civariables_createNewInstanceVariable + operationId: Civariables_createNewInstanceLevelVariable description: Create a new instance-level variable requestBody: content: application/json: schema: - $ref: '#/components/schemas/CivariablesCreateNewInstanceVariableRequest' + $ref: >- + #/components/schemas/CivariablesCreateNewInstanceLevelVariableRequest required: true responses: '201': @@ -1558,7 +1562,7 @@ paths: '400': description: 400 Bad Request content: {} - /api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}: + /admin/databases/{database_name}/dictionary/tables/{table_name}: get: tags: - admin @@ -1596,12 +1600,12 @@ paths: '404': description: 404 Not found content: {} - /api/v4/admin/clusters/{cluster_id}: + /admin/clusters/{cluster_id}: get: tags: - clusters summary: Get a single instance cluster - operationId: Clusters_getSingleInstanceCluster + operationId: Clusters_getSingleInstance description: >- This feature was introduced in GitLab 13.2. Returns a single instance cluster. @@ -1693,12 +1697,12 @@ paths: '404': description: Not found content: {} - /api/v4/admin/clusters/add: + /admin/clusters/add: post: tags: - clusters summary: Add existing instance cluster - operationId: Clusters_addExistingKubernetesInstanceCluster + operationId: Clusters_addExistingInstance description: >- This feature was introduced in GitLab 13.2. Adds an existing Kubernetes instance cluster. @@ -1706,8 +1710,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/ClustersAddExistingKubernetesInstanceClusterRequest + $ref: '#/components/schemas/ClustersAddExistingInstanceRequest' required: true responses: '201': @@ -1725,7 +1728,7 @@ paths: '404': description: Not found content: {} - /api/v4/admin/clusters: + /admin/clusters: get: tags: - clusters @@ -1744,7 +1747,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/admin/migrations/{timestamp}/mark: + /admin/migrations/{timestamp}/mark: post: tags: - migrations @@ -1779,12 +1782,12 @@ paths: '422': description: You can mark only pending migrations content: {} - /api/v4/applications/{id}: + /applications/{id}: delete: tags: - applications summary: Delete an application - operationId: Applications_deleteSpecificApplication + operationId: Applications_removeSpecificApplication description: Delete a specific application parameters: - description: The ID of the application (not the application_id) @@ -1798,7 +1801,7 @@ paths: '204': description: Delete an application content: {} - /api/v4/applications: + /applications: get: tags: - applications @@ -1831,11 +1834,11 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_ApplicationWithSecret' - /api/v4/avatar: + /avatar: get: tags: - avatar - operationId: Avatar_getUrlForUser + operationId: Avatar_getUserAvatarUrl description: Return avatar url for a user parameters: - description: Public email address of the user @@ -1857,7 +1860,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Avatar' - /api/v4/broadcast_messages/{id}: + /broadcast_messages/{id}: get: tags: - broadcast_messages @@ -1883,7 +1886,7 @@ paths: tags: - broadcast_messages summary: Update a broadcast message - operationId: Broadcastmessages_updateMessage + operationId: Broadcastmessages_updateMessageById description: This feature was introduced in GitLab 8.12. parameters: - description: Broadcast message ID @@ -1897,7 +1900,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BroadcastmessagesUpdateMessageRequest' + $ref: '#/components/schemas/BroadcastmessagesUpdateMessageByIdRequest' responses: '200': description: Update a broadcast message @@ -1926,12 +1929,12 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BroadcastMessage' - /api/v4/broadcast_messages: + /broadcast_messages: get: tags: - broadcast_messages summary: Get all broadcast messages - operationId: Broadcastmessages_listAll + operationId: Broadcastmessages_getAllMessages description: This feature was introduced in GitLab 8.12. parameters: - description: Current page number @@ -1974,7 +1977,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BroadcastMessage' - /api/v4/bulk_imports/{import_id}/entities/{entity_id}: + /bulk_imports/{import_id}/entities/{entity_id}: get: tags: - bulk_imports @@ -2012,7 +2015,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/{import_id}/entities: + /bulk_imports/{import_id}/entities: get: tags: - bulk_imports @@ -2068,7 +2071,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/{import_id}: + /bulk_imports/{import_id}: get: tags: - bulk_imports @@ -2099,7 +2102,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/entities: + /bulk_imports/entities: get: tags: - bulk_imports @@ -2157,7 +2160,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports: + /bulk_imports: get: tags: - bulk_imports @@ -2219,13 +2222,13 @@ paths: tags: - bulk_imports summary: Start a new GitLab Migration - operationId: Bulkimports_startNewMigration + operationId: Bulkimports_startMigration description: This feature was introduced in GitLab 14.2. requestBody: content: application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/BulkimportsStartNewMigrationRequest' + $ref: '#/components/schemas/BulkimportsStartMigrationRequest' required: true responses: '200': @@ -2249,7 +2252,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/application/appearance: + /application/appearance: get: tags: - application @@ -2279,7 +2282,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Appearance' - /api/v4/application/plan_limits: + /application/plan_limits: get: tags: - plan_limits @@ -2321,13 +2324,13 @@ paths: tags: - plan_limits summary: Change plan limits - operationId: Planlimits_modifyLimits + operationId: Planlimits_modifyPlanLimits description: Modify the limits of a plan on the GitLab instance. requestBody: content: application/json: schema: - $ref: '#/components/schemas/PlanlimitsModifyLimitsRequest' + $ref: '#/components/schemas/PlanlimitsModifyPlanLimitsRequest' required: true responses: '200': @@ -2345,7 +2348,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/metadata: + /metadata: get: tags: - metadata @@ -2362,12 +2365,12 @@ paths: '401': description: Unauthorized content: {} - /api/v4/version: + /version: get: tags: - metadata summary: Retrieves version information for the GitLab instance - operationId: Metadata_getVersionInformation + operationId: Metadata_getVersionInfo description: >- This feature was introduced in GitLab 8.13 and deprecated in 15.5. We recommend you instead use the Metadata API. @@ -2381,7 +2384,7 @@ paths: '401': description: Unauthorized content: {} - /api/v4/projects/{id}/jobs: + /projects/{id}/jobs: get: tags: - jobs @@ -2409,12 +2412,12 @@ paths: application/json: schema: $ref: '#/components/schemas/JobsListForProjectResponse' - /api/v4/projects/{id}/jobs/{job_id}: + /projects/{id}/jobs/{job_id}: get: tags: - jobs summary: Get a single job by ID - operationId: Jobs_getSingleById + operationId: Jobs_getById parameters: - description: The ID of the project name: id @@ -2435,7 +2438,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Job' - /api/v4/projects/{id}/jobs/{job_id}/play: + /projects/{id}/jobs/{job_id}/play: post: tags: - jobs @@ -3254,7 +3257,7 @@ components: name: description: Name for the badge type: string - BadgesAddBadgeToGroupRequest: + BadgesAddToGroupRequest: required: - image_url - link_url @@ -3268,7 +3271,7 @@ components: name: description: Name for the badge type: string - AccessrequestsApproveForUserRequest: + AccessrequestsApproveUserAccessRequest: properties: access_level: description: 'A valid access level (defaults: `30`, the Developer role)' @@ -3294,7 +3297,7 @@ components: name: description: Name for the badge type: string - BadgesAddProjectBadgeRequest: + BadgesAddToProjectRequest: required: - image_url - link_url @@ -3308,14 +3311,14 @@ components: name: description: Name for the badge type: string - AccessrequestsApproveForUserRequest1: + AccessrequestsApproveUserAccessRequest1: properties: access_level: description: 'A valid access level (defaults: `30`, the Developer role)' type: integer format: int32 default: 30 - AlertmanagementUpdateMetricImageRequest: + AlertmanagementUpdateMetricImageForAlertRequest: properties: url: description: The url to view more metric info @@ -3323,7 +3326,7 @@ components: url_text: description: A description of the image or URL type: string - AlertmanagementUploadMetricImageRequest: + AlertmanagementUploadMetricImageForAlertRequest: required: - file properties: @@ -3383,7 +3386,7 @@ components: enum: - env_var - file - CivariablesCreateNewInstanceVariableRequest: + CivariablesCreateNewInstanceLevelVariableRequest: required: - key - value @@ -3452,7 +3455,7 @@ components: platform_kubernetes_attributes[namespace]: description: Unique namespace related to Project type: string - ClustersAddExistingKubernetesInstanceClusterRequest: + ClustersAddExistingInstanceRequest: required: - name - platform_kubernetes_attributes[api_url] @@ -3545,7 +3548,7 @@ components: and Single Page Apps are considered non-confidential. Defaults to true if not supplied type: boolean default: true - BroadcastmessagesUpdateMessageRequest: + BroadcastmessagesUpdateMessageByIdRequest: properties: message: description: Message to display @@ -3633,7 +3636,7 @@ components: dismissable: description: Is dismissable type: boolean - BulkimportsStartNewMigrationRequest: + BulkimportsStartMigrationRequest: required: - configuration[access_token] - configuration[url] @@ -3736,7 +3739,7 @@ components: email_header_and_footer_enabled: description: Add header and footer to all outgoing emails if enabled type: boolean - PlanlimitsModifyLimitsRequest: + PlanlimitsModifyPlanLimitsRequest: required: - plan_name properties: @@ -3832,23 +3835,23 @@ components: tree type: integer format: int32 - BadgesGetListResponse: + BadgesListViewableByAuthenticatedUserResponse: type: array items: $ref: '#/components/schemas/API_Entities_Badge' - BranchesGetAllResponse: + BranchesGetProjectRepositoryResponse: type: array items: $ref: '#/components/schemas/API_Entities_Branch' - BadgesListViewableByAuthenticatedUserResponse: + BadgesListViewableByAuthenticatedUser200Response: type: array items: $ref: '#/components/schemas/API_Entities_Badge' - AlertmanagementGetMetricImagesForAlertResponse: + AlertmanagementGetMetricImagesResponse: type: array items: $ref: '#/components/schemas/API_Entities_MetricImage' - BatchedbackgroundmigrationsListResponse: + BatchedbackgroundmigrationsListMigrationsResponse: type: array items: $ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration' diff --git a/sdks/db/fixed-specs/launch-darkly-fixed-spec.yaml b/sdks/db/fixed-specs/launch-darkly-fixed-spec.yaml index 1c3812fdf1..7074c7ada5 100644 --- a/sdks/db/fixed-specs/launch-darkly-fixed-spec.yaml +++ b/sdks/db/fixed-specs/launch-darkly-fixed-spec.yaml @@ -31566,14 +31566,14 @@ components: example: - user unitAggregationType: - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated type: string example: average enum: - average - sum analysisType: - description: The strategy for analyzing metric events + description: The method for analyzing metric events type: string example: mean enum: @@ -31581,9 +31581,9 @@ components: - percentile percentileValue: description: >- - The percentile, an integer denoting the target percentile between 0 - and 100. Only present when analysisType is - percentile. + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. type: integer example: 95 eventDefault: @@ -31673,12 +31673,25 @@ components: example: - user unitAggregationType: - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated type: string example: average enum: - average - sum + analysisType: + description: The method for analyzing metric events + type: string + example: mean + percentileValue: + description: >- + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. + type: integer + example: 95 + eventDefault: + $ref: '#/components/schemas/MetricEventDefaultRep' MetricRep: type: object required: @@ -31797,14 +31810,14 @@ components: example: - user unitAggregationType: - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated type: string example: average enum: - average - sum analysisType: - description: The strategy for analyzing metric events + description: The method for analyzing metric events type: string example: mean enum: @@ -31812,9 +31825,9 @@ components: - percentile percentileValue: description: >- - The percentile, an integer denoting the target percentile between 0 - and 100. Only present when analysisType is - percentile. + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. type: integer example: 95 eventDefault: diff --git a/sdks/db/fixed-specs/post-hog-fixed-spec.yaml b/sdks/db/fixed-specs/post-hog-fixed-spec.yaml index dde21a3606..7d63a633b9 100644 --- a/sdks/db/fixed-specs/post-hog-fixed-spec.yaml +++ b/sdks/db/fixed-specs/post-hog-fixed-spec.yaml @@ -14081,6 +14081,14 @@ components: type: string format: date-time readOnly: true + records_total_count: + description: >- + The total count of records that should be exported in this + BatchExportRun. + type: integer + maximum: 2147483647 + minimum: -2147483648 + nullable: true batch_export: description: The BatchExport this run belongs to. type: string diff --git a/sdks/db/fixed-specs/salesflare-fixed-spec.yaml b/sdks/db/fixed-specs/salesflare-fixed-spec.yaml new file mode 100644 index 0000000000..5f40f68f8c --- /dev/null +++ b/sdks/db/fixed-specs/salesflare-fixed-spec.yaml @@ -0,0 +1,30828 @@ +openapi: 3.0.0 +info: + title: Salesflare API + 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) + + + ## 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. + version: 1.0.0 + contact: + email: support@salesflare.com + x-logo: + url: https://lib.salesflare.com/api_docs/api_logo.png + backgroundColor: '#3d4d65' + altText: Salesflare logo +servers: + - url: https://api.salesflare.com +tags: + - name: Accounts + - name: Custom Fields + - name: Tags + - name: Workflows + - name: Contacts + - name: Opportunities + - name: Meetings + - name: Users + - name: Tasks + - name: Pipelines + - name: Internal Notes + - name: Groups + - name: Email Data Sources + - name: Calls + - name: Regional Settings + - name: Persons + - name: Filter Fields +paths: + /accounts: + get: + tags: + - Accounts + summary: List accounts + operationId: Accounts_listAccounts + 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: '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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + - name: limit + in: query + schema: + type: number + minimum: 1 + default: 10 + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/AccountsListAccountsResponse' + post: + tags: + - Accounts + summary: Create an account + operationId: Accounts_createAccount + parameters: + - name: update_if_exists + in: query + schema: + type: boolean + default: false + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountsCreateAccountRequest' + x-alternatives: + - type: object + properties: + tags: + type: array + 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: + description: Deprecated, will be ignored + type: string + description: + type: string + owner: + type: number + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + address: + type: object + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + zip: + type: string + _dirty: + description: Deprecated, will be ignored + type: boolean + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + type: array + 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: + description: Deprecated, will be ignored + type: boolean + required: + - email + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + number: + type: string + type: + type: string + _dirty: + description: Deprecated, will be ignored + type: boolean + required: + - number + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + _dirty: + description: Deprecated, will be ignored + type: boolean + links: + type: string + customers: + 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 + _dirty: + description: Deprecated, will be ignored + type: boolean + parent_account: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + - 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 + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/AccountsCreateAccountResponse' + /contacts: + get: + tags: + - Contacts + summary: List contacts + operationId: Contacts_listContacts + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/ContactsListContactsResponse' + post: + tags: + - Contacts + summary: Create a contact + operationId: Contacts_createContact + description: >- + 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 will not be created if a contact + with the same email address used to exist. + name: force + in: query + schema: + type: boolean + default: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactsCreateContactRequest' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/ContactsCreateContactResponse' + /currencies: + get: + tags: + - Regional Settings + summary: List supported currencies + operationId: RegionalSettings_listSupportedCurrencies + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: >- + #/components/schemas/RegionalSettingsListSupportedCurrenciesResponse + /groups: + get: + tags: + - Groups + summary: List groups + operationId: Groups_list + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GroupsListResponse' + /me: + get: + tags: + - Users + summary: Get current user's details + operationId: Users_getCurrentUserDetails + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/UsersGetCurrentUserDetailsResponse' + /opportunities: + get: + tags: + - Opportunities + summary: List opportunities + operationId: Opportunities_list + description: >- + 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 + 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: '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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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 + - x-alternatives: + - type: object + required: + - condition + - rules + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/OpportunitiesListResponse' + post: + tags: + - Opportunities + summary: Create an opportunity + operationId: Opportunities_createOpportunity + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpportunitiesCreateOpportunityRequest' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/OpportunitiesCreateOpportunityResponse' + /persons: + get: + tags: + - Persons + summary: List persons + operationId: Persons_list + 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 + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PersonsListResponse' + /pipelines: + get: + tags: + - Pipelines + summary: List pipelines + operationId: Pipelines_list + parameters: + - name: search + in: query + schema: + type: string + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PipelinesListResponse' + /stages: + get: + tags: + - Pipelines + summary: List stages + operationId: Pipelines_listStages + 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 + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PipelinesListStagesResponse' + /tags: + get: + tags: + - Tags + summary: List tags + operationId: Tags_list + parameters: + - x-constraint: + single: true + name: id + in: query + explode: true + schema: + type: array + items: + type: number + - description: >- + This property is deprecated, use q.search instead. When both are + provided, q.search will be 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/TagsListResponse' + post: + tags: + - Tags + summary: Create a tag + operationId: Tags_createTag + requestBody: + $ref: '#/components/requestBodies/postTagsBody' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/TagsCreateTagResponse' + /tasks: + get: + tags: + - Tasks + summary: List tasks + operationId: Tasks_listTasks + parameters: + - x-constraint: + single: true + name: id + in: query + explode: true + schema: + type: array + items: + type: number + - name: search + in: query + schema: + type: string + - description: Defaults to the user + x-constraint: + single: true + name: assignees + in: query + explode: true + schema: + type: array + items: + type: number + - x-constraint: + single: true + name: type + in: query + explode: true + schema: + type: array + items: + type: number + - x-constraint: + single: true + name: account + in: query + explode: true + schema: + type: array + items: + type: number + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + x-constraint: + single: true + name: order_by + in: query + explode: true + schema: + type: array + items: + type: string + - name: limit + in: query + schema: + type: number + - name: offset + in: query + schema: + type: number + - x-alternatives: + - type: object + required: + - condition + - rules + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/TasksListTasksResponse' + post: + tags: + - Tasks + summary: Create a task + operationId: Tasks_createTask + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TasksCreateTaskRequest' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/TasksCreateTaskResponse' + /users: + get: + tags: + - Users + summary: List users + operationId: Users_list + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + x-constraint: + single: true + name: order_by + in: query + explode: true + schema: + type: array + items: + type: string + - name: onlyEnabled + in: query + schema: + type: boolean + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/UsersListResponse' + /workflows: + get: + tags: + - Workflows + summary: List workflows + operationId: Workflows_list + parameters: + - name: limit + in: query + schema: + type: number + minimum: 1 + default: 20 + - name: offset + in: query + schema: + type: number + minimum: 0 + default: 0 + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/WorkflowsListResponse' + post: + tags: + - Workflows + summary: Create a workflow + operationId: Workflows_createWorkflow + requestBody: + $ref: '#/components/requestBodies/postWorkflowsBody' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/WorkflowsCreateWorkflowResponse' + /accounts/{account_id}: + get: + tags: + - Accounts + summary: Get account details + operationId: getAccountsAccount_id + parameters: + - name: account_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GetAccountsAccountIdResponse' + put: + tags: + - Accounts + summary: Update an account + operationId: putAccountsAccount_id + parameters: + - name: account_id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PutAccountsAccountIdRequest' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutAccountsAccountIdResponse' + delete: + tags: + - Accounts + summary: Delete an account + operationId: deleteAccountsAccount_id + parameters: + - name: account_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/DeleteAccountsAccountIdResponse' + /campaigns/mergefields: + get: + tags: + - Workflows + summary: Get a workflow's merge fields + operationId: Workflows_getMergeFields + description: >- + Note that this route is currently still under `/campaigns` but might be + moved in the future. + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/WorkflowsGetMergeFieldsResponse' + /conferences/{conference_id}: + get: + tags: + - Meetings + summary: Get meeting details by conference id + operationId: getConferencesConference_id + parameters: + - name: conference_id + in: path + required: true + schema: + type: string + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GetConferencesConferenceIdResponse' + /contacts/{contact_id}: + get: + tags: + - Contacts + summary: Get contact details + operationId: getContactsContact_id + parameters: + - name: contact_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GetContactsContactIdResponse' + put: + tags: + - Contacts + summary: Update a contact + operationId: putContactsContact_id + parameters: + - name: contact_id + in: path + required: true + schema: + type: number + - description: >- + When force is false, the contact's name will not be updated if the + name in the update is just the first part of the email address. + name: force + in: query + schema: + type: boolean + default: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PutContactsContactIdRequest' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutContactsContactIdResponse' + delete: + tags: + - Contacts + summary: Delete a contact + operationId: deleteContactsContact_id + parameters: + - name: contact_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/DeleteContactsContactIdResponse' + /customfields/types: + get: + tags: + - Custom Fields + summary: List custom field types + operationId: CustomFields_listTypes + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/CustomFieldsListTypesResponse' + /customfields/{itemClass}: + get: + tags: + - Custom Fields + summary: List custom fields of a type + operationId: CustomFields_listTypeCustomFields + 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 + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/CustomFieldsListTypeCustomFieldsResponse' + post: + tags: + - Custom Fields + summary: Create a custom field of a type + operationId: CustomFields_createFieldType + parameters: + - name: itemClass + in: path + required: true + schema: + type: string + enum: + - accounts + - contacts + - opportunities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomFieldsCreateFieldTypeRequest' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/CustomFieldsCreateFieldTypeResponse' + /datasources/email: + get: + tags: + - Email Data Sources + summary: List email data sources + operationId: EmailDataSources_list + 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 + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/EmailDataSourcesListResponse' + /filterfields/{entity}: + get: + tags: + - Filter Fields + summary: List filter fields for an entity + operationId: FilterFields_listForEntity + 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 + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/FilterFieldsListForEntityResponse' + /groups/{id}: + get: + tags: + - Groups + summary: Get a group + operationId: Groups_getById + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GroupsGetByIdResponse' + /me/contacts: + get: + tags: + - Users + summary: List current user's contacts + operationId: Users_listContacts + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - value + x-properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + collectionFormat: multi + name: value + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/UsersListContactsResponse' + /meetings/{meeting_id}: + get: + tags: + - Meetings + summary: Get meeting details + operationId: getMeetingsMeeting_id + parameters: + - name: meeting_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GetMeetingsMeetingIdResponse' + put: + tags: + - Meetings + summary: Update a meeting + operationId: putMeetingsMeeting_id + parameters: + - name: meeting_id + in: path + required: true + schema: + type: number + requestBody: + $ref: '#/components/requestBodies/putMeetingsMeeting_idBody' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutMeetingsMeetingIdResponse' + delete: + tags: + - Meetings + summary: Delete a meeting + operationId: deleteMeetingsMeeting_id + parameters: + - name: meeting_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/DeleteMeetingsMeetingIdResponse' + /opportunities/{id}: + get: + tags: + - Opportunities + summary: Get opportunity details + operationId: Opportunities_getDetails + parameters: + - name: id + in: path + required: true + schema: + type: number + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/OpportunitiesGetDetailsResponse' + put: + tags: + - Opportunities + summary: Update an opportunity + operationId: Opportunities_updateOpportunity + parameters: + - name: id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpportunitiesUpdateOpportunityRequest' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/OpportunitiesUpdateOpportunityResponse' + delete: + tags: + - Opportunities + summary: Delete an opportunity + operationId: Opportunities_removeOpportunity + parameters: + - name: id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/OpportunitiesRemoveOpportunityResponse' + /stages/{stage_id}: + get: + tags: + - Pipelines + summary: Get stage details + operationId: getStagesStage_id + parameters: + - name: stage_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GetStagesStageIdResponse' + /tags/{tag_id}: + get: + tags: + - Tags + summary: Get tag details + operationId: getTagsTag_id + parameters: + - name: tag_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GetTagsTagIdResponse' + put: + tags: + - Tags + summary: Update a tag + operationId: putTagsTag_id + parameters: + - name: tag_id + in: path + required: true + schema: + type: number + requestBody: + $ref: '#/components/requestBodies/postTagsBody' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutTagsTagIdResponse' + delete: + tags: + - Tags + summary: Delete a tag + operationId: deleteTagsTag_id + parameters: + - name: tag_id + in: path + required: true + schema: + type: number + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/DeleteTagsTagIdResponse' + /users/{id}: + get: + tags: + - Users + summary: Get user details + operationId: Users_getUserDetails + parameters: + - name: id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/UsersGetUserDetailsResponse' + /workflows/{id}: + get: + tags: + - Workflows + summary: Get workflow details + operationId: Workflows_getDetails + parameters: + - name: id + in: path + required: true + schema: + type: number + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/WorkflowsGetDetailsResponse' + put: + tags: + - Workflows + summary: Update a workflow + operationId: Workflows_updateWorkflow + parameters: + - name: id + in: path + required: true + schema: + type: number + requestBody: + $ref: '#/components/requestBodies/postWorkflowsBody' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/WorkflowsUpdateWorkflowResponse' + /accounts/{account_id}/messages: + get: + tags: + - Accounts + 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 + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GetAccountsAccountIdMessagesResponse' + /customfields/{itemClass}/{id}: + get: + tags: + - Custom Fields + summary: Get custom field details + operationId: CustomFields_getDetails + parameters: + - name: itemClass + in: path + required: true + schema: + type: string + enum: + - accounts + - contacts + - opportunities + - name: id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/CustomFieldsGetDetailsResponse' + put: + tags: + - Custom Fields + summary: Update a custom field + operationId: CustomFields_updateField + 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: + $ref: '#/components/schemas/CustomFieldsUpdateFieldRequest' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/CustomFieldsUpdateFieldResponse' + delete: + tags: + - Custom Fields + summary: Delete a custom field + operationId: CustomFields_deleteCustomField + parameters: + - name: itemClass + in: path + required: true + schema: + type: string + enum: + - accounts + - contacts + - opportunities + - name: id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/CustomFieldsDeleteCustomFieldResponse' + /tags/{tag_id}/usage: + get: + tags: + - Tags + 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 + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/GetTagsTagIdUsageResponse' + /customfields/{itemClass}/{customFieldApiField}/options: + get: + tags: + - Custom Fields + summary: List a custom field's options + operationId: CustomFields_listOptions + 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 + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/CustomFieldsListOptionsResponse' + /calls: + post: + tags: + - Calls + summary: Create a call + operationId: Calls_createCall + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CallsCreateCallRequest' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/CallsCreateCallResponse' + /meetings: + post: + tags: + - Meetings + summary: Create a meeting + operationId: Meetings_createMeeting + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MeetingsCreateMeetingRequest' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/MeetingsCreateMeetingResponse' + /messages: + post: + tags: + - Internal Notes + summary: Create an internal note + operationId: InternalNotes_createNote + requestBody: + $ref: '#/components/requestBodies/postMessagesBody' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/InternalNotesCreateNoteResponse' + /accounts/{account_id}/users: + post: + tags: + - Accounts + 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' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PostAccountsAccountIdUsersResponse' + put: + tags: + - Accounts + 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' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutAccountsAccountIdUsersResponse' + /accounts/{account_id}/contacts: + post: + tags: + - Accounts + 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' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PostAccountsAccountIdContactsResponse' + put: + tags: + - Accounts + 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' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutAccountsAccountIdContactsResponse' + /calls/{meeting_id}: + put: + tags: + - Calls + summary: Update a call + operationId: putCallsMeeting_id + parameters: + - name: meeting_id + in: path + required: true + schema: + type: number + requestBody: + $ref: '#/components/requestBodies/putMeetingsMeeting_idBody' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutCallsMeetingIdResponse' + /messages/{message_id}: + put: + tags: + - Internal Notes + summary: Update an internal note + operationId: putMessagesMessage_id + parameters: + - name: message_id + in: path + required: true + schema: + type: number + requestBody: + $ref: '#/components/requestBodies/postMessagesBody' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutMessagesMessageIdResponse' + delete: + tags: + - Internal Notes + summary: Delete an internal note + operationId: deleteMessagesMessage_id + parameters: + - name: message_id + in: path + required: true + schema: + type: number + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/DeleteMessagesMessageIdResponse' + /tasks/{id}: + put: + tags: + - Tasks + summary: Update a task + operationId: Tasks_updateTask + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TasksUpdateTaskRequest' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/TasksUpdateTaskResponse' + delete: + tags: + - Tasks + summary: Delete a task + operationId: Tasks_deleteTask + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/TasksDeleteTaskResponse' + /datasources/email/{id}: + put: + tags: + - Email Data Sources + summary: Update an email data source + operationId: EmailDataSources_updateDataSource + parameters: + - name: id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EmailDataSourcesUpdateDataSourceRequest' + responses: + default: + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/EmailDataSourcesUpdateDataSourceResponse' + /workflows/{id}/audience/{record_id}: + put: + tags: + - Workflows + summary: 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: + $ref: '#/components/schemas/PutWorkflowsIdAudienceRecordIdRequest' + responses: + '200': + description: Successful + content: + '*/*': + schema: + $ref: '#/components/schemas/PutWorkflowsIdAudienceRecordIdResponse' +components: + requestBodies: + postAccountsAccount_idUsersBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostAccountsAccountIdUsersRequest' + postMessagesBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InternalNotesCreateNoteRequest' + putMeetingsMeeting_idBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PutMeetingsMeetingIdRequest' + x-alternatives: + - type: object + properties: + calendar_id: + type: string + external_id: + type: string + minutes: + description: >- + The use of this property is deprecated. Use the notes property + instead. + type: string + notes: + description: The only property you can modify on calendar meetings. + type: string + edited_by: + type: number + required: + - calendar_id + - external_id + - notes + - type: object + properties: + description: + type: string + date: + type: string + format: date-time + end_date: + type: string + format: date-time + subject: + type: string + maxLength: 200 + minutes: + description: >- + The use of this property is deprecated. Use the notes property + instead. + type: string + 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 + postWorkflowsBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkflowsCreateWorkflowRequest' + postTagsBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagsCreateTagRequest' + schemas: + AccountsCreateAccountRequest: + type: object + properties: + tags: + type: array + 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: + description: Deprecated, will be ignored + type: string + description: + type: string + owner: + type: number + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + address: + type: object + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + zip: + type: string + _dirty: + description: Deprecated, will be ignored + type: boolean + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + type: array + 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: + description: Deprecated, will be ignored + type: boolean + required: + - email + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + number: + type: string + type: + type: string + _dirty: + description: Deprecated, will be ignored + type: boolean + required: + - number + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + _dirty: + description: Deprecated, will be ignored + type: boolean + links: + type: string + customers: + 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 + _dirty: + description: Deprecated, will be ignored + type: boolean + parent_account: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + ContactsCreateContactRequest: + type: array + x-constraint: + single: true + items: + type: object + properties: + tags: + type: array + 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: + description: Deprecated, will be ignored + type: string + owner: + type: number + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + prefix: + type: string + firstname: + type: string + middle: + type: string + lastname: + type: string + suffix: + type: string + name: + type: string + picture: + type: string + maxLength: 500 + account: + description: >- + Any existing account will be removed from the contact when + specifically passing `null`! + type: number + birth_date: + type: string + format: date-time + 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 + address: + type: object + properties: + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + 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: + number: + type: string + type: + type: string + required: + - number + position: + type: object + properties: + organisation: + type: string + role: + type: string + positions: + type: array + items: + type: object + properties: + organisation: + type: string + role: + type: string + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + custom: + type: object + OpportunitiesCreateOpportunityRequest: + type: object + properties: + tags: + type: array + 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: + description: Deprecated, will be ignored + type: string + owner: + type: number + x-alternatives: + - type: number + - type: object + - type: string + account: + type: number + x-alternatives: + - type: number + - type: object + stage: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + x-constraint: + sign: positive + order: + type: number + probability: + type: number + fixed_stage: + type: number + required: + - id + - order + - probability + - type: string + lost_reason: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + - type: string + files: + type: array + items: + type: object + lead_source: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + start_date: + type: string + format: date-time + probability: + type: number + minimum: 0 + assignee: + type: number + x-alternatives: + - type: number + - type: object + - type: string + creator: + type: number + x-alternatives: + - type: number + - type: object + - type: string + status: + description: DEPRECATED + type: string + name: + type: string + value: + type: number + minimum: 0 + currency: + type: number + status_date: + description: DEPRECATED + type: string + close_date: + type: string + format: date-time + closed: + type: boolean + recurring_price_per_unit: + type: number + frequency: + type: string + enum: + - annually + - weekly + - monthly + - daily + x-convert: + case: lower + units: + type: number + contract_start_date: + type: string + format: date-time + contract_end_date: + type: string + format: date-time + main_contact: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + required: + - account + TagsCreateTagRequest: + type: object + properties: + name: + type: string + required: + - name + TasksCreateTaskRequest: + type: array + x-constraint: + single: true + items: + type: object + properties: + description: + type: string + account: + type: number + reminder_date: + type: string + format: date + default: '2024-03-27T13:03:17.281Z' + assignees: + type: array + x-constraint: + single: true + items: + type: number + required: + - description + WorkflowsCreateWorkflowRequest: + type: object + properties: + name: + type: string + filter: + description: When you pass `ids` all other filter options will be ignored + x-alternatives: + - description: When you pass `ids` all other filter options will be ignored + type: object + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + x-alternatives: + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + PutAccountsAccountIdRequest: + type: object + properties: + tags: + type: array + 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: + description: Deprecated, will be ignored + type: string + description: + type: string + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + address: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + 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 + trim: true + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + id: + type: number + number: + type: string + type: + type: string + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + social_profiles: + type: array + 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: + description: Deprecated, will be ignored + type: boolean + links: + type: string + _dirty: + description: Deprecated, will be ignored + type: boolean + parent_account: + type: number + required: + - parent_account + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + required: + - id + custom: + type: object + q: + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, `is_not_null`, + `true` and `false` are deprecated and should not be + used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + required: + - condition + - rules + PutContactsContactIdRequest: + type: object + properties: + tags: + type: array + 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: + description: Deprecated, will be ignored + type: string + prefix: + type: string + firstname: + type: string + middle: + type: string + lastname: + type: string + suffix: + type: string + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + role: + type: string + name: + type: string + owner: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + required: + - id + - type: string + picture: + type: string + account: + description: >- + Any existing account will be removed from the contact when + specifically passing `null`! + type: number + birth_date: + type: string + format: date-time + 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 + address: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + 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 + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + position: + type: object + properties: + id: + type: number + organisation: + type: string + role: + type: string + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + positions: + type: array + items: + type: object + properties: + id: + type: number + organisation: + type: string + role: + type: string + archived: + type: boolean + _dirty: + description: Deprecated, will be ignored + type: boolean + social_profiles: + type: array + 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: + description: Deprecated, will be ignored + type: boolean + custom: + type: object + _dirty: + description: Deprecated, will be ignored + type: boolean + archived: + type: boolean + CustomFieldsCreateFieldTypeRequest: + 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 + PutMeetingsMeetingIdRequest: + type: object + properties: + calendar_id: + type: string + external_id: + type: string + minutes: + description: >- + The use of this property is deprecated. Use the notes property + instead. + type: string + notes: + description: The only property you can modify on calendar meetings. + type: string + edited_by: + type: number + required: + - calendar_id + - external_id + - notes + OpportunitiesUpdateOpportunityRequest: + type: object + properties: + tags: + type: array + 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: + description: Deprecated, will be ignored + type: string + owner: + type: number + x-alternatives: + - type: number + - type: object + account: + type: number + x-alternatives: + - type: number + - type: object + stage: + type: number + x-constraint: + sign: positive + x-alternatives: + - type: number + x-constraint: + sign: positive + - type: object + properties: + id: + type: number + order: + type: number + probability: + type: number + fixed_stage: + type: number + required: + - id + - order + - probability + lost_reason: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + files: + type: array + items: + type: object + lead_source: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + start_date: + type: string + format: date-time + probability: + type: number + minimum: 0 + assignee: + type: number + x-alternatives: + - type: number + - type: object + - type: string + creator: + type: number + x-alternatives: + - type: number + - type: object + - type: string + name: + type: string + value: + type: number + minimum: 0 + close_date: + type: string + format: date-time + closed: + type: boolean + done: + type: boolean + recurring_price_per_unit: + type: number + frequency: + type: string + enum: + - annually + - weekly + - monthly + - daily + x-convert: + case: lower + units: + type: number + contract_start_date: + type: string + format: date-time + contract_end_date: + type: string + format: date-time + main_contact: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + CustomFieldsUpdateFieldRequest: + type: object + properties: + id: + type: number + type: + description: DEPRECATED + type: number + 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 + CallsCreateCallRequest: + type: array + x-constraint: + single: true + items: + type: object + properties: + description: + type: string + date: + type: string + format: date-time + end_date: + type: string + format: date-time + subject: + type: string + maxLength: 200 + minutes: + description: >- + The use of this property is deprecated. Use the notes property + instead. + type: string + notes: + type: string + phone_type: + type: string + phone_number_hash: + type: string + participants: + description: No participants is possible for call log sync + type: array + items: + type: number + required: + - date + - participants + MeetingsCreateMeetingRequest: + type: array + x-constraint: + single: true + items: + type: object + properties: + description: + type: string + date: + type: string + format: date-time + end_date: + type: string + format: date-time + subject: + type: string + maxLength: 200 + minutes: + description: >- + The use of this property is deprecated. Use the notes property + instead. + type: string + notes: + type: string + phone_type: + type: string + phone_number_hash: + type: string + participants: + description: No participants is possible for call log sync + type: array + items: + type: number + type: + type: string + default: meeting-live + enum: + - meeting-live + - meeting-phone + required: + - date + - participants + InternalNotesCreateNoteRequest: + type: object + properties: + account: + type: number + body: + type: string + mentions: + type: array + items: + type: number + date: + type: string + format: date-time + required: + - account + - body + PostAccountsAccountIdUsersRequest: + type: array + minItems: 1 + x-constraint: + single: true + items: + type: object + properties: + id: + type: number + _dirty: + type: boolean + _deleted: + type: boolean + TasksUpdateTaskRequest: + type: object + properties: + description: + type: string + account: + type: number + reminder_date: + type: string + format: date + assignees: + type: array + x-constraint: + single: true + items: + type: number + completed: + type: boolean + EmailDataSourcesUpdateDataSourceRequest: + 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 + PutWorkflowsIdAudienceRecordIdRequest: + type: object + properties: + exited: + description: >- + Setting `exited` of a workflow record to `false` is currently not + possible. + type: boolean + met_goal: + description: >- + Setting `met_goal` of a workflow record to `false` is currently not + possible. + type: boolean + AccountsListAccountsResponse: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + required: + - id + description: + type: string + id: + type: number + owner: + type: object + properties: + id: + type: number + name: + type: string + email: + type: string + picture: + type: string + required: + - id + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + last_interaction_date: + type: string + format: date-time + creation_date: + type: string + format: date-time + modification_date: + type: string + format: date-time + part_of: + type: boolean + hotness: + type: number + can_edit: + type: boolean + last_interaction: + type: object + properties: + description: + type: string + type: + type: string + date: + type: string + format: date-time + person: + type: object + properties: + id: + type: number + picture: + type: string + name: + type: string + last_email_date: + type: string + format: date-time + last_meeting_date: + type: string + format: date-time + social_profiles: + type: array + items: + type: object + properties: + id: + type: number + type: + type: string + url: + type: string + username: + type: string + required: + - id + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + required: + - id + email_addresses: + type: array + items: + type: object + properties: + id: + type: number + email: + type: string + phone_numbers: + type: array + items: + type: object + properties: + id: + type: number + number: + type: string + type: + type: string + parent_account: + type: object + properties: + id: + type: number + name: + type: string + domain: + type: string + picture: + type: string + entity: + type: string + enum: + - account + required: + - id + custom: + type: object + required: + - id + - domain + AccountsCreateAccountResponse: + type: string + ContactsListContactsResponse: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + required: + - id + 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 + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + 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 + required: + - id + ContactsCreateContactResponse: + type: array + x-constraint: + single: true + items: + type: object + properties: + id: + type: number + RegionalSettingsListSupportedCurrenciesResponse: + type: array + items: + type: object + properties: + id: + type: number + iso: + type: string + x-constraint: + length: 3 + html: + type: string + GroupsListResponse: + type: string + UsersGetCurrentUserDetailsResponse: + type: object + properties: + tags: + type: array + items: + type: object + 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 + campaign: + type: string + is_referred: + type: boolean + credit_usage: + type: number + credit_quota: + type: number + credit_package: + type: string + enum: + - S + - M + - L + - XL + 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 + 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 + referral_code: + type: string + referral_reward: + type: number + is_delinquent: + type: boolean + 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 + intercom_hash: + type: string + x-format: + hex: + byteAligned: false + first_day_of_week: + type: number + 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 + OpportunitiesListResponse: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + required: + - id + 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 + 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 + 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: + iso: + type: string + required: + - iso + close_date: + type: string + closed: + type: boolean + 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: + description: + type: string + type: + type: string + date: + type: string + format: date-time + person: + type: object + properties: + id: + type: number + picture: + type: string + name: + type: string + 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 + main_contact: + type: object + properties: + id: + type: number + name: + type: string + email: + type: string + picture: + type: string + entity: + type: string + enum: + - contact + required: + - id + custom: + type: object + last_stage_change_date: + type: string + format: date + required: + - id + OpportunitiesCreateOpportunityResponse: + type: object + properties: + id: + type: number + PersonsListResponse: + type: string + PipelinesListResponse: + 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 + PipelinesListStagesResponse: + type: string + TagsListResponse: + 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 + TagsCreateTagResponse: + type: object + properties: + id: + type: number + required: + - id + TasksListTasksResponse: + type: array + items: + type: object + properties: + description: + type: string + id: + type: number + type: + type: string + enum: + - meeting_notes + - email_reply + - account_inactive + - suggested_contact + - suggested_account + - manual_task + - meeting + meeting_type: + type: boolean + account: + type: object + properties: + id: + type: number + name: + type: string + picture: + type: string + creator: + type: number + reminder_date: + type: string + format: date-time + company: + type: number + meeting: + type: object + properties: + id: + type: number + subject: + type: string + conference_url: + type: string + required: + - id + email: + type: object + properties: + id: + type: number + email_message_id: + type: string + subject: + type: string + data_source: + type: number + service_message_id: + type: string + required: + - id + - email_message_id + - subject + completed: + type: boolean + completion_date: + type: string + format: date-time + completor: + type: number + archived: + type: boolean + archive_date: + type: string + format: date-time + archivor: + 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 + assignees: + type: array + items: + type: object + properties: + id: + type: number + email: + type: string + picture: + type: string + name: + type: string + disabled: + type: boolean + TasksCreateTaskResponse: + type: object + properties: + id: + type: number + UsersListResponse: + type: string + WorkflowsListResponse: + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + WorkflowsCreateWorkflowResponse: + type: object + properties: + id: + type: number + DeleteAccountsAccountIdResponse: + type: string + GetAccountsAccountIdResponse: + type: string + PutAccountsAccountIdResponse: + type: string + WorkflowsGetMergeFieldsResponse: + 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 + GetConferencesConferenceIdResponse: + type: string + DeleteContactsContactIdResponse: + type: string + GetContactsContactIdResponse: + type: string + PutContactsContactIdResponse: + type: string + CustomFieldsListTypesResponse: + type: string + CustomFieldsListTypeCustomFieldsResponse: + type: string + CustomFieldsCreateFieldTypeResponse: + type: object + properties: + id: + type: number + EmailDataSourcesListResponse: + 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 + 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 + FilterFieldsListForEntityResponse: + 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 + group: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + entity: + type: string + enum: + - account + - person + - opportunity + - campaign + - tag + - task + - workflow + - workflow_record + - workflow_step_record + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + 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 + pipeline: + type: number + enabled: + type: string + param_less: + type: boolean + required: + - id + - customfield_id + - label + - type + - enabled + GroupsGetByIdResponse: + type: string + UsersListContactsResponse: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + required: + - id + 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 + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + description: Deprecated property. Use state_region instead. + type: string + 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 + required: + - id + DeleteMeetingsMeetingIdResponse: + type: string + GetMeetingsMeetingIdResponse: + type: string + PutMeetingsMeetingIdResponse: + type: string + OpportunitiesRemoveOpportunityResponse: + type: string + OpportunitiesGetDetailsResponse: + type: object + properties: + tags: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + required: + - id + 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 + closed: + type: boolean + 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: + description: + type: string + type: + 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 + 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 + OpportunitiesUpdateOpportunityResponse: + type: string + GetStagesStageIdResponse: + type: string + DeleteTagsTagIdResponse: + type: object + properties: + success: + type: boolean + enum: + - true + GetTagsTagIdResponse: + type: string + PutTagsTagIdResponse: + type: object + properties: + success: + type: boolean + UsersGetUserDetailsResponse: + type: string + WorkflowsGetDetailsResponse: + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are + deprecated and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + x-alternatives: + - description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + id: + type: string + operator: + description: >- + `is_empty`, `is_not_empty`, `is_null`, + `is_not_null`, `true` and `false` are deprecated + and should not be used. + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `value` + type: object + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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: + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + WorkflowsUpdateWorkflowResponse: + type: object + properties: + success: + type: boolean + GetAccountsAccountIdMessagesResponse: + type: string + CustomFieldsDeleteCustomFieldResponse: + type: string + CustomFieldsGetDetailsResponse: + type: string + CustomFieldsUpdateFieldResponse: + type: string + GetTagsTagIdUsageResponse: + type: string + CustomFieldsListOptionsResponse: + type: string + CallsCreateCallResponse: + type: string + MeetingsCreateMeetingResponse: + type: string + InternalNotesCreateNoteResponse: + type: string + PostAccountsAccountIdUsersResponse: + type: string + PutAccountsAccountIdUsersResponse: + type: string + PostAccountsAccountIdContactsResponse: + type: string + PutAccountsAccountIdContactsResponse: + type: string + PutCallsMeetingIdResponse: + type: string + DeleteMessagesMessageIdResponse: + type: string + PutMessagesMessageIdResponse: + type: string + TasksDeleteTaskResponse: + type: object + properties: + success: + type: boolean + TasksUpdateTaskResponse: + type: object + properties: + success: + type: boolean + EmailDataSourcesUpdateDataSourceResponse: + type: string + PutWorkflowsIdAudienceRecordIdResponse: + type: object + properties: + success: + type: boolean +x-tagGroups: + - tags: + - Tasks + - Accounts + - Contacts + - Opportunities + - Workflows + - Insights + name: General + - tags: + - Calls + - Meetings + - Internal Notes + name: Interactions + - tags: + - Users + - Groups + name: User Management + - tags: + - Regional Settings + - Pipelines + - Custom Fields + - Email Data Sources + - Tags + - Filter Fields + - Persons + name: Configuration diff --git a/sdks/db/fixed-specs/terminal-fixed-spec.yaml b/sdks/db/fixed-specs/terminal-fixed-spec.yaml index 7d16350865..d494ac50bc 100644 --- a/sdks/db/fixed-specs/terminal-fixed-spec.yaml +++ b/sdks/db/fixed-specs/terminal-fixed-spec.yaml @@ -106,7 +106,7 @@ paths: in: query schema: type: string - example: sunt do est sit + example: non mollit reprehenderit - description: Filter connections that were last updated on or after a given time. name: updatedAfter in: query @@ -146,18 +146,18 @@ paths: - Tag Name - Tag Name backfill: - days: 18640422.26015696 + days: 5757343.118591592 startFrom: '2021-01-06T03:24:53.000Z' company: dotNumbers: - - do pariatur non - - adi - name: est aute + - pariatur est + - voluptate qui dolor + name: aute ut qui en credentials: - database: ut incididunt - password: esse consequat - username: ipsum quis eiusmod Ut - externalId: ipsum enim + database: nisi c + password: minim labore incididunt deserunt + username: aute in laboris + externalId: elit commodo in sunt provider: geotab syncMode: automatic responses: @@ -211,12 +211,12 @@ paths: Update Current Connection: value: tags: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu company: name: Acme Inc. - externalId: Excepteur enim irure - status: mollit sunt aliquip + externalId: pariatur dolor minim + status: do syncMode: automatic responses: '200': @@ -694,13 +694,13 @@ paths: in: query schema: type: string - example: '1984-11-05' + example: '1992-10-05' - description: Only include daily logs from on or before a specific date name: endDate in: query schema: type: string - example: '1984-11-05' + example: '1992-10-05' - description: Only include records that were last modified after a provided date. name: modifiedAfter in: query @@ -846,13 +846,13 @@ paths: in: query schema: type: string - example: '1957-08-03' + example: '1999-09-28' - description: Timestamp to end when the issue was last observed name: lastReportedBefore in: query schema: type: string - example: '1957-08-03' + example: '1999-09-28' - description: Expand related resources to see all details name: expand in: query @@ -870,7 +870,7 @@ paths: in: query schema: type: string - example: unknown_device_type + example: missing_permissions - description: Filter issues to a specific status name: status in: query @@ -888,7 +888,7 @@ paths: required: true schema: type: string - example: sunt do est sit + example: non mollit reprehenderit post: tags: - Issues @@ -1566,7 +1566,7 @@ components: properties: days: type: number - example: 18640422.26015696 + example: 5757343.118591592 startFrom: type: string example: '2021-01-06T03:24:53.000Z' @@ -1577,28 +1577,28 @@ components: type: array items: type: string - example: do pariatur non + example: pariatur est example: - - do pariatur non - - adi + - pariatur est + - voluptate qui dolor name: type: string - example: est aute + example: aute ut qui en credentials: type: object properties: database: type: string - example: ut incididunt + example: nisi c password: type: string - example: esse consequat + example: minim labore incididunt deserunt username: type: string - example: ipsum quis eiusmod Ut + example: aute in laboris externalId: type: string - example: ipsum enim + example: elit commodo in sunt provider: type: string example: geotab @@ -1612,10 +1612,10 @@ components: type: array items: type: string - example: laboris s + example: Excepteur Ut example: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu company: type: object properties: @@ -1624,10 +1624,10 @@ components: example: Acme Inc. externalId: type: string - example: Excepteur enim irure + example: pariatur dolor minim status: type: string - example: mollit sunt aliquip + example: do syncMode: type: string example: automatic diff --git a/sdks/db/fixed-specs/vimeo-fixed-spec.yaml b/sdks/db/fixed-specs/vimeo-fixed-spec.yaml index be028b76c1..8c7441677c 100644 --- a/sdks/db/fixed-specs/vimeo-fixed-spec.yaml +++ b/sdks/db/fixed-specs/vimeo-fixed-spec.yaml @@ -25384,30 +25384,50 @@ components: connections: properties: video: - description: The associated video object. + description: >- + The associated video object. This data requires a bearer + token with the `private` scope. properties: title: - description: The title of the associated video. + description: >- + The title of the associated video. This data requires a + bearer token with the `private` scope. type: string created_time: - description: The time in ISO 8601 format when the video was created. + description: >- + The time in ISO 8601 format when the video was created. + This data requires a bearer token with the `private` + scope. example: '2018-03-05T21:04:47+00:00' type: string duration: - description: The duration of the associated video. + description: >- + The duration of the associated video. This data requires + a bearer token with the `private` scope. type: number + manage_link: + description: >- + The link to the video management page. This data + requires a bearer token with the `private` scope. + example: /manage/videos/258684937 + type: string options: - description: An array of HTTP methods permitted on this URI. + description: >- + An array of HTTP methods permitted on this URI. This + data requires a bearer token with the `private` scope. items: type: string type: array uri: - description: The API URI that resolves to the connection data. + description: >- + The API URI that resolves to the connection data. This + data requires a bearer token with the `private` scope. example: /videos/152184 type: string required: - created_time - duration + - manage_link - options - title - uri @@ -34516,6 +34536,10 @@ components: description: The translated display name of the role. example: Admin type: string + is_disabled: + description: Whether the role is disabled for certain team members. + example: false + type: boolean permission_level: description: | The untranslated role of the user who made the request. diff --git a/sdks/db/fixed-specs/ynab-fixed-spec.yaml b/sdks/db/fixed-specs/ynab-fixed-spec.yaml index eeac5d6eed..6d63550f6e 100644 --- a/sdks/db/fixed-specs/ynab-fixed-spec.yaml +++ b/sdks/db/fixed-specs/ynab-fixed-spec.yaml @@ -844,7 +844,7 @@ paths: - Transactions summary: List transactions operationId: Transactions_listTransactions - description: Returns budget transactions + description: Returns budget transactions, excluding any pending transactions parameters: - description: >- The id of the budget. "last-used" can be used to specify the last @@ -1177,7 +1177,9 @@ paths: - Transactions summary: List account transactions operationId: Transactions_listByAccount - description: Returns all transactions for a specified account + description: >- + Returns all transactions for a specified account, excluding any pending + transactions parameters: - description: >- The id of the budget. "last-used" can be used to specify the last @@ -1243,7 +1245,7 @@ paths: get: tags: - Transactions - summary: List category transactions + summary: List category transactions, excluding any pending transactions operationId: Transactions_listByCategory description: Returns all transactions for a specified category parameters: @@ -1311,7 +1313,7 @@ paths: get: tags: - Transactions - summary: List payee transactions + summary: List payee transactions, excluding any pending transactions operationId: Transactions_listByPayee description: Returns all transactions for a specified payee parameters: diff --git a/sdks/db/generate-repository-description-cache/salesflare.json b/sdks/db/generate-repository-description-cache/salesflare.json new file mode 100644 index 0000000000..3686d163e3 --- /dev/null +++ b/sdks/db/generate-repository-description-cache/salesflare.json @@ -0,0 +1,3 @@ +{ + "Salesflare is the intelligent CRM startups and small businesses love to use. It's a zero-input sales pipeline tool that thinks and works for its user, not the other way around.\n\nNo more manual data entry. Salesflare fills out your address book and keeps track of all interactions with the people you're in contact with. It takes data from social media, company databases, phone, email, calendar and hands it to you in automated customer timelines that tell you everything you need to know. You just have to write the emails, make the calls, and have the coffee.\n\nNever miss a deal again. Salesflare will tell and remind you what to do about leads so deals can't fall through the cracks anymore. Visual pipelines and powerful insights put you in full control of your sales funnel. Intuitive and easy-to-use, Salesflare turns complexity into simplicity so you can turn leads into customers.\n\nSalesflare works wherever you work and with whatever you are working with. Use it on desktop, mobile or just from a sidebar in your email inbox (Gmail and Outlook). Get even more out of Salesflare by integrating with 5000+ other productivity tools, such as Google Apps, MailChimp, Trello and Slack.\n\nThere's a free trial available from salesflare.com.": "Salesflare is an intelligent CRM for startups and small businesses. It automates data input, organizes interactions, and provides insights to boost sales. Accessible on desktop, mobile, and email platforms with 5000+ integrations. Salesflare's {language} SDK generated by Konfig (https://konfigthis.com/)." +} \ No newline at end of file diff --git a/sdks/db/intermediate-fixed-specs/circleci/openapi.yaml b/sdks/db/intermediate-fixed-specs/circleci/openapi.yaml index 19199058e8..102a5ff35c 100644 --- a/sdks/db/intermediate-fixed-specs/circleci/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/circleci/openapi.yaml @@ -27,96 +27,6 @@ tags: description: '[__EXPERIMENTAL__] Endpoints related to creating and managing a project.' paths: /context: - get: - summary: List contexts - description: List all contexts for an owner. - tags: - - Context - operationId: listContexts - responses: - '200': - description: A paginated list of contexts - content: - application/json: - schema: - type: object - properties: - items: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - description: The unique ID of the context. - name: - type: string - description: The user defined name of the context. - created_at: - type: string - format: date-time - description: The date and time the context was created. - example: '2015-09-21T17:29:21.042Z' - required: - - id - - name - - created_at - title: Context - next_page_token: - type: string - x-nullable: true - description: >- - A token to pass as a `page-token` query parameter to - return the next page of results. - required: - - items - - next_page_token - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: query - name: owner-id - description: >- - The unique ID of the owner of the context. Specify either this or - owner-slug. - schema: - type: string - format: uuid - required: false - - in: query - name: owner-slug - description: >- - A string that represents an organization. Specify either this or - owner-id. Cannot be used for accounts. - schema: - type: string - required: false - - in: query - name: owner-type - description: >- - The type of the owner. Defaults to "organization". Accounts are only - used as context owners in server. - schema: - type: string - enum: - - account - - organization - required: false - - in: query - name: page-token - description: A token to retrieve the next page of results. - schema: - type: string - required: false - allowEmptyValue: true post: summary: Create a new context description: Creates a new context. @@ -207,27 +117,51 @@ paths: required: - name - owner - /context/{context-id}: - delete: - summary: Delete a context + get: + summary: List contexts + description: List all contexts for an owner. tags: - Context - operationId: deleteContext + operationId: listContexts responses: '200': - description: A confirmation message + description: A paginated list of contexts content: application/json: schema: type: object properties: - message: + items: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + description: The unique ID of the context. + name: + type: string + description: The user defined name of the context. + created_at: + type: string + format: date-time + description: The date and time the context was created. + example: '2015-09-21T17:29:21.042Z' + required: + - id + - name + - created_at + title: Context + next_page_token: type: string - description: A human-readable message + x-nullable: true + description: >- + A token to pass as a `page-token` query parameter to + return the next page of results. required: - - message - description: message response - title: MessageResponse + - items + - next_page_token default: content: application/json: @@ -238,13 +172,42 @@ paths: type: string description: Error response. parameters: - - in: path - name: context-id - description: ID of the context (UUID) + - in: query + name: owner-id + description: >- + The unique ID of the owner of the context. Specify either this or + owner-slug. schema: type: string format: uuid - required: true + required: false + - in: query + name: owner-slug + description: >- + A string that represents an organization. Specify either this or + owner-id. Cannot be used for accounts. + schema: + type: string + required: false + - in: query + name: owner-type + description: >- + The type of the owner. Defaults to "organization". Accounts are only + used as context owners in server. + schema: + type: string + enum: + - account + - organization + required: false + - in: query + name: page-token + description: A token to retrieve the next page of results. + schema: + type: string + required: false + allowEmptyValue: true + /context/{context-id}: get: summary: Get a context description: Returns basic information about a context. @@ -293,6 +256,43 @@ paths: type: string format: uuid required: true + delete: + summary: Delete a context + tags: + - Context + operationId: deleteContext + responses: + '200': + description: A confirmation message + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: context-id + description: ID of the context (UUID) + schema: + type: string + format: uuid + required: true /context/{context-id}/environment-variable: get: summary: List environment variables @@ -3839,83 +3839,30 @@ paths: - md5 required: false /project/{project-slug}/checkout-key/{fingerprint}: - delete: - summary: Delete a checkout key + get: + summary: Get a checkout key description: >- - Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys - should be url-encoded. + Returns an individual checkout key via md5 or sha256 fingerprint. sha256 + keys should be url-encoded. tags: - Project - operationId: deleteCheckoutKey + operationId: getCheckoutKey responses: '200': - description: A confirmation message. + description: The checkout key. content: application/json: schema: type: object properties: - message: + public-key: type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: project-slug - description: >- - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` - characters may be URL-escaped. For projects that use GitLab or - GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` - with the organization ID (found in Organization Settings), and - replace `repo-name` with the project ID (found in Project Settings). - schema: - type: string - required: true - example: gh/CircleCI-Public/api-preview-docs - allowReserved: true - - in: path - name: fingerprint - description: An SSH key fingerprint. - schema: - type: string - required: true - example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f - get: - summary: Get a checkout key - description: >- - Returns an individual checkout key via md5 or sha256 fingerprint. sha256 - keys should be url-encoded. - tags: - - Project - operationId: getCheckoutKey - responses: - '200': - description: The checkout key. - content: - application/json: - schema: - type: object - properties: - public-key: - type: string - description: A public SSH key. - example: ssh-rsa ... - type: - enum: - - deploy-key - - github-user-key + description: A public SSH key. + example: ssh-rsa ... + type: + enum: + - deploy-key + - github-user-key type: string description: >- The type of checkout key. This may be either `deploy-key` @@ -3973,6 +3920,59 @@ paths: type: string required: true example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f + delete: + summary: Delete a checkout key + description: >- + Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys + should be url-encoded. + tags: + - Project + operationId: deleteCheckoutKey + responses: + '200': + description: A confirmation message. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: project-slug + description: >- + Project slug in the form `vcs-slug/org-name/repo-name`. The `/` + characters may be URL-escaped. For projects that use GitLab or + GitHub App, use `circleci` as the `vcs-slug`, replace `org-name` + with the organization ID (found in Organization Settings), and + replace `repo-name` with the project ID (found in Project Settings). + schema: + type: string + required: true + example: gh/CircleCI-Public/api-preview-docs + allowReserved: true + - in: path + name: fingerprint + description: An SSH key fingerprint. + schema: + type: string + required: true + example: c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f /project/{project-slug}/envvar: post: summary: Create an environment variable @@ -4124,39 +4124,27 @@ paths: example: gh/CircleCI-Public/api-preview-docs allowReserved: true /project/{project-slug}/envvar/{name}: - get: - summary: Get a masked environment variable - description: Returns the masked value of environment variable :name. + delete: + summary: Delete an environment variable + description: Deletes the environment variable named :name. tags: - Project - operationId: getEnvVar + operationId: deleteEnvVar responses: '200': - description: The environment variable. + description: A confirmation message. content: application/json: schema: type: object properties: - name: - type: string - description: The name of the environment variable. - example: foo - value: + message: type: string - description: The value of the environment variable. - example: xxxx1234 - created-at: - x-nullable: true - description: The creation timestamp of the environment variable. - example: '#joda/inst 2023-04-14T21:20:14+0000' + description: A human-readable message required: - - name - - value - description: >- - An environment variable is a map containing a value and an - optional timestamp. - title: EnvironmentVariable + - message + description: message response + title: MessageResponse default: content: application/json: @@ -4187,27 +4175,39 @@ paths: type: string required: true example: foo - delete: - summary: Delete an environment variable - description: Deletes the environment variable named :name. + get: + summary: Get a masked environment variable + description: Returns the masked value of environment variable :name. tags: - Project - operationId: deleteEnvVar + operationId: getEnvVar responses: '200': - description: A confirmation message. + description: The environment variable. content: application/json: schema: type: object properties: - message: + name: type: string - description: A human-readable message + description: The name of the environment variable. + example: foo + value: + type: string + description: The value of the environment variable. + example: xxxx1234 + created-at: + x-nullable: true + description: The creation timestamp of the environment variable. + example: '#joda/inst 2023-04-14T21:20:14+0000' required: - - message - description: message response - title: MessageResponse + - name + - value + description: >- + An environment variable is a map containing a value and an + optional timestamp. + title: EnvironmentVariable default: content: application/json: @@ -6255,6 +6255,46 @@ paths: example: gh/CircleCI-Public/api-preview-docs allowReserved: true /schedule/{schedule-id}: + delete: + summary: Delete a schedule + description: >- + Not yet available to projects that use GitLab or GitHub App. Deletes the + schedule by id. + tags: + - Schedule + operationId: deleteScheduleById + responses: + '200': + description: A confirmation message. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: schedule-id + description: The unique ID of the schedule. + schema: + type: string + format: uuid + required: true patch: summary: Update a schedule description: >- @@ -6807,46 +6847,6 @@ paths: type: string format: uuid required: true - delete: - summary: Delete a schedule - description: >- - Not yet available to projects that use GitLab or GitHub App. Deletes the - schedule by id. - tags: - - Schedule - operationId: deleteScheduleById - responses: - '200': - description: A confirmation message. - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: schedule-id - description: The unique ID of the schedule. - schema: - type: string - format: uuid - required: true /user/{id}: get: summary: User Information @@ -7177,44 +7177,6 @@ paths: - scope description: The parameters for a create webhook request /webhook/{webhook-id}: - delete: - summary: Delete an outbound webhook - description: Deletes an outbound webhook - tags: - - Webhook - operationId: deleteWebhook - responses: - '200': - description: A confirmation message - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: A human-readable message - required: - - message - description: message response - title: MessageResponse - default: - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: Error response. - parameters: - - in: path - name: webhook-id - description: ID of the webhook (UUID) - schema: - type: string - format: uuid - required: true get: summary: Get a webhook description: Get an outbound webhook by id. @@ -7315,6 +7277,44 @@ paths: type: string format: uuid required: true + delete: + summary: Delete an outbound webhook + description: Deletes an outbound webhook + tags: + - Webhook + operationId: deleteWebhook + responses: + '200': + description: A confirmation message + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A human-readable message + required: + - message + description: message response + title: MessageResponse + default: + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: Error response. + parameters: + - in: path + name: webhook-id + description: ID of the webhook (UUID) + schema: + type: string + format: uuid + required: true put: summary: Update an outbound webhook description: Updates an outbound webhook. diff --git a/sdks/db/intermediate-fixed-specs/elevenlabs/openapi.yaml b/sdks/db/intermediate-fixed-specs/elevenlabs/openapi.yaml index 4168c6f5bc..735fee629a 100644 --- a/sdks/db/intermediate-fixed-specs/elevenlabs/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/elevenlabs/openapi.yaml @@ -5128,6 +5128,12 @@ components: title: Safety Control voice_verification: $ref: '#/components/schemas/VoiceVerificationResponseModel' + owner_id: + type: string + title: Owner Id + permission_on_resource: + type: string + title: Permission On Resource type: object required: - voice_id diff --git a/sdks/db/intermediate-fixed-specs/gitlab/openapi.yaml b/sdks/db/intermediate-fixed-specs/gitlab/openapi.yaml index 2a0c961bd2..d126989602 100644 --- a/sdks/db/intermediate-fixed-specs/gitlab/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/gitlab/openapi.yaml @@ -31,7 +31,7 @@ info: name: CC BY-SA 4.0 url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE servers: - - url: https://www.gitlab.com/api/ + - url: https://www.gitlab.com/api/v4 security: - ApiKeyAuth: [] tags: @@ -188,7 +188,7 @@ tags: - name: unleash_api description: Operations related to Unleash API paths: - /api/v4/groups/{id}/badges/{badge_id}: + /groups/{id}/badges/{badge_id}: get: tags: - badges @@ -286,7 +286,7 @@ paths: '204': description: Removes a badge from the group. content: {} - /api/v4/groups/{id}/badges: + /groups/{id}/badges: get: tags: - badges @@ -370,7 +370,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Badge' - /api/v4/groups/{id}/badges/render: + /groups/{id}/badges/render: get: tags: - badges @@ -405,7 +405,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BasicBadgeDetails' - /api/v4/groups/{id}/access_requests/{user_id}: + /groups/{id}/access_requests/{user_id}: delete: tags: - access_requests @@ -432,7 +432,7 @@ paths: '204': description: Denies an access request for the given user. content: {} - /api/v4/groups/{id}/access_requests/{user_id}/approve: + /groups/{id}/access_requests/{user_id}/approve: put: tags: - access_requests @@ -480,7 +480,7 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/groups/{id}/access_requests: + /groups/{id}/access_requests: get: tags: - access_requests @@ -547,7 +547,7 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/repository/merged_branches: + /projects/{id}/repository/merged_branches: delete: tags: - branches @@ -567,7 +567,7 @@ paths: '404': description: 404 Project Not Found content: {} - /api/v4/projects/{id}/repository/branches/{branch}: + /projects/{id}/repository/branches/{branch}: get: tags: - branches @@ -646,7 +646,7 @@ paths: '404': description: Not Found content: {} - /api/v4/projects/{id}/repository/branches: + /projects/{id}/repository/branches: get: tags: - branches @@ -743,7 +743,7 @@ paths: '400': description: Failed to create branch content: {} - /api/v4/projects/{id}/repository/branches/{branch}/unprotect: + /projects/{id}/repository/branches/{branch}/unprotect: put: tags: - branches @@ -772,7 +772,7 @@ paths: '404': description: 404 Project Not Found content: {} - /api/v4/projects/{id}/repository/branches/{branch}/protect: + /projects/{id}/repository/branches/{branch}/protect: put: tags: - branches @@ -812,7 +812,7 @@ paths: '404': description: 404 Branch Not Found content: {} - /api/v4/projects/{id}/badges/{badge_id}: + /projects/{id}/badges/{badge_id}: get: tags: - badges @@ -910,7 +910,7 @@ paths: '204': description: Removes a badge from the project. content: {} - /api/v4/projects/{id}/badges: + /projects/{id}/badges: get: tags: - badges @@ -994,7 +994,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Badge' - /api/v4/projects/{id}/badges/render: + /projects/{id}/badges/render: get: tags: - badges @@ -1029,7 +1029,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BasicBadgeDetails' - /api/v4/projects/{id}/access_requests/{user_id}: + /projects/{id}/access_requests/{user_id}: delete: tags: - access_requests @@ -1056,7 +1056,7 @@ paths: '204': description: Denies an access request for the given user. content: {} - /api/v4/projects/{id}/access_requests/{user_id}/approve: + /projects/{id}/access_requests/{user_id}/approve: put: tags: - access_requests @@ -1104,7 +1104,7 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/access_requests: + /projects/{id}/access_requests: get: tags: - access_requests @@ -1171,7 +1171,7 @@ paths: state: active created_at: '2012-10-22T14:13:35.000Z' access_level: 20 - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: put: tags: - alert_management @@ -1262,7 +1262,7 @@ paths: '422': description: Unprocessable entity content: {} - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images: get: tags: - alert_management @@ -1341,7 +1341,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: post: tags: - alert_management @@ -1368,7 +1368,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/admin/batched_background_migrations/{id}: + /admin/batched_background_migrations/{id}: get: tags: - batched_background_migrations @@ -1410,7 +1410,7 @@ paths: '404': description: 404 Not found content: {} - /api/v4/admin/batched_background_migrations: + /admin/batched_background_migrations: get: tags: - batched_background_migrations @@ -1444,7 +1444,7 @@ paths: '403': description: 403 Forbidden content: {} - /api/v4/admin/batched_background_migrations/{id}/resume: + /admin/batched_background_migrations/{id}/resume: put: tags: - batched_background_migrations @@ -1492,7 +1492,7 @@ paths: '422': description: You can resume only `paused` batched background migrations. content: {} - /api/v4/admin/batched_background_migrations/{id}/pause: + /admin/batched_background_migrations/{id}/pause: put: tags: - batched_background_migrations @@ -1540,7 +1540,7 @@ paths: '422': description: You can pause only `active` batched background migrations. content: {} - /api/v4/admin/ci/variables/{key}: + /admin/ci/variables/{key}: get: tags: - ci_variables @@ -1632,7 +1632,7 @@ paths: '404': description: Instance Variable Not Found content: {} - /api/v4/admin/ci/variables: + /admin/ci/variables: get: tags: - ci_variables @@ -1707,7 +1707,7 @@ paths: '400': description: 400 Bad Request content: {} - /api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}: + /admin/databases/{database_name}/dictionary/tables/{table_name}: get: tags: - admin @@ -1745,7 +1745,7 @@ paths: '404': description: 404 Not found content: {} - /api/v4/admin/clusters/{cluster_id}: + /admin/clusters/{cluster_id}: get: tags: - clusters @@ -1883,7 +1883,7 @@ paths: '404': description: Not found content: {} - /api/v4/admin/clusters/add: + /admin/clusters/add: post: tags: - clusters @@ -1968,7 +1968,7 @@ paths: '404': description: Not found content: {} - /api/v4/admin/clusters: + /admin/clusters: get: tags: - clusters @@ -1989,7 +1989,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/admin/migrations/{timestamp}/mark: + /admin/migrations/{timestamp}/mark: post: tags: - migrations @@ -2034,7 +2034,7 @@ paths: '422': description: You can mark only pending migrations content: {} - /api/v4/applications/{id}: + /applications/{id}: delete: tags: - applications @@ -2053,7 +2053,7 @@ paths: '204': description: Delete an application content: {} - /api/v4/applications: + /applications: get: tags: - applications @@ -2111,7 +2111,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_ApplicationWithSecret' - /api/v4/avatar: + /avatar: get: tags: - avatar @@ -2137,7 +2137,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Avatar' - /api/v4/broadcast_messages/{id}: + /broadcast_messages/{id}: get: tags: - broadcast_messages @@ -2247,7 +2247,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BroadcastMessage' - /api/v4/broadcast_messages: + /broadcast_messages: get: tags: - broadcast_messages @@ -2338,7 +2338,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_BroadcastMessage' - /api/v4/bulk_imports/{import_id}/entities/{entity_id}: + /bulk_imports/{import_id}/entities/{entity_id}: get: tags: - bulk_imports @@ -2376,7 +2376,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/{import_id}/entities: + /bulk_imports/{import_id}/entities: get: tags: - bulk_imports @@ -2434,7 +2434,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/{import_id}: + /bulk_imports/{import_id}: get: tags: - bulk_imports @@ -2465,7 +2465,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports/entities: + /bulk_imports/entities: get: tags: - bulk_imports @@ -2525,7 +2525,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/bulk_imports: + /bulk_imports: get: tags: - bulk_imports @@ -2666,7 +2666,7 @@ paths: '503': description: Service unavailable content: {} - /api/v4/application/appearance: + /application/appearance: get: tags: - application @@ -2748,7 +2748,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Appearance' - /api/v4/application/plan_limits: + /application/plan_limits: get: tags: - plan_limits @@ -2914,7 +2914,7 @@ paths: '403': description: Forbidden content: {} - /api/v4/metadata: + /metadata: get: tags: - metadata @@ -2931,7 +2931,7 @@ paths: '401': description: Unauthorized content: {} - /api/v4/version: + /version: get: tags: - metadata @@ -2950,7 +2950,7 @@ paths: '401': description: Unauthorized content: {} - /api/v4/projects/{id}/jobs: + /projects/{id}/jobs: get: tags: - jobs @@ -2980,7 +2980,7 @@ paths: type: array items: $ref: '#/components/schemas/API_Entities_Job' - /api/v4/projects/{id}/jobs/{job_id}: + /projects/{id}/jobs/{job_id}: get: tags: - jobs @@ -3006,7 +3006,7 @@ paths: application/json: schema: $ref: '#/components/schemas/API_Entities_Job' - /api/v4/projects/{id}/jobs/{job_id}/play: + /projects/{id}/jobs/{job_id}/play: post: tags: - jobs diff --git a/sdks/db/intermediate-fixed-specs/launchdarkly/openapi.yaml b/sdks/db/intermediate-fixed-specs/launchdarkly/openapi.yaml index 7427d9da2b..3e5157c56f 100644 --- a/sdks/db/intermediate-fixed-specs/launchdarkly/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/launchdarkly/openapi.yaml @@ -31585,14 +31585,14 @@ components: - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum analysisType: type: string - description: The strategy for analyzing metric events + description: The method for analyzing metric events example: mean enum: - mean @@ -31600,9 +31600,9 @@ components: percentileValue: type: integer description: >- - The percentile, an integer denoting the target percentile between 0 - and 100. Only present when analysisType is - percentile. + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. example: 95 eventDefault: $ref: '#/components/schemas/MetricEventDefaultRep' @@ -31692,11 +31692,24 @@ components: - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum + analysisType: + type: string + description: The method for analyzing metric events + example: mean + percentileValue: + type: integer + description: >- + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. + example: 95 + eventDefault: + $ref: '#/components/schemas/MetricEventDefaultRep' MetricRep: type: object required: @@ -31816,14 +31829,14 @@ components: - user unitAggregationType: type: string - description: The method in which multiple unit event values are aggregated + description: The method by which multiple unit event values are aggregated example: average enum: - average - sum analysisType: type: string - description: The strategy for analyzing metric events + description: The method for analyzing metric events example: mean enum: - mean @@ -31831,9 +31844,9 @@ components: percentileValue: type: integer description: >- - The percentile, an integer denoting the target percentile between 0 - and 100. Only present when analysisType is - percentile. + The percentile for the analysis method. An integer denoting the + target percentile between 0 and 100. Required when + analysisType is percentile. example: 95 eventDefault: $ref: '#/components/schemas/MetricEventDefaultRep' diff --git a/sdks/db/intermediate-fixed-specs/posthog/openapi.yaml b/sdks/db/intermediate-fixed-specs/posthog/openapi.yaml index f8b95160d6..0d068e339e 100644 --- a/sdks/db/intermediate-fixed-specs/posthog/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/posthog/openapi.yaml @@ -14096,6 +14096,14 @@ components: format: date-time readOnly: true description: The timestamp at which this BatchExportRun was last updated. + records_total_count: + type: integer + maximum: 2147483647 + minimum: -2147483648 + nullable: true + description: >- + The total count of records that should be exported in this + BatchExportRun. batch_export: type: string format: uuid diff --git a/sdks/db/intermediate-fixed-specs/salesflare/openapi.yaml b/sdks/db/intermediate-fixed-specs/salesflare/openapi.yaml new file mode 100644 index 0000000000..5e8f48c0b1 --- /dev/null +++ b/sdks/db/intermediate-fixed-specs/salesflare/openapi.yaml @@ -0,0 +1,30639 @@ +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) + + + ## 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/api_logo.png + backgroundColor: '#3d4d65' + 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 + 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: '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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + - name: limit + in: query + schema: + type: number + minimum: 1 + default: 10 + tags: + - Accounts + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + type: object + properties: + id: + type: number + owner: + type: object + properties: + id: + type: number + name: + type: string + email: + type: string + picture: + type: string + required: + - id + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + description: + type: string + last_interaction_date: + type: string + format: date-time + creation_date: + type: string + format: date-time + modification_date: + type: string + format: date-time + part_of: + type: boolean + hotness: + type: number + can_edit: + type: boolean + 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 + last_email_date: + type: string + format: date-time + last_meeting_date: + type: string + format: date-time + social_profiles: + type: array + items: + type: object + properties: + id: + type: number + type: + type: string + url: + type: string + username: + 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 property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + required: + - id + email_addresses: + type: array + items: + type: object + properties: + id: + type: number + email: + type: string + phone_numbers: + type: array + items: + type: object + properties: + id: + type: number + number: + type: string + type: + type: string + tags: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + required: + - id + parent_account: + type: object + properties: + id: + type: number + name: + type: string + domain: + type: string + picture: + type: string + entity: + type: string + enum: + - account + required: + - id + custom: + type: object + required: + - id + - domain + post: + summary: Create an account + operationId: postAccounts + parameters: + - name: update_if_exists + in: query + schema: + type: boolean + default: false + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + type: array + 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, will be ignored + required: + - email + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + number: + type: string + type: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + required: + - number + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + customers: + 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 + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + x-alternatives: + - type: object + properties: + owner: + type: number + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + type: array + 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, will be ignored + required: + - email + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + number: + type: string + type: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + required: + - number + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + customers: + 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 + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + - 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 + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Contacts + 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 property. 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 + required: + - id + post: + summary: Create a contact + operationId: postContacts + description: >- + 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 will not be created if a contact + with the same email address used to exist. + 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 + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + prefix: + type: string + firstname: + type: string + middle: + type: string + lastname: + type: string + suffix: + type: string + name: + type: string + picture: + type: string + maxLength: 500 + account: + type: number + description: >- + Any existing account will be removed from the contact when + specifically passing `null`! + birth_date: + type: string + format: date-time + 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 + tags: + type: array + 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, will be ignored + address: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + addresses: + type: array + items: + type: object + properties: + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + type: + type: string + zip: + type: string + 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: + number: + type: string + type: + type: string + required: + - number + position: + type: object + properties: + organisation: + type: string + role: + type: string + positions: + type: array + items: + type: object + properties: + organisation: + type: string + role: + type: string + social_profiles: + type: array + items: + type: string + x-alternatives: + - type: string + - type: object + properties: + type: + type: string + url: + type: string + username: + type: string + custom: + type: object + 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 + campaign: + type: string + is_referred: + type: boolean + credit_usage: + type: number + credit_quota: + type: number + credit_package: + type: string + enum: + - S + - M + - L + - XL + 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 + 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 + referral_code: + type: string + referral_reward: + type: number + is_delinquent: + type: boolean + 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 + first_day_of_week: + type: number + 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 + /opportunities: + get: + summary: List opportunities + operationId: getOpportunities + description: >- + 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 + 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: '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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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 + - x-alternatives: + - type: object + required: + - condition + - rules + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Opportunities + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + 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 + 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 + 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: + iso: + type: string + required: + - iso + close_date: + type: string + closed: + type: boolean + 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 + 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 + main_contact: + type: object + properties: + id: + type: number + name: + type: string + email: + type: string + picture: + type: string + entity: + type: string + enum: + - contact + required: + - id + custom: + type: object + last_stage_change_date: + type: string + format: date + required: + - id + post: + summary: Create an opportunity + operationId: postOpportunities + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + x-alternatives: + - type: number + - type: object + - type: string + account: + type: number + x-alternatives: + - type: number + - type: object + stage: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + x-constraint: + sign: positive + order: + type: number + probability: + type: number + fixed_stage: + type: number + required: + - id + - order + - probability + - type: string + lost_reason: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + - type: string + files: + type: array + items: + type: object + lead_source: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + start_date: + type: string + format: date-time + probability: + type: number + minimum: 0 + assignee: + type: number + x-alternatives: + - type: number + - type: object + - type: string + creator: + type: number + x-alternatives: + - type: number + - type: object + - type: string + status: + type: string + description: DEPRECATED + name: + type: string + value: + type: number + minimum: 0 + currency: + type: number + status_date: + type: string + description: DEPRECATED + close_date: + type: string + format: date-time + closed: + type: boolean + tags: + type: array + 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, will be ignored + recurring_price_per_unit: + type: number + frequency: + type: string + enum: + - annually + - weekly + - monthly + - daily + x-convert: + case: lower + units: + type: number + contract_start_date: + type: string + format: date-time + contract_end_date: + type: string + format: date-time + main_contact: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + 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 + parameters: + - name: search + in: query + schema: + type: string + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 + parameters: + - x-constraint: + single: true + name: id + in: query + explode: true + schema: + type: array + items: + type: number + - description: >- + This property is deprecated, use q.search instead. When both are + provided, q.search will be 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 + parameters: + - x-constraint: + single: true + name: id + in: query + explode: true + schema: + type: array + items: + type: number + - name: search + in: query + schema: + type: string + - description: Defaults to the user + x-constraint: + single: true + name: assignees + in: query + explode: true + schema: + type: array + items: + type: number + - x-constraint: + single: true + name: type + in: query + explode: true + schema: + type: array + items: + type: number + - x-constraint: + single: true + name: account + in: query + explode: true + schema: + type: array + items: + type: number + - description: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + x-constraint: + single: true + name: order_by + in: query + explode: true + schema: + type: array + items: + type: string + - name: limit + in: query + schema: + type: number + - name: offset + in: query + schema: + type: number + - x-alternatives: + - type: object + required: + - condition + - rules + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + schema: + type: string + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: array + items: + type: object + properties: + id: + type: number + type: + type: string + enum: + - meeting_notes + - email_reply + - account_inactive + - suggested_contact + - suggested_account + - manual_task + - meeting + meeting_type: + type: boolean + account: + type: object + properties: + id: + type: number + name: + type: string + picture: + type: string + creator: + type: number + description: + type: string + reminder_date: + type: string + format: date-time + company: + type: number + meeting: + type: object + properties: + id: + type: number + subject: + type: string + conference_url: + type: string + required: + - id + email: + type: object + properties: + id: + type: number + email_message_id: + type: string + subject: + type: string + data_source: + type: number + service_message_id: + type: string + required: + - id + - email_message_id + - subject + completed: + type: boolean + completion_date: + type: string + format: date-time + completor: + type: number + archived: + type: boolean + archive_date: + type: string + format: date-time + archivor: + 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 + assignees: + type: array + items: + type: object + properties: + id: + type: number + email: + type: string + picture: + type: string + name: + type: string + disabled: + type: boolean + post: + summary: Create a task + operationId: postTasks + requestBody: + content: + application/json: + schema: + type: array + x-constraint: + single: true + items: + type: object + properties: + account: + type: number + description: + type: string + reminder_date: + type: string + format: date + default: '2024-03-27T13:03:17.281Z' + assignees: + type: array + 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 + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + parameters: + - name: account_id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + domain: + type: string + picture: + type: string + size: + type: number + website: + type: string + x-format: + uri: + allowRelative: true + allowQuerySquareBrackets: true + description: + type: string + address: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. Use state_region instead. + state_region: + type: string + street: + type: string + zip: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + email_addresses: + 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 + trim: true + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + phone_number: + type: string + phone_numbers: + type: array + items: + type: object + properties: + id: + type: number + number: + type: string + type: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + social_profiles: + type: array + 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, will be ignored + tags: + type: array + 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, will be ignored + links: + type: string + _dirty: + type: boolean + description: Deprecated, will be ignored + parent_account: + type: number + required: + - parent_account + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + required: + - id + custom: + type: object + q: + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + parameters: + - name: contact_id + in: path + required: true + schema: + type: number + - description: >- + When force is false, the contact's name will not be updated if the + name in the update is just the first part of the email address. + name: force + in: query + schema: + type: boolean + default: true + requestBody: + content: + application/json: + schema: + type: object + properties: + prefix: + type: string + firstname: + type: string + middle: + type: string + lastname: + type: string + suffix: + type: string + email: + type: string + maxLength: 1000 + x-format: + email: + ignoreLength: true + tlds: + allow: false + minDomainSegments: 1 + x-convert: + case: lower + trim: true + role: + type: string + name: + type: string + owner: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + required: + - id + - type: string + picture: + type: string + account: + type: number + description: >- + Any existing account will be removed from the contact when + specifically passing `null`! + birth_date: + type: string + format: date-time + 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 + tags: + type: array + 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, will be ignored + address: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. 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, will be ignored + addresses: + type: array + items: + type: object + properties: + id: + type: number + city: + type: string + country: + type: string + region: + type: string + description: Deprecated property. 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, will be ignored + 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 + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + position: + type: object + properties: + id: + type: number + organisation: + type: string + role: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + positions: + type: array + items: + type: object + properties: + id: + type: number + organisation: + type: string + role: + type: string + archived: + type: boolean + _dirty: + type: boolean + description: Deprecated, will be ignored + social_profiles: + type: array + 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, will be ignored + custom: + type: object + _dirty: + type: boolean + description: Deprecated, will be 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 + 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 + group: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + entity: + type: string + enum: + - account + - person + - opportunity + - campaign + - tag + - task + - workflow + - workflow_record + - workflow_step_record + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + 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 + 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 + /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: >- + Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. + Defaults to asc. + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 + 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + not: + type: boolean + valid: + type: boolean + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `value` + required: + - id + - customfield_id + - operator + - enabled + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + - type: object + required: + - id + - operator + - 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 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 + pipeline: + type: number + - type: object + required: + - condition + x-properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + collectionFormat: multi + name: rules + order_by: + type: string + 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 property. 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 + 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 + closed: + type: boolean + 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 + parameters: + - name: id + in: path + required: true + schema: + type: number + requestBody: + content: + application/json: + schema: + type: object + properties: + owner: + type: number + x-alternatives: + - type: number + - type: object + account: + type: number + x-alternatives: + - type: number + - type: object + stage: + type: number + x-constraint: + sign: positive + x-alternatives: + - type: number + x-constraint: + sign: positive + - type: object + properties: + id: + type: number + order: + type: number + probability: + type: number + fixed_stage: + type: number + required: + - id + - order + - probability + lost_reason: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + files: + type: array + items: + type: object + lead_source: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + name: + type: string + start_date: + type: string + format: date-time + probability: + type: number + minimum: 0 + assignee: + type: number + x-alternatives: + - type: number + - type: object + - type: string + creator: + type: number + x-alternatives: + - type: number + - type: object + - type: string + name: + type: string + value: + type: number + minimum: 0 + close_date: + type: string + format: date-time + closed: + type: boolean + done: + type: boolean + tags: + type: array + 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, will be ignored + recurring_price_per_unit: + type: number + frequency: + type: string + enum: + - annually + - weekly + - monthly + - daily + x-convert: + case: lower + units: + type: number + contract_start_date: + type: string + format: date-time + contract_end_date: + type: string + format: date-time + main_contact: + type: number + x-alternatives: + - type: number + - type: object + properties: + id: + type: number + custom: + type: object + 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 + /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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + not: + type: boolean + valid: + type: boolean + required: + - condition + type: object + description: >- + Deprecated, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + raw_value: + type: array + items: + type: object + search_entity: + type: string + enum: + - account + - contact + - user + - tag + - pipeline + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + /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 + 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: >- + The use of this property is deprecated. Use the notes + property instead. + notes: + type: string + phone_type: + type: string + phone_number_hash: + type: string + participants: + type: array + description: No participants is 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: >- + The use of this property is deprecated. Use the notes + property instead. + notes: + type: string + phone_type: + type: string + phone_number_hash: + type: string + participants: + type: array + description: No participants is 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 + /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 + requestBody: + content: + application/json: + schema: + type: object + properties: + account: + type: number + description: + type: string + reminder_date: + type: string + format: date + assignees: + type: array + x-constraint: + single: true + items: + type: number + completed: + type: boolean + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: object + properties: + success: + type: boolean + delete: + summary: Delete a task + operationId: deleteTasksId + tags: + - Tasks + responses: + '200': + description: Successful + content: + '*/*': + schema: + type: object + properties: + success: + type: boolean + /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: 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` of a workflow record to `false` is + currently not possible. + 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 + putMeetingsMeeting_idBody: + content: + application/json: + schema: + type: object + properties: + calendar_id: + type: string + external_id: + type: string + minutes: + type: string + description: >- + The use of this property is 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: >- + The use of this property is 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: >- + The use of this property is 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 + postWorkflowsBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + filter: + x-alternatives: + - type: object + description: >- + When you pass `ids` all other filter options will be + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + not: + type: boolean + valid: + type: boolean + search: + type: string + required: + - condition + - rules + type: object + description: When you pass `ids` all other filter options will be 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 + 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only `id`, + `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + x-alternatives: + - type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with + only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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 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 + pipeline: + type: number + required: + - id + - operator + - value + - type: object + properties: + condition: + type: string + enum: + - AND + - OR + rules: + type: array + items: + type: object + description: >- + Deprecated, please use the slim version + with only `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + 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, please use the slim version with only + `id`, `operator`, `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 + display_entity: + type: string + enum: + - Account + - Contact + - Opportunity + - Campaign + - Tag + - Task + - Workflow + pipeline: + type: number + enabled: + type: string + internal: + type: boolean + required: + - id + - customfield_id + - operator + - enabled + order_by: + type: string + 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 + postTagsBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + required: + - name diff --git a/sdks/db/intermediate-fixed-specs/terminal/openapi.yaml b/sdks/db/intermediate-fixed-specs/terminal/openapi.yaml index e444dfd9b1..be18aab266 100644 --- a/sdks/db/intermediate-fixed-specs/terminal/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/terminal/openapi.yaml @@ -76,7 +76,7 @@ paths: in: query schema: type: string - example: sunt do est sit + example: non mollit reprehenderit description: Filter connections by tag - name: updatedAfter in: query @@ -116,7 +116,7 @@ paths: properties: days: type: number - example: 18640422.26015696 + example: 5757343.118591592 startFrom: type: string example: '2021-01-06T03:24:53.000Z' @@ -127,28 +127,28 @@ paths: type: array items: type: string - example: do pariatur non + example: pariatur est example: - - do pariatur non - - adi + - pariatur est + - voluptate qui dolor name: type: string - example: est aute + example: aute ut qui en credentials: type: object properties: database: type: string - example: ut incididunt + example: nisi c password: type: string - example: esse consequat + example: minim labore incididunt deserunt username: type: string - example: ipsum quis eiusmod Ut + example: aute in laboris externalId: type: string - example: ipsum enim + example: elit commodo in sunt provider: type: string example: geotab @@ -167,18 +167,18 @@ paths: Create Connection: value: backfill: - days: 18640422.26015696 + days: 5757343.118591592 startFrom: '2021-01-06T03:24:53.000Z' company: dotNumbers: - - do pariatur non - - adi - name: est aute + - pariatur est + - voluptate qui dolor + name: aute ut qui en credentials: - database: ut incididunt - password: esse consequat - username: ipsum quis eiusmod Ut - externalId: ipsum enim + database: nisi c + password: minim labore incididunt deserunt + username: aute in laboris + externalId: elit commodo in sunt provider: geotab syncMode: automatic tags: @@ -239,10 +239,10 @@ paths: example: Acme Inc. externalId: type: string - example: Excepteur enim irure + example: pariatur dolor minim status: type: string - example: mollit sunt aliquip + example: do syncMode: type: string example: automatic @@ -250,21 +250,21 @@ paths: type: array items: type: string - example: laboris s + example: Excepteur Ut example: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu examples: Update Current Connection: value: company: name: Acme Inc. - externalId: Excepteur enim irure - status: mollit sunt aliquip + externalId: pariatur dolor minim + status: do syncMode: automatic tags: - - laboris s - - commodo exercitation in + - Excepteur Ut + - deserunt incididunt eu responses: '200': description: '' @@ -757,13 +757,13 @@ paths: in: query schema: type: string - example: '1984-11-05' + example: '1992-10-05' description: Only include daily logs from on or after a specific date - name: endDate in: query schema: type: string - example: '1984-11-05' + example: '1992-10-05' description: Only include daily logs from on or before a specific date - name: modifiedAfter in: query @@ -909,13 +909,13 @@ paths: in: query schema: type: string - example: '1957-08-03' + example: '1999-09-28' description: Timestamp to start when the issue was last observed - name: lastReportedBefore in: query schema: type: string - example: '1957-08-03' + example: '1999-09-28' description: Timestamp to end when the issue was last observed - name: expand in: query @@ -933,7 +933,7 @@ paths: in: query schema: type: string - example: unknown_device_type + example: missing_permissions description: Filter issues to a specific error code - name: status in: query @@ -960,7 +960,7 @@ paths: required: true schema: type: string - example: sunt do est sit + example: non mollit reprehenderit description: '(Required) ' /providers: get: diff --git a/sdks/db/intermediate-fixed-specs/vimeo/openapi.yaml b/sdks/db/intermediate-fixed-specs/vimeo/openapi.yaml index 10f15ee556..e59a9c6c46 100644 --- a/sdks/db/intermediate-fixed-specs/vimeo/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/vimeo/openapi.yaml @@ -34456,30 +34456,50 @@ components: connections: properties: video: - description: The associated video object. + description: >- + The associated video object. This data requires a bearer + token with the `private` scope. properties: created_time: - description: The time in ISO 8601 format when the video was created. + description: >- + The time in ISO 8601 format when the video was created. + This data requires a bearer token with the `private` + scope. example: '2018-03-05T21:04:47+00:00' type: string duration: - description: The duration of the associated video. + description: >- + The duration of the associated video. This data requires + a bearer token with the `private` scope. type: number + manage_link: + description: >- + The link to the video management page. This data + requires a bearer token with the `private` scope. + example: /manage/videos/258684937 + type: string options: - description: An array of HTTP methods permitted on this URI. + description: >- + An array of HTTP methods permitted on this URI. This + data requires a bearer token with the `private` scope. items: type: string type: array title: - description: The title of the associated video. + description: >- + The title of the associated video. This data requires a + bearer token with the `private` scope. type: string uri: - description: The API URI that resolves to the connection data. + description: >- + The API URI that resolves to the connection data. This + data requires a bearer token with the `private` scope. example: /videos/152184 type: string required: - created_time - duration + - manage_link - options - title - uri @@ -43572,6 +43592,10 @@ components: description: The translated display name of the role. example: Admin type: string + is_disabled: + description: Whether the role is disabled for certain team members. + example: false + type: boolean permission_level: description: | The untranslated role of the user who made the request. diff --git a/sdks/db/intermediate-fixed-specs/you-need-a-budget/openapi.yaml b/sdks/db/intermediate-fixed-specs/you-need-a-budget/openapi.yaml index 1cb83b4c03..f14073672c 100644 --- a/sdks/db/intermediate-fixed-specs/you-need-a-budget/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/you-need-a-budget/openapi.yaml @@ -845,7 +845,7 @@ paths: tags: - Transactions summary: List transactions - description: Returns budget transactions + description: Returns budget transactions, excluding any pending transactions operationId: getTransactions parameters: - name: budget_id @@ -1178,7 +1178,9 @@ paths: tags: - Transactions summary: List account transactions - description: Returns all transactions for a specified account + description: >- + Returns all transactions for a specified account, excluding any pending + transactions operationId: getTransactionsByAccount parameters: - name: budget_id @@ -1245,7 +1247,7 @@ paths: get: tags: - Transactions - summary: List category transactions + summary: List category transactions, excluding any pending transactions description: Returns all transactions for a specified category operationId: getTransactionsByCategory parameters: @@ -1313,7 +1315,7 @@ paths: get: tags: - Transactions - summary: List payee transactions + summary: List payee transactions, excluding any pending transactions description: Returns all transactions for a specified payee operationId: getTransactionsByPayee parameters: diff --git a/sdks/db/processed-custom-request-cache/gitlab.com.yaml b/sdks/db/processed-custom-request-cache/gitlab.com.yaml index c8a4ea7fdd..c1f1d3c990 100644 --- a/sdks/db/processed-custom-request-cache/gitlab.com.yaml +++ b/sdks/db/processed-custom-request-cache/gitlab.com.yaml @@ -4,7 +4,7 @@ processed: type: apiKey in: header name: Private-Token - apiBaseUrl: https://www.gitlab.com/api/ + apiBaseUrl: https://www.gitlab.com/api/v4 apiVersion: v4 apiDescription: > An OpenAPI definition for the GitLab REST API. diff --git a/sdks/db/processed-custom-request-cache/launchdarkly.com.yaml b/sdks/db/processed-custom-request-cache/launchdarkly.com.yaml index 15112a8930..1f5df5139f 100644 --- a/sdks/db/processed-custom-request-cache/launchdarkly.com.yaml +++ b/sdks/db/processed-custom-request-cache/launchdarkly.com.yaml @@ -885,10 +885,10 @@ processed: endpoints: 164 sdkMethods: 257 schemas: 444 - parameters: 979 + parameters: 982 contactUrl: https://support.launchdarkly.com contactEmail: support@launchdarkly.com originalCustomRequest: lambda: true customRequestSpecFilename: launchdarkly.com.yaml - difficultyScore: 723.75 + difficultyScore: 724.5 diff --git a/sdks/db/processed-custom-request-cache/salesflare.com.yaml b/sdks/db/processed-custom-request-cache/salesflare.com.yaml new file mode 100644 index 0000000000..27e9b07579 --- /dev/null +++ b/sdks/db/processed-custom-request-cache/salesflare.com.yaml @@ -0,0 +1,124 @@ +processed: + securitySchemes: {} + apiBaseUrl: https://api.salesflare.com + apiVersion: 1.0.0 + apiDescription: >- + # 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) + + + ## 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. + apiTitle: Salesflare API + endpoints: 43 + sdkMethods: 67 + schemas: 0 + parameters: 406 + contactEmail: support@salesflare.com + originalCustomRequest: + type: GET + url: https://api.salesflare.com/openapi.json + customRequestSpecFilename: salesflare.com.yaml + difficultyScore: 168.5 diff --git a/sdks/db/progress/git-lab-progress.yaml b/sdks/db/progress/git-lab-progress.yaml index 05ba803e06..b062e8aed3 100644 --- a/sdks/db/progress/git-lab-progress.yaml +++ b/sdks/db/progress/git-lab-progress.yaml @@ -3,6 +3,33 @@ examples_2: {} examples_3: {} ignorePotentialIncorrectType: true operationIds: + /admin/batched_background_migrations: + get: Batchedbackgroundmigrations_listMigrations + /admin/batched_background_migrations/{id}: + get: Batchedbackgroundmigrations_getMigration + /admin/batched_background_migrations/{id}/pause: + put: Batchedbackgroundmigrations_pauseMigration + /admin/batched_background_migrations/{id}/resume: + put: Batchedbackgroundmigrations_resumeMigration + /admin/ci/variables: + get: Civariables_listAllInstanceVariables + post: Civariables_createNewInstanceLevelVariable + /admin/ci/variables/{key}: + delete: Civariables_deleteInstanceVariable + get: Civariables_getInstanceVariableDetails + put: Civariables_updateInstanceVariable + /admin/clusters: + get: Clusters_listInstanceClusters + /admin/clusters/add: + post: Clusters_addExistingInstance + /admin/clusters/{cluster_id}: + delete: Clusters_deleteInstanceCluster + get: Clusters_getSingleInstance + put: Clusters_updateInstanceCluster + /admin/databases/{database_name}/dictionary/tables/{table_name}: + get: Admin_getDictionaryDetails + /admin/migrations/{timestamp}/mark: + post: Migrations_markAsExecuted /api/v4/admin/batched_background_migrations: get: Batchedbackgroundmigrations_list /api/v4/admin/batched_background_migrations/{id}: @@ -124,9 +151,124 @@ operationIds: delete: Branches_deleteMerged /api/v4/version: get: Metadata_getVersionInformation + /application/appearance: + get: Application_getCurrentAppearance + put: Application_modifyAppearance + /application/plan_limits: + get: Planlimits_getCurrentLimits + put: Planlimits_modifyPlanLimits + /applications: + get: Applications_listAllRegistered + post: Applications_createNewApplication + /applications/{id}: + delete: Applications_removeSpecificApplication + /avatar: + get: Avatar_getUserAvatarUrl + /broadcast_messages: + get: Broadcastmessages_getAllMessages + post: Broadcastmessages_createMessage + /broadcast_messages/{id}: + delete: Broadcastmessages_deleteMessage + get: Broadcastmessages_getSpecificMessage + put: Broadcastmessages_updateMessageById + /bulk_imports: + get: Bulkimports_listMigrations + post: Bulkimports_startMigration + /bulk_imports/entities: + get: Bulkimports_listEntities + /bulk_imports/{import_id}: + get: Bulkimports_getMigrationDetails + /bulk_imports/{import_id}/entities: + get: Bulkimports_listEntities + /bulk_imports/{import_id}/entities/{entity_id}: + get: Bulkimports_getEntityDetails + /groups/{id}/access_requests: + get: Accessrequests_getListForGroup + post: Accessrequests_authenticateUserToGroup + /groups/{id}/access_requests/{user_id}: + delete: Accessrequests_denyAccessRequest + /groups/{id}/access_requests/{user_id}/approve: + put: Accessrequests_approveUserAccess + /groups/{id}/badges: + get: Badges_listViewableByAuthenticatedUser + post: Badges_addToGroup + /groups/{id}/badges/render: + get: Badges_previewFromGroup + /groups/{id}/badges/{badge_id}: + delete: Badges_removeFromGroup + get: Badges_getGroupBadge + put: Badges_updateGroupBadge + /metadata: + get: Metadata_getInformation + /projects/{id}/access_requests: + get: Accessrequests_listForProject + post: Accessrequests_requestAccessToProject + /projects/{id}/access_requests/{user_id}: + delete: Accessrequests_denyAccessRequest + /projects/{id}/access_requests/{user_id}/approve: + put: Accessrequests_approveUserAccess + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images: + get: Alertmanagement_getMetricImages + post: Alertmanagement_uploadMetricImageForAlert + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize: + post: Alertmanagement_authorizeMetricImageFileUpload + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: + delete: Alertmanagement_removeMetricImage + put: Alertmanagement_updateMetricImageForAlert + /projects/{id}/badges: + get: Badges_listViewableByAuthenticatedUser + post: Badges_addToProject + /projects/{id}/badges/render: + get: Badges_previewFromProject + /projects/{id}/badges/{badge_id}: + delete: Badges_removeFromProject + get: Badges_getProjectBadge + put: Badges_updateProjectBadge + /projects/{id}/jobs: + get: Jobs_listForProject + /projects/{id}/jobs/{job_id}: + get: Jobs_getById + /projects/{id}/jobs/{job_id}/play: + post: Jobs_runManualJob + /projects/{id}/repository/branches: + get: Branches_getProjectRepository + post: Branches_createBranch + /projects/{id}/repository/branches/{branch}: + delete: Branches_deleteBranch + get: Branches_getSingleBranch + head: Branches_checkExistence + /projects/{id}/repository/branches/{branch}/protect: + put: Branches_protectBranch + /projects/{id}/repository/branches/{branch}/unprotect: + put: Branches_unprotectBranch + /projects/{id}/repository/merged_branches: + delete: Branches_removeMergedBranches + /version: + get: Metadata_getVersionInfo operationTags: {} renameTags: {} requestSchemaNames: + /admin/batched_background_migrations/{id}/pause: + put: + application/json: BatchedbackgroundmigrationsPauseMigrationRequest + /admin/batched_background_migrations/{id}/resume: + put: + application/json: BatchedbackgroundmigrationsResumeMigrationRequest + /admin/ci/variables: + post: + application/json: CivariablesCreateNewInstanceLevelVariableRequest + /admin/ci/variables/{key}: + put: + application/json: CivariablesUpdateInstanceVariableRequest + /admin/clusters/add: + post: + application/json: ClustersAddExistingInstanceRequest + /admin/clusters/{cluster_id}: + put: + application/json: ClustersUpdateInstanceClusterRequest + /admin/migrations/{timestamp}/mark: + post: + application/json: MigrationsMarkAsExecutedRequest /api/v4/admin/batched_background_migrations/{id}/pause: put: application/json: BatchedbackgroundmigrationsPauseMigrationRequest @@ -193,8 +335,61 @@ requestSchemaNames: /api/v4/projects/{id}/repository/branches/{branch}/protect: put: application/json: BranchesProtectBranchRequest + /application/appearance: + put: + multipart/form-data: ApplicationModifyAppearanceRequest + /application/plan_limits: + put: + application/json: PlanlimitsModifyPlanLimitsRequest + /applications: + post: + application/json: ApplicationsCreateNewApplicationRequest + /broadcast_messages: + post: + application/json: BroadcastmessagesCreateMessageRequest + /broadcast_messages/{id}: + put: + application/json: BroadcastmessagesUpdateMessageByIdRequest + /bulk_imports: + post: + application/x-www-form-urlencoded: BulkimportsStartMigrationRequest + /groups/{id}/access_requests/{user_id}/approve: + put: + application/json: AccessrequestsApproveUserAccessRequest + /groups/{id}/badges: + post: + application/json: BadgesAddToGroupRequest + /groups/{id}/badges/{badge_id}: + put: + application/json: BadgesUpdateGroupBadgeRequest + /projects/{id}/access_requests/{user_id}/approve: + put: + application/json: AccessrequestsApproveUserAccessRequest1 + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images: + post: + multipart/form-data: AlertmanagementUploadMetricImageForAlertRequest + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}: + put: + multipart/form-data: AlertmanagementUpdateMetricImageForAlertRequest + /projects/{id}/badges: + post: + application/json: BadgesAddToProjectRequest + /projects/{id}/badges/{badge_id}: + put: + application/json: BadgesUpdateProjectBadgeRequest + /projects/{id}/repository/branches/{branch}/protect: + put: + application/json: BranchesProtectBranchRequest responseDescriptions: {} responseSchemaNames: + /admin/batched_background_migrations: + get: + '200': + application/json: BatchedbackgroundmigrationsListMigrationsResponse + /admin/clusters: + get: + '200': + application/json: ClustersListInstanceClustersResponse /api/v4/admin/batched_background_migrations: get: '200': @@ -239,6 +434,42 @@ responseSchemaNames: get: '200': application/json: BranchesGetAllResponse + /applications: + get: + '200': + application/json: ApplicationsListAllRegisteredResponse + /bulk_imports: + get: + '200': + application/json: BulkimportsListMigrationsResponse + /bulk_imports/entities: + get: + '200': + application/json: BulkimportsListEntities200Response + /bulk_imports/{import_id}/entities: + get: + '200': + application/json: BulkimportsListEntitiesResponse + /groups/{id}/badges: + get: + '200': + application/json: BadgesListViewableByAuthenticatedUserResponse + /projects/{id}/alert_management_alerts/{alert_iid}/metric_images: + get: + '200': + application/json: AlertmanagementGetMetricImagesResponse + /projects/{id}/badges: + get: + '200': + application/json: BadgesListViewableByAuthenticatedUser200Response + /projects/{id}/jobs: + get: + '200': + application/json: JobsListForProjectResponse + /projects/{id}/repository/branches: + get: + '200': + application/json: BranchesGetProjectRepositoryResponse securityParameters: branch: query: false diff --git a/sdks/db/progress/salesflare-progress.yaml b/sdks/db/progress/salesflare-progress.yaml new file mode 100644 index 0000000000..bb54d244e6 --- /dev/null +++ b/sdks/db/progress/salesflare-progress.yaml @@ -0,0 +1,497 @@ +examples: {} +examples_2: {} +examples_3: {} +operationIds: + /accounts: + get: Accounts_listAccounts + post: Accounts_createAccount + /calls: + post: Calls_createCall + /campaigns/mergefields: + get: Workflows_getMergeFields + /contacts: + get: Contacts_listContacts + post: Contacts_createContact + /currencies: + get: RegionalSettings_listSupportedCurrencies + /customfields/types: + get: CustomFields_listTypes + /customfields/{itemClass}: + get: CustomFields_listTypeCustomFields + post: CustomFields_createFieldType + /customfields/{itemClass}/{customFieldApiField}/options: + get: CustomFields_listOptions + /customfields/{itemClass}/{id}: + delete: CustomFields_deleteCustomField + get: CustomFields_getDetails + put: CustomFields_updateField + /datasources/email: + get: EmailDataSources_list + /datasources/email/{id}: + put: EmailDataSources_updateDataSource + /filterfields/{entity}: + get: FilterFields_listForEntity + /groups: + get: Groups_list + /groups/{id}: + get: Groups_getById + /me: + get: Users_getCurrentUserDetails + /me/contacts: + get: Users_listContacts + /meetings: + post: Meetings_createMeeting + /messages: + post: InternalNotes_createNote + /opportunities: + get: Opportunities_list + post: Opportunities_createOpportunity + /opportunities/{id}: + delete: Opportunities_removeOpportunity + get: Opportunities_getDetails + put: Opportunities_updateOpportunity + /persons: + get: Persons_list + /pipelines: + get: Pipelines_list + /stages: + get: Pipelines_listStages + /tags: + get: Tags_list + post: Tags_createTag + /tasks: + get: Tasks_listTasks + post: Tasks_createTask + /tasks/{id}: + delete: Tasks_deleteTask + put: Tasks_updateTask + /users: + get: Users_list + /users/{id}: + get: Users_getUserDetails + /workflows: + get: Workflows_list + post: Workflows_createWorkflow + /workflows/{id}: + get: Workflows_getDetails + put: Workflows_updateWorkflow +operationTags: {} +renameTags: {} +requestSchemaNames: + /accounts: + post: + application/json: AccountsCreateAccountRequest + /accounts/{account_id}: + put: + application/json: PutAccountsAccountIdRequest + /accounts/{account_id}/users: + post: + application/json: PostAccountsAccountIdUsersRequest + /calls: + post: + application/json: CallsCreateCallRequest + /contacts: + post: + application/json: ContactsCreateContactRequest + /contacts/{contact_id}: + put: + application/json: PutContactsContactIdRequest + /customfields/{itemClass}: + post: + application/json: CustomFieldsCreateFieldTypeRequest + /customfields/{itemClass}/{id}: + put: + application/json: CustomFieldsUpdateFieldRequest + /datasources/email/{id}: + put: + application/json: EmailDataSourcesUpdateDataSourceRequest + /meetings: + post: + application/json: MeetingsCreateMeetingRequest + /meetings/{meeting_id}: + put: + application/json: PutMeetingsMeetingIdRequest + /messages: + post: + application/json: InternalNotesCreateNoteRequest + /opportunities: + post: + application/json: OpportunitiesCreateOpportunityRequest + /opportunities/{id}: + put: + application/json: OpportunitiesUpdateOpportunityRequest + /tags: + post: + application/json: TagsCreateTagRequest + /tasks: + post: + application/json: TasksCreateTaskRequest + /tasks/{id}: + put: + application/json: TasksUpdateTaskRequest + /workflows: + post: + application/json: WorkflowsCreateWorkflowRequest + /workflows/{id}/audience/{record_id}: + put: + application/json: PutWorkflowsIdAudienceRecordIdRequest +responseDescriptions: {} +responseSchemaNames: + /accounts: + get: + '200': + '*/*': AccountsListAccountsResponse + post: + default: + '*/*': AccountsCreateAccountResponse + /accounts/{account_id}: + delete: + default: + '*/*': DeleteAccountsAccountIdResponse + get: + default: + '*/*': GetAccountsAccountIdResponse + put: + default: + '*/*': PutAccountsAccountIdResponse + /accounts/{account_id}/contacts: + post: + default: + '*/*': PostAccountsAccountIdContactsResponse + put: + default: + '*/*': PutAccountsAccountIdContactsResponse + /accounts/{account_id}/messages: + get: + default: + '*/*': GetAccountsAccountIdMessagesResponse + /accounts/{account_id}/users: + post: + default: + '*/*': PostAccountsAccountIdUsersResponse + put: + default: + '*/*': PutAccountsAccountIdUsersResponse + /calls: + post: + default: + '*/*': CallsCreateCallResponse + /calls/{meeting_id}: + put: + default: + '*/*': PutCallsMeetingIdResponse + /campaigns/mergefields: + get: + '200': + '*/*': WorkflowsGetMergeFieldsResponse + /conferences/{conference_id}: + get: + default: + '*/*': GetConferencesConferenceIdResponse + /contacts: + get: + '200': + '*/*': ContactsListContactsResponse + post: + '200': + '*/*': ContactsCreateContactResponse + /contacts/{contact_id}: + delete: + default: + '*/*': DeleteContactsContactIdResponse + get: + default: + '*/*': GetContactsContactIdResponse + put: + default: + '*/*': PutContactsContactIdResponse + /currencies: + get: + '200': + '*/*': RegionalSettingsListSupportedCurrenciesResponse + /customfields/types: + get: + default: + '*/*': CustomFieldsListTypesResponse + /customfields/{itemClass}: + get: + default: + '*/*': CustomFieldsListTypeCustomFieldsResponse + post: + '200': + '*/*': CustomFieldsCreateFieldTypeResponse + /customfields/{itemClass}/{customFieldApiField}/options: + get: + default: + '*/*': CustomFieldsListOptionsResponse + /customfields/{itemClass}/{id}: + delete: + default: + '*/*': CustomFieldsDeleteCustomFieldResponse + get: + default: + '*/*': CustomFieldsGetDetailsResponse + put: + default: + '*/*': CustomFieldsUpdateFieldResponse + /datasources/email: + get: + '200': + '*/*': EmailDataSourcesListResponse + /datasources/email/{id}: + put: + default: + '*/*': EmailDataSourcesUpdateDataSourceResponse + /filterfields/{entity}: + get: + '200': + '*/*': FilterFieldsListForEntityResponse + /groups: + get: + default: + '*/*': GroupsListResponse + /groups/{id}: + get: + default: + '*/*': GroupsGetByIdResponse + /me: + get: + '200': + '*/*': UsersGetCurrentUserDetailsResponse + /me/contacts: + get: + '200': + '*/*': UsersListContactsResponse + /meetings: + post: + default: + '*/*': MeetingsCreateMeetingResponse + /meetings/{meeting_id}: + delete: + default: + '*/*': DeleteMeetingsMeetingIdResponse + get: + default: + '*/*': GetMeetingsMeetingIdResponse + put: + default: + '*/*': PutMeetingsMeetingIdResponse + /messages: + post: + default: + '*/*': InternalNotesCreateNoteResponse + /messages/{message_id}: + delete: + default: + '*/*': DeleteMessagesMessageIdResponse + put: + default: + '*/*': PutMessagesMessageIdResponse + /opportunities: + get: + '200': + '*/*': OpportunitiesListResponse + post: + '200': + '*/*': OpportunitiesCreateOpportunityResponse + /opportunities/{id}: + delete: + default: + '*/*': OpportunitiesRemoveOpportunityResponse + get: + '200': + '*/*': OpportunitiesGetDetailsResponse + put: + default: + '*/*': OpportunitiesUpdateOpportunityResponse + /persons: + get: + default: + '*/*': PersonsListResponse + /pipelines: + get: + '200': + '*/*': PipelinesListResponse + /stages: + get: + default: + '*/*': PipelinesListStagesResponse + /stages/{stage_id}: + get: + default: + '*/*': GetStagesStageIdResponse + /tags: + get: + '200': + '*/*': TagsListResponse + post: + '200': + '*/*': TagsCreateTagResponse + /tags/{tag_id}: + delete: + '200': + '*/*': DeleteTagsTagIdResponse + get: + default: + '*/*': GetTagsTagIdResponse + put: + '200': + '*/*': PutTagsTagIdResponse + /tags/{tag_id}/usage: + get: + default: + '*/*': GetTagsTagIdUsageResponse + /tasks: + get: + '200': + '*/*': TasksListTasksResponse + post: + '200': + '*/*': TasksCreateTaskResponse + /tasks/{id}: + delete: + '200': + '*/*': TasksDeleteTaskResponse + put: + '200': + '*/*': TasksUpdateTaskResponse + /users: + get: + default: + '*/*': UsersListResponse + /users/{id}: + get: + default: + '*/*': UsersGetUserDetailsResponse + /workflows: + get: + '200': + '*/*': WorkflowsListResponse + post: + '200': + '*/*': WorkflowsCreateWorkflowResponse + /workflows/{id}: + get: + '200': + '*/*': WorkflowsGetDetailsResponse + put: + '200': + '*/*': WorkflowsUpdateWorkflowResponse + /workflows/{id}/audience/{record_id}: + put: + '200': + '*/*': PutWorkflowsIdAudienceRecordIdResponse +securityParameters: + account: + query: false + address.city: + query: false + address.country: + query: false + address.state_region: + query: false + after: + query: false + assignee: + query: false + assignee_group: + query: false + assignees: + query: false + before: + query: false + close_after: + query: false + close_before: + query: false + closed: + query: false + creation_after: + query: false + creation_before: + query: false + custom: + query: false + details: + query: false + domain: + query: false + done: + query: false + email: + query: false + force: + query: false + hotness: + query: false + id: + query: false + includeArchived: + query: false + includeDisabled: + query: false + includePipelineSpecificPredefinedFilterFields: + query: false + includeTeamDataSources: + query: false + limit: + query: false + max_size: + query: false + max_value: + query: false + min_size: + query: false + min_value: + query: false + modification_after: + query: false + modification_before: + query: false + name: + query: false + offset: + query: false + onlyEnabled: + query: false + order_by: + query: false + owner: + query: false + owner_group: + query: false + phone_number: + query: false + pipeline: + query: false + pipeline.id: + query: false + pipeline.name: + query: false + position.role: + query: false + q: + query: false + search: + query: false + searchString: + query: false + stage: + query: false + stage.name: + query: false + status: + query: false + tag: + query: false + tag.name: + query: false + team_member: + query: false + team_member_group: + query: false + type: + query: false + update_if_exists: + query: false +validServerUrls: {} diff --git a/sdks/db/published/from-custom-request_gitlab.com.json b/sdks/db/published/from-custom-request_gitlab.com.json index 825c7bc3f5..afb79a8eb6 100644 --- a/sdks/db/published/from-custom-request_gitlab.com.json +++ b/sdks/db/published/from-custom-request_gitlab.com.json @@ -6,7 +6,7 @@ "name": "Private-Token" } }, - "apiBaseUrl": "https://www.gitlab.com/api/", + "apiBaseUrl": "https://www.gitlab.com/api/v4", "apiVersion": "v4", "apiDescription": "An OpenAPI definition for the GitLab REST API.\nFew API resources or endpoints are currently included.\nThe intent is to expand this to match the entire Markdown documentation of the API:\n. Contributions are welcome.\n\nWhen viewing this on gitlab.com, you can test API calls directly from the browser\nagainst the `gitlab.com` instance, if you are logged in.\nThe feature uses the current [GitLab session cookie](https://docs.gitlab.com/ee/api/index.html#session-cookie),\nso each request is made using your account.\n\nInstructions for using this tool can be found in [Interactive API Documentation](https://docs.gitlab.com/ee/api/openapi/openapi_interactive.html)\n", "apiTitle": "GitLab API", @@ -38,7 +38,7 @@ "category": "Developer Tools", "methods": [ { - "url": "/api/v4/groups/{id}/badges/{badge_id}", + "url": "/groups/{id}/badges/{badge_id}", "method": "removeFromGroup", "httpMethod": "delete", "tag": "badges", @@ -63,7 +63,7 @@ "responses": [] }, { - "url": "/api/v4/groups/{id}/badges/{badge_id}", + "url": "/groups/{id}/badges/{badge_id}", "method": "getGroupBadge", "httpMethod": "get", "tag": "badges", @@ -93,7 +93,7 @@ ] }, { - "url": "/api/v4/groups/{id}/badges/{badge_id}", + "url": "/groups/{id}/badges/{badge_id}", "method": "updateGroupBadge", "httpMethod": "put", "tag": "badges", @@ -138,8 +138,8 @@ ] }, { - "url": "/api/v4/groups/{id}/badges", - "method": "getList", + "url": "/groups/{id}/badges", + "method": "listViewableByAuthenticatedUser", "httpMethod": "get", "tag": "badges", "typeScriptTag": "badges", @@ -178,8 +178,8 @@ ] }, { - "url": "/api/v4/groups/{id}/badges", - "method": "addBadgeToGroup", + "url": "/groups/{id}/badges", + "method": "addToGroup", "httpMethod": "post", "tag": "badges", "typeScriptTag": "badges", @@ -221,8 +221,8 @@ ] }, { - "url": "/api/v4/groups/{id}/badges/render", - "method": "previewBadgeFromGroup", + "url": "/groups/{id}/badges/render", + "method": "previewFromGroup", "httpMethod": "get", "tag": "badges", "typeScriptTag": "badges", @@ -258,8 +258,8 @@ ] }, { - "url": "/api/v4/groups/{id}/access_requests/{user_id}", - "method": "denyAccessToUser", + "url": "/groups/{id}/access_requests/{user_id}", + "method": "denyAccessRequest", "httpMethod": "delete", "tag": "access_requests", "typeScriptTag": "accessRequests", @@ -283,8 +283,8 @@ "responses": [] }, { - "url": "/api/v4/groups/{id}/access_requests/{user_id}/approve", - "method": "approveForUser", + "url": "/groups/{id}/access_requests/{user_id}/approve", + "method": "approveUserAccess", "httpMethod": "put", "tag": "access_requests", "typeScriptTag": "accessRequests", @@ -319,8 +319,8 @@ ] }, { - "url": "/api/v4/groups/{id}/access_requests", - "method": "getList", + "url": "/groups/{id}/access_requests", + "method": "getListForGroup", "httpMethod": "get", "tag": "access_requests", "typeScriptTag": "accessRequests", @@ -354,8 +354,8 @@ ] }, { - "url": "/api/v4/groups/{id}/access_requests", - "method": "requestAccessToGroup", + "url": "/groups/{id}/access_requests", + "method": "authenticateUserToGroup", "httpMethod": "post", "tag": "access_requests", "typeScriptTag": "accessRequests", @@ -377,8 +377,8 @@ ] }, { - "url": "/api/v4/projects/{id}/repository/merged_branches", - "method": "deleteMerged", + "url": "/projects/{id}/repository/merged_branches", + "method": "removeMergedBranches", "httpMethod": "delete", "tag": "branches", "typeScriptTag": "branches", @@ -395,7 +395,7 @@ "responses": [] }, { - "url": "/api/v4/projects/{id}/repository/branches/{branch}", + "url": "/projects/{id}/repository/branches/{branch}", "method": "deleteBranch", "httpMethod": "delete", "tag": "branches", @@ -420,7 +420,7 @@ "responses": [] }, { - "url": "/api/v4/projects/{id}/repository/branches/{branch}", + "url": "/projects/{id}/repository/branches/{branch}", "method": "getSingleBranch", "httpMethod": "get", "tag": "branches", @@ -450,8 +450,8 @@ ] }, { - "url": "/api/v4/projects/{id}/repository/branches/{branch}", - "method": "checkIfExists", + "url": "/projects/{id}/repository/branches/{branch}", + "method": "checkExistence", "httpMethod": "head", "tag": "branches", "typeScriptTag": "branches", @@ -475,8 +475,8 @@ "responses": [] }, { - "url": "/api/v4/projects/{id}/repository/branches", - "method": "getAll", + "url": "/projects/{id}/repository/branches", + "method": "getProjectRepository", "httpMethod": "get", "tag": "branches", "typeScriptTag": "branches", @@ -530,7 +530,7 @@ ] }, { - "url": "/api/v4/projects/{id}/repository/branches", + "url": "/projects/{id}/repository/branches", "method": "createBranch", "httpMethod": "post", "tag": "branches", @@ -567,7 +567,7 @@ ] }, { - "url": "/api/v4/projects/{id}/repository/branches/{branch}/unprotect", + "url": "/projects/{id}/repository/branches/{branch}/unprotect", "method": "unprotectBranch", "httpMethod": "put", "tag": "branches", @@ -597,7 +597,7 @@ ] }, { - "url": "/api/v4/projects/{id}/repository/branches/{branch}/protect", + "url": "/projects/{id}/repository/branches/{branch}/protect", "method": "protectBranch", "httpMethod": "put", "tag": "branches", @@ -637,7 +637,7 @@ ] }, { - "url": "/api/v4/projects/{id}/badges/{badge_id}", + "url": "/projects/{id}/badges/{badge_id}", "method": "removeFromProject", "httpMethod": "delete", "tag": "badges", @@ -662,7 +662,7 @@ "responses": [] }, { - "url": "/api/v4/projects/{id}/badges/{badge_id}", + "url": "/projects/{id}/badges/{badge_id}", "method": "getProjectBadge", "httpMethod": "get", "tag": "badges", @@ -692,7 +692,7 @@ ] }, { - "url": "/api/v4/projects/{id}/badges/{badge_id}", + "url": "/projects/{id}/badges/{badge_id}", "method": "updateProjectBadge", "httpMethod": "put", "tag": "badges", @@ -737,7 +737,7 @@ ] }, { - "url": "/api/v4/projects/{id}/badges", + "url": "/projects/{id}/badges", "method": "listViewableByAuthenticatedUser", "httpMethod": "get", "tag": "badges", @@ -777,8 +777,8 @@ ] }, { - "url": "/api/v4/projects/{id}/badges", - "method": "addProjectBadge", + "url": "/projects/{id}/badges", + "method": "addToProject", "httpMethod": "post", "tag": "badges", "typeScriptTag": "badges", @@ -820,8 +820,8 @@ ] }, { - "url": "/api/v4/projects/{id}/badges/render", - "method": "renderPreviewFromProject", + "url": "/projects/{id}/badges/render", + "method": "previewFromProject", "httpMethod": "get", "tag": "badges", "typeScriptTag": "badges", @@ -857,8 +857,8 @@ ] }, { - "url": "/api/v4/projects/{id}/access_requests/{user_id}", - "method": "denyAccessToUser", + "url": "/projects/{id}/access_requests/{user_id}", + "method": "denyAccessRequest", "httpMethod": "delete", "tag": "access_requests", "typeScriptTag": "accessRequests", @@ -882,8 +882,8 @@ "responses": [] }, { - "url": "/api/v4/projects/{id}/access_requests/{user_id}/approve", - "method": "approveForUser", + "url": "/projects/{id}/access_requests/{user_id}/approve", + "method": "approveUserAccess", "httpMethod": "put", "tag": "access_requests", "typeScriptTag": "accessRequests", @@ -918,8 +918,8 @@ ] }, { - "url": "/api/v4/projects/{id}/access_requests", - "method": "getList", + "url": "/projects/{id}/access_requests", + "method": "listForProject", "httpMethod": "get", "tag": "access_requests", "typeScriptTag": "accessRequests", @@ -953,7 +953,7 @@ ] }, { - "url": "/api/v4/projects/{id}/access_requests", + "url": "/projects/{id}/access_requests", "method": "requestAccessToProject", "httpMethod": "post", "tag": "access_requests", @@ -976,7 +976,7 @@ ] }, { - "url": "/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}", + "url": "/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}", "method": "removeMetricImage", "httpMethod": "delete", "tag": "alert_management", @@ -1013,8 +1013,8 @@ ] }, { - "url": "/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}", - "method": "updateMetricImage", + "url": "/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}", + "method": "updateMetricImageForAlert", "httpMethod": "put", "tag": "alert_management", "typeScriptTag": "alertManagement", @@ -1060,8 +1060,8 @@ ] }, { - "url": "/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images", - "method": "getMetricImagesForAlert", + "url": "/projects/{id}/alert_management_alerts/{alert_iid}/metric_images", + "method": "getMetricImages", "httpMethod": "get", "tag": "alert_management", "typeScriptTag": "alertManagement", @@ -1090,8 +1090,8 @@ ] }, { - "url": "/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images", - "method": "uploadMetricImage", + "url": "/projects/{id}/alert_management_alerts/{alert_iid}/metric_images", + "method": "uploadMetricImageForAlert", "httpMethod": "post", "tag": "alert_management", "typeScriptTag": "alertManagement", @@ -1139,8 +1139,8 @@ ] }, { - "url": "/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize", - "method": "authorizeMetricImageUpload", + "url": "/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize", + "method": "authorizeMetricImageFileUpload", "httpMethod": "post", "tag": "alert_management", "typeScriptTag": "alertManagement", @@ -1164,7 +1164,7 @@ "responses": [] }, { - "url": "/api/v4/admin/batched_background_migrations/{id}", + "url": "/admin/batched_background_migrations/{id}", "method": "getMigration", "httpMethod": "get", "tag": "batched_background_migrations", @@ -1193,8 +1193,8 @@ ] }, { - "url": "/api/v4/admin/batched_background_migrations", - "method": "list", + "url": "/admin/batched_background_migrations", + "method": "listMigrations", "httpMethod": "get", "tag": "batched_background_migrations", "typeScriptTag": "batchedBackgroundMigrations", @@ -1215,7 +1215,7 @@ ] }, { - "url": "/api/v4/admin/batched_background_migrations/{id}/resume", + "url": "/admin/batched_background_migrations/{id}/resume", "method": "resumeMigration", "httpMethod": "put", "tag": "batched_background_migrations", @@ -1244,7 +1244,7 @@ ] }, { - "url": "/api/v4/admin/batched_background_migrations/{id}/pause", + "url": "/admin/batched_background_migrations/{id}/pause", "method": "pauseMigration", "httpMethod": "put", "tag": "batched_background_migrations", @@ -1273,7 +1273,7 @@ ] }, { - "url": "/api/v4/admin/ci/variables/{key}", + "url": "/admin/ci/variables/{key}", "method": "deleteInstanceVariable", "httpMethod": "delete", "tag": "ci_variables", @@ -1296,8 +1296,8 @@ ] }, { - "url": "/api/v4/admin/ci/variables/{key}", - "method": "getSpecificInstanceVariable", + "url": "/admin/ci/variables/{key}", + "method": "getInstanceVariableDetails", "httpMethod": "get", "tag": "ci_variables", "typeScriptTag": "ciVariables", @@ -1319,7 +1319,7 @@ ] }, { - "url": "/api/v4/admin/ci/variables/{key}", + "url": "/admin/ci/variables/{key}", "method": "updateInstanceVariable", "httpMethod": "put", "tag": "ci_variables", @@ -1367,8 +1367,8 @@ ] }, { - "url": "/api/v4/admin/ci/variables", - "method": "listInstanceVariables", + "url": "/admin/ci/variables", + "method": "listAllInstanceVariables", "httpMethod": "get", "tag": "ci_variables", "typeScriptTag": "ciVariables", @@ -1395,8 +1395,8 @@ ] }, { - "url": "/api/v4/admin/ci/variables", - "method": "createNewInstanceVariable", + "url": "/admin/ci/variables", + "method": "createNewInstanceLevelVariable", "httpMethod": "post", "tag": "ci_variables", "typeScriptTag": "ciVariables", @@ -1449,7 +1449,7 @@ ] }, { - "url": "/api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}", + "url": "/admin/databases/{database_name}/dictionary/tables/{table_name}", "method": "getDictionaryDetails", "httpMethod": "get", "tag": "admin", @@ -1479,7 +1479,7 @@ ] }, { - "url": "/api/v4/admin/clusters/{cluster_id}", + "url": "/admin/clusters/{cluster_id}", "method": "deleteInstanceCluster", "httpMethod": "delete", "tag": "clusters", @@ -1502,8 +1502,8 @@ ] }, { - "url": "/api/v4/admin/clusters/{cluster_id}", - "method": "getSingleInstanceCluster", + "url": "/admin/clusters/{cluster_id}", + "method": "getSingleInstance", "httpMethod": "get", "tag": "clusters", "typeScriptTag": "clusters", @@ -1525,7 +1525,7 @@ ] }, { - "url": "/api/v4/admin/clusters/{cluster_id}", + "url": "/admin/clusters/{cluster_id}", "method": "updateInstanceCluster", "httpMethod": "put", "tag": "clusters", @@ -1604,8 +1604,8 @@ ] }, { - "url": "/api/v4/admin/clusters/add", - "method": "addExistingKubernetesInstanceCluster", + "url": "/admin/clusters/add", + "method": "addExistingInstance", "httpMethod": "post", "tag": "clusters", "typeScriptTag": "clusters", @@ -1700,7 +1700,7 @@ ] }, { - "url": "/api/v4/admin/clusters", + "url": "/admin/clusters", "method": "listInstanceClusters", "httpMethod": "get", "tag": "clusters", @@ -1715,7 +1715,7 @@ ] }, { - "url": "/api/v4/admin/migrations/{timestamp}/mark", + "url": "/admin/migrations/{timestamp}/mark", "method": "markAsExecuted", "httpMethod": "post", "tag": "migrations", @@ -1739,8 +1739,8 @@ "responses": [] }, { - "url": "/api/v4/applications/{id}", - "method": "deleteSpecificApplication", + "url": "/applications/{id}", + "method": "removeSpecificApplication", "httpMethod": "delete", "tag": "applications", "typeScriptTag": "applications", @@ -1757,7 +1757,7 @@ "responses": [] }, { - "url": "/api/v4/applications", + "url": "/applications", "method": "listAllRegistered", "httpMethod": "get", "tag": "applications", @@ -1772,7 +1772,7 @@ ] }, { - "url": "/api/v4/applications", + "url": "/applications", "method": "createNewApplication", "httpMethod": "post", "tag": "applications", @@ -1816,8 +1816,8 @@ ] }, { - "url": "/api/v4/avatar", - "method": "getUrlForUser", + "url": "/avatar", + "method": "getUserAvatarUrl", "httpMethod": "get", "tag": "avatar", "typeScriptTag": "avatar", @@ -1844,7 +1844,7 @@ ] }, { - "url": "/api/v4/broadcast_messages/{id}", + "url": "/broadcast_messages/{id}", "method": "deleteMessage", "httpMethod": "delete", "tag": "broadcast_messages", @@ -1867,7 +1867,7 @@ ] }, { - "url": "/api/v4/broadcast_messages/{id}", + "url": "/broadcast_messages/{id}", "method": "getSpecificMessage", "httpMethod": "get", "tag": "broadcast_messages", @@ -1890,8 +1890,8 @@ ] }, { - "url": "/api/v4/broadcast_messages/{id}", - "method": "updateMessage", + "url": "/broadcast_messages/{id}", + "method": "updateMessageById", "httpMethod": "put", "tag": "broadcast_messages", "typeScriptTag": "broadcastMessages", @@ -1958,8 +1958,8 @@ ] }, { - "url": "/api/v4/broadcast_messages", - "method": "listAll", + "url": "/broadcast_messages", + "method": "getAllMessages", "httpMethod": "get", "tag": "broadcast_messages", "typeScriptTag": "broadcastMessages", @@ -1986,7 +1986,7 @@ ] }, { - "url": "/api/v4/broadcast_messages", + "url": "/broadcast_messages", "method": "createMessage", "httpMethod": "post", "tag": "broadcast_messages", @@ -2057,7 +2057,7 @@ ] }, { - "url": "/api/v4/bulk_imports/{import_id}/entities/{entity_id}", + "url": "/bulk_imports/{import_id}/entities/{entity_id}", "method": "getEntityDetails", "httpMethod": "get", "tag": "bulk_imports", @@ -2087,7 +2087,7 @@ ] }, { - "url": "/api/v4/bulk_imports/{import_id}/entities", + "url": "/bulk_imports/{import_id}/entities", "method": "listEntities", "httpMethod": "get", "tag": "bulk_imports", @@ -2127,7 +2127,7 @@ ] }, { - "url": "/api/v4/bulk_imports/{import_id}", + "url": "/bulk_imports/{import_id}", "method": "getMigrationDetails", "httpMethod": "get", "tag": "bulk_imports", @@ -2150,7 +2150,7 @@ ] }, { - "url": "/api/v4/bulk_imports/entities", + "url": "/bulk_imports/entities", "method": "listEntities", "httpMethod": "get", "tag": "bulk_imports", @@ -2189,7 +2189,7 @@ ] }, { - "url": "/api/v4/bulk_imports", + "url": "/bulk_imports", "method": "listMigrations", "httpMethod": "get", "tag": "bulk_imports", @@ -2228,8 +2228,8 @@ ] }, { - "url": "/api/v4/bulk_imports", - "method": "startNewMigration", + "url": "/bulk_imports", + "method": "startMigration", "httpMethod": "post", "tag": "bulk_imports", "typeScriptTag": "bulkImports", @@ -2294,7 +2294,7 @@ ] }, { - "url": "/api/v4/application/appearance", + "url": "/application/appearance", "method": "getCurrentAppearance", "httpMethod": "get", "tag": "application", @@ -2309,7 +2309,7 @@ ] }, { - "url": "/api/v4/application/appearance", + "url": "/application/appearance", "method": "modifyAppearance", "httpMethod": "put", "tag": "application", @@ -2405,7 +2405,7 @@ ] }, { - "url": "/api/v4/application/plan_limits", + "url": "/application/plan_limits", "method": "getCurrentLimits", "httpMethod": "get", "tag": "plan_limits", @@ -2427,8 +2427,8 @@ ] }, { - "url": "/api/v4/application/plan_limits", - "method": "modifyLimits", + "url": "/application/plan_limits", + "method": "modifyPlanLimits", "httpMethod": "put", "tag": "plan_limits", "typeScriptTag": "planLimits", @@ -2564,7 +2564,7 @@ ] }, { - "url": "/api/v4/metadata", + "url": "/metadata", "method": "getInformation", "httpMethod": "get", "tag": "metadata", @@ -2579,8 +2579,8 @@ ] }, { - "url": "/api/v4/version", - "method": "getVersionInformation", + "url": "/version", + "method": "getVersionInfo", "httpMethod": "get", "tag": "metadata", "typeScriptTag": "metadata", @@ -2594,7 +2594,7 @@ ] }, { - "url": "/api/v4/projects/{id}/jobs", + "url": "/projects/{id}/jobs", "method": "listForProject", "httpMethod": "get", "tag": "jobs", @@ -2623,8 +2623,8 @@ ] }, { - "url": "/api/v4/projects/{id}/jobs/{job_id}", - "method": "getSingleById", + "url": "/projects/{id}/jobs/{job_id}", + "method": "getById", "httpMethod": "get", "tag": "jobs", "typeScriptTag": "jobs", @@ -2653,7 +2653,7 @@ ] }, { - "url": "/api/v4/projects/{id}/jobs/{job_id}/play", + "url": "/projects/{id}/jobs/{job_id}/play", "method": "runManualJob", "httpMethod": "post", "tag": "jobs", @@ -2696,7 +2696,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/gitlab/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/gitlab/favicon.png", "clientNameCamelCase": "gitLab", - "lastUpdated": "2024-03-24T21:41:22.682Z", + "lastUpdated": "2024-03-27T20:44:35.877Z", "typescriptSdkUsageCode": "import { GitLab } from 'git-lab-typescript-sdk';\n\nconst gitLab = new GitLab({\n apiKeyAuth: \"PRIVATE_TOKEN\"\n})", "typescriptSdkFirstRequestCode": "// Removes a badge from the group.\nconst removeFromGroupResponse = gitLab.badges.removeFromGroup({\n id: \"ID\"\n badgeId: 0\n})", "fixedSpecFileName": "git-lab-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_launchdarkly.com.json b/sdks/db/published/from-custom-request_launchdarkly.com.json index 06fe8d7130..b3cceda59b 100644 --- a/sdks/db/published/from-custom-request_launchdarkly.com.json +++ b/sdks/db/published/from-custom-request_launchdarkly.com.json @@ -13,14 +13,14 @@ "endpoints": 164, "sdkMethods": 257, "schemas": 448, - "parameters": 979, + "parameters": 982, "contactUrl": "https://support.launchdarkly.com", "contactEmail": "support@launchdarkly.com", "originalCustomRequest": { "lambda": true }, "customRequestSpecFilename": "launchdarkly.com.yaml", - "difficultyScore": 723.75, + "difficultyScore": 724.5, "difficulty": "Very Hard", "company": "LaunchDarkly", "sdkName": "launch-darkly-{language}-sdk", @@ -5237,6 +5237,26 @@ "required": false, "description": "", "example": "average" + }, + { + "name": "analysisType", + "schema": "string", + "required": false, + "description": "", + "example": "mean" + }, + { + "name": "percentileValue", + "schema": "integer", + "required": false, + "description": "", + "example": 95 + }, + { + "name": "eventDefault", + "schema": "object", + "required": false, + "description": "" } ], "responses": [ @@ -15103,7 +15123,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/launchdarkly/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/launchdarkly/favicon.png", "clientNameCamelCase": "launchDarkly", - "lastUpdated": "2024-03-27T01:23:25.425Z", + "lastUpdated": "2024-03-27T20:44:35.877Z", "typescriptSdkUsageCode": "import { LaunchDarkly } from 'launch-darkly-typescript-sdk';\n\nconst launchDarkly = new LaunchDarkly({\n apiKey: \"AUTHORIZATION\"\n})", "typescriptSdkFirstRequestCode": "// Root resource\nconst getResourceCategoriesResponse = launchDarkly.other.getResourceCategories()", "fixedSpecFileName": "launch-darkly-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_salesflare.com.json b/sdks/db/published/from-custom-request_salesflare.com.json new file mode 100644 index 0000000000..077ba52568 --- /dev/null +++ b/sdks/db/published/from-custom-request_salesflare.com.json @@ -0,0 +1,3346 @@ +{ + "securitySchemes": {}, + "apiBaseUrl": "https://api.salesflare.com", + "apiVersion": "1.0.0", + "apiDescription": "# Introduction\n\n## Getting Started\n\nThe Salesflare API allows you to access and build your own applications or integrations that interact with Salesflare.\n\nThe Salesflare API provides a RESTful interface with JSON-formatted responses to access most Salesflare resources.\n\n## Authentication\n\nThe 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.\n\nYou can make an API key in [\"Settings\" > \"API keys\"](https://app.salesflare.com/#/settings/apikeys).\n\nClick on the large orange \"+\" button on the bottom right of the screen to create an API key.\n\n![Screenshot API Key Settings](https://lib.salesflare.com/api_docs/screenshot_settings_apikeys.png)\n\n## Requests\n\nAll 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.\n\nFor PUT or POST requests (e.g. create, update), the payload must be provided as JSON in the request body.\n\n## Responses\n\nResponses use HTTP status codes, with the most typical ones being:\n\n| Code | Meaning |\n|------------------------|-----------------------|\n| Successful Responses |\n| 200 | OK |\n| Error Responses |\n| 400 | Bad Request |\n| 401 | Unauthorized |\n| 404 | Not Found |\n| 429 | Too Many Requests |\n| 500 | Internal Server Error |\n\n## Testing\n\nWe recommend testing our API with Postman.\n\n### Download specification\n\nOur API is documented following the OpenAPI specification. You can download it [here](https://api.salesflare.com/openapi.json)\n\n### Import in Postman\n\nTo import the collection, open Postman and click Import, then select \"Import From Link\"\n\nCopy & Paste the following link and press the \"Import\" button:\n\n> https://api.salesflare.com/openapi.json\n\n![Screenshot Postman Import](https://lib.salesflare.com/api_docs/screenshot_postman_import.png)\n\n## Support\n\nFor API questions and support, please email support@salesflare.com or click the chat bubble below.", + "apiTitle": "Salesflare API", + "endpoints": 43, + "sdkMethods": 67, + "schemas": 86, + "parameters": 406, + "contactEmail": "support@salesflare.com", + "originalCustomRequest": { + "type": "GET", + "url": "https://api.salesflare.com/openapi.json" + }, + "customRequestSpecFilename": "salesflare.com.yaml", + "difficultyScore": 168.5, + "difficulty": "Medium", + "company": "Salesflare", + "sdkName": "salesflare-{language}-sdk", + "clientName": "Salesflare", + "metaDescription": "Salesflare is the intelligent CRM startups and small businesses love to use. It's a zero-input sales pipeline tool that thinks and works for its user, not the other way around.\n\nNo more manual data entry. Salesflare fills out your address book and keeps track of all interactions with the people you're in contact with. It takes data from social media, company databases, phone, email, calendar and hands it to you in automated customer timelines that tell you everything you need to know. You just have to write the emails, make the calls, and have the coffee.\n\nNever miss a deal again. Salesflare will tell and remind you what to do about leads so deals can't fall through the cracks anymore. Visual pipelines and powerful insights put you in full control of your sales funnel. Intuitive and easy-to-use, Salesflare turns complexity into simplicity so you can turn leads into customers.\n\nSalesflare works wherever you work and with whatever you are working with. Use it on desktop, mobile or just from a sidebar in your email inbox (Gmail and Outlook). Get even more out of Salesflare by integrating with 5000+ other productivity tools, such as Google Apps, MailChimp, Trello and Slack.\n\nThere's a free trial available from salesflare.com.", + "apiStatusUrls": "inherit", + "homepage": "salesflare.com", + "developerDocumentation": "api.salesflare.com/docs", + "categories": [ + "crm", + "sales" + ], + "category": "CRM (Customer Relationship Management)", + "methods": [ + { + "url": "/accounts", + "method": "listAccounts", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "List accounts", + "parameters": [ + { + "name": "id", + "schema": "array", + "description": "" + }, + { + "name": "details", + "schema": "boolean", + "description": "", + "default": true + }, + { + "name": "search", + "schema": "string", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "creationAfter", + "schema": "string", + "description": "" + }, + { + "name": "creationBefore", + "schema": "string", + "description": "" + }, + { + "name": "minSize", + "schema": "number", + "description": "" + }, + { + "name": "maxSize", + "schema": "number", + "description": "" + }, + { + "name": "domain", + "schema": "array", + "description": "" + }, + { + "name": "tag", + "schema": "array", + "description": "" + }, + { + "name": "tagName", + "schema": "array", + "description": "" + }, + { + "name": "addressCountry", + "schema": "array", + "description": "" + }, + { + "name": "addressCity", + "schema": "array", + "description": "" + }, + { + "name": "addressStateRegion", + "schema": "array", + "description": "" + }, + { + "name": "hotness", + "schema": "number", + "description": "1: Room temp, 2: Hot, 3: On fire" + }, + { + "name": "offset", + "schema": "number", + "description": "" + }, + { + "name": "custom", + "schema": "string", + "description": "" + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "q", + "schema": "string", + "description": "" + }, + { + "name": "limit", + "schema": "number", + "description": "", + "default": 10 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/accounts", + "method": "createAccount", + "httpMethod": "post", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Create an account", + "parameters": [ + { + "name": "updateIfExists", + "schema": "boolean", + "description": "", + "default": false + }, + { + "name": "tags", + "schema": "array", + "description": "" + }, + { + "name": "description", + "schema": "string", + "description": "" + }, + { + "name": "owner", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "domain", + "schema": "string", + "description": "" + }, + { + "name": "picture", + "schema": "string", + "description": "" + }, + { + "name": "size", + "schema": "number", + "description": "" + }, + { + "name": "website", + "schema": "string", + "description": "" + }, + { + "name": "address", + "schema": "object", + "description": "" + }, + { + "name": "addresses", + "schema": "array", + "description": "" + }, + { + "name": "email", + "schema": "string", + "description": "" + }, + { + "name": "email_addresses", + "schema": "array", + "description": "" + }, + { + "name": "phone_number", + "schema": "string", + "description": "" + }, + { + "name": "phone_numbers", + "schema": "array", + "description": "" + }, + { + "name": "social_profiles", + "schema": "array", + "description": "" + }, + { + "name": "links", + "schema": "string", + "description": "" + }, + { + "name": "customers", + "schema": "array", + "description": "" + }, + { + "name": "_dirty", + "schema": "boolean", + "description": "" + }, + { + "name": "parent_account", + "schema": "number", + "description": "" + }, + { + "name": "custom", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/contacts", + "method": "listContacts", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "List contacts", + "parameters": [ + { + "name": "id", + "schema": "array", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "email", + "schema": "string", + "description": "" + }, + { + "name": "phoneNumber", + "schema": "string", + "description": "" + }, + { + "name": "domain", + "schema": "string", + "description": "" + }, + { + "name": "modificationAfter", + "schema": "string", + "description": "" + }, + { + "name": "modificationBefore", + "schema": "string", + "description": "" + }, + { + "name": "creationAfter", + "schema": "string", + "description": "" + }, + { + "name": "creationBefore", + "schema": "string", + "description": "" + }, + { + "name": "account", + "schema": "array", + "description": "" + }, + { + "name": "tag", + "schema": "array", + "description": "" + }, + { + "name": "tagName", + "schema": "array", + "description": "" + }, + { + "name": "positionRole", + "schema": "array", + "description": "" + }, + { + "name": "addressCountry", + "schema": "array", + "description": "" + }, + { + "name": "addressStateRegion", + "schema": "array", + "description": "" + }, + { + "name": "addressCity", + "schema": "array", + "description": "" + }, + { + "name": "includeArchived", + "schema": "boolean", + "description": "" + }, + { + "name": "search", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + }, + { + "name": "limit", + "schema": "number", + "description": "", + "default": 20 + }, + { + "name": "offset", + "schema": "number", + "description": "", + "default": 0 + }, + { + "name": "custom", + "schema": "string", + "description": "" + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "q", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/contacts", + "method": "createContact", + "httpMethod": "post", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Create a contact", + "parameters": [ + { + "name": "force", + "schema": "boolean", + "description": "When force is false, the contact will not be created if a contact with the same email address used to exist.", + "default": true + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/currencies", + "method": "listSupportedCurrencies", + "httpMethod": "get", + "tag": "Regional Settings", + "typeScriptTag": "regionalSettings", + "description": "List supported currencies", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/groups", + "method": "list", + "httpMethod": "get", + "tag": "Groups", + "typeScriptTag": "groups", + "description": "List groups", + "parameters": [], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/me", + "method": "getCurrentUserDetails", + "httpMethod": "get", + "tag": "Users", + "typeScriptTag": "users", + "description": "Get current user's details", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/opportunities", + "method": "list", + "httpMethod": "get", + "tag": "Opportunities", + "typeScriptTag": "opportunities", + "description": "List opportunities", + "parameters": [ + { + "name": "search", + "schema": "string", + "description": "" + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "DEPRECATED" + }, + { + "name": "stage", + "schema": "number", + "description": "" + }, + { + "name": "stageName", + "schema": "string", + "description": "" + }, + { + "name": "owner", + "schema": "number", + "description": "" + }, + { + "name": "teamMember", + "schema": "number", + "description": "" + }, + { + "name": "ownerGroup", + "schema": "number", + "description": "" + }, + { + "name": "assigneeGroup", + "schema": "number", + "description": "" + }, + { + "name": "teamMemberGroup", + "schema": "number", + "description": "" + }, + { + "name": "account", + "schema": "number", + "description": "" + }, + { + "name": "assignee", + "schema": "number", + "description": "" + }, + { + "name": "minValue", + "schema": "number", + "description": "" + }, + { + "name": "maxValue", + "schema": "number", + "description": "" + }, + { + "name": "closeAfter", + "schema": "string", + "description": "" + }, + { + "name": "closeBefore", + "schema": "string", + "description": "" + }, + { + "name": "creationAfter", + "schema": "string", + "description": "" + }, + { + "name": "creationBefore", + "schema": "string", + "description": "" + }, + { + "name": "closed", + "schema": "boolean", + "description": "" + }, + { + "name": "done", + "schema": "boolean", + "description": "" + }, + { + "name": "tag", + "schema": "array", + "description": "" + }, + { + "name": "tagName", + "schema": "string", + "description": "" + }, + { + "name": "hotness", + "schema": "number", + "description": "1: Room temp, 2: Hot, 3: On fire" + }, + { + "name": "limit", + "schema": "number", + "description": "" + }, + { + "name": "offset", + "schema": "number", + "description": "" + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "pipeline", + "schema": "number", + "description": "" + }, + { + "name": "custom", + "schema": "string", + "description": "" + }, + { + "name": "details", + "schema": "boolean", + "description": "" + }, + { + "name": "q", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/opportunities", + "method": "createOpportunity", + "httpMethod": "post", + "tag": "Opportunities", + "typeScriptTag": "opportunities", + "description": "Create an opportunity", + "parameters": [ + { + "name": "tags", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "owner", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "account", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "stage", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "lost_reason", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "files", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "lead_source", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "start_date", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "probability", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "assignee", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "creator", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "value", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "currency", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "status_date", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "close_date", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "closed", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "recurring_price_per_unit", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "frequency", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "units", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "contract_start_date", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "contract_end_date", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "main_contact", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "custom", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/persons", + "method": "list", + "httpMethod": "get", + "tag": "Persons", + "typeScriptTag": "persons", + "description": "List persons", + "parameters": [ + { + "name": "id", + "schema": "array", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "email", + "schema": "string", + "description": "" + }, + { + "name": "search", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/pipelines", + "method": "list", + "httpMethod": "get", + "tag": "Pipelines", + "typeScriptTag": "pipelines", + "description": "List pipelines", + "parameters": [ + { + "name": "search", + "schema": "string", + "description": "" + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "q", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/stages", + "method": "listStages", + "httpMethod": "get", + "tag": "Pipelines", + "typeScriptTag": "pipelines", + "description": "List stages", + "parameters": [ + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "pipelineId", + "schema": "number", + "description": "" + }, + { + "name": "pipelineName", + "schema": "string", + "description": "" + }, + { + "name": "orderBy", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/tags", + "method": "list", + "httpMethod": "get", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "List tags", + "parameters": [ + { + "name": "id", + "schema": "array", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "This property is deprecated, use q.search instead. When both are provided, q.search will be used." + }, + { + "name": "limit", + "schema": "number", + "description": "", + "default": 20 + }, + { + "name": "offset", + "schema": "number", + "description": "", + "default": 0 + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "q", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/tags", + "method": "createTag", + "httpMethod": "post", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Create a tag", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/tasks", + "method": "listTasks", + "httpMethod": "get", + "tag": "Tasks", + "typeScriptTag": "tasks", + "description": "List tasks", + "parameters": [ + { + "name": "id", + "schema": "array", + "description": "" + }, + { + "name": "search", + "schema": "string", + "description": "" + }, + { + "name": "assignees", + "schema": "array", + "description": "Defaults to the user" + }, + { + "name": "type", + "schema": "array", + "description": "" + }, + { + "name": "account", + "schema": "array", + "description": "" + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "limit", + "schema": "number", + "description": "" + }, + { + "name": "offset", + "schema": "number", + "description": "" + }, + { + "name": "q", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/tasks", + "method": "createTask", + "httpMethod": "post", + "tag": "Tasks", + "typeScriptTag": "tasks", + "description": "Create a task", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users", + "method": "list", + "httpMethod": "get", + "tag": "Users", + "typeScriptTag": "users", + "description": "List users", + "parameters": [ + { + "name": "id", + "schema": "array", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "email", + "schema": "string", + "description": "" + }, + { + "name": "search", + "schema": "string", + "description": "" + }, + { + "name": "limit", + "schema": "number", + "description": "" + }, + { + "name": "offset", + "schema": "number", + "description": "" + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "onlyEnabled", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/workflows", + "method": "list", + "httpMethod": "get", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "List workflows", + "parameters": [ + { + "name": "limit", + "schema": "number", + "description": "", + "default": 20 + }, + { + "name": "offset", + "schema": "number", + "description": "", + "default": 0 + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "search", + "schema": "string", + "description": "" + }, + { + "name": "q", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/workflows", + "method": "createWorkflow", + "httpMethod": "post", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "Create a workflow", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "filter", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "individual_record_filter", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "status_message", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "record_type", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "goal", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "continuous", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "exit_after_days", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "schedule_date", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "schedule_time_start", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "schedule_time_end", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "schedule_days", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "steps", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/accounts/{account_id}", + "method": "id", + "httpMethod": "delete", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Delete an account", + "parameters": [ + { + "name": "accountId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/accounts/{account_id}", + "method": "id", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get account details", + "parameters": [ + { + "name": "accountId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/accounts/{account_id}", + "method": "id", + "httpMethod": "put", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Update an account", + "parameters": [ + { + "name": "accountId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "tags", + "schema": "array", + "description": "" + }, + { + "name": "description", + "schema": "string", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "domain", + "schema": "string", + "description": "" + }, + { + "name": "picture", + "schema": "string", + "description": "" + }, + { + "name": "size", + "schema": "number", + "description": "" + }, + { + "name": "website", + "schema": "string", + "description": "" + }, + { + "name": "address", + "schema": "object", + "description": "" + }, + { + "name": "addresses", + "schema": "array", + "description": "" + }, + { + "name": "email", + "schema": "string", + "description": "" + }, + { + "name": "email_addresses", + "schema": "array", + "description": "" + }, + { + "name": "phone_number", + "schema": "string", + "description": "" + }, + { + "name": "phone_numbers", + "schema": "array", + "description": "" + }, + { + "name": "social_profiles", + "schema": "array", + "description": "" + }, + { + "name": "links", + "schema": "string", + "description": "" + }, + { + "name": "_dirty", + "schema": "boolean", + "description": "" + }, + { + "name": "parent_account", + "schema": "number", + "description": "" + }, + { + "name": "custom", + "schema": "object", + "description": "" + }, + { + "name": "q", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/campaigns/mergefields", + "method": "getMergeFields", + "httpMethod": "get", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "Get a workflow's merge fields", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/conferences/{conference_id}", + "method": "id", + "httpMethod": "get", + "tag": "Meetings", + "typeScriptTag": "meetings", + "description": "Get meeting details by conference id", + "parameters": [ + { + "name": "conferenceId", + "schema": "string", + "required": true, + "description": "", + "example": "CONFERENCE_ID" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/contacts/{contact_id}", + "method": "id", + "httpMethod": "delete", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Delete a contact", + "parameters": [ + { + "name": "contactId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/contacts/{contact_id}", + "method": "id", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get contact details", + "parameters": [ + { + "name": "contactId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/contacts/{contact_id}", + "method": "id", + "httpMethod": "put", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Update a contact", + "parameters": [ + { + "name": "contactId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "force", + "schema": "boolean", + "description": "When force is false, the contact's name will not be updated if the name in the update is just the first part of the email address.", + "default": true + }, + { + "name": "tags", + "schema": "array", + "description": "" + }, + { + "name": "prefix", + "schema": "string", + "description": "" + }, + { + "name": "firstname", + "schema": "string", + "description": "" + }, + { + "name": "middle", + "schema": "string", + "description": "" + }, + { + "name": "lastname", + "schema": "string", + "description": "" + }, + { + "name": "suffix", + "schema": "string", + "description": "" + }, + { + "name": "email", + "schema": "string", + "description": "" + }, + { + "name": "role", + "schema": "string", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "owner", + "schema": "number", + "description": "" + }, + { + "name": "picture", + "schema": "string", + "description": "" + }, + { + "name": "account", + "schema": "number", + "description": "" + }, + { + "name": "birth_date", + "schema": "string", + "description": "" + }, + { + "name": "opt-out", + "schema": "boolean", + "description": "" + }, + { + "name": "opt-out_date", + "schema": "string", + "description": "" + }, + { + "name": "opt-out_campaign", + "schema": "string", + "description": "" + }, + { + "name": "bounced", + "schema": "boolean", + "description": "" + }, + { + "name": "bounced_date", + "schema": "string", + "description": "" + }, + { + "name": "files", + "schema": "array", + "description": "" + }, + { + "name": "address", + "schema": "object", + "description": "" + }, + { + "name": "addresses", + "schema": "array", + "description": "" + }, + { + "name": "phone_number", + "schema": "string", + "description": "" + }, + { + "name": "mobile_phone_number", + "schema": "string", + "description": "" + }, + { + "name": "home_phone_number", + "schema": "string", + "description": "" + }, + { + "name": "fax_number", + "schema": "string", + "description": "" + }, + { + "name": "phone_numbers", + "schema": "array", + "description": "" + }, + { + "name": "position", + "schema": "object", + "description": "" + }, + { + "name": "positions", + "schema": "array", + "description": "" + }, + { + "name": "social_profiles", + "schema": "array", + "description": "" + }, + { + "name": "custom", + "schema": "object", + "description": "" + }, + { + "name": "_dirty", + "schema": "boolean", + "description": "" + }, + { + "name": "archived", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/customfields/types", + "method": "listTypes", + "httpMethod": "get", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "List custom field types", + "parameters": [], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/customfields/{itemClass}", + "method": "listTypeCustomFields", + "httpMethod": "get", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "List custom fields of a type", + "parameters": [ + { + "name": "itemClass", + "schema": "string", + "required": true, + "description": "", + "example": "ITEMCLASS" + }, + { + "name": "includeDisabled", + "schema": "boolean", + "description": "" + }, + { + "name": "pipeline", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/customfields/{itemClass}", + "method": "createFieldType", + "httpMethod": "post", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Create a custom field of a type", + "parameters": [ + { + "name": "itemClass", + "schema": "string", + "required": true, + "description": "", + "example": "ITEMCLASS" + }, + { + "name": "type", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "enabled", + "schema": "boolean", + "description": "" + }, + { + "name": "archived", + "schema": "boolean", + "description": "" + }, + { + "name": "required", + "schema": "boolean", + "description": "" + }, + { + "name": "pipeline", + "schema": "number", + "description": "" + }, + { + "name": "predefined_customfield", + "schema": "number", + "description": "" + }, + { + "name": "users_can_add_options", + "schema": "boolean", + "description": "" + }, + { + "name": "options", + "schema": "array", + "description": "" + }, + { + "name": "order_alphabetically", + "schema": "boolean", + "description": "", + "default": false + }, + { + "name": "min_number", + "schema": "number", + "description": "" + }, + { + "name": "max_number", + "schema": "number", + "description": "" + }, + { + "name": "min_date", + "schema": "string", + "description": "" + }, + { + "name": "max_date", + "schema": "string", + "description": "" + }, + { + "name": "default_boolean_value", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/datasources/email", + "method": "list", + "httpMethod": "get", + "tag": "Email Data Sources", + "typeScriptTag": "emailDataSources", + "description": "List email data sources", + "parameters": [ + { + "name": "includeTeamDataSources", + "schema": "boolean", + "description": "Team data sources will only be included when the session user is an admin.", + "default": false + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/filterfields/{entity}", + "method": "listForEntity", + "httpMethod": "get", + "tag": "Filter Fields", + "typeScriptTag": "filterFields", + "description": "List filter fields for an entity", + "parameters": [ + { + "name": "entity", + "schema": "string", + "required": true, + "description": "", + "example": "ENTITY" + }, + { + "name": "pipeline", + "schema": "number", + "description": "" + }, + { + "name": "includePipelineSpecificPredefinedFilterFields", + "schema": "boolean", + "description": "", + "default": true + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/groups/{id}", + "method": "getById", + "httpMethod": "get", + "tag": "Groups", + "typeScriptTag": "groups", + "description": "Get a group", + "parameters": [], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/me/contacts", + "method": "listContacts", + "httpMethod": "get", + "tag": "Users", + "typeScriptTag": "users", + "description": "List current user's contacts", + "parameters": [ + { + "name": "id", + "schema": "array", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "email", + "schema": "string", + "description": "" + }, + { + "name": "phoneNumber", + "schema": "string", + "description": "" + }, + { + "name": "domain", + "schema": "string", + "description": "" + }, + { + "name": "modificationAfter", + "schema": "string", + "description": "" + }, + { + "name": "modificationBefore", + "schema": "string", + "description": "" + }, + { + "name": "creationAfter", + "schema": "string", + "description": "" + }, + { + "name": "creationBefore", + "schema": "string", + "description": "" + }, + { + "name": "account", + "schema": "array", + "description": "" + }, + { + "name": "tag", + "schema": "array", + "description": "" + }, + { + "name": "tagName", + "schema": "array", + "description": "" + }, + { + "name": "positionRole", + "schema": "array", + "description": "" + }, + { + "name": "addressCountry", + "schema": "array", + "description": "" + }, + { + "name": "addressStateRegion", + "schema": "array", + "description": "" + }, + { + "name": "addressCity", + "schema": "array", + "description": "" + }, + { + "name": "includeArchived", + "schema": "boolean", + "description": "" + }, + { + "name": "search", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + }, + { + "name": "limit", + "schema": "number", + "description": "", + "default": 20 + }, + { + "name": "offset", + "schema": "number", + "description": "", + "default": 0 + }, + { + "name": "custom", + "schema": "string", + "description": "" + }, + { + "name": "orderBy", + "schema": "array", + "description": "Can be just 'key' e.g. 'name' or 'key sortOrder' e.g. 'name desc'. Defaults to asc." + }, + { + "name": "q", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/meetings/{meeting_id}", + "method": "id", + "httpMethod": "delete", + "tag": "Meetings", + "typeScriptTag": "meetings", + "description": "Delete a meeting", + "parameters": [ + { + "name": "meetingId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/meetings/{meeting_id}", + "method": "id", + "httpMethod": "get", + "tag": "Meetings", + "typeScriptTag": "meetings", + "description": "Get meeting details", + "parameters": [ + { + "name": "meetingId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/meetings/{meeting_id}", + "method": "id", + "httpMethod": "put", + "tag": "Meetings", + "typeScriptTag": "meetings", + "description": "Update a meeting", + "parameters": [ + { + "name": "meetingId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "calendar_id", + "schema": "string", + "required": true, + "description": "", + "example": "CALENDAR_ID" + }, + { + "name": "external_id", + "schema": "string", + "required": true, + "description": "", + "example": "EXTERNAL_ID" + }, + { + "name": "minutes", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "notes", + "schema": "string", + "required": true, + "description": "", + "example": "NOTES" + }, + { + "name": "edited_by", + "schema": "number", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/opportunities/{id}", + "method": "removeOpportunity", + "httpMethod": "delete", + "tag": "Opportunities", + "typeScriptTag": "opportunities", + "description": "Delete an opportunity", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/opportunities/{id}", + "method": "getDetails", + "httpMethod": "get", + "tag": "Opportunities", + "typeScriptTag": "opportunities", + "description": "Get opportunity details", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/opportunities/{id}", + "method": "updateOpportunity", + "httpMethod": "put", + "tag": "Opportunities", + "typeScriptTag": "opportunities", + "description": "Update an opportunity", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "tags", + "schema": "array", + "description": "" + }, + { + "name": "owner", + "schema": "number", + "description": "" + }, + { + "name": "account", + "schema": "number", + "description": "" + }, + { + "name": "stage", + "schema": "number", + "description": "" + }, + { + "name": "lost_reason", + "schema": "number", + "description": "" + }, + { + "name": "files", + "schema": "array", + "description": "" + }, + { + "name": "lead_source", + "schema": "number", + "description": "" + }, + { + "name": "start_date", + "schema": "string", + "description": "" + }, + { + "name": "probability", + "schema": "number", + "description": "" + }, + { + "name": "assignee", + "schema": "number", + "description": "" + }, + { + "name": "creator", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "value", + "schema": "number", + "description": "" + }, + { + "name": "close_date", + "schema": "string", + "description": "" + }, + { + "name": "closed", + "schema": "boolean", + "description": "" + }, + { + "name": "done", + "schema": "boolean", + "description": "" + }, + { + "name": "recurring_price_per_unit", + "schema": "number", + "description": "" + }, + { + "name": "frequency", + "schema": "string", + "description": "" + }, + { + "name": "units", + "schema": "number", + "description": "" + }, + { + "name": "contract_start_date", + "schema": "string", + "description": "" + }, + { + "name": "contract_end_date", + "schema": "string", + "description": "" + }, + { + "name": "main_contact", + "schema": "number", + "description": "" + }, + { + "name": "custom", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/stages/{stage_id}", + "method": "id", + "httpMethod": "get", + "tag": "Pipelines", + "typeScriptTag": "pipelines", + "description": "Get stage details", + "parameters": [ + { + "name": "stageId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/tags/{tag_id}", + "method": "id", + "httpMethod": "delete", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Delete a tag", + "parameters": [ + { + "name": "tagId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/tags/{tag_id}", + "method": "id", + "httpMethod": "get", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Get tag details", + "parameters": [ + { + "name": "tagId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/tags/{tag_id}", + "method": "id", + "httpMethod": "put", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Update a tag", + "parameters": [ + { + "name": "tagId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{id}", + "method": "getUserDetails", + "httpMethod": "get", + "tag": "Users", + "typeScriptTag": "users", + "description": "Get user details", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/workflows/{id}", + "method": "getDetails", + "httpMethod": "get", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "Get workflow details", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/workflows/{id}", + "method": "updateWorkflow", + "httpMethod": "put", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "Update a workflow", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "filter", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "individual_record_filter", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "status_message", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "record_type", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "goal", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "continuous", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "exit_after_days", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "schedule_date", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "schedule_time_start", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "schedule_time_end", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "schedule_days", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "steps", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/accounts/{account_id}/messages", + "method": "idMessages", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "List an account's messages", + "parameters": [ + { + "name": "accountId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "before", + "schema": "string", + "description": "" + }, + { + "name": "after", + "schema": "string", + "description": "", + "default": "1970-01-01T00:00:00.000Z" + }, + { + "name": "limit", + "schema": "number", + "description": "", + "default": 10 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/customfields/{itemClass}/{id}", + "method": "deleteCustomField", + "httpMethod": "delete", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Delete a custom field", + "parameters": [ + { + "name": "itemClass", + "schema": "string", + "required": true, + "description": "", + "example": "ITEMCLASS" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/customfields/{itemClass}/{id}", + "method": "getDetails", + "httpMethod": "get", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Get custom field details", + "parameters": [ + { + "name": "itemClass", + "schema": "string", + "required": true, + "description": "", + "example": "ITEMCLASS" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/customfields/{itemClass}/{id}", + "method": "updateField", + "httpMethod": "put", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Update a custom field", + "parameters": [ + { + "name": "itemClass", + "schema": "string", + "required": true, + "description": "", + "example": "ITEMCLASS" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "type", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "enabled", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "archived", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "required", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "pipeline", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "pipelineName", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "order", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "predefined_customfield", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "users_can_add_options", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "options", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "order_alphabetically", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "min_number", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "max_number", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "min_date", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "max_date", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/tags/{tag_id}/usage", + "method": "idUsage", + "httpMethod": "get", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Get tag details on usage in workflows, saved filters & reports", + "parameters": [ + { + "name": "tagId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/customfields/{itemClass}/{customFieldApiField}/options", + "method": "listOptions", + "httpMethod": "get", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "List a custom field's options", + "parameters": [ + { + "name": "itemClass", + "schema": "string", + "required": true, + "description": "", + "example": "ITEMCLASS" + }, + { + "name": "customFieldApiField", + "schema": "string", + "required": true, + "description": "", + "example": "CUSTOMFIELDAPIFIELD" + }, + { + "name": "searchString", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/calls", + "method": "createCall", + "httpMethod": "post", + "tag": "Calls", + "typeScriptTag": "calls", + "description": "Create a call", + "parameters": [], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/meetings", + "method": "createMeeting", + "httpMethod": "post", + "tag": "Meetings", + "typeScriptTag": "meetings", + "description": "Create a meeting", + "parameters": [], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/messages", + "method": "createNote", + "httpMethod": "post", + "tag": "Internal Notes", + "typeScriptTag": "internalNotes", + "description": "Create an internal note", + "parameters": [ + { + "name": "account", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "body", + "schema": "string", + "required": true, + "description": "", + "example": "BODY" + }, + { + "name": "mentions", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "date", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/accounts/{account_id}/users", + "method": "idUsers", + "httpMethod": "post", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Update an account's users", + "parameters": [ + { + "name": "accountId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/accounts/{account_id}/users", + "method": "idUsers", + "httpMethod": "put", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Update an account's users", + "parameters": [ + { + "name": "accountId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/accounts/{account_id}/contacts", + "method": "idContacts", + "httpMethod": "post", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Update an account's contacts", + "parameters": [ + { + "name": "accountId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/accounts/{account_id}/contacts", + "method": "idContacts", + "httpMethod": "put", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Update an account's contacts", + "parameters": [ + { + "name": "accountId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/calls/{meeting_id}", + "method": "id", + "httpMethod": "put", + "tag": "Calls", + "typeScriptTag": "calls", + "description": "Update a call", + "parameters": [ + { + "name": "meetingId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "calendar_id", + "schema": "string", + "required": true, + "description": "", + "example": "CALENDAR_ID" + }, + { + "name": "external_id", + "schema": "string", + "required": true, + "description": "", + "example": "EXTERNAL_ID" + }, + { + "name": "minutes", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "notes", + "schema": "string", + "required": true, + "description": "", + "example": "NOTES" + }, + { + "name": "edited_by", + "schema": "number", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/messages/{message_id}", + "method": "id", + "httpMethod": "delete", + "tag": "Internal Notes", + "typeScriptTag": "internalNotes", + "description": "Delete an internal note", + "parameters": [ + { + "name": "messageId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/messages/{message_id}", + "method": "id", + "httpMethod": "put", + "tag": "Internal Notes", + "typeScriptTag": "internalNotes", + "description": "Update an internal note", + "parameters": [ + { + "name": "messageId", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "account", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "body", + "schema": "string", + "required": true, + "description": "", + "example": "BODY" + }, + { + "name": "mentions", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "date", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/tasks/{id}", + "method": "deleteTask", + "httpMethod": "delete", + "tag": "Tasks", + "typeScriptTag": "tasks", + "description": "Delete a task", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/tasks/{id}", + "method": "updateTask", + "httpMethod": "put", + "tag": "Tasks", + "typeScriptTag": "tasks", + "description": "Update a task", + "parameters": [ + { + "name": "description", + "schema": "string", + "description": "" + }, + { + "name": "account", + "schema": "number", + "description": "" + }, + { + "name": "reminder_date", + "schema": "string", + "description": "" + }, + { + "name": "assignees", + "schema": "array", + "description": "" + }, + { + "name": "completed", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/datasources/email/{id}", + "method": "updateDataSource", + "httpMethod": "put", + "tag": "Email Data Sources", + "typeScriptTag": "emailDataSources", + "description": "Update an email data source", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "email_signature", + "schema": "string", + "description": "" + }, + { + "name": "add_signature_to_campaign", + "schema": "boolean", + "description": "" + }, + { + "name": "add_signature_to_replies", + "schema": "boolean", + "description": "" + }, + { + "name": "max_emails_day", + "schema": "number", + "description": "" + }, + { + "name": "max_emails_hour", + "schema": "number", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/workflows/{id}/audience/{record_id}", + "method": "id", + "httpMethod": "put", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "Exit an entity from a workflow", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "recordId", + "schema": "number", + "required": true, + "description": "This is the entity id. For email workflows this should be the contact id.", + "example": 0 + }, + { + "name": "exited", + "schema": "boolean", + "description": "" + }, + { + "name": "met_goal", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + } + ], + "repositoryDescription": "Salesflare is an intelligent CRM for startups and small businesses. It automates data input, organizes interactions, and provides insights to boost sales. Accessible on desktop, mobile, and email platforms with 5000+ integrations. Salesflare's {language} SDK generated by Konfig (https://konfigthis.com/).", + "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/salesflare/logo.png", + "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/salesflare/openapi.yaml", + "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/salesflare/openapi.yaml", + "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/salesflare/imagePreview.jpg", + "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/salesflare/favicon.png", + "clientNameCamelCase": "salesflare", + "lastUpdated": "2024-03-27T20:44:35.877Z", + "typescriptSdkUsageCode": "import { Salesflare } from 'salesflare-typescript-sdk';\n\nconst salesflare = new Salesflare()", + "typescriptSdkFirstRequestCode": "// List accounts\nconst listAccountsResponse = salesflare.accounts.listAccounts({\n details: true\n limit: 10\n})", + "fixedSpecFileName": "salesflare-fixed-spec.yaml" +} \ No newline at end of file diff --git a/sdks/db/published/from-custom-request_withterminal.com.json b/sdks/db/published/from-custom-request_withterminal.com.json index 8713fa76fb..4af0b638c3 100644 --- a/sdks/db/published/from-custom-request_withterminal.com.json +++ b/sdks/db/published/from-custom-request_withterminal.com.json @@ -95,7 +95,7 @@ "name": "tag", "schema": "string", "description": "Filter connections by tag", - "example": "sunt do est sit" + "example": "non mollit reprehenderit" }, { "name": "updatedAfter", @@ -153,7 +153,7 @@ "name": "externalId", "schema": "string", "description": "", - "example": "ipsum enim" + "example": "elit commodo in sunt" }, { "name": "provider", @@ -216,8 +216,8 @@ "schema": "array", "description": "", "example": [ - "laboris s", - "commodo exercitation in" + "Excepteur Ut", + "deserunt incididunt eu" ] }, { @@ -229,13 +229,13 @@ "name": "externalId", "schema": "string", "description": "", - "example": "Excepteur enim irure" + "example": "pariatur dolor minim" }, { "name": "status", "schema": "string", "description": "", - "example": "mollit sunt aliquip" + "example": "do" }, { "name": "syncMode", @@ -700,13 +700,13 @@ "name": "startDate", "schema": "string", "description": "Only include daily logs from on or after a specific date", - "example": "1984-11-05" + "example": "1992-10-05" }, { "name": "endDate", "schema": "string", "description": "Only include daily logs from on or before a specific date", - "example": "1984-11-05" + "example": "1992-10-05" }, { "name": "modifiedAfter", @@ -834,13 +834,13 @@ "name": "lastReportedAfter", "schema": "string", "description": "Timestamp to start when the issue was last observed", - "example": "1957-08-03" + "example": "1999-09-28" }, { "name": "lastReportedBefore", "schema": "string", "description": "Timestamp to end when the issue was last observed", - "example": "1957-08-03" + "example": "1999-09-28" }, { "name": "expand", @@ -858,7 +858,7 @@ "name": "errorCode", "schema": "string", "description": "Filter issues to a specific error code", - "example": "unknown_device_type" + "example": "missing_permissions" }, { "name": "status", @@ -1504,7 +1504,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/terminal/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/terminal/favicon.png", "clientNameCamelCase": "terminal", - "lastUpdated": "2024-03-27T01:23:25.425Z", + "lastUpdated": "2024-03-27T20:44:35.877Z", "typescriptSdkUsageCode": "import { Terminal } from 'terminal-typescript-sdk';\n\nconst terminal = new Terminal({\n bearerAuth: \"BEARER_AUTH\"\n})", "typescriptSdkFirstRequestCode": "// Public Token Exchange\nconst exchangeTokenResponse = terminal.authentication.exchangeToken({\n publicToken: \"INSERT_PUBLIC_TOKEN\"\n})", "fixedSpecFileName": "terminal-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_ynab.com.json b/sdks/db/published/from-custom-request_ynab.com.json index 91ed5caa6b..22ef0a335d 100644 --- a/sdks/db/published/from-custom-request_ynab.com.json +++ b/sdks/db/published/from-custom-request_ynab.com.json @@ -1035,7 +1035,7 @@ "httpMethod": "get", "tag": "Transactions", "typeScriptTag": "transactions", - "description": "List category transactions", + "description": "List category transactions, excluding any pending transactions", "parameters": [ { "name": "budgetId", @@ -1088,7 +1088,7 @@ "httpMethod": "get", "tag": "Transactions", "typeScriptTag": "transactions", - "description": "List payee transactions", + "description": "List payee transactions, excluding any pending transactions", "parameters": [ { "name": "budgetId", @@ -1217,7 +1217,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/you-need-a-budget/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/you-need-a-budget/favicon.png", "clientNameCamelCase": "ynab", - "lastUpdated": "2024-03-27T01:23:25.425Z", + "lastUpdated": "2024-03-27T20:44:35.877Z", "typescriptSdkUsageCode": "import { YNAB } from 'ynab-typescript-sdk';\n\nconst ynab = new YNAB({\n bearer: \"BEARER\"\n})", "typescriptSdkFirstRequestCode": "// User info\nconst infoGetResponse = ynab.user.infoGet()", "fixedSpecFileName": "ynab-fixed-spec.yaml" diff --git a/sdks/db/spec-data/bluemix.net_containers_3.0.0.json b/sdks/db/spec-data/bluemix.net_containers_3.0.0.json index 85eb3147d5..3440adf00d 100644 --- a/sdks/db/spec-data/bluemix.net_containers_3.0.0.json +++ b/sdks/db/spec-data/bluemix.net_containers_3.0.0.json @@ -17,5 +17,5 @@ "schemas": 37, "parameters": 170, "difficultyScore": 108, - "difficulty": "Easy" + "difficulty": "Medium" } \ No newline at end of file diff --git a/sdks/db/spec-data/from-custom-request_gitlab.com.json b/sdks/db/spec-data/from-custom-request_gitlab.com.json index bd4fa76969..aa38da2d32 100644 --- a/sdks/db/spec-data/from-custom-request_gitlab.com.json +++ b/sdks/db/spec-data/from-custom-request_gitlab.com.json @@ -6,7 +6,7 @@ "name": "Private-Token" } }, - "apiBaseUrl": "https://www.gitlab.com/api/", + "apiBaseUrl": "https://www.gitlab.com/api/v4", "apiVersion": "v4", "apiDescription": "An OpenAPI definition for the GitLab REST API.\nFew API resources or endpoints are currently included.\nThe intent is to expand this to match the entire Markdown documentation of the API:\n. Contributions are welcome.\n\nWhen viewing this on gitlab.com, you can test API calls directly from the browser\nagainst the `gitlab.com` instance, if you are logged in.\nThe feature uses the current [GitLab session cookie](https://docs.gitlab.com/ee/api/index.html#session-cookie),\nso each request is made using your account.\n\nInstructions for using this tool can be found in [Interactive API Documentation](https://docs.gitlab.com/ee/api/openapi/openapi_interactive.html)\n", "apiTitle": "GitLab API", diff --git a/sdks/db/spec-data/from-custom-request_launchdarkly.com.json b/sdks/db/spec-data/from-custom-request_launchdarkly.com.json index 36aa743daf..0236ecc601 100644 --- a/sdks/db/spec-data/from-custom-request_launchdarkly.com.json +++ b/sdks/db/spec-data/from-custom-request_launchdarkly.com.json @@ -13,13 +13,13 @@ "endpoints": 164, "sdkMethods": 257, "schemas": 444, - "parameters": 979, + "parameters": 982, "contactUrl": "https://support.launchdarkly.com", "contactEmail": "support@launchdarkly.com", "originalCustomRequest": { "lambda": true }, "customRequestSpecFilename": "launchdarkly.com.yaml", - "difficultyScore": 723.75, + "difficultyScore": 724.5, "difficulty": "Very Hard" } \ No newline at end of file diff --git a/sdks/db/spec-data/from-custom-request_salesflare.com.json b/sdks/db/spec-data/from-custom-request_salesflare.com.json new file mode 100644 index 0000000000..2793253a52 --- /dev/null +++ b/sdks/db/spec-data/from-custom-request_salesflare.com.json @@ -0,0 +1,19 @@ +{ + "securitySchemes": {}, + "apiBaseUrl": "https://api.salesflare.com", + "apiVersion": "1.0.0", + "apiDescription": "# Introduction\n\n## Getting Started\n\nThe Salesflare API allows you to access and build your own applications or integrations that interact with Salesflare.\n\nThe Salesflare API provides a RESTful interface with JSON-formatted responses to access most Salesflare resources.\n\n## Authentication\n\nThe 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.\n\nYou can make an API key in [\"Settings\" > \"API keys\"](https://app.salesflare.com/#/settings/apikeys).\n\nClick on the large orange \"+\" button on the bottom right of the screen to create an API key.\n\n![Screenshot API Key Settings](https://lib.salesflare.com/api_docs/screenshot_settings_apikeys.png)\n\n## Requests\n\nAll 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.\n\nFor PUT or POST requests (e.g. create, update), the payload must be provided as JSON in the request body.\n\n## Responses\n\nResponses use HTTP status codes, with the most typical ones being:\n\n| Code | Meaning |\n|------------------------|-----------------------|\n| Successful Responses |\n| 200 | OK |\n| Error Responses |\n| 400 | Bad Request |\n| 401 | Unauthorized |\n| 404 | Not Found |\n| 429 | Too Many Requests |\n| 500 | Internal Server Error |\n\n## Testing\n\nWe recommend testing our API with Postman.\n\n### Download specification\n\nOur API is documented following the OpenAPI specification. You can download it [here](https://api.salesflare.com/openapi.json)\n\n### Import in Postman\n\nTo import the collection, open Postman and click Import, then select \"Import From Link\"\n\nCopy & Paste the following link and press the \"Import\" button:\n\n> https://api.salesflare.com/openapi.json\n\n![Screenshot Postman Import](https://lib.salesflare.com/api_docs/screenshot_postman_import.png)\n\n## Support\n\nFor API questions and support, please email support@salesflare.com or click the chat bubble below.", + "apiTitle": "Salesflare API", + "endpoints": 43, + "sdkMethods": 67, + "schemas": 0, + "parameters": 406, + "contactEmail": "support@salesflare.com", + "originalCustomRequest": { + "type": "GET", + "url": "https://api.salesflare.com/openapi.json" + }, + "customRequestSpecFilename": "salesflare.com.yaml", + "difficultyScore": 168.5, + "difficulty": "Medium" +} \ No newline at end of file diff --git a/sdks/db/transpile-postman-to-openapi-cache/withterminal.com-4e42941dff7e7be3cfbca80afc5326a21160c0a03dcebfc5c5118305e3e9ab25.json b/sdks/db/transpile-postman-to-openapi-cache/withterminal.com-4e42941dff7e7be3cfbca80afc5326a21160c0a03dcebfc5c5118305e3e9ab25.json new file mode 100644 index 0000000000..8d3bf2e93e --- /dev/null +++ b/sdks/db/transpile-postman-to-openapi-cache/withterminal.com-4e42941dff7e7be3cfbca80afc5326a21160c0a03dcebfc5c5118305e3e9ab25.json @@ -0,0 +1,2224 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Terminal API", + "description": "Terminal is a unified API that makes it easy to integrate with the leading telematics service providers.\n\nContact Support:\n Name: Terminal\n Email: connect@withterminal.com", + "version": "1.0.0", + "contact": {} + }, + "servers": [ + { + "url": "https://api.sandbox.withterminal.com/tsp/v1/" + } + ], + "paths": { + "/public-token/exchange": { + "post": { + "tags": [ + "Authentication" + ], + "summary": "Public Token Exchange", + "description": "Exchange the `publicToken` returned by our hosted authentication flow for a long lived connection token that will be used when requesting data from a customer's TSP.", + "operationId": "publicTokenExchange", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "publicToken": { + "type": "string", + "example": "INSERT_PUBLIC_TOKEN" + } + } + }, + "examples": { + "Public Token Exchange": { + "value": { + "publicToken": "INSERT_PUBLIC_TOKEN" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/connections": { + "get": { + "tags": [ + "Connections" + ], + "summary": "List All Connections", + "description": "List all of the connections you have for your application. Connections represent the authenticated access you have to your customer's TSP data.", + "operationId": "listAllConnections", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "externalId", + "in": "query", + "schema": { + "type": "string", + "example": "123" + } + }, + { + "name": "dotNumber", + "in": "query", + "schema": { + "type": "string", + "example": "123" + } + }, + { + "name": "tag", + "in": "query", + "schema": { + "type": "string", + "example": "non mollit reprehenderit" + }, + "description": "Filter connections by tag" + }, + { + "name": "updatedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Filter connections that were last updated on or after a given time." + }, + { + "name": "updatedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Filter connections that were last updated on or before a given time." + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "post": { + "tags": [ + "Connections" + ], + "summary": "Create Connection", + "description": "Create a new connection via API. This endpoint can be used to provide a completely custom connection creation experience for your customers.\n\nFor most use cases we recommend using the [Link UI](./rhuaxk9205cn8-link-component) to create connections.", + "operationId": "createConnection", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "backfill": { + "type": "object", + "properties": { + "days": { + "type": "number", + "example": 5757343.118591592 + }, + "startFrom": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + } + } + }, + "company": { + "type": "object", + "properties": { + "dotNumbers": { + "type": "array", + "items": { + "type": "string", + "example": "pariatur est" + }, + "example": [ + "pariatur est", + "voluptate qui dolor" + ] + }, + "name": { + "type": "string", + "example": "aute ut qui en" + } + } + }, + "credentials": { + "type": "object", + "properties": { + "database": { + "type": "string", + "example": "nisi c" + }, + "password": { + "type": "string", + "example": "minim labore incididunt deserunt" + }, + "username": { + "type": "string", + "example": "aute in laboris" + } + } + }, + "externalId": { + "type": "string", + "example": "elit commodo in sunt" + }, + "provider": { + "type": "string", + "example": "geotab" + }, + "syncMode": { + "type": "string", + "example": "automatic" + }, + "tags": { + "type": "array", + "items": { + "type": "string", + "example": "Tag Name" + }, + "example": [ + "Tag Name", + "Tag Name" + ] + } + } + }, + "examples": { + "Create Connection": { + "value": { + "backfill": { + "days": 5757343.118591592, + "startFrom": "2021-01-06T03:24:53.000Z" + }, + "company": { + "dotNumbers": [ + "pariatur est", + "voluptate qui dolor" + ], + "name": "aute ut qui en" + }, + "credentials": { + "database": "nisi c", + "password": "minim labore incididunt deserunt", + "username": "aute in laboris" + }, + "externalId": "elit commodo in sunt", + "provider": "geotab", + "syncMode": "automatic", + "tags": [ + "Tag Name", + "Tag Name" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/connections/current": { + "get": { + "tags": [ + "Connections" + ], + "summary": "Get Current Connection", + "description": "Get the details of the current active connection. The current connection is derived from the provided connection token.", + "operationId": "getCurrentConnection", + "parameters": [ + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "patch": { + "tags": [ + "Connections" + ], + "summary": "Update Current Connection", + "description": "Update the details of the current active connection. The current connection is derived from the provided connection token.", + "operationId": "updateCurrentConnection", + "parameters": [ + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Acme Inc." + } + } + }, + "externalId": { + "type": "string", + "example": "pariatur dolor minim" + }, + "status": { + "type": "string", + "example": "do" + }, + "syncMode": { + "type": "string", + "example": "automatic" + }, + "tags": { + "type": "array", + "items": { + "type": "string", + "example": "Excepteur Ut" + }, + "example": [ + "Excepteur Ut", + "deserunt incididunt eu" + ] + } + } + }, + "examples": { + "Update Current Connection": { + "value": { + "company": { + "name": "Acme Inc." + }, + "externalId": "pariatur dolor minim", + "status": "do", + "syncMode": "automatic", + "tags": [ + "Excepteur Ut", + "deserunt incididunt eu" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/syncs": { + "get": { + "tags": [ + "Data Management" + ], + "summary": "List Sync History", + "description": "List a log of all batch sync jobs for the current connection.", + "operationId": "listSyncHistory", + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "status", + "in": "query", + "schema": { + "type": "string", + "example": "in_progress" + } + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand related resources in the response to reduce requests." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "post": { + "tags": [ + "Data Management" + ], + "summary": "Request Sync", + "description": "Manually request to sync the current connections data.\n\nBy default, Terminal will sync all connections where `syncMode = automatic` on a regular cadence. For customers that may not need a fleet's data to be kept up to date and want to reduce their active tracked trucks, you can set `syncMode = manual` and invoke this endpoint when you want to sync data.\n\nIf you're wondering if this is relevent to your use case then feel free to reach out and we'd be happy to assist.", + "operationId": "requestSync", + "parameters": [ + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days": { + "type": "number", + "example": 7 + } + } + }, + "examples": { + "Request Sync": { + "value": { + "days": 7 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/syncs/{id}": { + "get": { + "tags": [ + "Data Management" + ], + "summary": "Get Sync Job Status", + "description": "Get the status of a sync job by ID.", + "operationId": "getSyncJobStatus", + "parameters": [ + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand related resources in the response to reduce requests." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "example": "{{syncId}}" + }, + "description": "(Required) " + } + ] + }, + "/passthrough": { + "post": { + "tags": [ + "Data Management" + ], + "summary": "Passthrough", + "description": "Make an authenticated request to the underlying telematics provider. \n\nThis endpoint helps ensure that you are never limited by Terminal. You can use passthrough requests to access capabilities that may be limited to a specific TSP or not yet in the normalized model.\n\nOur team is here an ready to support custom use cases that may need `/passthrough`", + "operationId": "passthrough", + "parameters": [ + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "example": "{\"reportId\":\"1234\"}" + }, + "headers": { + "type": "object", + "properties": {} + }, + "method": { + "type": "string", + "example": "POST" + }, + "path": { + "type": "string", + "example": "/reports" + } + } + }, + "examples": { + "Passthrough": { + "value": { + "body": "{\"reportId\":\"1234\"}", + "headers": {}, + "method": "POST", + "path": "/reports" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "" + } + } + } + }, + "/drivers": { + "get": { + "tags": [ + "Drivers" + ], + "summary": "List Drivers", + "description": "List all of the drivers in the connected account", + "operationId": "listDrivers", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/drivers/{id}": { + "get": { + "tags": [ + "Drivers" + ], + "summary": "Get Driver", + "description": "Get the details of a specific driver", + "operationId": "getDriver", + "parameters": [ + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "example": "{{driverId}}" + }, + "description": "(Required) " + } + ] + }, + "/groups": { + "get": { + "tags": [ + "Groups" + ], + "summary": "List Groups", + "description": "List Groups", + "operationId": "listGroups", + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/hos/available-time": { + "get": { + "tags": [ + "Hours of Service" + ], + "summary": "Available Time for Drivers", + "description": "List available time for the driver. This endpoint provides live access to the driver's available time. Different than most endpoints, this endpoint calls the provider's API in real time to get the latest available time for the driver. This endpoint is useful for building real time applications that need to know the driver's available time.", + "operationId": "availableTimeForDrivers", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "driverIds", + "in": "query", + "schema": { + "type": "string", + "example": "{{driverId}}" + }, + "description": "Comma separated list of driver IDs to filter for" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/hos/logs": { + "get": { + "tags": [ + "Hours of Service" + ], + "summary": "List HOS Logs", + "description": "List all hours of service logs. Currently, HOS logs are tracked as the distinct changes in duty status. In the future we will be offering endpoints to expose current HOS status and historical daily summaries.", + "operationId": "listHosLogs", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "startedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records of statuses that started after a provided date." + }, + { + "name": "startedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records of statuses that started before a provided date." + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "driverIds", + "in": "query", + "schema": { + "type": "string", + "example": "{{driverId}}" + }, + "description": "Comma separated list of driver IDs to filter for" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/hos/daily-logs": { + "get": { + "tags": [ + "Hours of Service" + ], + "summary": "List HOS Daily Logs", + "description": "List daily summary of hours of service. Each daily log represents the time a driver spent in each duty status for a given day.", + "operationId": "listHosDailyLogs", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "startDate", + "in": "query", + "schema": { + "type": "string", + "example": "1992-10-05" + }, + "description": "Only include daily logs from on or after a specific date" + }, + { + "name": "endDate", + "in": "query", + "schema": { + "type": "string", + "example": "1992-10-05" + }, + "description": "Only include daily logs from on or before a specific date" + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "driverIds", + "in": "query", + "schema": { + "type": "string", + "example": "{{driverId}}" + }, + "description": "Comma separated list of driver IDs to filter for" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/ifta/summary": { + "get": { + "tags": [ + "IFTA" + ], + "summary": "Get IFTA Summary", + "description": "Get all vehicle IFTA reports for the requested time span.\n\nCurrently can only increment by full months. \n\n_Note:_ data may change for a few days after the month. We will continue to update those reports to ensure you get accurate results.", + "operationId": "getIftaSummary", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "startMonth", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01" + }, + "description": "(Required) The month from which to start including vehicle reports" + }, + { + "name": "endMonth", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01" + }, + "description": "(Required) Include vehicle reports up to and including this month" + }, + { + "name": "groupBy", + "in": "query", + "schema": { + "type": "string", + "example": "vehicle,jurisdiction" + }, + "description": "Computes the total distance traversed within a specified month range, with the results grouped by either jurisdiction, vehicle, or both. If no grouping parameter is provided, the default grouping is `vehicle,jurisdiction`." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/issues": { + "get": { + "tags": [ + "Issues" + ], + "summary": "List Issues", + "description": "List all issues that have been observed by Terminal.\nIssues are generated when we observe something that may impact the completeness or accuracy of the data we provide but do not justify a full error.\nFor example, if we lack permissions for a specific resource or need to skip an item due to invalid data.", + "operationId": "listIssues", + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "lastReportedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "1999-09-28" + }, + "description": "Timestamp to start when the issue was last observed" + }, + { + "name": "lastReportedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "1999-09-28" + }, + "description": "Timestamp to end when the issue was last observed" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand related resources to see all details" + }, + { + "name": "connectionId", + "in": "query", + "schema": { + "type": "string", + "example": "conn_01GV12VR4DJP70GD1ZBK0SDWFH" + }, + "description": "Filter issues to a specific connection" + }, + { + "name": "errorCode", + "in": "query", + "schema": { + "type": "string", + "example": "missing_permissions" + }, + "description": "Filter issues to a specific error code" + }, + { + "name": "status", + "in": "query", + "schema": { + "type": "string", + "example": "resolved" + }, + "description": "Filter issues to a specific status" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/issues/{issueId}/resolve": { + "post": { + "tags": [ + "Issues" + ], + "summary": "Resolve Issue", + "description": "Mark an issue's status as `resolved` until the issue is observed again.", + "operationId": "resolveIssue", + "responses": { + "200": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "issueId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "example": "non mollit reprehenderit" + }, + "description": "(Required) " + } + ] + }, + "/providers": { + "get": { + "tags": [ + "Providers" + ], + "summary": "List Providers", + "description": "Retrieve a list of the providers Terminal supports. This endpoint will grow to include additional details about the supported capabilities of each provider.", + "operationId": "listProviders", + "responses": { + "200": { + "description": "" + } + } + } + }, + "/safety/events": { + "get": { + "tags": [ + "Safety" + ], + "summary": "List Safety Events", + "description": "List all safety events detected by the provider.", + "operationId": "listSafetyEvents", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "startedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records of statuses that started after a provided date." + }, + { + "name": "startedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records of statuses that started before a provided date." + }, + { + "name": "driverIds", + "in": "query", + "schema": { + "type": "string", + "example": "{{driverId}}" + }, + "description": "Comma separated list of driver IDs to filter for" + }, + { + "name": "vehicleIds", + "in": "query", + "schema": { + "type": "string", + "example": "{{vehicleId}}" + }, + "description": "Comma separated list of vehicle IDs to filter for" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/trailers": { + "get": { + "tags": [ + "Trailers" + ], + "summary": "List Trailers", + "description": "List Trailers", + "operationId": "listTrailers", + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/trailers/locations": { + "get": { + "tags": [ + "Trailers" + ], + "summary": "Latest Trailer Locations", + "description": "Latest Trailer Locations", + "operationId": "latestTrailerLocations", + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/vehicles": { + "get": { + "tags": [ + "Vehicles" + ], + "summary": "List Vehicles", + "description": "List all of the vehicles in the connected account", + "operationId": "listVehicles", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/vehicles/{id}": { + "get": { + "tags": [ + "Vehicles" + ], + "summary": "Get Vehicle", + "description": "Get the details of a specific vehicle", + "operationId": "getVehicle", + "parameters": [ + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "example": "{{vehicleId}}" + }, + "description": "(Required) " + } + ] + }, + "/vehicles/locations": { + "get": { + "tags": [ + "Vehicles" + ], + "summary": "Latest Vehicle Locations", + "description": "List the latest location of the vehicles in the connected account.\nThis endpoint will call the provider's API in real time to get the latest location of the vehicle. \n_Please note: this endpoint will exclude vehicles that have no last known location._", + "operationId": "latestVehicleLocations", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "vehicleIds", + "in": "query", + "schema": { + "type": "string", + "example": "{{vehicleId}}" + }, + "description": "Comma separated list of vehicle IDs to filter for" + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/vehicles/{vehicleId}/locations": { + "get": { + "tags": [ + "Vehicles" + ], + "summary": "Historical Vehicle Locations", + "description": "List the historical breadcrumb locations for a vehicle.\n\n_Note:_\n\nGiven the large volume of location data available, we encourage customers to accept compressed (`gzip`) responses in order to maximize throughput. This is supported with many popular HTTP clients. Result limits vary depending on if results are compressed or not.", + "operationId": "historicalVehicleLocations", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "startAt", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Timestamp to start from - defaults to `TODAY - 1 MONTH`" + }, + { + "name": "endAt", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Timestamp to end at - defaults to `TODAY`" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "vehicleId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "example": "{{vehicleId}}" + }, + "description": "(Required) Vehicle to retrieve breadcrumb locations for" + } + ] + }, + "/vehicles/{vehicleId}/stats/historical": { + "get": { + "tags": [ + "Vehicles" + ], + "summary": "Historical Vehicle Stats", + "description": "List historical stats and logs about the vehicle.", + "operationId": "historicalVehicleStats", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "startAt", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Timestamp to start from - defaults to `TODAY - 1 MONTH`" + }, + { + "name": "endAt", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Timestamp to end at - defaults to `TODAY`" + }, + { + "name": "types", + "in": "query", + "schema": { + "type": "string", + "example": "odometer,engine_state,fuel_level,total_fuel_consumption" + }, + "description": "Comma separated list of vehicle stats to filter for" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "vehicleId", + "in": "path", + "required": true, + "schema": { + "type": "string", + "example": "{{vehicleId}}" + }, + "description": "(Required) " + } + ] + }, + "/trips": { + "get": { + "tags": [ + "Trips" + ], + "summary": "List Trips", + "description": "List all trips in the connected account. Trips define a period of time where a vehicle is in motion.", + "operationId": "listTrips", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "startedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include trips that started after a provided date." + }, + { + "name": "startedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include trips that started before a provided date." + }, + { + "name": "endedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include trips that ended after a provided date." + }, + { + "name": "endedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include trips that ended before a provided date." + }, + { + "name": "driverIds", + "in": "query", + "schema": { + "type": "string", + "example": "{{driverId}}" + }, + "description": "Comma separated list of driver IDs to filter for" + }, + { + "name": "vehicleIds", + "in": "query", + "schema": { + "type": "string", + "example": "{{vehicleId}}" + }, + "description": "Comma separated list of vehicle IDs to filter for" + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "expand", + "in": "query", + "schema": { + "type": "string", + "example": "" + }, + "description": "Expand resources in the returned response" + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/devices": { + "get": { + "tags": [ + "Devices" + ], + "summary": "List Devices", + "description": "List all devices in the connected account.", + "operationId": "listDevices", + "parameters": [ + { + "name": "cursor", + "in": "query", + "schema": { + "type": "string", + "example": "{{nextCursor}}" + }, + "description": "Pagination cursor to start requests from" + }, + { + "name": "limit", + "in": "query", + "schema": { + "type": "string", + "example": "1" + }, + "description": "The maximum number of results to return in a page." + }, + { + "name": "modifiedAfter", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified after a provided date." + }, + { + "name": "modifiedBefore", + "in": "query", + "schema": { + "type": "string", + "example": "2021-01-06T03:24:53.000Z" + }, + "description": "Only include records that were last modified before a provided date." + }, + { + "name": "raw", + "in": "query", + "schema": { + "type": "string", + "example": "true" + }, + "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." + }, + { + "name": "connection-token", + "in": "header", + "schema": { + "type": "string", + "example": "{{connectionToken}}" + }, + "description": "(Required) The token returned when a user authenticated their account. This authorizes access to a specific account." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + } + }, + "components": { + "securitySchemes": { + "bearerAuth": { + "type": "http", + "scheme": "bearer" + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ], + "tags": [ + { + "name": "Authentication", + "description": "" + }, + { + "name": "Connections", + "description": "" + }, + { + "name": "Data Management", + "description": "" + }, + { + "name": "Drivers", + "description": "" + }, + { + "name": "Groups", + "description": "" + }, + { + "name": "Hours of Service", + "description": "" + }, + { + "name": "IFTA", + "description": "" + }, + { + "name": "Issues", + "description": "" + }, + { + "name": "Providers", + "description": "" + }, + { + "name": "Safety", + "description": "" + }, + { + "name": "Trailers", + "description": "" + }, + { + "name": "Vehicles", + "description": "" + }, + { + "name": "Webhook Events", + "description": "" + }, + { + "name": "Trips", + "description": "" + }, + { + "name": "Devices", + "description": "" + } + ] +} \ No newline at end of file diff --git a/sdks/publish.yaml b/sdks/publish.yaml index 2cf2b38878..bce2fc6f13 100644 --- a/sdks/publish.yaml +++ b/sdks/publish.yaml @@ -4946,22 +4946,22 @@ publish: Pipeliner has revolutionized the complexity of CRM with a simple, unique visual interface, a no-code workflow automation engine, and instant, dynamic insights and reporting. - + There is no other CRM that provides sales reps and sales management with so many ways to view and analyze sales data, while delivering intelligent, system-generated insights. - + Plus, thanks to our automation engine and easy integration with other systems (such as email, ERP, marketing), Pipeliner eliminates many of the manual and routine tasks that other systems impose on both sales reps and sales managers. - + The Pipeliner CRM experience is so different from traditional CRM, which is why we drive the highest adoption rates, lower total cost of ownership, and rapid return on investment. Plus, with our quick onboarding and ease of learning to use and/or administer the system, there is little to no business disruption during deployment. - + And because we are committed to supporting the professional development of salespeople, we have even integrated our online sales magazine Sales POP! into the product to provide unparalleled sales-related content at the @@ -5004,3 +5004,43 @@ publish: serviceName: false sdkName: echelon-{language}-sdk clientName: Echelon + from-custom-request_salesflare.com: + homepage: salesflare.com + company: Salesflare + developerDocumentation: api.salesflare.com/docs + apiStatusUrls: inherit + metaDescription: >- + Salesflare is the intelligent CRM startups and small businesses love to + use. It's a zero-input sales pipeline tool that thinks and works for its + user, not the other way around. + + + No more manual data entry. Salesflare fills out your address book and + keeps track of all interactions with the people you're in contact with. It + takes data from social media, company databases, phone, email, calendar + and hands it to you in automated customer timelines that tell you + everything you need to know. You just have to write the emails, make the + calls, and have the coffee. + + + Never miss a deal again. Salesflare will tell and remind you what to do + about leads so deals can't fall through the cracks anymore. Visual + pipelines and powerful insights put you in full control of your sales + funnel. Intuitive and easy-to-use, Salesflare turns complexity into + simplicity so you can turn leads into customers. + + + Salesflare works wherever you work and with whatever you are working with. + Use it on desktop, mobile or just from a sidebar in your email inbox + (Gmail and Outlook). Get even more out of Salesflare by integrating with + 5000+ other productivity tools, such as Google Apps, MailChimp, Trello and + Slack. + + + There's a free trial available from salesflare.com. + categories: + - crm + - sales + serviceName: false + sdkName: salesflare-{language}-sdk + clientName: Salesflare diff --git a/sdks/src/collect-from-custom-requests.ts b/sdks/src/collect-from-custom-requests.ts index 0d26d404c5..6e7fa53d91 100644 --- a/sdks/src/collect-from-custom-requests.ts +++ b/sdks/src/collect-from-custom-requests.ts @@ -501,6 +501,10 @@ const customRequests: Record = { type: "GET", url: "https://developers.pipedrive.com/docs/api/v1/openapi.yaml", }, + "salesflare.com": { + type: "GET", + url: "https://api.salesflare.com/openapi.json", + }, "pipelinersales.com": { type: "GET", url: "https://stoplight.io/api/v1/projects/pipeliner/api-docs/nodes/openapi.json?fromExportButton=true&snapshotType=http_service&deref=optimizedBundle", @@ -1796,7 +1800,7 @@ const customRequests: Record = { "echelonpro.io": { type: "GET", url: "https://developers.echelonpay.com/api/_static/openapi.yaml", - } + }, }; async function downloadOpenApiSpecFromMintlify({