{ "item": [ { "id": "9e250930-2e3c-4383-9452-b3fced34a73c", "name": "Custom Fields", "description": { "content": "Custom Fields endpoints.", "type": "text/plain" }, "item": [ { "id": "ae8d7610-c351-46ce-a563-754c422475ff", "name": "Retrieves a list of custom fields in a tenant.", "request": { "name": "Retrieves a list of custom fields in a tenant.", "description": { "content": "Retrieves a list of custom fields in a tenant.", "type": "text/plain" }, "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "70cf84e5-3db4-4a28-9f01-7091bd4aff97", "name": "a list of PipelineCustomFields", "originalRequest": { "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": {\n \"description\": \"The discriminator for the model property type. This field is required.\",\n \"value\": \"\"\n },\n \"primitive_type\": {\n \"description\": \"The base primitive type of the custom field. This field is required.\",\n \"value\": \"\"\n },\n \"array\": {\n \"description\": \"The array property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"ref\": {\n \"description\": \"The reference property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": false,\n \"type\": {\n \"description\": \"The type of display options. This field is required.\",\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"description\": \"The display options for array type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"description\": \"The display options for reference type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"description\": \"The display options for date and time type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"description\": \"The display options for boolean type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"duration\": {\n \"description\": \"The display options for duration type custom fields. This field is optional.\",\n \"value\": \"\"\n }\n },\n \"options\": {\n \"display_type\": {\n \"description\": \"The display type of the custom field options. This field is required.\",\n \"value\": \"\"\n },\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"description\": \"The source of the custom field options. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n }\n },\n {\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": {\n \"description\": \"The discriminator for the model property type. This field is required.\",\n \"value\": \"\"\n },\n \"primitive_type\": {\n \"description\": \"The base primitive type of the custom field. This field is required.\",\n \"value\": \"\"\n },\n \"array\": {\n \"description\": \"The array property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"ref\": {\n \"description\": \"The reference property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\n \"type\": {\n \"description\": \"The type of display options. This field is required.\",\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"description\": \"The display options for array type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"description\": \"The display options for reference type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"description\": \"The display options for date and time type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"description\": \"The display options for boolean type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"duration\": {\n \"description\": \"The display options for duration type custom fields. This field is optional.\",\n \"value\": \"\"\n }\n },\n \"options\": {\n \"display_type\": {\n \"description\": \"The display type of the custom field options. This field is required.\",\n \"value\": \"\"\n },\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"description\": \"The source of the custom field options. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n }\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37a097f2-78e4-47fe-a06e-188d65f9993b", "name": "Creates a new custom field.", "request": { "name": "Creates a new custom field.", "description": { "content": "Creates a new custom field.", "type": "text/plain" }, "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"aItGk\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"PERCENT\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"example_value\": {},\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"DEFAULT\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE_BUTTON\"\n },\n \"duration\": {\n \"duration_units\": [\n \"HOURS\",\n \"YEARS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"CHECKBOX\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 4531,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 9430,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"size\": 9511,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 6052,\n \"size_type\": \"MAX\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "824e9991-0256-469d-aa09-b7977307ee4f", "name": "The created custom field as a PipelineCustomField object.", "originalRequest": { "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"S\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"LONG_TEXT\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"example_value\": {},\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"REF\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": false\n },\n \"reference_type_display_options\": {\n \"hidden\": false,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"YEARS\",\n \"MINUTES\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 7637,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 8370,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"size\": 470,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 8479,\n \"size_type\": \"MAX\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": \"ARRAY\",\n \"primitive_type\": \"YEAR\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"size\": 8184,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 3489,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"BOOLEAN\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MINUTES\",\n \"DAYS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"CHECKBOX\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 5992,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 9456,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c10f8414-64de-459f-a638-58584ad45b7b", "name": "Deletes a custom field", "request": { "name": "Deletes a custom field", "description": { "content": "Deletes a custom field", "type": "text/plain" }, "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to delete" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "86a1c24a-34ee-4ecb-a1e0-91f30b3302ee", "name": "deletePipelineCustomField 204 response", "originalRequest": { "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to delete" } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4a93eaa-8e00-46d1-a1c8-9a3f2afae802", "name": "Updates a custom field", "request": { "name": "Updates a custom field", "description": { "content": "Updates a custom field", "type": "text/plain" }, "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to update" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"label\": \"string\",\n \"description\": \"string\",\n \"hint\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": false,\n \"type\": \"DATE_TIME\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": false,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"CARD\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE_BUTTON\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MINUTES\",\n \"MINUTES\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 7259,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 1816,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"size\": 8507,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 9885,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"deleted\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dd25f520-ab1a-46dc-ae62-fa5e78210a63", "name": "the updated PipelineCustomField", "originalRequest": { "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to update" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"string\",\n \"description\": \"string\",\n \"hint\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"DEFAULT\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": false,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE_BUTTON\"\n },\n \"duration\": {\n \"duration_units\": [\n \"YEARS\",\n \"YEARS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"RADIO\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 8205,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 6625,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"size\": 7159,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 8452,\n \"size_type\": \"MIN\"\n }\n }\n ],\n \"deleted\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": \"ARRAY\",\n \"primitive_type\": \"YEAR\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"size\": 8184,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 3489,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"BOOLEAN\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MINUTES\",\n \"DAYS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"CHECKBOX\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 5992,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 9456,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "abf40fc6-04d4-468a-971d-daeda8b9e199", "name": "DateExpression", "description": { "content": "DateExpression endpoints.", "type": "text/plain" }, "item": [ { "id": "1c744d8a-f3f1-4f34-9c18-409788001716", "name": "query Date Expressions", "request": { "name": "query Date Expressions", "description": {}, "url": { "path": [ "v2", "dateExpressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "time_zone", "value": "string" }, { "disabled": false, "key": "query", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b541bad8-8f9f-41a5-a5f2-6e41806a4119", "name": "queryDateExpressions 200 response", "originalRequest": { "url": { "path": [ "v2", "dateExpressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "time_zone", "value": "string" }, { "key": "query", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"date_inferred\": true,\n \"parse_end\": 5716,\n \"parse_start\": 1499,\n \"query\": \"string\",\n \"recurring\": false,\n \"recurse_until\": {\n \"dates\": [\n \"1990-02-03T08:22:48.340Z\",\n \"2018-06-11T12:21:15.385Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"1965-10-22T05:49:46.149Z\",\n \"1964-06-27T01:09:07.627Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": true,\n \"complete_match\": false\n },\n {\n \"date_inferred\": false,\n \"parse_end\": 5845,\n \"parse_start\": 9354,\n \"query\": \"string\",\n \"recurring\": true,\n \"recurse_until\": {\n \"dates\": [\n \"1971-10-16T18:52:39.250Z\",\n \"1989-07-09T17:28:04.137Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"1967-11-05T13:16:24.680Z\",\n \"2002-06-14T23:17:25.392Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": false,\n \"complete_match\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "42ae1787-c312-48f7-bedc-fe1ee5e34709", "name": "Deals", "description": { "content": "Deals endpoints.", "type": "text/plain" }, "item": [ { "id": "a01b32ba-c5a2-462d-8143-87c791fd7fa7", "name": "List Deal", "request": { "name": "List Deal", "description": { "content": "Lists entities based on the provided ListCommand.", "type": "text/plain" }, "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ad03cc34-c370-4bb5-b5e0-e5c412bff464", "name": "a response containing the list of entities", "originalRequest": { "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 4825.25990222671,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2012-04-04T05:11:32.929Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1964-05-07T01:04:09.279Z\",\n \"closed_time\": \"1952-08-10T10:12:06.241Z\",\n \"custom_fields\": {\n \"key_0\": false\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 4211.564373904026,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1991-12-27T20:24:23.427Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2022-09-16T04:21:19.306Z\",\n \"closed_time\": \"2000-03-15T02:10:11.604Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": 9651.309144785477,\n \"key_2\": 3450\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89927995-9629-4a23-9d25-448078f5c58e", "name": "Create Deal", "request": { "name": "Create Deal", "description": { "content": "Creates a new entity.", "type": "text/plain" }, "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 4448.017919569589,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2018-11-24T03:25:19.746Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 2235,\n \"key_2\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1b62645e-436a-4ea4-bc19-154ab243e4c3", "name": "The created entity", "originalRequest": { "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 1303.6445550999365,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1994-09-05T10:04:43.861Z\",\n \"custom_fields\": {\n \"key_0\": 2869.267187010389\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 7701.8612019733855,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2015-11-23T13:38:29.920Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2000-10-14T12:03:58.375Z\",\n \"closed_time\": \"1990-09-17T13:11:56.858Z\",\n \"custom_fields\": {\n \"key_0\": 3859.705836594942,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7bf769d-1077-4942-a20c-009b1d835477", "name": "Retrieves a list of deals by their IDs.", "request": { "name": "Retrieves a list of deals by their IDs.", "description": { "content": "Retrieves a list of deals by their IDs.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "string", "description": "(Required) the deal IDs to list" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "223214a1-9237-4bc6-b7d2-13f58d64531c", "name": "the list of requested Deal", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 1529.4789713803668,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1971-03-07T03:13:22.855Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1968-05-02T23:08:57.840Z\",\n \"closed_time\": \"1958-04-23T16:41:33.042Z\",\n \"custom_fields\": {\n \"key_0\": 7518.3868528852145,\n \"key_1\": 8067.9891443819815,\n \"key_2\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 7574.585222520096,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1983-02-12T14:58:14.133Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2003-01-20T05:54:12.201Z\",\n \"closed_time\": \"2020-08-05T01:20:48.650Z\",\n \"custom_fields\": {\n \"key_0\": 5907\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62281cb4-8be3-42d4-9a7a-82cdbdd78a99", "name": "Deletes a list of deals by their IDs.", "request": { "name": "Deletes a list of deals by their IDs.", "description": { "content": "Deletes a list of deals by their IDs.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "string", "description": "(Required) each ID of each deal to delete" } ], "variable": [] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fce62d5b-a0f2-4032-8e09-189a24b1f600", "name": "deleteDealsInBulk 204 response", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17fe0db2-5a31-4c26-8cb5-d3aa2ba77771", "name": "Lists all deals associated with a specific contact.", "request": { "name": "Lists all deals associated with a specific contact.", "description": { "content": "Lists all deals associated with a specific contact.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) the contact ID to list deals for" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "47fba2bf-03fa-49fd-b199-527e967ada1e", "name": "a list of deals wrapped in a DealListResponse", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) the contact ID to list deals for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 6630.0295952900615,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2011-07-08T02:12:59.417Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2022-09-22T01:02:59.561Z\",\n \"closed_time\": \"1986-10-05T08:10:31.338Z\",\n \"custom_fields\": {\n \"key_0\": 2310.181457579301,\n \"key_1\": 461.32232930308436,\n \"key_2\": 5366.3905498531685\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 1853.2857513545853,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1976-10-31T11:53:36.504Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2002-12-28T16:42:16.047Z\",\n \"closed_time\": \"2009-09-27T00:05:24.337Z\",\n \"custom_fields\": {\n \"key_0\": true,\n \"key_1\": 1438\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0b04cbc-04e4-47ea-bf2b-4b3333e2bf14", "name": "Creates new notes in bulk.", "request": { "name": "Creates new notes in bulk.", "description": { "content": "Creates new notes in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"create_note_requests\": [\n {\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"deal_id\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1d5c4ab0-6756-4427-8a47-9dbe55163e49", "name": "the created DealNote", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_note_requests\": [\n {\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"deal_id\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"create_note_responses\": [\n {\n \"id\": \"string\",\n \"body\": \"string\",\n \"deal_id\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1996-09-18T07:09:22.247Z\",\n \"modified_time\": \"1999-07-03T02:40:09.788Z\",\n \"create_success\": false,\n \"error_message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"body\": \"string\",\n \"deal_id\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1994-04-28T22:01:00.862Z\",\n \"modified_time\": \"1999-08-22T03:39:35.096Z\",\n \"create_success\": true,\n \"error_message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0953280c-4c89-496b-b473-6135f7af7bc6", "name": "Retrieves a specific deal note by its ID.", "request": { "name": "Retrieves a specific deal note by its ID.", "description": { "content": "Retrieves a specific deal note by its ID.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to retrieve" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ba88f4be-557a-47b2-9c80-2c68bb2186df", "name": "the requested DealNote", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to retrieve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1981-12-07T08:55:16.808Z\",\n \"modified_time\": \"1990-03-14T02:54:31.299Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f55fe87a-6abe-4338-9968-9749ec9a6a51", "name": "Deletes a specific deal note by its ID.", "request": { "name": "Deletes a specific deal note by its ID.", "description": { "content": "Deletes a specific deal note by its ID.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to delete" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ca45082f-bd94-42d2-92c5-b953b2ffe75a", "name": "a HttpResponse indicating the result of the delete operation", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to delete" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1984e69d-1783-40a8-9167-2c18d36eed29", "name": "Updates a specific deal note by its ID.", "request": { "name": "Updates a specific deal note by its ID.", "description": { "content": "Updates a specific deal note by its ID.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to update" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9c2ed957-4664-4da2-882b-95f720c81d6a", "name": "the updated DealNote", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to update" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"body\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1981-12-07T08:55:16.808Z\",\n \"modified_time\": \"1990-03-14T02:54:31.299Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa2ca9ad-54d1-40e1-97a8-81b6e99795c4", "name": "Creates multiple deals in bulk.", "request": { "name": "Creates multiple deals in bulk.", "description": { "content": "Creates multiple deals in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"create_deal_requests\": [\n {\n \"contacts\": [\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"stri\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 5777.60797628371,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1986-10-21T18:40:45.628Z\",\n \"custom_fields\": {\n \"key_0\": 1846\n }\n },\n {\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 9857.764838680774,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2025-07-05T16:45:36.344Z\",\n \"custom_fields\": {\n \"key_0\": 523,\n \"key_1\": 2979.9963042743393\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "72c9f58f-9987-4ec2-9152-900a2cb19d12", "name": "the created deals", "originalRequest": { "url": { "path": [ "v2", "deals", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_deal_requests\": [\n {\n \"contacts\": [\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 5197.348291016008,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1988-08-20T04:46:41.967Z\",\n \"custom_fields\": {\n \"key_0\": true\n }\n },\n {\n \"contacts\": [\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 7380.018945344406,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2011-06-19T02:35:28.201Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created_deals\": {\n \"key_0\": {\n \"deal_id\": \"string\",\n \"create_success\": true,\n \"error_message\": \"string\"\n },\n \"key_1\": {\n \"deal_id\": \"string\",\n \"create_success\": true,\n \"error_message\": \"string\"\n },\n \"key_2\": {\n \"deal_id\": \"string\",\n \"create_success\": false,\n \"error_message\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52067a1b-db72-40cb-8832-5d3d9544249f", "name": "Moves the active deals of specified contacts from one stage to another, in bulk.", "request": { "name": "Moves the active deals of specified contacts from one stage to another, in bulk.", "description": { "content": "Moves the active deals of specified contacts from one stage to another, in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "moveByContactIds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ],\n \"from_stage\": \"string\",\n \"to_stage\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "353f09bd-57a7-4aa2-84c8-99e463dde33a", "name": "the IDs of the Deals moved", "originalRequest": { "url": { "path": [ "v2", "deals", "moveByContactIds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ],\n \"from_stage\": \"string\",\n \"to_stage\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"moved_deal_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2efc013e-29a2-47d4-94be-b984cd294713", "name": "Get Deal", "request": { "name": "Get Deal", "description": { "content": "Retrieves an entity by its identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "674cd5b2-c1d6-4fc4-bcf3-7dcc64957c37", "name": "The retrieved entity", "originalRequest": { "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 7701.8612019733855,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2015-11-23T13:38:29.920Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2000-10-14T12:03:58.375Z\",\n \"closed_time\": \"1990-09-17T13:11:56.858Z\",\n \"custom_fields\": {\n \"key_0\": 3859.705836594942,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fb90b26-bbd1-4378-9db0-714e51b4cfba", "name": "Deletes an entity by its identifier.", "request": { "name": "Deletes an entity by its identifier.", "description": { "content": "Deletes an entity by its identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2b3dee3b-f727-4f4b-a863-f2390c34ed10", "name": "A response indicating no content", "originalRequest": { "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4614781-b78a-4d55-aa3a-6d6da0d6ce2a", "name": "Update Deal", "request": { "name": "Update Deal", "description": { "content": "Updates an existing entity.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" }, { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"name\": \"string\",\n \"amount\": 2396.678765426903,\n \"currency_code\": \"string\",\n \"contacts\": [\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"owner_id\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"previous_deal_id\": \"string\",\n \"next_deal_id\": \"string\",\n \"estimated_close_date\": \"1949-02-09T22:05:49.682Z\",\n \"closed_date\": \"1976-12-14T18:09:28.781Z\",\n \"custom_fields\": {\n \"key_0\": 7388.869178502533,\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "67ead2c3-f1c1-46a6-a6d2-a863e8a7ad56", "name": "The updated entity", "originalRequest": { "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" }, { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"name\": \"string\",\n \"amount\": 4945.539643323174,\n \"currency_code\": \"string\",\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"owner_id\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"previous_deal_id\": \"string\",\n \"next_deal_id\": \"string\",\n \"estimated_close_date\": \"1992-12-17T14:49:00.476Z\",\n \"closed_date\": \"1962-08-19T19:02:49.974Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": \"string\",\n \"key_3\": 5031.429799595319\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 7701.8612019733855,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2015-11-23T13:38:29.920Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2000-10-14T12:03:58.375Z\",\n \"closed_time\": \"1990-09-17T13:11:56.858Z\",\n \"custom_fields\": {\n \"key_0\": 3859.705836594942,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59b0d0da-01dc-4de1-a49d-df57e8271f93", "name": "Validates the custom fields in a Deal.", "request": { "name": "Validates the custom fields in a Deal.", "description": { "content": "Validates the custom fields in a Deal.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id", "customFields:validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the deal to move" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"custom_fields\": {\n \"key_0\": 6317\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a2511133-b9c2-4fed-89d5-8349495b11b0", "name": "the result of the validation containing errors and warnings", "originalRequest": { "url": { "path": [ "v2", "deals", ":id", "customFields:validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the deal to move" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"custom_fields\": {\n \"key_0\": 6317\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"args\": {},\n \"logref\": \"string\"\n },\n {\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"args\": {},\n \"logref\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"args\": {},\n \"logref\": \"string\"\n },\n {\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"args\": {},\n \"logref\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae79a690-d73a-4892-bef8-aead1c25d09a", "name": "Lists all notes associated with a specific deal.", "request": { "name": "Lists all notes associated with a specific deal.", "description": { "content": "Lists all notes associated with a specific deal.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the deal ID to list notes for" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0cb6a4a8-539b-4234-96fb-3f304f3b653f", "name": "a list of deal notes wrapped in a DealNoteListResponse", "originalRequest": { "url": { "path": [ "v2", "deals", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the deal ID to list notes for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"notes\": [\n {\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1974-08-01T10:00:26.808Z\",\n \"modified_time\": \"2012-02-23T06:25:38.779Z\"\n },\n {\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1990-08-28T09:09:03.579Z\",\n \"modified_time\": \"2006-09-06T14:55:07.817Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "964f05d7-d98c-4125-8303-c9e61e2b39f7", "name": "Creates a new note for a specific deal.", "request": { "name": "Creates a new note for a specific deal.", "description": { "content": "Creates a new note for a specific deal.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the deal ID to associate the new note with" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"string\",\n \"created_by\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d09d5b0-035f-4dd7-b5b1-56d2df367342", "name": "the created DealNote", "originalRequest": { "url": { "path": [ "v2", "deals", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the deal ID to associate the new note with" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"string\",\n \"created_by\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1981-12-07T08:55:16.808Z\",\n \"modified_time\": \"1990-03-14T02:54:31.299Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54de3ec3-2c14-4792-ac40-5742d5715884", "name": "Retrieves the count of deals based on the specified filter criteria.", "request": { "name": "Retrieves the count of deals based on the specified filter criteria.", "description": { "content": "Retrieves the count of deals based on the specified filter criteria.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "{{id}}:count" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4683e579-3989-4665-b759-96c2ce7f3979", "name": "the count of deals matching the specified filter criteria.", "originalRequest": { "url": { "path": [ "v2", "deals", "{{id}}:count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "1190", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5be0003c-ef38-46a6-a240-65add7edb1bc", "name": "Moves the specified deal to a specified stage.", "request": { "name": "Moves the specified deal to a specified stage.", "description": { "content": "Moves the specified deal to a specified stage.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "{{id}}:move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "string", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "50781a18-0cb6-4540-9625-982a83f24f3a", "name": "the IDs of the Deals moved", "originalRequest": { "url": { "path": [ "v2", "deals", "{{id}}:move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "string", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4b2ac39e-0327-4062-acef-37bd482b0e1d", "name": "Display Forms", "description": { "content": "Display Forms endpoints.", "type": "text/plain" }, "item": [ { "id": "6ac7ea93-a86d-4dee-a408-f07ee88cff78", "name": "Retrieves a specific display form by a pipeline ID.", "request": { "name": "Retrieves a specific display form by a pipeline ID.", "description": { "content": "Retrieves a specific display form by a pipeline ID.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "eaf40821-544d-4c84-b505-6794d4855c30", "name": "the requested Deal", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"id\": \"string\",\n \"sort_order\": 105,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"string\",\n \"sort_order\": 7444,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d33a891c-2c54-46dd-a7ca-9cc42e75f2c0", "name": "Updates a display form", "request": { "name": "Updates a display form", "description": { "content": "Updates a display form", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"groups\": [\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 6209,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 8818,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"title\": \"string\",\n \"sort_order\": 8388,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 6272,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 5394,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"title\": \"string\",\n \"sort_order\": 5707,\n \"description\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e08ff4a4-0100-4b6a-ba81-041e7bc0305e", "name": "the updated DisplayForm", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"groups\": [\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 6581,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 5847,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"title\": \"string\",\n \"sort_order\": 1426,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 3419,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 2883,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"title\": \"string\",\n \"sort_order\": 8907,\n \"description\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"id\": \"string\",\n \"sort_order\": 2786,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"string\",\n \"sort_order\": 9810,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "395387fa-7a17-440c-988f-e25d16570a56", "name": "Pipelines", "description": { "content": "Pipelines endpoints.", "type": "text/plain" }, "item": [ { "id": "0539ebde-a5e6-4d5c-96d4-2795ea97af5f", "name": "List Pipeline", "request": { "name": "List Pipeline", "description": { "content": "Lists entities based on the provided ListCommand.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fe0ee782-0313-4df9-a230-c710b8741785", "name": "a response containing the list of entities", "originalRequest": { "url": { "path": [ "v2", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"pipelines\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f297179-d14a-46b2-b525-1b1661f0ddc8", "name": "Create Pipeline", "request": { "name": "Create Pipeline", "description": { "content": "Creates a new entity.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"stages\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "53cce220-6353-42a2-8d9d-4cf2cd105cf5", "name": "The created entity", "originalRequest": { "url": { "path": [ "v2", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"stages\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a642ccbc-1e9a-4897-afaf-0438cbfaa072", "name": "Retrieves a list of pipeline summaries.", "request": { "name": "Retrieves a list of pipeline summaries.", "description": { "content": "Retrieves a list of pipeline summaries.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3f054f0f-a866-461b-9296-ff4e615fb1d4", "name": "the response containing the list of pipeline summaries and the next page token", "originalRequest": { "url": { "path": [ "v2", "pipelines", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"pipeline_summaries\": [\n {\n \"pipeline_name\": \"string\",\n \"pipeline_id\": \"38600471621\",\n \"stat_total_deal_count\": 7551,\n \"stat_new_deal_count\": 3746\n },\n {\n \"pipeline_name\": \"string\",\n \"pipeline_id\": \"69559717813\",\n \"stat_total_deal_count\": 9098,\n \"stat_new_deal_count\": 6775\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ddcb377-eb73-46ac-82e8-ec1e267a3cce", "name": "Get Pipeline", "request": { "name": "Get Pipeline", "description": { "content": "Retrieves an entity by its identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "00aa161e-74ca-4075-a395-6cecf7b752d7", "name": "The retrieved entity", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f4a906c-164f-4265-bb4b-dfe60a27fb16", "name": "Deletes a pipeline.", "request": { "name": "Deletes a pipeline.", "description": { "content": "Deletes a pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "new_stage_id", "value": "string", "description": "the new stage identifier, can be null" }, { "disabled": false, "key": "allow_cleanup", "value": "false", "description": "flag indicating whether cleanup is allowed, can be null" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a0bff522-0f2e-4eee-962b-e58971b507e1", "name": "A response indicating no content", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "new_stage_id", "value": "string" }, { "key": "allow_cleanup", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81157d98-ffdc-4e37-8e9e-f5be49209977", "name": "Update Pipeline", "request": { "name": "Update Pipeline", "description": { "content": "Updates an existing entity.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" }, { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "082c42b1-3ba1-47e2-b88a-185cf69af324", "name": "The updated entity", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" }, { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39366d7c-7a9f-434f-a5a6-cab843e91ac9", "name": "Updates a pipeline's deals in bulk.", "request": { "name": "Updates a pipeline's deals in bulk.", "description": { "content": "Updates a pipeline's deals in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"bulk_deal_update_type\": \"string\",\n \"exclude_deal_ids_specified\": false,\n \"filters\": [\n {\n \"key\": \"string\",\n \"operator\": \"GREATER_THAN\",\n \"value\": \"string\"\n },\n {\n \"key\": \"string\",\n \"operator\": \"BETWEEN\",\n \"value\": \"string\"\n }\n ],\n \"new_value\": \"string\",\n \"deal_ids\": [\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "db0fa205-2c2e-4057-ba80-c8003e4bae4c", "name": "the response containing the results of the bulk update operation", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"bulk_deal_update_type\": \"string\",\n \"exclude_deal_ids_specified\": true,\n \"filters\": [\n {\n \"key\": \"string\",\n \"operator\": \"IN\",\n \"value\": \"string\"\n },\n {\n \"key\": \"string\",\n \"operator\": \"GREATER_THAN_OR_EQUAL\",\n \"value\": \"string\"\n }\n ],\n \"new_value\": \"string\",\n \"deal_ids\": [\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"stage_move_success\": false,\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c50e82bc-872e-429b-8fff-0649fa7a5975", "name": "Retrieves the list of deals for a specific pipeline.", "request": { "name": "Retrieves the list of deals for a specific pipeline.", "description": { "content": "Retrieves the list of deals for a specific pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c075f69d-e518-42ca-b201-95dbd9360c34", "name": "a Mono emitting the count of deals", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"name\": \"string\",\n \"id\": \"string\",\n \"value\": {\n \"amount\": 1454.169877340552,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"1976-03-02T20:10:34.612Z\",\n \"close_time\": \"1995-06-01T23:32:55.299Z\",\n \"estimated_close_time\": \"1972-04-17T14:17:58.647Z\",\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"LOST\",\n \"order\": \"string\"\n },\n {\n \"name\": \"string\",\n \"id\": \"string\",\n \"value\": {\n \"amount\": 9876.962853208839,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"1986-05-24T00:10:52.142Z\",\n \"close_time\": \"1965-02-08T14:59:29.973Z\",\n \"estimated_close_time\": \"2018-05-31T17:28:33.202Z\",\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"LOST\",\n \"order\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ed172f1-13b6-4fb0-8dba-d218264ffb37", "name": "Gets the outcome labels for a pipeline.", "request": { "name": "Gets the outcome labels for a pipeline.", "description": { "content": "Gets the outcome labels for a pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b0ef70d5-144e-42d2-83c2-f1e9204a7aa5", "name": "the updated list of the pipeline's outcome labels", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"outcome_labels\": [\n {\n \"value\": \"WON\",\n \"label\": \"string\"\n },\n {\n \"value\": \"LOST\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebb5a203-d976-4255-b783-de5a93835dcd", "name": "Sets the outcome labels for a pipeline.", "request": { "name": "Sets the outcome labels for a pipeline.", "description": { "content": "Sets the outcome labels for a pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"outcome_labels\": [\n {\n \"value\": \"ACTIVE\",\n \"label\": \"string\"\n },\n {\n \"value\": \"ACTIVE\",\n \"label\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31004a84-6e22-4182-8590-2143f32b6bdf", "name": "the updated list of the pipeline's outcome labels", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"outcome_labels\": [\n {\n \"value\": \"ACTIVE\",\n \"label\": \"string\"\n },\n {\n \"value\": \"ACTIVE\",\n \"label\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"outcome_labels\": [\n {\n \"value\": \"WON\",\n \"label\": \"string\"\n },\n {\n \"value\": \"LOST\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13900c36-b523-48ae-a86d-6b5d5f7e68cb", "name": "Retrieves a list of stages for a specific pipeline.", "request": { "name": "Retrieves a list of stages for a specific pipeline.", "description": { "content": "Retrieves a list of stages for a specific pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a3561d9e-fe70-497d-8b6b-df44f9e24f0b", "name": "the response containing the list of pipeline stages and the next page token", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"stages\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "811bfb9f-528f-4ff5-8876-b74739308f0e", "name": "Retrieves the count of deals for a specific pipeline.", "request": { "name": "Retrieves the count of deals for a specific pipeline.", "description": { "content": "Retrieves the count of deals for a specific pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", "{{id}}:dealsCount" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "001ef59f-e067-45a3-b2e5-a8fe1a20e345", "name": "a Mono emitting the count of deals", "originalRequest": { "url": { "path": [ "v2", "pipelines", "{{id}}:dealsCount" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "1190", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "77bcf127-8ef8-4eac-91aa-977b76835a81", "name": "Stages", "description": { "content": "Stages endpoints.", "type": "text/plain" }, "item": [ { "id": "7e1462a2-782b-46f0-8f9a-022938ae632b", "name": "List Stages", "request": { "name": "List Stages", "description": { "content": "Lists entities based on the provided ListCommand.", "type": "text/plain" }, "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e1b03b6a-3beb-4a9f-990e-e40ccae4b4ae", "name": "a response containing the list of entities", "originalRequest": { "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"stages\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0783a6ee-0b95-449c-a966-9d076bafc1fc", "name": "Create Stages", "request": { "name": "Create Stages", "description": { "content": "Creates a new entity.", "type": "text/plain" }, "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2082e7d0-37a2-4e7d-a155-38bb99d1f311", "name": "The created entity", "originalRequest": { "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6a15d8b-01e8-4061-8f2f-baf9176bdc9a", "name": "Get Stages", "request": { "name": "Get Stages", "description": { "content": "Retrieves an entity by its identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "86f4ada0-aa06-492f-bc31-ae62ff150d2e", "name": "The retrieved entity", "originalRequest": { "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b01907de-f530-4dd2-abfe-d11b0da74c02", "name": "Deletes a stage by its identifier for a given tenant.", "request": { "name": "Deletes a stage by its identifier for a given tenant.", "description": { "content": "Deletes a stage by its identifier for a given tenant.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "new_stage_id", "value": "string", "description": "the new stage identifier, can be null" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "64fcc976-1b54-4d41-929e-aea835f30caf", "name": "A response indicating no content", "originalRequest": { "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "new_stage_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41cd1a8c-cfbf-44d7-8c4c-26d36a07fff9", "name": "Update Stages", "request": { "name": "Update Stages", "description": { "content": "Updates an existing entity.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" }, { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"next_stage_id\": \"string\",\n \"pipeline_id\": \"string\",\n \"previous_stage_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "711e6089-356b-43ab-9fe7-68c69a684984", "name": "The updated entity", "originalRequest": { "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" }, { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"next_stage_id\": \"string\",\n \"pipeline_id\": \"string\",\n \"previous_stage_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9727ad53-bf36-4acb-af53-acefc0dd4081", "name": "Counts the number of deals in a specific stage.", "request": { "name": "Counts the number of deals in a specific stage.", "description": { "content": "Counts the number of deals in a specific stage.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id", "dealCount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0b9847e6-9f35-4833-a92d-c9f4fdb46604", "name": "the count of deals in the stage", "originalRequest": { "url": { "path": [ "v2", "stages", ":id", "dealCount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "1190", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff9d8476-ad9a-4985-87ef-469e559145b4", "name": "Retrieves a list of deals for a specific stage.", "request": { "name": "Retrieves a list of deals for a specific stage.", "description": { "content": "Retrieves a list of deals for a specific stage.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f8dd9750-9736-4010-b437-e76d0278cda0", "name": "the response containing the list of deals and the next page token", "originalRequest": { "url": { "path": [ "v2", "stages", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 9111.711248250609,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2009-06-08T23:36:26.206Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1967-12-03T13:36:12.777Z\",\n \"closed_time\": \"1988-08-28T05:17:54.527Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": false\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 2402.293470299086,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1969-12-02T08:24:30.519Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2013-01-31T14:33:02.608Z\",\n \"closed_time\": \"1996-03-13T16:27:28.337Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 487\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-stge.infusiontest.com/services", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) the pipeline identifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ], "info": { "_postman_id": "67a7c941-1f41-4f1b-9f60-e0d7bda57b64", "name": "API Reference", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Service Level Aggregation API (SLAAPI) to handle public API spec compliance\n\nContact Support:\n Name: Gryffindor\n Email: gryffindor@keap.com", "type": "text/plain" } } }