{ "openapi": "3.0.0", "info": { "title": "ActionKit Tools API", "version": "1.0.0" }, "servers": [ { "url": "https://actionkit.useparagon.com", "description": "US Cloud" } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Your [Paragon User Token](/getting-started/installing-the-connect-sdk#setup) (JWT), which you can generate using your project's signing keys." } } }, "paths": { "/projects/{project_id}/tools/#AMAZON_S3_CREATE_FOLDER": { "post": { "summary": "Create Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AMAZON_S3_CREATE_FOLDER" }, "parameters": { "type": "object", "properties": { "bucketName": { "type": "string", "description": "Bucket : Please specify the Bucket Name. (example: \"Bucket Name\")" }, "folderPath": { "type": "string", "description": "Path : The path for the folder (use slashes to represent hierarchy, e.g., \"folder/subfolder/\") (example: \"folderName/\")" } }, "required": [ "bucketName", "folderPath" ], "x-integration": "amazons3" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AMAZON_S3_DELETE_FOLDER": { "post": { "summary": "Delete Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AMAZON_S3_DELETE_FOLDER" }, "parameters": { "type": "object", "properties": { "bucketName": { "type": "string", "description": "Bucket : Please specify the Bucket Name. (example: \"Bucket Name\")" }, "folderPath": { "type": "string", "description": "Path : The path for the folder (use slashes to represent hierarchy, e.g., \"folder/subfolder/\") (example: \"folderName/\")" } }, "required": [ "bucketName", "folderPath" ], "x-integration": "amazons3" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AMAZON_S3_UPLOAD_FILE": { "post": { "summary": "Upload File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AMAZON_S3_UPLOAD_FILE" }, "parameters": { "type": "object", "properties": { "bucketName": { "type": "string", "description": "Bucket : Specify a bucket to upload this File to. (example: \"Bucket Name\")" }, "objectFileName": { "type": "string", "description": "File : Select a File to upload. (example: \"https://picsum.photos/200/300\")" }, "filePath": { "type": "string", "description": "Path : Upload the File to a specific path. By default, it will upload to the root of the Bucket, with the name of the File that is selected (example: \"fileName\")" }, "additionalOptions": { "type": "object", "description": "Additional Options : Include additional options for the PutObject operation as JSON. See the Amazon S3 docs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html#API_PutObject_RequestSyntax) for the full list of options. (example: \"{\n \"ACL\": \"public-read\"\n}\")", "properties": {} } }, "required": [ "bucketName", "objectFileName", "filePath" ], "x-integration": "amazons3" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AMAZON_S3_DOWNLOAD_FILE": { "post": { "summary": "Download File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AMAZON_S3_DOWNLOAD_FILE" }, "parameters": { "type": "object", "properties": { "bucketName": { "type": "string", "description": "Bucket : Specify a bucket to download this File from. (example: \"Bucket Name\")" }, "downloadFileName": { "type": "string", "description": "Key : Specify the Key of the File to download. (example: \"Key Name\")" }, "expiresIn": { "type": "string", "description": "Expires In : Specify the number of seconds the signed URL will be valid for. (example: \"3600\")" } }, "required": [ "bucketName", "downloadFileName" ], "x-integration": "amazons3" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "201": { "description": "**Response with File URL**", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "A temporary signed download URL from the Amazon S3 API. Send a request to this URL from your request client or provide the URL to an LLM provider to download or use the file contents." } } } } } } } } }, "/projects/{project_id}/tools/#AMAZON_S3_LIST_FILES": { "post": { "summary": "List Files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AMAZON_S3_LIST_FILES" }, "parameters": { "type": "object", "properties": { "bucketName": { "type": "string", "description": "Bucket : Please specify the Bucket Name. (example: \"Bucket Name\")" } }, "required": [ "bucketName" ], "x-integration": "amazons3" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AIRTABLE_FETCH_RECORDS": { "post": { "summary": "Fetch Records", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AIRTABLE_FETCH_RECORDS" }, "parameters": { "type": "object", "properties": { "baseId": { "type": "string", "description": "Base : Specify the base ID. Defaults to the user’s primary base if left blank. (example: \"{{settings.base}}\")" }, "tableName": { "type": "string", "description": "Table Name : Specify the table name. (example: \"{{settings.table}}\")" }, "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "$none", "$stringContains", "$stringDoesNotContain", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist", "$isNotUndefinedOrNull", "$isUndefinedOrNull", "$numberLessThanOrEqualTo", "$numberGreaterThanOrEqualTo" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "string", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "tableName" ], "x-integration": "airtable" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AIRTABLE_CREATE_RECORD": { "post": { "summary": "Create Record", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AIRTABLE_CREATE_RECORD" }, "parameters": { "type": "object", "properties": { "baseId": { "type": "string", "description": "Base : Specify the base ID. Defaults to the user’s primary base if left blank. (example: \"{{settings.base}}\")" }, "tableName": { "type": "string", "description": "Table Name : Specify the table name. (example: \"{{settings.table}}\")" }, "additionalFields": { "type": "object", "description": "Fields : Specify record fields as a JSON object of field names to values. (example: \"{\n \"Field Name 1\": \"value1\",\n \"Field Name 2\": \"value2\"\n}\")", "properties": {} } }, "required": [ "tableName" ], "x-integration": "airtable" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AIRTABLE_UPDATE_RECORD": { "post": { "summary": "Update Record", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AIRTABLE_UPDATE_RECORD" }, "parameters": { "type": "object", "properties": { "baseId": { "type": "string", "description": "Base : Specify the base ID. Defaults to the user’s primary base if left blank. (example: \"{{settings.base}}\")" }, "tableName": { "type": "string", "description": "Table Name : Specify the table name. (example: \"{{settings.table}}\")" }, "recordId": { "type": "string", "description": "Record ID : Specify the ID of the record you want to update." }, "additionalFields": { "type": "object", "description": "Fields : Specify record fields as a JSON object of field names to values. (example: \"{\n \"Field Name 1\": \"value1\",\n \"Field Name 2\": \"value2\"\n}\")", "properties": {} } }, "required": [ "tableName", "recordId" ], "x-integration": "airtable" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_CREATE_COMMENT": { "post": { "summary": "Create Comment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_CREATE_COMMENT" }, "parameters": { "type": "object", "properties": { "task": { "type": "string", "description": "Task ID : The ID of the Task the comment will be added to. The comment will be authored by the currently authenticated user." }, "text": { "type": "string", "description": "Text (example: \"This is a comment.\")" } }, "required": [ "task", "text" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_CREATE_PROJECT": { "post": { "summary": "Create Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_CREATE_PROJECT" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name (example: \"Stuff to buy\")" }, "workspace": { "type": "string", "description": "Specify which workspace to perform the operation in. Defaults to the user's first workspace if not provided" }, "team": { "type": "string", "description": "Specify which team to share this project with. Defaults to the user's first team if not provided" }, "notes": { "type": "string", "description": "Notes (example: \"These are things we need to purchase.\")" } }, "required": [ "name", "workspace" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_GET_PROJECTS": { "post": { "summary": "Get Projects", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_GET_PROJECTS" }, "parameters": { "type": "object", "properties": { "archived": { "type": "string", "description": "Archived : Choose Yes to show archived projects. Select No to display only active projects and The Default option will show both archived and active projects.", "enum": [ "default", "true", "false" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_GET_PROJECT_BY_ID": { "post": { "summary": "Get Project By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_GET_PROJECT_BY_ID" }, "parameters": { "type": "object", "properties": { "projectFilterId": { "type": "string", "description": "Project ID" } }, "required": [ "projectFilterId" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_CREATE_TASK": { "post": { "summary": "Create Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_CREATE_TASK" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name (example: \"Task Name\")" }, "workspace": { "type": "string", "description": "Specify which workspace to perform the operation in. Defaults to the user's first workspace if not provided" }, "project": { "type": "string", "description": "Specify which project to perform the operation in" }, "notes": { "type": "string", "description": "Notes" }, "dueOnDate": { "type": "string", "description": "Due On : The date on which this task is due. Cannot be used together with Due At. (example: \"YYYY-MM-DD\")" }, "dueAtDate": { "type": "string", "description": "Due At : The date and time (ISO timestamp) at which this task is due . Cannot be used together with Due On. (example: \"2019-09-15T02:06:58.147Z\")" }, "assignee": { "type": "string", "description": "Specify the ID of the Asana user this task will be assigned to" }, "gid": { "type": "string", "description": "External ID : An ID from your application to associate this task with. You can use this ID to sync updates to this task later." } }, "required": [ "name" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_UPDATE_TASK": { "post": { "summary": "Update Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_UPDATE_TASK" }, "parameters": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID : The ID of the Task that will be updated." }, "completeStatus": { "type": "string", "description": "Completed Status", "enum": [ "true", "false" ] }, "name": { "type": "string", "description": "Name (example: \"Task Name\")" }, "notes": { "type": "string", "description": "Notes" }, "dueOnDate": { "type": "string", "description": "Due On : The date on which this task is due. Cannot be used together with Due At. (example: \"YYYY-MM-DD\")" }, "dueAtDate": { "type": "string", "description": "Due At : The date and time (ISO timestamp) at which this task is due . Cannot be used together with Due On. (example: \"2019-09-15T02:06:58.147Z\")" }, "assignee": { "type": "string", "description": "Specify the ID of the Asana user this task will be assigned to" }, "gid": { "type": "string", "description": "External ID : An ID from your application to associate this task with. You can use this ID to sync updates to this task later." } }, "required": [ "taskId" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_GET_TASKS_V2": { "post": { "summary": "Get Tasks", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_GET_TASKS_V2" }, "parameters": { "type": "object", "properties": { "workspace": { "type": "string", "description": "Specify which workspace to perform the operation in. Defaults to the user's first workspace if not provided" }, "project": { "type": "string", "description": "Specify which project to perform the operation in" }, "assignee": { "type": "string", "description": "Specify the ID of the Asana user this task will be assigned to" }, "completedSince": { "type": "string", "description": "Completed since : Only return tasks that are either incomplete or that have been completed since this time (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_GET_TASKS_BY_ID": { "post": { "summary": "Get Tasks By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_GET_TASKS_BY_ID" }, "parameters": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID" } }, "required": [ "taskId" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_GET_TASK_BY_EXTERNAL_ID": { "post": { "summary": "Get Task By External ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_GET_TASK_BY_EXTERNAL_ID" }, "parameters": { "type": "object", "properties": { "gid": { "type": "string", "description": "External ID : The ID that this task is associated or synced with, from your application." } }, "required": [ "gid" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_ADD_TASK_TO_SECTION": { "post": { "summary": "Add Task To Section", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_ADD_TASK_TO_SECTION" }, "parameters": { "type": "object", "properties": { "sectionId": { "type": "string", "description": "Specify the ID of the Asana section to add the task to." }, "taskId": { "type": "string", "description": "Task ID : The ID of the task. (example: \"1204619611402340\")" }, "beforeTaskId": { "type": "string", "description": "Before Task ID : The ID of a task in this section that this task will be inserted before. Cannot be used with After Task ID. (example: \"1204619611402340\")" }, "afterTaskId": { "type": "string", "description": "After Task ID : The ID of a task in this section that this task will be inserted after. Cannot be used with Before Task ID. (example: \"1204619611402340\")" } }, "required": [ "sectionId", "taskId" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_GET_TEAMS_V2": { "post": { "summary": "Get Teams", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_GET_TEAMS_V2" }, "parameters": { "type": "object", "properties": { "workspace": { "type": "string", "description": "Workspace : Returns the teams in this workspace visible to the authorized user." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "workspace" ], "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ASANA_GET_WORKSPACES_V2": { "post": { "summary": "Get Workspaces", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ASANA_GET_WORKSPACES_V2" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "asana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AZURE_DEVOPS_SEARCH_WORKITEMS": { "post": { "summary": "Search Workitems", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AZURE_DEVOPS_SEARCH_WORKITEMS" }, "parameters": { "type": "object", "properties": { "projectFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "[Microsoft.VSTS.Common.Activity]", "[System.AreaPath]", "[System.AssignedTo]", "[Microsoft.VSTS.Common.BusinessValue]", "[System.ChangedDate]", "[System.CreatedDate]", "[System.Description]", "[Microsoft.VSTS.Scheduling.Effort]", "[System.IterationPath]", "[Microsoft.VSTS.Common.Priority]", "[Microsoft.VSTS.Common.ResolvedReason]", "[Microsoft.VSTS.Common.Risk]", "[System.Reason]", "[Microsoft.VSTS.Scheduling.StartDate]", "[Microsoft.VSTS.Scheduling.StoryPoints]", "[System.State]", "[Microsoft.VSTS.Common.Severity]", "[System.Tags]", "[Microsoft.VSTS.Scheduling.TargetDate]", "[System.TeamProject]", "[System.Title]", "[Microsoft.VSTS.Common.TimeCriticality]", "[System.WorkItemType]" ] }, "operator": { "type": "string", "enum": [ "$numberLessThan", "$numberEquals", "$numberGreaterThan", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$stringIsIn", "$stringIsNotIn", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$stringDoesNotContain", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "azuredevops" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AZURE_DEVOPS_CREATE_WORKITEM": { "post": { "summary": "Create Workitem", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AZURE_DEVOPS_CREATE_WORKITEM" }, "parameters": { "type": "object", "properties": { "project": { "type": "string", "description": "Specify a project to perform the operation in" }, "workItemType": { "type": "string", "description": "Work Item Type : Search for work items that match specified filters. (example: \"Type\")", "enum": [ "BUG", "EPIC", "FEATURE", "ISSUE", "TASK", "TEST CASE", "USER STORY" ] }, "reproSteps": { "type": "string", "description": "Repro Steps : Description of how to see the bug. \nThis field appears only when 'workItemType' = 'BUG')" }, "systemInfo": { "type": "string", "description": "System Info : Test context, can be automatically provided by test infrastructure. \nThis field appears only when 'workItemType' = 'BUG')" }, "resolvedReason": { "type": "string", "description": "Resolved Reason : The reason why the bug was resolved. \nThis field appears only when 'workItemType' = 'BUG')" }, "storyPoints": { "type": "string", "description": "Story Points : The size of work estimated for fixing the bug. \nThis field appears only when 'workItemType' = 'BUG')" }, "priority": { "type": "string", "description": "Priority : Business importance. \nThis field appears only when 'workItemType' = 'BUG') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '')" }, "severity": { "type": "string", "description": "Severity : An assessment of the effect of the bug on the project. \nThis field appears only when 'workItemType' = 'BUG')", "enum": [ "1 - Critical", "2 - High", "3 - Medium", "4 - Low" ] }, "activity": { "type": "string", "description": "Activity : Type of work involved for this work item. \nThis field appears only when 'workItemType' = 'BUG')", "enum": [ "Deployment", "Design", "Development", "Documentation ", "Requirements", "Testing " ] }, "description": { "type": "string", "description": "Description : Description or acceptance criteria for this epic to be considered complete. \nThis field appears only when 'workItemType' = 'EPIC') \nThis field appears only when 'type' = '')" }, "risk": { "type": "string", "description": "Risk : Uncertainty in epic. \nThis field appears only when 'workItemType' = 'EPIC') \nThis field appears only when 'type' = '')", "enum": [ "1", "2", "3" ] }, "effort": { "type": "string", "description": "Effort : The estimated effort to implemented the epic. \nThis field appears only when 'workItemType' = 'EPIC') \nThis field appears only when 'type' = '')" }, "businessValue": { "type": "string", "description": "Business Value : The business value for the customer when the epic is released. \nThis field appears only when 'workItemType' = 'EPIC') \nThis field appears only when 'type' = '')" }, "timeCriticality": { "type": "string", "description": "Time Criticality : How the business value of this epic decays over time. Higher values make the epic more time-critical. \nThis field appears only when 'workItemType' = 'EPIC') \nThis field appears only when 'type' = '')" }, "startDate": { "type": "string", "description": "Start Date : The date to start the task. \nThis field appears only when 'workItemType' = 'EPIC') \nThis field appears only when 'type' = '')" }, "targetDate": { "type": "string", "description": "Target Date : The target date for completing the epic. \nThis field appears only when 'workItemType' = 'EPIC') \nThis field appears only when 'type' = '')" }, "title": { "type": "string", "description": "Title" }, "assignee": { "type": "string", "description": "Assignee : Specify a user that this work item should be assigned to." }, "state": { "type": "string", "description": "State : The state of the created work item.", "enum": [ "New", "Active", "Resolved", "Closed" ] }, "reason": { "type": "string", "description": "Reason : The reason for the created work item. This value may accept different values depending on the current State of the work item." }, "area": { "type": "string", "description": "Specify the area for the work item" }, "iteration": { "type": "string", "description": "Specify the iteration for the work item" }, "additionalFields": { "type": "object", "description": "Additional Fields (example: \"\n{\n \"Custom.customfield\": \"Value for custom field\"\n}\")", "properties": {} } }, "required": [ "project", "workItemType", "title" ], "x-integration": "azuredevops" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AZURE_DEVOPS_UPDATE_WORKITEM": { "post": { "summary": "Update Workitem", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AZURE_DEVOPS_UPDATE_WORKITEM" }, "parameters": { "type": "object", "properties": { "project": { "type": "string", "description": "Specify a project to perform the operation in" }, "workItemId": { "type": "string", "description": "Work Item ID : The ID of the work item to update." }, "title": { "type": "string", "description": "Title" }, "assignee": { "type": "string", "description": "Assignee : Specify a user that this work item should be assigned to." }, "state": { "type": "string", "description": "State : The state of the created work item.", "enum": [ "New", "Active", "Resolved", "Closed" ] }, "reason": { "type": "string", "description": "Reason : The reason for the created work item. This value may accept different values depending on the current State of the work item." }, "area": { "type": "string", "description": "Specify the area for the work item" }, "iteration": { "type": "string", "description": "Specify the iteration for the work item" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this work item as JSON. (example: \"\n{\n \"Custom.customfield\": \"Value for custom field\"\n}\")", "properties": {} } }, "required": [ "project", "workItemId" ], "x-integration": "azuredevops" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#AZURE_DEVOPS_DELETE_WORKITEM": { "post": { "summary": "Delete Workitem", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "AZURE_DEVOPS_DELETE_WORKITEM" }, "parameters": { "type": "object", "properties": { "project": { "type": "string", "description": "Specify a project to perform the operation in" }, "workItemId": { "type": "string", "description": "Work Item ID : The ID of the work item to delete." } }, "required": [ "project", "workItemId" ], "x-integration": "azuredevops" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_CREATE_EMPLOYEE": { "post": { "summary": "Create Employee", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_CREATE_EMPLOYEE" }, "parameters": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First Name : Specify the first name of the employee to create. (example: \"John\")" }, "lastName": { "type": "string", "description": "Last Name : Specify the last name of the employee to create. (example: \"Doe\")" }, "dateOfBirth": { "type": "string", "description": "Date of Birth (example: \"yyyy-mm-dd\")" }, "employeeNumber": { "type": "string", "description": "Employee Number (example: \"5\")" }, "gender": { "type": "string", "description": "Gender : Specify the plain text name of the gender." }, "socialSecurity": { "type": "string", "description": "Social Security Number : Specify the social security number of the employee to create." }, "maritalStatus": { "type": "string", "description": "Marital Status : Specify the plain text status of marriage. (example: \"Single\")" }, "hireDate": { "type": "string", "description": "Hire Date : Specify the date of hire for the employee to create. (example: \"yyyy-mm-dd\")" }, "address": { "type": "string", "description": "Address Line 1 (example: \"2000 Oak Street\")" }, "city": { "type": "string", "description": "City (example: \"San Francisco\")" }, "state": { "type": "string", "description": "State : Specify the full name of the state or province. (example: \"California\")" }, "country": { "type": "string", "description": "Country : Specify the name of the country. Must exist in the BambooHR country list. (example: \"United States\")" }, "employmentHistory": { "type": "string", "description": "Employment History Status : The employee's employment status as used to filter employees in BambooHR.", "enum": [ "contractor", "full-time", "furloughed", "intern", "part-time", "terminated" ] }, "exempt": { "type": "string", "description": "Exempt : Specify the FLSA Overtime Status of the employee.", "enum": [ "exempt", "non exempt" ] }, "payType": { "type": "string", "description": "Pay Type : Specify the employee’s current pay type.", "enum": [ "hourly", "salary", "commision", "exception hourly", "monthly", "piece rate", "contract", "daily", "pro rata" ] }, "payRate": { "type": "string", "description": "Pay Rate : Specify the employee’s current pay rate. (example: \"8.25\")" }, "payPer": { "type": "string", "description": "Pay Per : Specify the employee’s current pay per.", "enum": [ "hour", "day", "week", "month", "quater", "year" ] }, "location": { "type": "string", "description": "Location : Specify the employee's current location. The provided location must exist in the BambooHR instance’s location table." }, "department": { "type": "string", "description": "Department : Specify the employee's current department. The provided department must exist in the BambooHR instance’s department table." }, "division": { "type": "string", "description": "Division : Specify the employee's current division. The provided division must exist in the BambooHR instance’s division table." }, "additionalFields": { "type": "object", "description": "Additional Fields (example: \"{\n jobTitle: \"Accountant\",\n nickname: \"John\",\n address2: \"Seattle\"\n}\")", "properties": {} } }, "required": [ "firstName", "lastName" ], "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_UPDATE_EMPLOYEE": { "post": { "summary": "Update Employee", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_UPDATE_EMPLOYEE" }, "parameters": { "type": "object", "properties": { "employeeId": { "type": "string", "description": "Employee ID : Specify the ID of the employee to update. (example: \"45\")" }, "firstName": { "type": "string", "description": "First Name : Specify the first name of the employee to update. (example: \"John\")" }, "lastName": { "type": "string", "description": "Last Name : Specify the last name of the employee to update. (example: \"Doe\")" }, "dateOfBirth": { "type": "string", "description": "Date of Birth (example: \"yyyy-mm-dd\")" }, "employeeNumber": { "type": "string", "description": "Employee Number (example: \"5\")" }, "gender": { "type": "string", "description": "Gender : Specify the plain text name of the gender." }, "socialSecurity": { "type": "string", "description": "Social Security Number : Specify the social security number of the employee to update." }, "maritalStatus": { "type": "string", "description": "Marital Status : Specify the plain text status of marriage. (example: \"Single\")" }, "hireDate": { "type": "string", "description": "Hire Date : Specify the date of hire for the employee to update. (example: \"yyyy-mm-dd\")" }, "address": { "type": "string", "description": "Address Line 1 (example: \"2000 Oak Street\")" }, "city": { "type": "string", "description": "City (example: \"San Francisco\")" }, "state": { "type": "string", "description": "State : Specify the full name of the state or province. (example: \"California\")" }, "country": { "type": "string", "description": "Country : Specify the name of the country. Must exist in the BambooHR country list. (example: \"United States\")" }, "employmentHistory": { "type": "string", "description": "Employment History Status : The employee's employment status as used to filter employees in BambooHR.", "enum": [ "contractor", "full-time", "furloughed", "intern", "part-time", "terminated" ] }, "exempt": { "type": "string", "description": "Exempt : Specify the FLSA Overtime Status of the employee.", "enum": [ "exempt", "non exempt" ] }, "payType": { "type": "string", "description": "Pay Type : Specify the employee’s current pay type.", "enum": [ "hourly", "salary", "commision", "exception hourly", "monthly", "piece rate", "contract", "daily", "pro rata" ] }, "payRate": { "type": "string", "description": "Pay Rate : Specify the employee’s current pay rate. (example: \"8.25\")" }, "payPer": { "type": "string", "description": "Pay Per : Specify the employee’s current pay per.", "enum": [ "hour", "day", "week", "month", "quater", "year" ] }, "location": { "type": "string", "description": "Location : Specify the employee's current location. The provided location must exist in the BambooHR instance’s location table." }, "department": { "type": "string", "description": "Department : Specify the employee's current department. The provided department must exist in the BambooHR instance’s department table." }, "division": { "type": "string", "description": "Division : Specify the employee's current division. The provided division must exist in the BambooHR instance’s division table." }, "additionalFields": { "type": "object", "description": "Additional Fields (example: \"{\n jobTitle: \"Accountant\",\n nickname: \"John\",\n address2: \"Seattle\"\n}\")", "properties": {} } }, "required": [ "employeeId" ], "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_GET_EMPLOYEE_BY_ID": { "post": { "summary": "Get Employee By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_GET_EMPLOYEE_BY_ID" }, "parameters": { "type": "object", "properties": { "employeeId": { "type": "string", "description": "Employee ID : Specify the ID of the employee to get. (example: \"45\")" } }, "required": [ "employeeId" ], "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_GET_EMPLOYEE_DIRECTORY": { "post": { "summary": "Get Employee Directory", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_GET_EMPLOYEE_DIRECTORY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_CREATE_TIME_OFF_REQUEST": { "post": { "summary": "Create Time Off Request", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_CREATE_TIME_OFF_REQUEST" }, "parameters": { "type": "object", "properties": { "employeeId": { "type": "string", "description": "Employee ID : Specify the ID of the employee associated with this time off request. (example: \"45\")" }, "timeOffTypeId": { "type": "string", "description": "Time Off Type ID : Specify the associated time off type ID to create a time off request. (example: \"11\")" }, "startDate": { "type": "string", "description": "Start Date (example: \"yyyy-mm-dd\")" }, "endDate": { "type": "string", "description": "End Date (example: \"yyyy-mm-dd\")" }, "status": { "type": "string", "description": "Status : Specify the status of this time off request.", "enum": [ "approved", "denied", "requested" ] }, "amount": { "type": "string", "description": "Amount : Specify the amount of days/hours to update the employee’s balance by. The unit will be based on the settings of the time off type. (example: \"1\")" }, "employeeNote": { "type": "string", "description": "Employee Note : Specify an employee note to attach to the time off request in this free-text space." }, "managerNote": { "type": "string", "description": "Manager Note : Specify a manager note to attach to the time off request in this free-text space." } }, "required": [ "employeeId", "timeOffTypeId", "startDate", "endDate", "status" ], "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_CHANGE_REQUEST_STATUS": { "post": { "summary": "Change Request Status", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_CHANGE_REQUEST_STATUS" }, "parameters": { "type": "object", "properties": { "requestId": { "type": "string", "description": "Request ID : Specify the request ID of the time off request to update. (example: \"12\")" }, "status": { "type": "string", "description": "Status : Specify the status of this time off request.", "enum": [ "approved", "denied", "requested" ] }, "managerNote": { "type": "string", "description": "Manager Note : Specify a manager note to attach to the updated time off request in this free text space." } }, "required": [ "requestId", "status" ], "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_ADJUST_TIME_OFF_BALANCE_FOR_EMPLOYEE": { "post": { "summary": "Adjust Time Off Balance For Employee", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_ADJUST_TIME_OFF_BALANCE_FOR_EMPLOYEE" }, "parameters": { "type": "object", "properties": { "employeeId": { "type": "string", "description": "Employee ID : Specify the ID of the employee associated with this adjustment. (example: \"45\")" }, "date": { "type": "string", "description": "Date : Specify the date adjustment. Accepts ISO 8601 date format. (example: \"yyyy-mm-dd\")" }, "timeOffTypeId": { "type": "string", "description": "Time Off Type ID : Specify the associated time off type ID to add a balance adjustment for. (example: \"11\")" }, "amount": { "type": "string", "description": "Amount : Specify the number of hours/days to adjust the balance by. The units of this amount will be determined by the time off type. (example: \"-6.0000\")" }, "note": { "type": "string", "description": "Note : Specify a note to attach to this adjustment." } }, "required": [ "employeeId", "date", "timeOffTypeId", "amount" ], "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_GET_TIME_OFF_REQUESTS_FOR_EMPLOYEE": { "post": { "summary": "Get Time Off Requests For Employee", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_GET_TIME_OFF_REQUESTS_FOR_EMPLOYEE" }, "parameters": { "type": "object", "properties": { "employeeId": { "type": "string", "description": "Employee ID : Specify the ID of the employee to search time off requests for. (example: \"4\")" }, "startDate": { "type": "string", "description": "Start Date (example: \"yyyy-mm-dd\")" }, "endDate": { "type": "string", "description": "End Date (example: \"yyyy-mm-dd\")" } }, "required": [ "employeeId", "startDate", "endDate" ], "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_GET_TIME_OFF_TYPES": { "post": { "summary": "Get Time Off Types", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_GET_TIME_OFF_TYPES" }, "parameters": { "type": "object", "properties": {}, "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_GET_FIELD_LIST": { "post": { "summary": "Get Field List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_GET_FIELD_LIST" }, "parameters": { "type": "object", "properties": {}, "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BAMBOO_HR_ADD_LIST_FIELD_VALUE": { "post": { "summary": "Add List Field Value", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BAMBOO_HR_ADD_LIST_FIELD_VALUE" }, "parameters": { "type": "object", "properties": { "listFieldId": { "type": "string", "description": "List Field ID" }, "customFieldOptions": { "type": "object", "description": "Custom Fields Options (example: \"[\n {\n value: \"New Value\",\n archived: \"yes\"\n },\n]\")", "properties": {} } }, "required": [ "listFieldId", "customFieldOptions" ], "x-integration": "bamboohr" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_SAVE_FILE": { "post": { "summary": "Save File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_SAVE_FILE" }, "parameters": { "type": "object", "properties": { "fileAttributes": { "type": "object", "description": "Attributes : Additional attributes (https://developer.box.com/reference/post-files-content#param-attributes) of the file being uploaded. (example: \"{\n \"content_created_at\": \"2012-12-12T10:53:43-08:00\",\n \"content_modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"name\": \"qwerty.png\",\n \"parent\": { \"id\": \"1234567\" }\n}\")", "properties": {} }, "file": { "type": "string", "description": "File URL : Files must be smaller than 50MB in size. (example: \"https://picsum.photos/200/300\")" } }, "required": [ "fileAttributes", "file" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_SAVE_FILE_FROM_OBJECT": { "post": { "summary": "Save File From Object", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_SAVE_FILE_FROM_OBJECT" }, "parameters": { "type": "object", "properties": { "file": { "type": "object", "description": "File to save to Box. (example: {\n \"data\": \"48656c6c6f2c20776f726c6421\",\n \"dataType\": \"FILE\",\n \"mimeType\": \"text/plain\"\n})", "properties": {} }, "fileName": { "type": "string", "description": "File Name (example: \"qwerty.png\")" }, "folder": { "type": "string", "description": "The File's Folder destination. Defaults to the user's root folder if left blank" } }, "required": [ "file", "fileName" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_GET_FILE_BY_ID": { "post": { "summary": "Get File By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_GET_FILE_BY_ID" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : The unique identifier that represents a file. (example: \"12345\")" } }, "required": [ "fileId" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_LIST_FILES_V2": { "post": { "summary": "List Files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_LIST_FILES_V2" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : The unique identifier that represents a folder. (example: \"0\")" }, "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "direction", "sort" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$booleanFalse", "$booleanTrue", "$numberEquals" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results. Since Box returns mixed files and folders, filtered results may contain fewer records than the limit (or none) even when nextPageCursor is present. Continue paginating until nextPageCursor is null." } } } }, "required": [ "folderId" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_CREATE_FOLDER": { "post": { "summary": "Create Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_CREATE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderName": { "type": "string", "description": "Name : The name for the new folder. (example: \"New Folder\")" }, "folderParent": { "type": "object", "description": "Parent Folder : Parent folder (https://developer.box.com/reference/post-folders#param-parent) to create the new folder within. (example: \"{\n \"id\": \"123456\"\n}\")", "properties": {} } }, "required": [ "folderName", "folderParent" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_MOVE_FOLDER": { "post": { "summary": "Move Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_MOVE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : The unique identifier that represents a folder. (example: \"0\")" }, "folderName": { "type": "string", "description": "Name : The name for the new folder. (example: \"New Folder\")" }, "folderParent": { "type": "object", "description": "Parent Folder : Parent folder (https://developer.box.com/reference/post-folders#param-parent) to create the new folder within. (example: \"{\n \"id\": \"123456\"\n}\")", "properties": {} } }, "required": [ "folderId", "folderName", "folderParent" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_GET_FOLDER_BY_ID": { "post": { "summary": "Get Folder By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_GET_FOLDER_BY_ID" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : The unique identifier that represents a folder. (example: \"0\")" } }, "required": [ "folderId" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_SEARCH_FOLDERS_V2": { "post": { "summary": "Search Folders", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_SEARCH_FOLDERS_V2" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : Specify the unique identifier that represents a folder. 0 will be used if not specified (example: \"0\")" }, "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "direction", "sort" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$booleanFalse", "$booleanTrue", "$numberEquals" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_DELETE_FOLDER": { "post": { "summary": "Delete Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_DELETE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : The unique identifier that represents a folder. (example: \"0\")" }, "recursive": { "type": "boolean", "description": "Recursive : Delete a folder that is not empty by recursively deleting the folder and all of its content." } }, "required": [ "folderId" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#BOX_DOWNLOAD_FILE": { "post": { "summary": "Download File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "BOX_DOWNLOAD_FILE" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : The unique identifier that represents a file. (example: \"12345\")" } }, "required": [ "fileId" ], "x-integration": "box" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "201": { "description": "**Response with File URL**", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "A temporary signed download URL from the Box API. Send a request to this URL from your request client or provide the URL to an LLM provider to download or use the file contents." } } } } } } } } }, "/projects/{project_id}/tools/#CALENDLY_GET_EVENT_TYPES": { "post": { "summary": "Get Event Types", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CALENDLY_GET_EVENT_TYPES" }, "parameters": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Event UUID : Specify the Event UUID of the event type to fetch. (example: \"23dd4622-4dbe-42ad-bee0-1a8092e1772a\")" } }, "required": [ "uuid" ], "x-integration": "calendly" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CALENDLY_GET_AVAILABLE_TIMES_FOR_EVENT_TYPE": { "post": { "summary": "Get Available Times For Event Type", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CALENDLY_GET_AVAILABLE_TIMES_FOR_EVENT_TYPE" }, "parameters": { "type": "object", "properties": { "event_type": { "type": "string", "description": "Event Type : Specify the event type to fetch. (example: \"https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA\")" }, "start_time": { "type": "string", "description": "Start Time : Specify a start time for the event availability to fetch. (example: \"2022-01-02T24:00:00.000000Z\")" }, "end_time": { "type": "string", "description": "End Time : Specify an end time for the event availability to fetch. (example: \"2022-01-07T24:00:00.000000Z\")" } }, "required": [ "event_type", "start_time", "end_time" ], "x-integration": "calendly" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CALENDLY_SEARCH_EVENTS": { "post": { "summary": "Search Events", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CALENDLY_SEARCH_EVENTS" }, "parameters": { "type": "object", "properties": { "searchFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "invitee_email", "organization", "status" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "searchFilterFormula" ], "x-integration": "calendly" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CALENDLY_GET_EVENT_BY_ID": { "post": { "summary": "Get Event By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CALENDLY_GET_EVENT_BY_ID" }, "parameters": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Event UUID : Specify the Event UUID of the scheduled event to fetch. (example: \"23dd4622-4dbe-42ad-bee0-1a8092e1772a\")" } }, "required": [ "uuid" ], "x-integration": "calendly" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CALENDLY_GET_EVENT_INVITEES": { "post": { "summary": "Get Event Invitees", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CALENDLY_GET_EVENT_INVITEES" }, "parameters": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Event UUID : Specify the Event UUID of the scheduled event to fetch associated invitees. (example: \"23dd4622-4dbe-42ad-bee0-1a8092e1772a\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "uuid" ], "x-integration": "calendly" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CALENDLY_CANCEL_EVENT": { "post": { "summary": "Cancel Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CALENDLY_CANCEL_EVENT" }, "parameters": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Event UUID : Specify the Event UUID of the scheduled event to cancel. (example: \"23dd4622-4dbe-42ad-bee0-1a8092e1772a\")" }, "reason": { "type": "string", "description": "Reason : Specify a reason for the cancellation of this event." } }, "required": [ "uuid" ], "x-integration": "calendly" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_SEARCH_TASKS": { "post": { "summary": "Search Tasks", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_SEARCH_TASKS" }, "parameters": { "type": "object", "properties": { "taskFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "space_ids[]", "project_ids[]", "list_ids[]", "statuses[]", "include_closed", "assignees[]", "tags[]", "due_date_gt", "due_date_lt", "date_created_gt", "date_created_lt", "date_updated_gt", "date_updated_lt", "date_created_gt" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$numberEquals", "$booleanFalse", "$booleanTrue", "$dateTimeEquals" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_GET_TASK_IN_LIST": { "post": { "summary": "Get Task In List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_GET_TASK_IN_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "Specify the list ID to perform the operation on" }, "taskFilterFormula": { "type": "string", "description": "Search for tasks that match specified filters. For example: name=task1" } }, "required": [ "listId" ], "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_CREATE_TASK": { "post": { "summary": "Create Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_CREATE_TASK" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "Specify the list ID to perform the operation on" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "status": { "type": "string", "description": "Specify the status for the task" }, "assignees": { "type": "string", "description": "Specify the members (or an array of member IDs) to be assigned to this task" }, "dueDate": { "type": "string", "description": "Due Date : Specify a date for this task to be due on." }, "priority": { "type": "string", "description": "Priority : The priority of the task.", "enum": [ "1", "2", "3", "4" ] }, "tags": { "type": "string", "description": "Tags : Comma-separated list of tag names to add to this task. (example: \"bug, feature, urgent\")" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be included on this task in JSON format. Please refer to the ClickUp API documentation (https://developer.clickup.com/reference/createtask) for the available fields. (example: \"{\n \"check_required_custom_fields\": true,\n \"custom_fields\": [\n {\n \"id\": \"03efda77-c7a0-42d3-8afd-fd546353c2f5\",\n \"value\": \"user@example.com\"\n }\n ],\n \"notify_all\": true,\n \"points\": 5,\n \"markdown_content\": \"Task description with **markdown**\",\n \"parent\": null,\n \"start_date\": 1768379560648,\n \"start_date_time\": true,\n \"due_date_time\": true,\n \"links_to\": null\n}\")", "properties": {} } }, "required": [ "listId", "name" ], "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_UPDATE_TASK": { "post": { "summary": "Update Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_UPDATE_TASK" }, "parameters": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID : The ID of the task to update." }, "listId": { "type": "string", "description": "Specify the list ID to perform the operation on" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "status": { "type": "string", "description": "Specify the status for the task" }, "assignees": { "type": "string", "description": "Specify the members (or an array of member IDs) to be assigned to this task" }, "dueDate": { "type": "string", "description": "Due Date : Specify a date for this task to be due on." }, "priority": { "type": "string", "description": "Priority : The priority of the task.", "enum": [ "1", "2", "3", "4" ] }, "tags": { "type": "string", "description": "Tags : Comma-separated list of tag names to add to this task. (example: \"bug, feature, urgent\")" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be included on this task in JSON format. Please refer to the ClickUp API documentation (https://developer.clickup.com/reference/updatetask) for the available fields. (example: \"{\n \"notify_all\": true,\n \"points\": 5,\n \"markdown_content\": \"Task description with **markdown**\",\n \"parent\": null,\n \"start_date\": 1768379560648,\n \"start_date_time\": true,\n \"due_date_time\": true,\n \"links_to\": null\n}\")", "properties": {} } }, "required": [ "taskId", "listId" ], "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_DELETE_TASK": { "post": { "summary": "Delete Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_DELETE_TASK" }, "parameters": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID : The ID of the task to delete." } }, "required": [ "taskId" ], "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_GET_LIST": { "post": { "summary": "Get List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_GET_LIST" }, "parameters": { "type": "object", "properties": { "spaceId": { "type": "string", "description": "Specify the space ID to perform the operation on" } }, "required": [ "spaceId" ], "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_GET_CUSTOM_FIELDS_IN_LIST": { "post": { "summary": "Get Custom Fields In List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_GET_CUSTOM_FIELDS_IN_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "Specify the list ID to perform the operation on" } }, "required": [ "listId" ], "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_GET_ALL_FIELDS_IN_LIST": { "post": { "summary": "Get All Fields In List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_GET_ALL_FIELDS_IN_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "Specify the list ID to perform the operation on" } }, "required": [ "listId" ], "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_GET_SPACE": { "post": { "summary": "Get Space", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_GET_SPACE" }, "parameters": { "type": "object", "properties": { "spaceId": { "type": "string", "description": "Specify the space ID to perform the operation on" } }, "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_GET_FOLDERS": { "post": { "summary": "Get Folders", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_GET_FOLDERS" }, "parameters": { "type": "object", "properties": { "spaceId": { "type": "string", "description": "Specify the space ID to perform the operation on" } }, "required": [ "spaceId" ], "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLICKUP_GET_MEMBER": { "post": { "summary": "Get Member", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLICKUP_GET_MEMBER" }, "parameters": { "type": "object", "properties": {}, "x-integration": "clickup" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_CREATE_RECORD_LEAD": { "post": { "summary": "Create Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_CREATE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : Specify the name of the lead." }, "leadDescription": { "type": "string", "description": "Description : Specify a description for this lead." }, "leadContact": { "type": "object", "description": "Contacts : Specify contact details as JSON to attach to this lead. (example: \"[\n {\n \"name\": \"Gob\",\n \"title\": \"Sr. Vice President\",\n \"emails\": [\n {\n \"type\": \"office\",\n \"email\": \"gob@example.com\"\n }\n ],\n \"phones\": [\n {\n \"type\": \"office\",\n \"phone\": \"8004445555\"\n }\n ]\n }\n]\")", "properties": {} }, "leadAddress": { "type": "object", "description": "Addresses : Specify address details as JSON to attach to this lead. (example: \"[\n {\n \"label\": \"business\",\n \"address_1\": \"747 Howard St\",\n \"address_2\": \"Room 3\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipcode\": \"94103\",\n \"country\":\"US\",\n }\n]\")", "properties": {} }, "status": { "type": "string", "description": "The status of the lead" }, "leadAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this lead as JSON. See the docs (https://developer.close.com/resources/leads/#create-a-new-lead) for available fields. (example: \"{\n \"confidence\": 90,\n \"value_period\": \"monthly\",\n \"custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj\": \"https://www.example.com/contract.pdf\"\n}\")", "properties": {} } }, "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_CREATE_RECORD_OPPORTUNITY": { "post": { "summary": "Create Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_CREATE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "leadId": { "type": "string", "description": "Lead ID : Specify the ID of the Lead this opportunity is associated with." }, "value": { "type": "string", "description": "Value : Specify a value for this opportunity. (example: \"500\")" }, "note": { "type": "string", "description": "Note : Specify a note to attach to this opportunity" }, "opportunityStatus": { "type": "string", "description": "The status of the opportunity" }, "confidence": { "type": "string", "description": "Confidence" }, "opportunityAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this opportunity as JSON. See the docs (https://developer.close.com/resources/opportunities/#list-or-filter-opportunities) for available fields. (example: \"{\n \"value_period\": \"monthly\",\n \"custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj\": \"https://www.example.com/contract.pdf\"\n}\")", "properties": {} } }, "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_CREATE_RECORD_CONTACT": { "post": { "summary": "Create Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_CREATE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "leadId": { "type": "string", "description": "Lead ID : Specify ID of the Lead this contact is associated with." }, "name": { "type": "string", "description": "Name : Specify a name for this contact." }, "title": { "type": "string", "description": "Title : Specify a title for this contact. (example: \"President\")" }, "phone": { "type": "object", "description": "Phones (example: \"[\n {\"phone\":\"9045551234\",\"type\":\"mobile\"}\n]\")", "properties": {} }, "email": { "type": "object", "description": "Emails (example: \"[\n {\"email\":\"john@example.com\",\"type\":\"office\"}\n]\")", "properties": {} }, "urls": { "type": "object", "description": "Urls (example: \"[\n {\"url\":\"http://twitter.com/google/\",\"type\":\"url\"}\n]\")", "properties": {} }, "contactAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this contact as JSON. See the docs (https://developer.close.com/resources/contacts/#create-a-new-contact) for available fields. (example: \"{\n \"custom.cf_FSYEbxYJFsnY9tN1OTAPIF33j7Sw5Lb7Eawll7JzoNh\": \"Account Executive\",\n}\")", "properties": {} } }, "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_CREATE_RECORD_TASK": { "post": { "summary": "Create Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_CREATE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "leadId": { "type": "string", "description": "Lead ID : Specify ID of the Lead this task is associated with." }, "title": { "type": "string", "description": "Title : Specify a title for this contact. (example: \"Connect with Account Manager\")" }, "assignedTo": { "type": "string", "description": "Specify the user to assign this task to" }, "date": { "type": "string", "description": "Date (example: \"2013-02-06\")" }, "isComplete": { "type": "boolean", "description": "Mark task as completed" } }, "required": [ "leadId", "title", "isComplete" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_UPDATE_RECORD_TASK": { "post": { "summary": "Update Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_UPDATE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID : Specify Id of the task to update." }, "title": { "type": "string", "description": "Title : Specify a title for this contact. (example: \"Connect with Account Manager\")" }, "assignedTo": { "type": "string", "description": "Specify the user to assign this task to" }, "date": { "type": "string", "description": "Date (example: \"2013-02-06\")" }, "isComplete": { "type": "boolean", "description": "Mark task as completed" } }, "required": [ "taskId", "title", "isComplete" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_UPDATE_RECORD_OPPORTUNITY": { "post": { "summary": "Update Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_UPDATE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "opportunityId": { "type": "string", "description": "Opportunity ID : Specify Id of opportunity to update." }, "value": { "type": "string", "description": "Value : Specify a value for this opportunity. (example: \"500\")" }, "note": { "type": "string", "description": "Note : Specify a note to attach to this opportunity" }, "opportunityStatus": { "type": "string", "description": "The status of the opportunity" }, "confidence": { "type": "string", "description": "Confidence" }, "opportunityAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this opportunity as JSON. See the docs (https://developer.close.com/resources/opportunities/#list-or-filter-opportunities) for available fields. (example: \"{\n \"value_period\": \"monthly\",\n \"custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj\": \"https://www.example.com/contract.pdf\"\n}\")", "properties": {} } }, "required": [ "opportunityId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_UPDATE_RECORD_CONTACT": { "post": { "summary": "Update Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_UPDATE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID : Specify the of Contact to update" }, "name": { "type": "string", "description": "Name : Specify a name for this contact." }, "title": { "type": "string", "description": "Title : Specify a title for this contact. (example: \"President\")" }, "phone": { "type": "object", "description": "Phones (example: \"[\n {\"phone\":\"9045551234\",\"type\":\"mobile\"}\n]\")", "properties": {} }, "email": { "type": "object", "description": "Emails (example: \"[\n {\"email\":\"john@example.com\",\"type\":\"office\"}\n]\")", "properties": {} }, "urls": { "type": "object", "description": "Urls (example: \"[\n {\"url\":\"http://twitter.com/google/\",\"type\":\"url\"}\n]\")", "properties": {} }, "contactAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this contact as JSON. See the docs (https://developer.close.com/resources/contacts/#create-a-new-contact) for available fields. (example: \"{\n \"custom.cf_FSYEbxYJFsnY9tN1OTAPIF33j7Sw5Lb7Eawll7JzoNh\": \"Account Executive\",\n}\")", "properties": {} } }, "required": [ "contactId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_UPDATE_RECORD_LEAD": { "post": { "summary": "Update Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_UPDATE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "leadId": { "type": "string", "description": "Lead ID : Specify the Id of Lead to update." }, "name": { "type": "string", "description": "Name : Specify the name of the lead." }, "leadDescription": { "type": "string", "description": "Description : Specify a description for this lead." }, "leadContact": { "type": "object", "description": "Contacts : Specify contact details as JSON to attach to this lead. (example: \"[\n {\n \"name\": \"Gob\",\n \"title\": \"Sr. Vice President\",\n \"emails\": [\n {\n \"type\": \"office\",\n \"email\": \"gob@example.com\"\n }\n ],\n \"phones\": [\n {\n \"type\": \"office\",\n \"phone\": \"8004445555\"\n }\n ]\n }\n]\")", "properties": {} }, "leadAddress": { "type": "object", "description": "Addresses : Specify address details as JSON to attach to this lead. (example: \"[\n {\n \"label\": \"business\",\n \"address_1\": \"747 Howard St\",\n \"address_2\": \"Room 3\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipcode\": \"94103\",\n \"country\":\"US\",\n }\n]\")", "properties": {} }, "status": { "type": "string", "description": "The status of the lead" }, "leadAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this lead as JSON. See the docs (https://developer.close.com/resources/leads/#create-a-new-lead) for available fields. (example: \"{\n \"confidence\": 90,\n \"value_period\": \"monthly\",\n \"custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj\": \"https://www.example.com/contract.pdf\"\n}\")", "properties": {} } }, "required": [ "leadId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_GET_RECORD_BY_ID_LEAD": { "post": { "summary": "Get Record By ID Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_GET_RECORD_BY_ID_LEAD" }, "parameters": { "type": "object", "properties": { "leadId": { "type": "string", "description": "Lead ID : Specify the ID of lead to fetch" } }, "required": [ "leadId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_GET_RECORD_BY_ID_OPPORTUNITY": { "post": { "summary": "Get Record By ID Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_GET_RECORD_BY_ID_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "opportunityId": { "type": "string", "description": "Opportunity ID : Specify the ID of opportunity to fetch" } }, "required": [ "opportunityId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_GET_RECORD_BY_ID_CONTACT": { "post": { "summary": "Get Record By ID Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_GET_RECORD_BY_ID_CONTACT" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID : Specify the ID of contact to fetch" } }, "required": [ "contactId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_GET_RECORD_BY_ID_TASK": { "post": { "summary": "Get Record By ID Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_GET_RECORD_BY_ID_TASK" }, "parameters": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID : Specify the ID of task to fetch" } }, "required": [ "taskId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_SEARCH_RECORD_LEAD": { "post": { "summary": "Search Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_SEARCH_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_SEARCH_RECORD_OPPORTUNITY": { "post": { "summary": "Search Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_SEARCH_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "opportunityFilterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "_type", "lead_id", "user_id", "value_period", "status_label" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_SEARCH_RECORD_CONTACT": { "post": { "summary": "Search Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_SEARCH_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_SEARCH_RECORD_TASK": { "post": { "summary": "Search Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_SEARCH_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "taskFilterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "_type", "lead_id", "membership_id", "assigned_to", "view" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_DELETE_RECORD_LEAD": { "post": { "summary": "Delete Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_DELETE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "leadId": { "type": "string", "description": "Lead ID : Specify the ID of lead to delete" } }, "required": [ "leadId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_DELETE_RECORD_OPPORTUNITY": { "post": { "summary": "Delete Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_DELETE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "opportunityId": { "type": "string", "description": "Opportunity ID : Specify the ID of opportunity to delete" } }, "required": [ "opportunityId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_DELETE_RECORD_CONTACT": { "post": { "summary": "Delete Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_DELETE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID : Specify the ID of contact to delete" } }, "required": [ "contactId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_DELETE_RECORD_TASK": { "post": { "summary": "Delete Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_DELETE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Task ID : Specify the ID of task to delete" } }, "required": [ "taskId" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_ADVANCED_FILTERING": { "post": { "summary": "Advanced Filtering", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_ADVANCED_FILTERING" }, "parameters": { "type": "object", "properties": { "jsonFilter": { "type": "object", "description": "Json Filter : Write a query using the Close CRM Advanced Filtering specification. See the close docs (https://developer.close.com/resources/advanced-filtering/) for more details. (example: \"{\n \"query\":{ \n \"queries\": [\n {\n \"object_type\": \"contact\",\n \"type\": \"object_type\"\n },\n {\n \"type\": \"field_condition\",\n \"field\": {\n \"object_type\": \"contact\",\n \"type\": \"regular_field\",\n \"field_name\": \"title\"\n },\n \"condition\": {\n \"type\": \"text\",\n \"mode\": \"full_words\",\n \"value\": \"CEO\"\n }\n }\n ],\n \"type\": \"and\",\n },\n \"_fields\": {\n \"contact\": [\"id\", \"name\", \"title\"]\n }\n}\")", "properties": {} }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "jsonFilter" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CLOSE_GET_CUSTOM_FIELDS": { "post": { "summary": "Get Custom Fields", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CLOSE_GET_CUSTOM_FIELDS" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "recordType" ], "x-integration": "close" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CODA_CREATE_DOCUMENT": { "post": { "summary": "Create Document", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CODA_CREATE_DOCUMENT" }, "parameters": { "type": "object", "properties": { "title": { "type": "string", "description": "Title : Title of the new doc. Defaults to \"Untitled\" (example: \"Project Tracker\")" }, "sourceDoc": { "type": "string", "description": "Source Doc : An optional doc ID from which to create a copy (example: \"iJKlm_noPq\")" }, "folderId": { "type": "string", "description": "Folder ID : The ID of the folder within which to create this doc. Defaults to your My docs (example: \"fl-ABcdEFgHJi\")" } }, "x-integration": "coda" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CODA_SEARCH_DOCUMENTS": { "post": { "summary": "Search Documents", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CODA_SEARCH_DOCUMENTS" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "isOwner", "isPublished", "query", "sourceDoc", "isStarred", "inGallery", "workspaceId", "workspaceId" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$numberEquals", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "coda" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CODA_GET_DOCUMENT_BY_ID": { "post": { "summary": "Get Document By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CODA_GET_DOCUMENT_BY_ID" }, "parameters": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Document ID : ID of the Doc (example: \"AbCDeFGH\")" } }, "required": [ "documentId" ], "x-integration": "coda" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CODA_DELETE_DOCUMENT": { "post": { "summary": "Delete Document", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CODA_DELETE_DOCUMENT" }, "parameters": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Document ID : ID of the Doc (example: \"AbCDeFGH\")" } }, "required": [ "documentId" ], "x-integration": "coda" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CODA_SEARCH_TABLES_V2": { "post": { "summary": "Search Tables", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CODA_SEARCH_TABLES_V2" }, "parameters": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Document ID : ID of the Doc (example: \"AbCDeFGH\")" }, "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "sortBy", "tableTypes" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$numberEquals", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "documentId" ], "x-integration": "coda" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CODA_GET_TABLE_BY_ID": { "post": { "summary": "Get Table By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CODA_GET_TABLE_BY_ID" }, "parameters": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Document ID : ID of the Doc (example: \"AbCDeFGH\")" }, "tableId": { "type": "string", "description": "Table ID : ID or name of the table (example: \"grid-pqRst-U\")" } }, "required": [ "documentId", "tableId" ], "x-integration": "coda" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_CREATE_PAGE": { "post": { "summary": "Create Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_CREATE_PAGE" }, "parameters": { "type": "object", "properties": { "spaceId": { "type": "string", "description": "Space ID : ID of the space (example: \"65539\")" }, "status": { "type": "string", "description": "Status : The status of the page", "enum": [ "current", "draft" ] }, "title": { "type": "string", "description": "Title : Title of the page, required if page status is not draft (example: \"Page Title\")" }, "parentId": { "type": "string", "description": "Parent ID : The parent content ID of the page (example: \"131154\")" }, "additionalBody": { "type": "object", "description": "Body : Additional Body with a format of either PageBodyWrite (https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-put:~:text=REQUIRED-,PageBodyWrite,-Show%20child%20properties) or PageNestedBodyWrite (https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-put:~:text=Show%20child%20properties-,PageNestedBodyWrite,-Show%20child%20properties) (example: \"{\n \"storage\": {\n \"representation\": \"storage\",\n \"value\": \"\"\n },\n \"atlas_doc_format\": {\n \"representation\": \"storage\",\n \"value\": \"\"\n },\n \"wiki\": {\n \"representation\": \"storage\",\n \"value\": \"\"\n }\n}\")", "properties": {} } }, "required": [ "spaceId" ], "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_UPDATE_PAGE": { "post": { "summary": "Update Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_UPDATE_PAGE" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : ID of the page (example: \"3145729\")" }, "spaceId": { "type": "string", "description": "Space ID : ID of the space (example: \"65539\")" }, "status": { "type": "string", "description": "Status : The current status of the page", "enum": [ "current", "draft", "archived", "deleted" ] }, "title": { "type": "string", "description": "Title : Title of the page, required if page status is not draft (example: \"Page Title\")" }, "version": { "type": "object", "description": "Version : Version number and message to be stored with updated page (example: \"{\n \"number\":47,\n \"message\":\"\"\n}\")", "properties": {} }, "additionalBody": { "type": "object", "description": "Body : Additional Body with a format of either PageBodyWrite (https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-put:~:text=REQUIRED-,PageBodyWrite,-Show%20child%20properties) or PageNestedBodyWrite (https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-put:~:text=Show%20child%20properties-,PageNestedBodyWrite,-Show%20child%20properties) (example: \"{\n \"storage\": {\n \"representation\": \"storage\",\n \"value\": \"\"\n },\n \"atlas_doc_format\": {\n \"representation\": \"storage\",\n \"value\": \"\"\n },\n \"wiki\": {\n \"representation\": \"storage\",\n \"value\": \"\"\n }\n}\")", "properties": {} } }, "required": [ "pageId", "spaceId", "status", "title", "version", "additionalBody" ], "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_GET_PAGE_BY_ID": { "post": { "summary": "Get Page By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_GET_PAGE_BY_ID" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : ID of the page (example: \"3145729\")" }, "bodyFormat": { "type": "string", "description": "Body Format : The content format types to be returned in the body field of the response", "enum": [ "storage", "atlas_doc_format" ] }, "getDraft": { "type": "boolean", "description": "Get Draft : Retrieve the draft version of this page. Defaults to false" }, "versionNumber": { "type": "string", "description": "Version Number : Allows you to retrieve a previously published version. Specify the previous version`s number to retrieve its details (example: \"2\")" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. For example, you may want to provide a labels here. See the docs (https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get-request-Query%20parameters) for available fields. (example: \"{\n \"include-labels\": true\n}\")", "properties": {} } }, "required": [ "pageId" ], "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_GET_PAGES_IN_SPACE": { "post": { "summary": "Get Pages In Space", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_GET_PAGES_IN_SPACE" }, "parameters": { "type": "object", "properties": { "spaceId": { "type": "string", "description": "Space ID : ID of the space (example: \"65539\")" }, "status": { "type": "string", "description": "Status : The status of the page", "enum": [ "current", "archived", "trashed" ] }, "bodyFormat": { "type": "string", "description": "Body Format : The content format types to be returned in the body field of the response", "enum": [ "storage", "atlas_doc_format" ] }, "limit": { "type": "string", "description": "Limit : Maximum number of records to return in the result. Defaults to no limit. (example: \"No limit\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "spaceId" ], "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_GET_PAGES_BY_LABEL": { "post": { "summary": "Get Pages By Label", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_GET_PAGES_BY_LABEL" }, "parameters": { "type": "object", "properties": { "labelId": { "type": "string", "description": "Label ID : The ID of the label for which pages should be returned (example: \"3178497\")" }, "bodyFormat": { "type": "string", "description": "Body Format : The content format types to be returned in the body field of the response", "enum": [ "storage", "atlas_doc_format" ] }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. For example, you may want to provide a sort order here. See the docs (https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-labels-id-pages-get) for available fields. (example: \"{\n \"sort\":\"id\"\n}\")", "properties": {} }, "limit": { "type": "string", "description": "Limit : Maximum number of records to return in the result. Defaults to no limit. (example: \"No limit\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "labelId" ], "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_SEARCH_PAGES": { "post": { "summary": "Search Pages", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_SEARCH_PAGES" }, "parameters": { "type": "object", "properties": { "limit": { "type": "string", "description": "Limit : Maximum number of records to return in the result. Defaults to no limit. (example: \"No limit\")" }, "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "status", "body-format" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_DELETE_PAGE": { "post": { "summary": "Delete Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_DELETE_PAGE" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : The ID of the page to be deleted (example: \"3145729\")" } }, "required": [ "pageId" ], "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_GET_SPACE_BY_ID": { "post": { "summary": "Get Space By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_GET_SPACE_BY_ID" }, "parameters": { "type": "object", "properties": { "spaceId": { "type": "string", "description": "Space ID : ID of the space (example: \"65539\")" }, "descriptionFormat": { "type": "string", "description": "Description Format : The content format type to be returned in the description field of the response", "enum": [ "plain", "view" ] } }, "required": [ "spaceId" ], "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_SEARCH_SPACES": { "post": { "summary": "Search Spaces", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_SEARCH_SPACES" }, "parameters": { "type": "object", "properties": { "limit": { "type": "string", "description": "Limit : Maximum number of records to return in the result. Defaults to no limit. (example: \"No limit\")" }, "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "ids", "keys", "type", "status", "labels", "sort", "description-format" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#CONFLUENCE_GET_BLOG_POSTS": { "post": { "summary": "Get Blog Posts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "CONFLUENCE_GET_BLOG_POSTS" }, "parameters": { "type": "object", "properties": { "limit": { "type": "string", "description": "Limit : Maximum number of blog posts per result to return (example: \"No limit\")" }, "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "space-id", "sort", "status", "title", "body-format", "cursor" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "confluence" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DOCUSIGN_CREATE_AN_ENVELOPE": { "post": { "summary": "Create An Envelope", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DOCUSIGN_CREATE_AN_ENVELOPE" }, "parameters": { "type": "object", "properties": { "status": { "type": "string", "description": "Status", "enum": [ "created", "sent" ] }, "emailSubject": { "type": "string", "description": "Email Subject" }, "documents": { "type": "object", "description": "Documents (example: \"[\n {\n \"documentBase64\": \"JVBERi0xLjcKCjQgMCBvYmoKPDw...\",\n \"documentId\": \"1\",\n \"fileExtension\": \"PDF\",\n \"name\": \"TXU.pdf\"\n }\n]\"). Required this field for status value is sent otherwise optional", "properties": {} }, "recipients": { "type": "object", "description": "Recipients (example: \"{\n \"signers\": [\n {\n \"email\": \"test@test.com\",\n \"name\": \"Jesse\",\n \"recipientId\": 56011693\n }\n ]\n}\"). Required this field for status value is sent otherwise optional", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be needed in the envelope item as JSON. (example: \"{\n \"allowRecipientRecursion\": \"string\",\n \"templateId\": \"string\",\n \"password\": \"string\"\n}\")", "properties": {} } }, "required": [ "status" ], "x-integration": "docusign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DOCUSIGN_UPDATE_ENVELOPE": { "post": { "summary": "Update Envelope", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DOCUSIGN_UPDATE_ENVELOPE" }, "parameters": { "type": "object", "properties": { "envelopeId": { "type": "string", "description": "Envelope ID (example: \"93be49ab-xxxx-xxxx-xxxx-f752070d71ec\")" }, "status": { "type": "string", "description": "Status", "enum": [ "created", "sent" ] }, "emailBlurb": { "type": "string", "description": "Email Blurb" }, "emailSubject": { "type": "string", "description": "Email Subject" }, "documents": { "type": "object", "description": "Documents (example: \"[\n {\n \"documentBase64\": \"JVBERi0xLjcKCjQgMCBvYmoKPDw...\",\n \"documentId\": \"1\",\n \"fileExtension\": \"PDF\",\n \"name\": \"TXU.pdf\"\n }\n]\"). Required this field for status value is sent otherwise optional", "properties": {} }, "recipients": { "type": "object", "description": "Recipients (example: \"{\n \"signers\": [\n {\n \"email\": \"test@test.com\",\n \"name\": \"Jesse\",\n \"recipientId\": 56011693\n }\n ]\n}\"). Required this field for status value is sent otherwise optional", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be needed in the envelope item as JSON. (example: \"{\n \"allowRecipientRecursion\": \"string\",\n \"templateId\": \"string\",\n \"password\": \"string\"\n}\")", "properties": {} } }, "required": [ "envelopeId" ], "x-integration": "docusign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DOCUSIGN_GET_ENVELOPE_BY_ID": { "post": { "summary": "Get Envelope By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DOCUSIGN_GET_ENVELOPE_BY_ID" }, "parameters": { "type": "object", "properties": { "envelopeId": { "type": "string", "description": "Envelope ID (example: \"93be49ab-xxxx-xxxx-xxxx-f752070d71ec\")" } }, "required": [ "envelopeId" ], "x-integration": "docusign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DOCUSIGN_SEND_AN_ENVELOPE": { "post": { "summary": "Send An Envelope", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DOCUSIGN_SEND_AN_ENVELOPE" }, "parameters": { "type": "object", "properties": { "envelopeId": { "type": "string", "description": "Envelope ID (example: \"93be49ab-xxxx-xxxx-xxxx-f752070d71ec\")" } }, "required": [ "envelopeId" ], "x-integration": "docusign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DOCUSIGN_SEARCH_ENVELOPES": { "post": { "summary": "Search Envelopes", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DOCUSIGN_SEARCH_ENVELOPES" }, "parameters": { "type": "object", "properties": { "envelopeFilterSearch": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "user_id", "search_text", "from_date", "to_date", "envelope_ids", "transaction_ids", "status", "ac_status" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "count": { "type": "number", "description": "Count to fetch records default is 100" }, "start_position": { "type": "number", "description": "Start Position to fetch records default is 0" } } } }, "x-integration": "docusign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DOCUSIGN_ENVELOPE_CUSTOM_FIELD": { "post": { "summary": "Envelope Custom Field", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DOCUSIGN_ENVELOPE_CUSTOM_FIELD" }, "parameters": { "type": "object", "properties": { "envelopeId": { "type": "string", "description": "Envelope ID (example: \"93be49ab-xxxx-xxxx-xxxx-f752070d71ec\")" }, "envelopeCustomFieldOperation": { "type": "string", "description": "Operation : To perform execution based on Operation.", "enum": [ "get", "post", "put", "delete" ] }, "listCustomFields": { "type": "object", "description": "List Custom Fields (example: \"[\n {\n \"listItems\": [\n \"string\"\n ],\n \"fieldId\": \"string\",\n \"name\": \"string\"\n }\n]\")", "properties": {} }, "textCustomFields": { "type": "object", "description": "Text Custom Fields (example: \"[\n {\n \"fieldId\": \"string\",\n \"name\": \"string\",\n \"show\": \"boolean\"\n }\n]\")", "properties": {} } }, "required": [ "envelopeId", "envelopeCustomFieldOperation" ], "x-integration": "docusign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_SAVE_FILE": { "post": { "summary": "Save File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_SAVE_FILE" }, "parameters": { "type": "object", "properties": { "file": { "type": "object", "description": "File to save to Dropbox. (example: {\n \"data\": \"48656c6c6f2c20776f726c6421\",\n \"dataType\": \"FILE\",\n \"mimeType\": \"text/plain\"\n})", "properties": {} }, "folder": { "type": "string", "description": "Folder : Use Connect Portal User Settings to allow users to select which Folder to retrieve files from. Defaults to the user's root folder if unspecified. (example: \"/my_folder/my_subfolder\")" }, "fileName": { "type": "string", "description": "File Name : Defaults to origin file name if unspecified. If origin file name is not available, it will be \"uploadedFile\" with the file extension extracted from the file mime type. (example: \"file.pdf\")" } }, "required": [ "file" ], "x-integration": "dropbox" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_LIST_FILES": { "post": { "summary": "List Files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_LIST_FILES" }, "parameters": { "type": "object", "properties": { "folder": { "type": "string", "description": "Specify which Folder to retrieve files from. Defaults to the user’s root folder if not provided." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" }, "limit": { "type": "number", "description": "Limit (default 100)" } } } }, "x-integration": "dropbox" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_SEARCH_FOLDERS": { "post": { "summary": "Search Folders", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_SEARCH_FOLDERS" }, "parameters": { "type": "object", "properties": { "folderName": { "type": "string", "description": "Folder Name : Specify a string to search for. (example: \"testfolder\")" }, "match_field_options": { "type": "boolean", "description": "Match Field Options : Field options to match with" }, "code": { "type": "object", "description": "Options : Options for additional fields (example: \"{\n file_status: 'active',\n filename_only: false,\n max_results: 20,\n path: '/Folder'\n}\")", "properties": {} }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" }, "limit": { "type": "number", "description": "Limit (default 100)" } } } }, "required": [ "folderName" ], "x-integration": "dropbox" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_CREATE_FOLDER": { "post": { "summary": "Create Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_CREATE_FOLDER" }, "parameters": { "type": "object", "properties": { "path": { "type": "string", "description": "Path : Specify a Path in the users’ Dropbox to create. (example: \"/home/test\")" }, "autoRename": { "type": "boolean", "description": "Auto Rename : The default for this field is False." } }, "required": [ "path" ], "x-integration": "dropbox" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_MOVE_FOLDER": { "post": { "summary": "Move Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_MOVE_FOLDER" }, "parameters": { "type": "object", "properties": { "fromPath": { "type": "string", "description": "From Path : Path in the users’ Dropbox to be copied or moved. (example: \"/home/test\")" }, "toPath": { "type": "string", "description": "To Path : Path in the users’ Dropbox that is the destination. (example: \"/home/test\")" }, "allowOwnershipTransfer": { "type": "boolean", "description": "Allow Ownership Transfer : The default for this field is False." }, "autoRename": { "type": "boolean", "description": "Auto Rename : The default for this field is False." } }, "required": [ "fromPath", "toPath" ], "x-integration": "dropbox" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_GET_FOLDER_BY_ID": { "post": { "summary": "Get Folder By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_GET_FOLDER_BY_ID" }, "parameters": { "type": "object", "properties": { "path": { "type": "string", "description": "Path : Specify the ID/path of the Folder to Retrieve. (example: \"/home/test\")" }, "includeDeleted": { "type": "boolean", "description": "Include Deleted : The default for this field is False." }, "includeHasExplicitSharedMembers": { "type": "boolean", "description": "Include Has Explicit Shared Members : The default for this field is False." }, "includeMediaInfo": { "type": "boolean", "description": "Include Media Info : The default for this field is False." } }, "required": [ "path" ], "x-integration": "dropbox" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_DELETE_FOLDER": { "post": { "summary": "Delete Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_DELETE_FOLDER" }, "parameters": { "type": "object", "properties": { "path": { "type": "string", "description": "Path : Path in the users’ Dropbox to Delete. (example: \"/home/test\")" } }, "required": [ "path" ], "x-integration": "dropbox" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_DOWNLOAD_FILE": { "post": { "summary": "Download File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_DOWNLOAD_FILE" }, "parameters": { "type": "object", "properties": { "fileName": { "type": "string", "description": "Specify the file name to download. (example: \"document.pdf\")" } }, "required": [ "fileName" ], "x-integration": "dropbox" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "201": { "description": "**Response with File URL**", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "A temporary signed download URL from the Dropbox API. Send a request to this URL from your request client or provide the URL to an LLM provider to download or use the file contents." } } } } } } } } }, "/projects/{project_id}/tools/#DROPBOX_SIGN_CREATE_AND_SEND_SIGNATURE_REQUEST": { "post": { "summary": "Create And Send Signature Request", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_SIGN_CREATE_AND_SEND_SIGNATURE_REQUEST" }, "parameters": { "type": "object", "properties": { "fileUrls": { "type": "string", "description": "File URLs : Specify File URLs to have Dropbox Sign download the file(s) to send for signature. (example: \"[\"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\"]\")" }, "signers": { "type": "object", "description": "Signers : Add Signers to your Signature Request. (example: \"[{\n email_address: \"jack@example.com\",\n name: \"Jack\",\n order: 0\n}]\")", "properties": {} }, "title": { "type": "string", "description": "Title : Specify the title you want to assign to the SignatureRequest." }, "subject": { "type": "string", "description": "Subject : Specify the subject in the email that will be sent to the signers." }, "message": { "type": "string", "description": "Message : Specify the custom message in the email that will be sent to the signers." }, "ccEmails": { "type": "string", "description": "CC Email Addresses : Specify the email addresses that should be CCed." }, "attachments": { "type": "object", "description": "Attachments : A list describing the attachments. (example: \"[{\n name: \"Jack Doe File\",\n signer_index: 0\n}]\")", "properties": {} }, "signingOptions": { "type": "object", "description": "Signing Options : This allows the requester to specify the types allowed for creating a signature. The allowed types will default to those specified in the account settings (example: \"{\n draw: true,\n type: true,\n default_type: \"draw\"\n}\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional query parameters that should be needed in the signature request as JSON. Refer to the see the docs (https://developers.hellosign.com/api/reference/operation/signatureRequestSend) for more. (example: \"{\n hide_text_tags: true, \n allow_decline: true,\n expires_at: 1672396800\n}\")", "properties": {} } }, "required": [ "fileUrls", "signers" ], "x-integration": "dropboxsign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_SIGN_UPDATE_SIGNATURE_REQUEST": { "post": { "summary": "Update Signature Request", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_SIGN_UPDATE_SIGNATURE_REQUEST" }, "parameters": { "type": "object", "properties": { "signatureRequestId": { "type": "string", "description": "Signature Request ID : Specify the Signature Request ID of the request to update signature request. (example: \"fa5c8a0b0f492d768749333ad6fcc214c111e967\")" }, "signatureId": { "type": "string", "description": "Signature ID : Specify the Signature ID for the recipient. (example: \"78caf2a1d01cd39cea2bc1cbb340dac3\")" }, "email": { "type": "string", "description": "Email : Specify the new email address for the recipient. Optional if Name is provided. (example: \"john@example.com\")" }, "name": { "type": "string", "description": "Name : Specify the new name for the recipient. Optional if Email is provided. (example: \"John Doe\")" }, "expireAt": { "type": "string", "description": "Expire At : The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See Signature Request Expiration Date (https://developers.hellosign.com/docs/signature-request/expiration/) for details. (example: \"1685435660\")" } }, "required": [ "signatureRequestId", "signatureId" ], "x-integration": "dropboxsign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_SIGN_GET_SIGNATURE_REQUEST_BY_ID": { "post": { "summary": "Get Signature Request By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_SIGN_GET_SIGNATURE_REQUEST_BY_ID" }, "parameters": { "type": "object", "properties": { "signatureRequestId": { "type": "string", "description": "Signature Request ID : Specify the Signature Request ID of the request to get it. (example: \"fa5c8a0b0f492d768749333ad6fcc214c111e967\")" } }, "required": [ "signatureRequestId" ], "x-integration": "dropboxsign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_SIGN_SEARCH_SIGNATURE_REQUESTS": { "post": { "summary": "Search Signature Requests", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_SIGN_SEARCH_SIGNATURE_REQUESTS" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : Specify Account ID to return SignatureRequests for. Must be a team member. Use all to indicate all team members. Defaults to your account. (example: \"d57de93d53f840a144fd316faa294c8f66b3ffae\")" }, "query": { "type": "string", "description": "Query : Specify the query that includes search terms and/or fields to be used to filter the SignatureRequest objects. (example: \"John\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Page Size(default 20, recommended < 50, maximum 100)" }, "pageNo": { "type": "number", "description": "Page Number(Default 1)" } } } }, "x-integration": "dropboxsign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_SIGN_CANCEL_INCOMPLETE_SIGNATURE_REQUEST": { "post": { "summary": "Cancel Incomplete Signature Request", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_SIGN_CANCEL_INCOMPLETE_SIGNATURE_REQUEST" }, "parameters": { "type": "object", "properties": { "signatureRequestId": { "type": "string", "description": "Signature Request ID : Specify the Signature Request ID of the request to cancel incomplete signature request. (example: \"fa5c8a0b0f492d768749333ad6fcc214c111e967\")" } }, "required": [ "signatureRequestId" ], "x-integration": "dropboxsign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DROPBOX_SIGN_DOWNLOAD_FILES": { "post": { "summary": "Download Files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DROPBOX_SIGN_DOWNLOAD_FILES" }, "parameters": { "type": "object", "properties": { "signatureRequestId": { "type": "string", "description": "Signature Request ID : Specify the Signature Request ID of the request to download its files. (example: \"fa5c8a0b0f492d768749333ad6fcc214c111e967\")" }, "fileType": { "type": "string", "description": "The File type for Download file.", "enum": [ "pdf" ] } }, "required": [ "signatureRequestId" ], "x-integration": "dropboxsign" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "201": { "description": "**Response with File URL**", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "A temporary signed download URL from the Dropbox Sign API. Send a request to this URL from your request client or provide the URL to an LLM provider to download or use the file contents." } } } } } } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_ACCOUNTS": { "post": { "summary": "Get Accounts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_ACCOUNTS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_VENDOR": { "post": { "summary": "Create Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_CREATE_VENDOR" }, "parameters": { "type": "object", "properties": { "VendorAccountNumber": { "type": "string", "description": "Vendor Account : Specify a unique identifier for the Vendor Account." }, "VendorName": { "type": "string", "description": "Name : Specify the display name of the Vendor." }, "VendorGroupId": { "type": "string", "description": "Group : Specify the Vendor Group for the new vendor." }, "OrganizationNumber": { "type": "string", "description": "Organization Number" }, "VendorPartyType": { "type": "string", "description": "Type : Specify the type of vendor.", "enum": [ "Organization", "Person" ] }, "vendorAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this vendor as JSON. For example, you may specify a different billing address here. See the metadata for available fields. (example: \"[\n {\n \"AddressCity\": \"Seattle\",\n \"AddressZipCode\": \"98104\",\n },\n ]\")", "properties": {} } }, "required": [ "VendorAccountNumber", "VendorName", "VendorGroupId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_VENDOR": { "post": { "summary": "Update Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_UPDATE_VENDOR" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : Specify the VendorAccountNumber of the Vendor to update." }, "VendorName": { "type": "string", "description": "Name : Specify the display name of the Vendor." }, "VendorGroupId": { "type": "string", "description": "Group : Specify the Vendor Group for the new vendor." }, "OrganizationNumber": { "type": "string", "description": "Organization Number" }, "VendorPartyType": { "type": "string", "description": "Type : Specify the type of vendor.", "enum": [ "Organization", "Person" ] }, "vendorAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this vendor as JSON. For example, you may specify a different billing address here. See the metadata for available fields. (example: \"[\n {\n \"AddressCity\": \"Seattle\",\n \"AddressZipCode\": \"98104\",\n },\n ]\")", "properties": {} } }, "required": [ "vendorId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_VENDOR_BY_ID": { "post": { "summary": "Get Vendor By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_VENDOR_BY_ID" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : Specify the VendorAccountNumber of the Vendor to Search." } }, "required": [ "vendorId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_VENDORS": { "post": { "summary": "Search Vendors", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_SEARCH_VENDORS" }, "parameters": { "type": "object", "properties": { "vendorFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "VendorAccountNumber", "VendorName", "VendorGroupId", "OrganizationNumber", "PrimaryEmailAddress" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_BILL": { "post": { "summary": "Create Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_CREATE_BILL" }, "parameters": { "type": "object", "properties": { "dataAreaId": { "type": "string", "description": "Company : Specify the company code of the company incurring the bill. (example: \"dat\")" }, "InvoiceAccount": { "type": "string", "description": "Invoice Account : Specify the vendor account sending the bill." }, "InvoiceNumber": { "type": "string", "description": "Invoice Number : Specify an internal invoice identification number. (example: \"001\")" }, "InvoiceDescription": { "type": "string", "description": "Invoice Description" }, "InvoiceDate": { "type": "string", "description": "Invoice Date (example: \"2022-01-01\")" }, "Date": { "type": "string", "description": "Posting Date (example: \"2022-01-01\")" }, "DueDate": { "type": "string", "description": "Due Date (example: \"2022-01-01\")" }, "IsOnHold": { "type": "string", "description": "Invoice On Hold Status", "enum": [ "Yes", "No" ] }, "billAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this bill as JSON. For example, you may specify a cash discount date here. See the metadata for available fields. (example: \"[\n {\n \"CashDiscountDate\": \"2022-10-01\",\n \"PrimaryContactTwitter\": \"iamjohn@twitter\"\n },\n ]\")", "properties": {} } }, "required": [ "dataAreaId", "InvoiceAccount", "InvoiceNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_BILL": { "post": { "summary": "Update Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_UPDATE_BILL" }, "parameters": { "type": "object", "properties": { "billId": { "type": "string", "description": "Bill Header Reference : Specify the bill header reference of the bill to update. (example: \"DAT-000055\")" }, "InvoiceAccount": { "type": "string", "description": "Invoice Account : Specify the vendor account sending the bill." }, "InvoiceNumber": { "type": "string", "description": "Invoice Number : Specify an internal invoice identification number. (example: \"001\")" }, "InvoiceDescription": { "type": "string", "description": "Invoice Description" }, "InvoiceDate": { "type": "string", "description": "Invoice Date (example: \"2022-01-01\")" }, "Date": { "type": "string", "description": "Posting Date (example: \"2022-01-01\")" }, "DueDate": { "type": "string", "description": "Due Date (example: \"2022-01-01\")" }, "IsOnHold": { "type": "string", "description": "Invoice On Hold Status", "enum": [ "Yes", "No" ] }, "billAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this bill as JSON. For example, you may specify a cash discount date here. See the metadata for available fields. (example: \"[\n {\n \"CashDiscountDate\": \"2022-10-01\",\n \"PrimaryContactTwitter\": \"iamjohn@twitter\"\n },\n ]\")", "properties": {} } }, "required": [ "billId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_BILL_BY_ID": { "post": { "summary": "Get Bill By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_BILL_BY_ID" }, "parameters": { "type": "object", "properties": { "billId": { "type": "string", "description": "Bill Header Reference : Specify the bill header reference of the Bill to fetch. (example: \"DAT-000055\")" } }, "required": [ "billId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_BILL": { "post": { "summary": "Delete Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_DELETE_BILL" }, "parameters": { "type": "object", "properties": { "billId": { "type": "string", "description": "Bill Header Reference : Specify the bill header reference of the Bill to delete. (example: \"DAT-000055\")" } }, "required": [ "billId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_BILLS": { "post": { "summary": "Search Bills", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_SEARCH_BILLS" }, "parameters": { "type": "object", "properties": { "billFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "InvoiceAccount", "InvoiceNumber", "InvoiceDate", "Date", "DueDate", "IsOnHold" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanFalse", "$booleanTrue" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_BILL_LINE_ITEM": { "post": { "summary": "Create Bill Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_CREATE_BILL_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "HeaderReference": { "type": "string", "description": "Parent Bill Header Reference : Specify the Header Reference of the Parent Bill. (example: \"DAT-000052\")" }, "ItemNumber": { "type": "string", "description": "Item Number" }, "ProcurementCategoryName": { "type": "string", "description": "Procurement Category (example: \"CORP PROCUREMENT CATEGORIES\")" }, "ReceiveNow": { "type": "string", "description": "Quantity (example: \"1\")" }, "Unit": { "type": "string", "description": "Unit" } }, "required": [ "HeaderReference", "ItemNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_BILL_LINE_ITEM": { "post": { "summary": "Update Bill Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_UPDATE_BILL_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "HeaderReference": { "type": "string", "description": "Parent Bill Header Reference : Specify the Header Reference of the Parent Bill. (example: \"DAT-000052\")" }, "InvoiceLineNumber": { "type": "string", "description": "Invoice Line Number : Specify the record ID of the Bill Line Item to update. (example: \"2\")" }, "ProcurementCategoryName": { "type": "string", "description": "Procurement Category (example: \"CORP PROCUREMENT CATEGORIES\")" }, "ReceiveNow": { "type": "string", "description": "Quantity (example: \"1\")" }, "Unit": { "type": "string", "description": "Unit" } }, "required": [ "HeaderReference", "InvoiceLineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_BILL_LINE_ITEM_BY_ID": { "post": { "summary": "Get Bill Line Item By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_BILL_LINE_ITEM_BY_ID" }, "parameters": { "type": "object", "properties": { "HeaderReference": { "type": "string", "description": "Parent Bill Header Reference : Specify the Header Reference of the Parent Bill. (example: \"DAT-000052\")" }, "InvoiceLineNumber": { "type": "string", "description": "Invoice Line Number : Specify the invoice line number of the Bill Line Item to fetch. (example: \"2\")" } }, "required": [ "HeaderReference", "InvoiceLineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_BILL_LINE_ITEMS": { "post": { "summary": "Search Bill Line Items", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_SEARCH_BILL_LINE_ITEMS" }, "parameters": { "type": "object", "properties": { "billLineItemFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "ItemNumber", "ItemName", "ProcurementCategoryName", "UnitPrice", "HeaderReference" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberEquals", "$numberDoesNotEqual", "$numberGreaterThan", "$numberLessThan" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_BILL_LINE_ITEM": { "post": { "summary": "Delete Bill Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_DELETE_BILL_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "HeaderReference": { "type": "string", "description": "Parent Bill Header Reference : Specify the record ID of the parent Bill of the Bill Line Item to delete. (example: \"DAT-000052\")" }, "InvoiceLineNumber": { "type": "string", "description": "Invoice Line Number : Specify the invoice line number of the Bill Line Item to delete. (example: \"2\")" } }, "required": [ "HeaderReference", "InvoiceLineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_CUSTOMER": { "post": { "summary": "Create Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_CREATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "CustomerAccount": { "type": "string", "description": "Customer Account : Specify a unique identifier for the Customer Account." }, "Name": { "type": "string", "description": "Name" }, "CustomerGroupId": { "type": "string", "description": "Customer Group : Specify the Customer Group for the new customer." }, "OrganizationNumber": { "type": "string", "description": "Organization Number" }, "PartyType": { "type": "string", "description": "Type : Specify the type of customer.", "enum": [ "Organization", "Person" ] }, "SalesCurrencyCode": { "type": "string", "description": "Currency : The three-letter currency code associated with this customer." }, "PartyCountry": { "type": "string", "description": "Country" }, "AddressStreet": { "type": "string", "description": "Street Address" }, "AddressCity": { "type": "string", "description": "City" }, "AddressZipCode": { "type": "string", "description": "Zip Code" }, "PrimaryContactPhone": { "type": "string", "description": "Phone Number" }, "PrimaryContactEmail": { "type": "string", "description": "Email Address" }, "customerAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this customer as JSON. For example, you may specify a different billing address here. See the metadata for available fields. (example: \"[\n {\n \"InvoiceAddressCity\": \"N.Y\",\n \"PrimaryContactTwitter\": \"iamjohn@twitter\"\n },\n ]\")", "properties": {} } }, "required": [ "CustomerAccount", "Name", "CustomerGroupId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_CUSTOMER": { "post": { "summary": "Update Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_UPDATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Customer Account Code : Specify the customer account code of the customer to update. (example: \"DAK\")" }, "Name": { "type": "string", "description": "Name" }, "CustomerGroupId": { "type": "string", "description": "Customer Group : Specify the Customer Group for the new customer." }, "OrganizationNumber": { "type": "string", "description": "Organization Number" }, "PartyType": { "type": "string", "description": "Type : Specify the type of customer.", "enum": [ "Organization", "Person" ] }, "SalesCurrencyCode": { "type": "string", "description": "Currency : The three-letter currency code associated with this customer." }, "PartyCountry": { "type": "string", "description": "Country" }, "AddressStreet": { "type": "string", "description": "Street Address" }, "AddressCity": { "type": "string", "description": "City" }, "AddressZipCode": { "type": "string", "description": "Zip Code" }, "PrimaryContactPhone": { "type": "string", "description": "Phone Number" }, "PrimaryContactEmail": { "type": "string", "description": "Email Address" }, "customerAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this customer as JSON. For example, you may specify a different billing address here. See the metadata for available fields. (example: \"[\n {\n \"InvoiceAddressCity\": \"N.Y\",\n \"PrimaryContactTwitter\": \"iamjohn@twitter\"\n },\n ]\")", "properties": {} } }, "required": [ "customerId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_CUSTOMER_BY_ID": { "post": { "summary": "Get Customer By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_CUSTOMER_BY_ID" }, "parameters": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Customer Account Code : Specify the customer account code of the customer to fetch. (example: \"DAK\")" } }, "required": [ "customerId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_CUSTOMERS": { "post": { "summary": "Search Customers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_SEARCH_CUSTOMERS" }, "parameters": { "type": "object", "properties": { "customerFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "CustomerAccount", "Name", "CustomerGroupId", "OrganizationNumber", "PartyType" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_CUSTOMER": { "post": { "summary": "Delete Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_DELETE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Customer Account Code : Specify the customer account code of the customer to delete. (example: \"DAK\")" } }, "required": [ "customerId" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_INVOICE": { "post": { "summary": "Create Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_CREATE_INVOICE" }, "parameters": { "type": "object", "properties": { "CustomerAccount": { "type": "string", "description": "Customer Account : Specify the Customer Account of the recipient of this invoice." }, "InvoiceAccount": { "type": "string", "description": "Invoice Account" }, "CurrencyCode": { "type": "string", "description": "Currency : The three-letter currency code associated with this invoice." }, "InvoiceDate": { "type": "string", "description": "Invoice Date : Accepts ISO 8601 date format. (example: \"2022-01-01\")" }, "DueDate": { "type": "string", "description": "Due Date (example: \"2022-01-01\")" }, "MethodOfPayment": { "type": "string", "description": "Method of Payment" }, "TermsOfPayment": { "type": "string", "description": "Terms of Payment" }, "IsOneTimeCustomer": { "type": "string", "description": "One-time customer", "enum": [ "Yes", "No" ] } }, "required": [ "CustomerAccount", "InvoiceAccount", "CurrencyCode", "InvoiceDate" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_INVOICE": { "post": { "summary": "Update Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_UPDATE_INVOICE" }, "parameters": { "type": "object", "properties": { "InvoiceIdentifier": { "type": "string", "description": "Invoice ID : Specify the record ID of the Invoice to update." }, "CustomerAccount": { "type": "string", "description": "Customer Account : Specify the Customer Account of the recipient of this invoice." }, "InvoiceAccount": { "type": "string", "description": "Invoice Account" }, "CurrencyCode": { "type": "string", "description": "Currency : The three-letter currency code associated with this invoice." }, "InvoiceDate": { "type": "string", "description": "Invoice Date : Accepts ISO 8601 date format. (example: \"2022-01-01\")" }, "DueDate": { "type": "string", "description": "Due Date (example: \"2022-01-01\")" }, "MethodOfPayment": { "type": "string", "description": "Method of Payment" }, "TermsOfPayment": { "type": "string", "description": "Terms of Payment" }, "IsOneTimeCustomer": { "type": "string", "description": "One-time customer", "enum": [ "Yes", "No" ] } }, "required": [ "InvoiceIdentifier" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_INVOICE_BY_ID": { "post": { "summary": "Get Invoice By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_INVOICE_BY_ID" }, "parameters": { "type": "object", "properties": { "InvoiceIdentifier": { "type": "string", "description": "Invoice ID : Specify the record ID of the Invoice to fetch." } }, "required": [ "InvoiceIdentifier" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_INVOICES": { "post": { "summary": "Search Invoices", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_SEARCH_INVOICES" }, "parameters": { "type": "object", "properties": { "invoiceFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "CustomerAccount", "InvoiceDate", "DueDate" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_INVOICE": { "post": { "summary": "Delete Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_DELETE_INVOICE" }, "parameters": { "type": "object", "properties": { "InvoiceIdentifier": { "type": "string", "description": "Invoice ID : Specify the record ID of the Invoice to delete." } }, "required": [ "InvoiceIdentifier" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_INVOICE_LINE_ITEM": { "post": { "summary": "Create Invoice Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_CREATE_INVOICE_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "ParentRecId": { "type": "string", "description": "Parent Invoice ID : Specify the record ID of the parent invoice to create line item. (example: \"5637146829\")" }, "LineNumber": { "type": "string", "description": "Invoice Line Item ID : Specify Line Number of the Invoice Line Item to create line item. (example: \"1\")" }, "MainAccountDisplayValue": { "type": "string", "description": "Main Account : Specify the revenue account to use to post to the general ledger." }, "Description": { "type": "string", "description": "Description" }, "SalesTaxGroupId": { "type": "string", "description": "Sales Tax Group : Specify the sales tax group for this line item" }, "Quantity": { "type": "string", "description": "Quantity (example: \"1\")" }, "UnitPrice": { "type": "string", "description": "Unit Price" } }, "required": [ "ParentRecId", "LineNumber", "MainAccountDisplayValue" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_INVOICE_LINE_ITEM": { "post": { "summary": "Update Invoice Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_UPDATE_INVOICE_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "ParentRecId": { "type": "string", "description": "Parent Invoice ID : Specify the record ID of the parent invoice for this Invoice Line Item. (example: \"5637146829\")" }, "LineNumber": { "type": "string", "description": "Invoice Line Item ID : Specify Line Number of the Invoice Line Item to update. (example: \"1\")" }, "MainAccountDisplayValue": { "type": "string", "description": "Main Account : Specify the revenue account to use to post to the general ledger." }, "Description": { "type": "string", "description": "Description" }, "SalesTaxGroupId": { "type": "string", "description": "Sales Tax Group : Specify the sales tax group for this line item" }, "Quantity": { "type": "string", "description": "Quantity (example: \"1\")" }, "UnitPrice": { "type": "string", "description": "Unit Price" } }, "required": [ "ParentRecId", "LineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_INVOICE_LINE_ITEM_BY_ID": { "post": { "summary": "Get Invoice Line Item By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_INVOICE_LINE_ITEM_BY_ID" }, "parameters": { "type": "object", "properties": { "ParentRecId": { "type": "string", "description": "Parent Invoice ID : Specify the record ID of the parent invoice for the Invoice Line Item to fetch. (example: \"5637146829\")" }, "LineNumber": { "type": "string", "description": "Invoice Line Item ID : Specify the Line Number of the Invoice Line Item to fetch. (example: \"1\")" } }, "required": [ "ParentRecId", "LineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_INVOICE_LINE_ITEMS": { "post": { "summary": "Search Invoice Line Items", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_SEARCH_INVOICE_LINE_ITEMS" }, "parameters": { "type": "object", "properties": { "invoiceLineFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Quantity", "MainAccountDisplayValue", "SalesTaxGroupId", "ParentRecId" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberEquals", "$numberDoesNotEqual", "$numberGreaterThan", "$numberLessThan" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_INVOICE_LINE_ITEM": { "post": { "summary": "Delete Invoice Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_DELETE_INVOICE_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "ParentRecId": { "type": "string", "description": "Parent Invoice ID : Specify the record ID of the parent invoice for the Invoice Line Item to delete. (example: \"5637146829\")" }, "LineNumber": { "type": "string", "description": "Invoice Line Item ID : Specify the Line Number of the Invoice Line Item to delete. (example: \"1\")" } }, "required": [ "ParentRecId", "LineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL": { "post": { "summary": "Create Payment Journal", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL" }, "parameters": { "type": "object", "properties": { "JournalName": { "type": "string", "description": "Name : Specify a Journal Name to use." }, "Description": { "type": "string", "description": "Description" } }, "required": [ "JournalName" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL": { "post": { "summary": "Update Payment Journal", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL" }, "parameters": { "type": "object", "properties": { "JournalBatchNumber": { "type": "string", "description": "Journal Batch Number : Specify the Journal Batch Number of the Payment Journal to update. (example: \"DAT-000001\")" }, "Description": { "type": "string", "description": "Description" } }, "required": [ "JournalBatchNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_BY_ID": { "post": { "summary": "Get Payment Journal By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_BY_ID" }, "parameters": { "type": "object", "properties": { "JournalBatchNumber": { "type": "string", "description": "Journal Batch Number : Specify the record ID of the Payment Journal to fetch all associated Payments. (example: \"DAT-000001\")" } }, "required": [ "JournalBatchNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNALS": { "post": { "summary": "Search Payment Journals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNALS" }, "parameters": { "type": "object", "properties": { "paymentJournalFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "JournalName", "JournalBatchNumber" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanFalse", "$booleanTrue" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL": { "post": { "summary": "Delete Payment Journal", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL" }, "parameters": { "type": "object", "properties": { "JournalBatchNumber": { "type": "string", "description": "Journal Batch Number : Specify the record ID of the Payment Journal to delete all associated Payments. (example: \"DAT-000001\")" } }, "required": [ "JournalBatchNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL_LINE_ITEM": { "post": { "summary": "Create Payment Journal Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "JournalBatchNumber": { "type": "string", "description": "Journal Batch Number : Specify the batch number of the Parent Payment Journal to fetch all associated Payments. (example: \"DAT-000001\")" }, "LineNumber": { "type": "string", "description": "Payment Journal Line Item ID : Specify Line Number for the Payment Journal Line Item. (example: \"1\")" }, "TransactionDate": { "type": "string", "description": "Date : Accepts ISO 8601 date format. (example: \"2022-01-01\")" }, "Voucher": { "type": "string", "description": "Voucher : Specify the voucher number for the transaction. Voucher series are set up in the Number sequences page in Dynamics Finance." }, "MarkedInvoice": { "type": "string", "description": "Invoice ID" }, "CreditAmount": { "type": "string", "description": "Credit : Specify a credit amount in the currency that is selected for the journal line." }, "CurrencyCode": { "type": "string", "description": "Currency : The three-letter currency code associated with this invoice." } }, "required": [ "JournalBatchNumber", "LineNumber", "TransactionDate", "CurrencyCode" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL_LINE_ITEM": { "post": { "summary": "Update Payment Journal Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "JournalBatchNumber": { "type": "string", "description": "Journal Batch Number : Specify the batch number of the Parent Payment Journal to update its child line item. (example: \"DAT-000001\")" }, "LineNumber": { "type": "string", "description": "Payment Journal Line Item ID : Specify Line Number of the Payment Journal Line Item to update. (example: \"1\")" }, "TransactionDate": { "type": "string", "description": "Date : Accepts ISO 8601 date format. (example: \"2022-01-01\")" }, "Voucher": { "type": "string", "description": "Voucher : Specify the voucher number for the transaction. Voucher series are set up in the Number sequences page in Dynamics Finance." }, "MarkedInvoice": { "type": "string", "description": "Invoice ID" }, "CreditAmount": { "type": "string", "description": "Credit : Specify a credit amount in the currency that is selected for the journal line." }, "CurrencyCode": { "type": "string", "description": "Currency : The three-letter currency code associated with this invoice." } }, "required": [ "JournalBatchNumber", "LineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_LINE_ITEM_BY_ID": { "post": { "summary": "Get Payment Journal Line Item By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_LINE_ITEM_BY_ID" }, "parameters": { "type": "object", "properties": { "JournalBatchNumber": { "type": "string", "description": "Journal Batch Number : Specify the record ID of the Payment Journal to fetch all associated Payments. (example: \"DAT-000001\")" }, "LineNumber": { "type": "string", "description": "Payment Journal Line Item ID : Specify the Line Number of the Payment Journal Line Item to fetch. (example: \"1\")" } }, "required": [ "JournalBatchNumber", "LineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNAL_LINE_ITEMS": { "post": { "summary": "Search Payment Journal Line Items", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNAL_LINE_ITEMS" }, "parameters": { "type": "object", "properties": { "paymentJournalLineFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "TransactionDate", "LineNumber" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberEquals", "$numberDoesNotEqual", "$numberGreaterThan", "$numberLessThan", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "$top": { "type": "number", "description": "Limit($top) to limit the number of items to return. Default is 100" }, "$skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return. Default is 0" } } } }, "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL_LINE_ITEM": { "post": { "summary": "Delete Payment Journal Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "JournalBatchNumber": { "type": "string", "description": "Journal Batch Number : Specify the batch number of the Parent Payment Journal to delete its child line item. (example: \"DAT-000001\")" }, "LineNumber": { "type": "string", "description": "Payment Journal Line Item ID : Specify the Line Number of the Payment Journal Line Item to delete. (example: \"1\")" } }, "required": [ "JournalBatchNumber", "LineNumber" ], "x-integration": "dynamicsfinance" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_VENDOR": { "post": { "summary": "Create Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_CREATE_VENDOR" }, "parameters": { "type": "object", "properties": { "vendorNumber": { "type": "string", "description": "Vendor Number" }, "vendorName": { "type": "string", "description": "Name" }, "vendorEmail": { "type": "string", "description": "Email (example: \"primary@vendor.com\")" }, "taxRegNumber": { "type": "string", "description": "Tax Registration Number : The vendor's tax registration number." }, "paymentTermsId": { "type": "string", "description": "Payment Term ID" }, "addressLine1": { "type": "string", "description": "Address Line 1" }, "addressLine2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State (example: \"Use state or province.\")" }, "zip": { "type": "string", "description": "ZIP (example: \"Use ZIP or postal code, if applicable.\")" }, "country": { "type": "string", "description": "Country" }, "vendorsAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this vendor as JSON. For example, you may specify a different billing address here. See the docs (https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_vendor) for available fields. (example: \"{\n \"phoneNumber\": \"string\",\n \"website\": \"string\",\n \"currencyCode\": \"string\",\n \"irs1099Code\": \"string\",\n \"taxLiable\": \"boolean\",\n \"balance\": \"decimal\",\n \"lastModifiedDateTime\": \"datetime\"\n}\")", "properties": {} } }, "required": [ "vendorNumber" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_VENDOR": { "post": { "summary": "Update Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_UPDATE_VENDOR" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : Specify the record ID of the Vendor to update." }, "vendorNumber": { "type": "string", "description": "Vendor Number" }, "vendorName": { "type": "string", "description": "Name" }, "vendorEmail": { "type": "string", "description": "Email (example: \"primary@vendor.com\")" }, "taxRegNumber": { "type": "string", "description": "Tax Registration Number : The vendor's tax registration number." }, "paymentTermsId": { "type": "string", "description": "Payment Term ID" }, "addressLine1": { "type": "string", "description": "Address Line 1" }, "addressLine2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State (example: \"Use state or province.\")" }, "zip": { "type": "string", "description": "ZIP (example: \"Use ZIP or postal code, if applicable.\")" }, "country": { "type": "string", "description": "Country" }, "vendorsAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this vendor as JSON. For example, you may specify a different billing address here. See the docs (https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_vendor) for available fields. (example: \"{\n \"phoneNumber\": \"string\",\n \"website\": \"string\",\n \"currencyCode\": \"string\",\n \"irs1099Code\": \"string\",\n \"taxLiable\": \"boolean\",\n \"balance\": \"decimal\",\n \"lastModifiedDateTime\": \"datetime\"\n}\")", "properties": {} } }, "required": [ "vendorId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_VENDOR_BY_ID": { "post": { "summary": "Get Vendor By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_GET_VENDOR_BY_ID" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : Specify the record ID of the Vendor to fetch." } }, "required": [ "vendorId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_VENDOR": { "post": { "summary": "Search Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_SEARCH_VENDOR" }, "parameters": { "type": "object", "properties": { "vendorsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "displayName", "email", "taxRegistrationNumber", "paymentTermsId" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberEquals", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberDoesNotEqual", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (maximum 100)" }, "skipToken": { "type": "string", "description": "Skip token to fetch next page of records" } } } }, "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_VENDOR": { "post": { "summary": "Delete Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_DELETE_VENDOR" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : Specify the record ID of the Vendor to delete." } }, "required": [ "vendorId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE": { "post": { "summary": "Create Purchase Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceVendorId": { "type": "string", "description": "Vendor Id : The Id of the vendor who delivers the products." }, "vendorInvoiceNumber": { "type": "string", "description": "Vendor Invoice Number : An internal number for the invoice." }, "invoiceDate": { "type": "string", "description": "Invoice Date : Accepts ISO 8601 date format. (example: \"2022-01-01\")" }, "postingDate": { "type": "string", "description": "Posting Date : Accepts ISO 8601 date format. (example: \"2022-01-02\")" }, "dueDate": { "type": "string", "description": "Due Date : Accepts ISO 8601 date format. (example: \"2022-02-03\")" }, "purchaseInvoiceAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this Purchase Invoice as JSON. See the docs (https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_purchaseinvoice) for available fields. (example: \"{\n shipToName: \"John Apple\",\n shipToAddressLine1: \"2000 Durant Ave.\"\n}\")", "properties": {} } }, "required": [ "purchaseInvoiceVendorId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE": { "post": { "summary": "Update Purchase Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceId": { "type": "string", "description": "Purchase Invoice ID : Specify the record ID of the Purchase Invoice to update." }, "purchaseInvoiceVendorId": { "type": "string", "description": "Vendor Id : The Id of the vendor who delivers the products." }, "vendorInvoiceNumber": { "type": "string", "description": "Vendor Invoice Number : An internal number for the invoice." }, "invoiceDate": { "type": "string", "description": "Invoice Date : Accepts ISO 8601 date format. (example: \"2022-01-01\")" }, "postingDate": { "type": "string", "description": "Posting Date : Accepts ISO 8601 date format. (example: \"2022-01-02\")" }, "dueDate": { "type": "string", "description": "Due Date : Accepts ISO 8601 date format. (example: \"2022-02-03\")" }, "purchaseInvoiceAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this Purchase Invoice as JSON. See the docs (https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_purchaseinvoice) for available fields. (example: \"{\n shipToName: \"John Apple\",\n shipToAddressLine1: \"2000 Durant Ave.\"\n}\")", "properties": {} } }, "required": [ "purchaseInvoiceId", "purchaseInvoiceVendorId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_POST_PURCHASE_INVOICE": { "post": { "summary": "Post Purchase Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_POST_PURCHASE_INVOICE" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceId": { "type": "string", "description": "Purchase Invoice ID : Specify the record ID of the Purchase Invoice to post to the ledger." } }, "required": [ "purchaseInvoiceId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_BY_ID": { "post": { "summary": "Get Purchase Invoice By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_BY_ID" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceId": { "type": "string", "description": "Purchase Invoice ID : Specify the record ID of the Purchase Invoice to fetch." } }, "required": [ "purchaseInvoiceId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_FOR_PURCHASE_INVOICE": { "post": { "summary": "Search For Purchase Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_SEARCH_FOR_PURCHASE_INVOICE" }, "parameters": { "type": "object", "properties": { "purchaseInvoicesFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "vendorName", "vendorInvoiceNumber", "dueDate", "postingDate", "status" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberEquals", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberDoesNotEqual", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (maximum 100)" }, "skipToken": { "type": "string", "description": "Skip token to fetch next page of records" } } } }, "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE": { "post": { "summary": "Delete Purchase Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceId": { "type": "string", "description": "Purchase Invoice ID : Specify the record ID of the Purchase Invoice to delete." } }, "required": [ "purchaseInvoiceId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE_LINE_ITEM": { "post": { "summary": "Create Purchase Invoice Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "parentInvoiceId": { "type": "string", "description": "Parent Purchase Invoice Id" }, "lineType": { "type": "string", "description": "Line Type", "enum": [ "Item", "Resource", "Comment", "Account", "Fixed Asset", "Charge" ] }, "resourceNumber": { "type": "string", "description": "Number : Specify the number of the item, account, resource, charge, or fixed asset associated with the Purchase Invoice Line. Items and resources will be created if they do not exist. (example: \"1896-S\")" }, "lineDescription": { "type": "string", "description": "Description (example: \"ATHENS Desk\")" }, "quantity": { "type": "string", "description": "Quantity (example: \"20\")" }, "unitCost": { "type": "string", "description": "Unit Cost (example: \"10.99\")" }, "accountId": { "type": "string", "description": "Account ID : Specify the ID of the Account that the Purchase Invoice Line is related to. (example: \"00000000-0000-0000-0000-000000000000\")" }, "measureCodeUnit": { "type": "string", "description": "Unit of Measure Code (example: \"PCS\")" }, "taxPercent": { "type": "string", "description": "Tax Percent (example: \"6.00004\")" }, "taxGroupCode": { "type": "string", "description": "Tax Group Code (example: \"FURNITURE\")" }, "purchaseInvoiceLineAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this Purchase Invoice Line as JSON. See the docs (https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_purchaseinvoiceline) for available fields. (example: \"{\n documentId: \"5d115c9c-44e3-ea11-bb43-000d3a2feca1\",\n}\")", "properties": {} } }, "required": [ "parentInvoiceId", "lineType", "resourceNumber", "lineDescription", "quantity", "unitCost", "accountId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE_LINE_ITEM": { "post": { "summary": "Update Purchase Invoice Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceLineId": { "type": "string", "description": "Purchase Invoice Line ID : The record ID of the Purchase Invoice Line to update." }, "lineType": { "type": "string", "description": "Line Type", "enum": [ "Item", "Resource", "Comment", "Account", "Fixed Asset", "Charge" ] }, "resourceNumber": { "type": "string", "description": "Number : Specify the number of the item, account, resource, charge, or fixed asset associated with the Purchase Invoice Line. Items and resources will be created if they do not exist. (example: \"1896-S\")" }, "lineDescription": { "type": "string", "description": "Description (example: \"ATHENS Desk\")" }, "quantity": { "type": "string", "description": "Quantity (example: \"20\")" }, "unitCost": { "type": "string", "description": "Unit Cost (example: \"10.99\")" }, "accountId": { "type": "string", "description": "Account ID : Specify the ID of the Account that the Purchase Invoice Line is related to. (example: \"00000000-0000-0000-0000-000000000000\")" }, "measureCodeUnit": { "type": "string", "description": "Unit of Measure Code (example: \"PCS\")" }, "taxPercent": { "type": "string", "description": "Tax Percent (example: \"6.00004\")" }, "taxGroupCode": { "type": "string", "description": "Tax Group Code (example: \"FURNITURE\")" }, "purchaseInvoiceLineAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this Purchase Invoice Line as JSON. See the docs (https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_purchaseinvoiceline) for available fields. (example: \"{\n documentId: \"5d115c9c-44e3-ea11-bb43-000d3a2feca1\",\n}\")", "properties": {} } }, "required": [ "purchaseInvoiceLineId", "lineType", "resourceNumber", "lineDescription", "quantity", "unitCost" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINES": { "post": { "summary": "Get Purchase Invoice Lines", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINES" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceId": { "type": "string", "description": "Purchase Invoice ID : Specify the record ID of the Purchase Invoice ID to fetch all associated Purchase Invoice Lines." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (maximum 100)" }, "skipToken": { "type": "string", "description": "Skip token to fetch next page of records" } } } }, "required": [ "purchaseInvoiceId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINE_ITEM_BY_ID": { "post": { "summary": "Get Purchase Invoice Line Item By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINE_ITEM_BY_ID" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceLineId": { "type": "string", "description": "Purchase Invoice Line ID : Specify the record ID of the Purchase Invoice Line to fetch." } }, "required": [ "purchaseInvoiceLineId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_PURCHASE_INVOICE_LINE_ITEM": { "post": { "summary": "Search Purchase Invoice Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_SEARCH_PURCHASE_INVOICE_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "parentInvoiceId": { "type": "string", "description": "Parent Purchase Invoice Id" }, "purchaseInvoiceLinesFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "taxCode", "description", "lineType" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberEquals", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberDoesNotEqual", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (maximum 100)" }, "skipToken": { "type": "string", "description": "Skip token to fetch next page of records" } } } }, "required": [ "parentInvoiceId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE_LINE_ITEM": { "post": { "summary": "Delete Purchase Invoice Line Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE_LINE_ITEM" }, "parameters": { "type": "object", "properties": { "purchaseInvoiceLineId": { "type": "string", "description": "Purchase Invoice Line ID : The record ID of the Purchase Invoice Line to delete." } }, "required": [ "purchaseInvoiceLineId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNTS": { "post": { "summary": "Get Accounts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNTS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (maximum 100)" }, "skipToken": { "type": "string", "description": "Skip token to fetch next page of records" } } } }, "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNT_BY_ID": { "post": { "summary": "Get Account By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNT_BY_ID" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : Specify the record ID of the Account to fetch." } }, "required": [ "accountId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_TAX_GROUP": { "post": { "summary": "Create Tax Group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_CREATE_TAX_GROUP" }, "parameters": { "type": "object", "properties": { "taxGroupCode": { "type": "string", "description": "Tax Group Code : Specify the code of the Tax Group. (example: \"FURNITURE\")" }, "taxGroupName": { "type": "string", "description": "Name (example: \"Taxable Olympic Furniture\")" } }, "required": [ "taxGroupCode", "taxGroupName" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_TAX_GROUP": { "post": { "summary": "Update Tax Group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_UPDATE_TAX_GROUP" }, "parameters": { "type": "object", "properties": { "taxGroupId": { "type": "string", "description": "Tax Group ID : The record ID of the Tax Group to update." }, "taxGroupName": { "type": "string", "description": "Name (example: \"Taxable Olympic Furniture\")" } }, "required": [ "taxGroupId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_TAX_GROUP_BY_ID": { "post": { "summary": "Get Tax Group By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_GET_TAX_GROUP_BY_ID" }, "parameters": { "type": "object", "properties": { "taxGroupId": { "type": "string", "description": "Tax Group ID : Specify the record ID of the Tax Group to fetch." } }, "required": [ "taxGroupId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_TAX_GROUP": { "post": { "summary": "Search Tax Group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_SEARCH_TAX_GROUP" }, "parameters": { "type": "object", "properties": { "taxGroupsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "code", "displayName", "taxType" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberEquals", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberDoesNotEqual", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (maximum 100)" }, "skipToken": { "type": "string", "description": "Skip token to fetch next page of records" } } } }, "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_TAX_GROUP": { "post": { "summary": "Delete Tax Group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_DELETE_TAX_GROUP" }, "parameters": { "type": "object", "properties": { "taxGroupId": { "type": "string", "description": "Tax Group ID : The record ID of the Tax Group to delete." } }, "required": [ "taxGroupId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PAYMENT_TERM": { "post": { "summary": "Create Payment Term", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_CREATE_PAYMENT_TERM" }, "parameters": { "type": "object", "properties": { "paymentTermCode": { "type": "string", "description": "Payment Term Code : The code to identify this set of payment terms. (example: \"10 DAYS\")" }, "paymentTermName": { "type": "string", "description": "Name : This name will appear on all sales documents for the payment term. (example: \"Net 10 days\")" }, "dueDateCalculation": { "type": "string", "description": "Due Date Calculation (example: \"10D\")" }, "discountDateCalculation": { "type": "string", "description": "Discount Date Calculation (example: \"8D\")" }, "discountPercent": { "type": "string", "description": "Discount Percent : Specify the percentage of the invoice amount (amount including tax is the default setting) that will constitute a possible payment discount. (example: \"2\")" } }, "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PAYMENT_TERM": { "post": { "summary": "Update Payment Term", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_UPDATE_PAYMENT_TERM" }, "parameters": { "type": "object", "properties": { "paymentTermsId": { "type": "string", "description": "Payment Term ID : The record ID of the Payment Term to update." }, "paymentTermCode": { "type": "string", "description": "Payment Term Code : The code to identify this set of payment terms. (example: \"10 DAYS\")" }, "paymentTermName": { "type": "string", "description": "Name : This name will appear on all sales documents for the payment term. (example: \"Net 10 days\")" }, "dueDateCalculation": { "type": "string", "description": "Due Date Calculation (example: \"10D\")" }, "discountDateCalculation": { "type": "string", "description": "Discount Date Calculation (example: \"8D\")" }, "discountPercent": { "type": "string", "description": "Discount Percent : Specify the percentage of the invoice amount (amount including tax is the default setting) that will constitute a possible payment discount. (example: \"2\")" } }, "required": [ "paymentTermsId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_PAYMENT_TERM_BY_ID": { "post": { "summary": "Get Payment Term By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_GET_PAYMENT_TERM_BY_ID" }, "parameters": { "type": "object", "properties": { "paymentTermsId": { "type": "string", "description": "Payment Term ID : Specify the record ID of the Payment Term to fetch." } }, "required": [ "paymentTermsId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_PAYMENT_TERM": { "post": { "summary": "Search Payment Term", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_SEARCH_PAYMENT_TERM" }, "parameters": { "type": "object", "properties": { "paymentTermsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "code", "displayName", "discountPercent" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberEquals", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberDoesNotEqual", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (maximum 100)" }, "skipToken": { "type": "string", "description": "Skip token to fetch next page of records" } } } }, "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PAYMENT_TERM": { "post": { "summary": "Delete Payment Term", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "DYNAMICS_BUSINESS_CENTRAL_DELETE_PAYMENT_TERM" }, "parameters": { "type": "object", "properties": { "paymentTermsId": { "type": "string", "description": "Payment Term ID : The record ID of the Payment Term to delete." } }, "required": [ "paymentTermsId" ], "x-integration": "dynamicsbusinesscentral" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_GET_FILE_BY_ID": { "post": { "summary": "Get File By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_GET_FILE_BY_ID" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" }, "depth": { "type": "string", "description": "Depth : Specify the depth of the nodes to retrieve. For example, setting this to 1 returns only Pages, setting it to 2 returns Pages and all top level objects on each page. Not setting this parameter returns all nodes. (example: \"1\")" } }, "required": [ "fileId" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_GET_FILE_NODES": { "post": { "summary": "Get File Nodes", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_GET_FILE_NODES" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" }, "ids": { "type": "string", "description": "Node IDs : Specify a comma separated list of Node IDs to retrieve. The Node ID can be parsed from any Figma node url: https://www.figma.com/file/:key/:title?node-id=:id. (example: \"0:1,0:2\")" } }, "required": [ "fileId", "ids" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_GET_RENDERED_IMAGE": { "post": { "summary": "Get Rendered Image", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_GET_RENDERED_IMAGE" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" }, "ids": { "type": "string", "description": "Node IDs : Specify a comma separated list of Node IDs to retrieve. The Node ID can be parsed from any Figma node url: https://www.figma.com/file/:key/:title?node-id=:id. (example: \"0:1,0:2\")" } }, "required": [ "fileId", "ids" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_GET_PROJECT": { "post": { "summary": "Get Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_GET_PROJECT" }, "parameters": { "type": "object", "properties": { "teamId": { "type": "string", "description": "Team ID : Specify ID of the Team to list projects. The Team ID can be parsed from team url: https://www.figma.com/files/team/:id/:title (example: \"21321312\")" } }, "required": [ "teamId" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_GET_PROJECT_FILES": { "post": { "summary": "Get Project Files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_GET_PROJECT_FILES" }, "parameters": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID : Specify ID of the Project to list files from. (example: \"21321312\")" } }, "required": [ "projectId" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_CREATE_COMMENT": { "post": { "summary": "Create Comment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_CREATE_COMMENT" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" }, "message": { "type": "string", "description": "Message : The text contents of the comment to post" }, "additionalData": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this comment as JSON. See the docs (https://www.figma.com/developers/api#post-comments-endpoint) for available fields. (example: \"{\n \"comment_id\": \"string\",\n \"client_meta\": {\n \"x\":100,\n \"y\":100\n }\n}\")", "properties": {} } }, "required": [ "fileId", "message" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_GET_COMMENTS_BY_FILE": { "post": { "summary": "Get Comments By File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_GET_COMMENTS_BY_FILE" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" } }, "required": [ "fileId" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_DELETE_COMMENTS": { "post": { "summary": "Delete Comments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_DELETE_COMMENTS" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" }, "commentId": { "type": "string", "description": "Comment ID : Specify the ID of the comment to delete. (example: \"469424202\")" } }, "required": [ "fileId", "commentId" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_CREATE_COMMENT_REACTION": { "post": { "summary": "Create Comment Reaction", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_CREATE_COMMENT_REACTION" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" }, "commentId": { "type": "string", "description": "Comment ID : Specify the ID of the comment to add reaction to. (example: \"469424202\")" }, "emoji": { "type": "string", "description": "Emoji : Specify the emoji type of reaction to add.", "enum": [ ":eyes:", ":heart_eyes:", ":heavy_plus_sign:", ":+1:", ":-1:", ":joy:", ":fire:" ] } }, "required": [ "fileId", "commentId", "emoji" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_GET_COMMENT_REACTION": { "post": { "summary": "Get Comment Reaction", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_GET_COMMENT_REACTION" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" }, "commentId": { "type": "string", "description": "Comment ID : Specify the ID of the comment to get reactions from. (example: \"469424202\")" } }, "required": [ "fileId", "commentId" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FIGMA_DELETE_COMMENT_REACTION": { "post": { "summary": "Delete Comment Reaction", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FIGMA_DELETE_COMMENT_REACTION" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify a File ID. The File ID can be parsed from file url: https://www.figma.com/file/:id/:title (example: \"CRcEzuiEc3ybXCg6B\")" }, "commentId": { "type": "string", "description": "Comment ID : Specify the ID of the comment to remove reaction from. (example: \"469424202\")" }, "emoji": { "type": "string", "description": "Emoji : Specify the emoji type of reaction to delete.", "enum": [ ":eyes:", ":heart_eyes:", ":heavy_plus_sign:", ":+1:", ":-1:", ":joy:", ":fire:" ] } }, "required": [ "fileId", "commentId", "emoji" ], "x-integration": "figma" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_CAMPAIGN": { "post": { "summary": "Create Campaign", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_CREATE_CAMPAIGN" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : The name of the campaign." }, "objective": { "type": "string", "description": "Objective : Specify the objective for this campaign.", "enum": [ "OUTCOME_AWARENESS", "OUTCOME_ENGAGEMENT", "OUTCOME_LEADS", "OUTCOME_SALES", "OUTCOME_APP_PROMOTION", "OUTCOME_TRAFFIC" ] }, "status": { "type": "string", "description": "Status : This value will default to Paused to prevent your test account from being billed while testing. Change this to Active for production uses.", "enum": [ "PAUSED", "ACTIVE" ] }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this campaign as JSON. (example: \"{\n \"is_adset_budget_sharing_enabled\": false,\n \"bid_strategy\": \"LOWEST_COST_WITHOUT_CAP\"\n}\")", "properties": {} } }, "required": [ "name", "objective", "status" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_UPDATE_CAMPAIGN": { "post": { "summary": "Update Campaign", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_UPDATE_CAMPAIGN" }, "parameters": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "Campaign ID : The ID of the campaign to update." }, "name": { "type": "string", "description": "Name : The name of the campaign." }, "objective": { "type": "string", "description": "Objective : Specify the objective for this campaign.", "enum": [ "OUTCOME_AWARENESS", "OUTCOME_ENGAGEMENT", "OUTCOME_LEADS", "OUTCOME_SALES", "OUTCOME_APP_PROMOTION", "OUTCOME_TRAFFIC" ] }, "status": { "type": "string", "description": "Status : This value will default to Paused to prevent your test account from being billed while testing. Change this to Active for production uses.", "enum": [ "PAUSED", "ACTIVE", "ARCHIVED", "DELETED" ] }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this campaign as JSON. (example: \"{\n \"is_adset_budget_sharing_enabled\": false,\n \"bid_strategy\": \"LOWEST_COST_WITHOUT_CAP\"\n}\")", "properties": {} } }, "required": [ "campaignId" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_GET_CAMPAIGN_BY_ID": { "post": { "summary": "Get Campaign By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_GET_CAMPAIGN_BY_ID" }, "parameters": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "Campaign ID : The ID of the campaign to get." } }, "required": [ "campaignId" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_GET_CAMPAIGNS": { "post": { "summary": "Get Campaigns", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_GET_CAMPAIGNS" }, "parameters": { "type": "object", "properties": { "effectiveStatus": { "type": "string", "description": "Effective Status (example: \"[\"ACTIVE\", \"PAUSED\"]\")" }, "campaignFilterFormula": { "type": "string", "description": "Filter search: Search for campaigns that match specified filters. (example: \"field\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_AD_SET": { "post": { "summary": "Create Ad Set", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_CREATE_AD_SET" }, "parameters": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "Specify the campaign ID to perform the operation on" }, "name": { "type": "string", "description": "Name : The name of the ad set." }, "status": { "type": "string", "description": "Status : This value will default to Paused to prevent your test account from being billed while testing. Change this to Active for production uses.", "enum": [ "PAUSED", "ACTIVE" ] }, "optimizationGoal": { "type": "string", "description": "Optimization Goal : Specify the optimization goal that this ad set will use.", "enum": [ "APP_INSTALLS", "AD_RECALL_LIFT", "ENGAGED_USERS", "EVENT_RESPONSES", "IMPRESSIONS", "LEAD_GENERATION", "QUALITY_LEAD", "LINK_CLICKS", "OFFSITE_CONVERSIONS", "PAGE_LIKES", "POST_ENGAGEMENT", "QUALITY_CALL", "REACH", "LANDING_PAGE_VIEWS", "VISIT_INSTAGRAM_PROFILE", "VALUE", "VALUE_THROUGHPLAY", "DERIVED_EVENTS", "APP_INSTALLS_AND_OFFSITE_CONVERSIONS", "CONVERSIONS" ] }, "billingEvent": { "type": "string", "description": "Billing Event : Specify the billing event that this ad set will use.", "enum": [ "APP_INSTALLS", "CLICKS", "IMPRESSIONS", "LINK_CLICKS", "OFFER_CLAIMS", "PAGE_LIKES", "POST_ENGAGEMENT", "VIDEO_VIEWS", "VALUE_THROUGHPLAY" ] }, "bidAmount": { "type": "string", "description": "Bid Amount : Set a maximum bid you want to pay for a result based on this ad set’s optimization goal. Value is in cents, for your account’s local currency." }, "dailyBudget": { "type": "string", "description": "Daily Budget : Set a daily budget for this ad set to use, in your account’s local currency." }, "startTime": { "type": "string", "description": "Start Time : Specify when this ad set should start running. (example: \"2021-01-01 12:00:00 AM\")" }, "targeting": { "type": "object", "description": "Targeting : Provide a Targeting spec to define the audience for this ad set. (example: \"{\n \"geo_locations\": {\"countries\": [\"US\"]},\n \"interests\": [{id: 6003139266461, 'name': 'Movies'}]\n}\")", "properties": {} }, "promotedObject": { "type": "object", "description": "Promoted Object : The object an ad set promotes, such as a Page or app. This field may be required depending on your campaign’s Objective. Read the docs (https://developers.facebook.com/docs/marketing-api/reference/ad-promoted-object) for more details. (example: \"{\n \"page_id\": \"11111111111111111\"\n}\")", "properties": {} } }, "required": [ "campaignId", "name", "status", "optimizationGoal", "billingEvent", "bidAmount", "dailyBudget", "startTime", "targeting" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_UPDATE_AD_SET": { "post": { "summary": "Update Ad Set", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_UPDATE_AD_SET" }, "parameters": { "type": "object", "properties": { "adSetId": { "type": "string", "description": "Ad Set ID : The ID of the ad set to update." }, "campaignId": { "type": "string", "description": "Specify the campaign ID to perform the operation on" }, "name": { "type": "string", "description": "Name : The name of the ad set." }, "status": { "type": "string", "description": "Status : This value will default to Paused to prevent your test account from being billed while testing. Change this to Active for production uses.", "enum": [ "PAUSED", "ACTIVE" ] }, "optimizationGoal": { "type": "string", "description": "Optimization Goal : Specify the optimization goal that this ad set will use.", "enum": [ "APP_INSTALLS", "AD_RECALL_LIFT", "ENGAGED_USERS", "EVENT_RESPONSES", "IMPRESSIONS", "LEAD_GENERATION", "QUALITY_LEAD", "LINK_CLICKS", "OFFSITE_CONVERSIONS", "PAGE_LIKES", "POST_ENGAGEMENT", "QUALITY_CALL", "REACH", "LANDING_PAGE_VIEWS", "VISIT_INSTAGRAM_PROFILE", "VALUE", "VALUE_THROUGHPLAY", "DERIVED_EVENTS", "APP_INSTALLS_AND_OFFSITE_CONVERSIONS", "CONVERSIONS" ] }, "billingEvent": { "type": "string", "description": "Billing Event : Specify the billing event that this ad set will use.", "enum": [ "APP_INSTALLS", "CLICKS", "IMPRESSIONS", "LINK_CLICKS", "OFFER_CLAIMS", "PAGE_LIKES", "POST_ENGAGEMENT", "VIDEO_VIEWS", "VALUE_THROUGHPLAY" ] }, "bidAmount": { "type": "string", "description": "Bid Amount : Set a maximum bid you want to pay for a result based on this ad set’s optimization goal. Value is in cents, for your account’s local currency." }, "dailyBudget": { "type": "string", "description": "Daily Budget : Set a daily budget for this ad set to use, in your account’s local currency." }, "startTime": { "type": "string", "description": "Start Time : Specify when this ad set should start running. (example: \"2021-01-01 12:00:00 AM\")" }, "targeting": { "type": "object", "description": "Targeting : Provide a Targeting spec to define the audience for this ad set. (example: \"{\n \"geo_locations\": {\"countries\": [\"US\"]},\n \"interests\": [{id: 6003139266461, 'name': 'Movies'}]\n}\")", "properties": {} } }, "required": [ "adSetId" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_GET_AD_SET_BY_ID": { "post": { "summary": "Get Ad Set By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_GET_AD_SET_BY_ID" }, "parameters": { "type": "object", "properties": { "adSetId": { "type": "string", "description": "Ad Set ID : The ID of the ad set to get." } }, "required": [ "adSetId" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_GET_AD_SETS": { "post": { "summary": "Get Ad Sets", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_GET_AD_SETS" }, "parameters": { "type": "object", "properties": { "effectiveStatus": { "type": "string", "description": "Effective Status (example: \"[\"ACTIVE\", \"PAUSED\"]\")" }, "adSetFilterFormula": { "type": "string", "description": "Filter search: Search for ad sets that match specified filters. (example: \"field\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_AD": { "post": { "summary": "Create Ad", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_CREATE_AD" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : Specify a name for this ad." }, "status": { "type": "string", "description": "Status : This value will default to Paused to prevent your test account from being billed while testing. Change this to Active for production uses.", "enum": [ "PAUSED", "ACTIVE", "ARCHIVED", "DELETED" ] }, "adSetId": { "type": "string", "description": "Ad Set ID : The ID of the ad set to create this ad for." }, "adCreativeId": { "type": "string", "description": "Ad Creative ID : The ID of the ad creative to use for this ad." } }, "required": [ "name", "status", "adSetId", "adCreativeId" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_UPDATE_AD": { "post": { "summary": "Update Ad", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_UPDATE_AD" }, "parameters": { "type": "object", "properties": { "adId": { "type": "string", "description": "Ad ID : The ID of the ad to update." }, "name": { "type": "string", "description": "Name : Specify a name for this ad." }, "status": { "type": "string", "description": "Status : This value will default to Paused to prevent your test account from being billed while testing. Change this to Active for production uses.", "enum": [ "PAUSED", "ACTIVE", "ARCHIVED", "DELETED" ] }, "adCreativeId": { "type": "string", "description": "Ad Creative ID : The ID of the ad creative to use for this ad." } }, "required": [ "adId" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_GET_AD_BY_ID": { "post": { "summary": "Get Ad By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_GET_AD_BY_ID" }, "parameters": { "type": "object", "properties": { "adId": { "type": "string", "description": "Ad ID : The ID of the ad to get." } }, "required": [ "adId" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT": { "post": { "summary": "Build Ad Creative Object", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT" }, "parameters": { "type": "object", "properties": { "adCreativeType": { "type": "string", "description": "Type : Select a type of ad creative to build.", "enum": [ "IMAGE", "TEXT", "LINK", "LEAD_GEN_FORM_ID" ] }, "imageURL": { "type": "string", "description": "Image URL : This image will be uploaded to your ad account’s image library. (example: \"https://example.com/ad.png\") \nThis field appears only when 'adCreativeType' = 'IMAGE')" }, "linkURL": { "type": "string", "description": "Link URL : The URL used for the CTA in this ad. (example: \"https://example.com/promo\") \nThis field appears only when 'adCreativeType' = 'IMAGE') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '')" }, "linkTitle": { "type": "string", "description": "Link Title : A title to use for the link of your ad. \nThis field appears only when 'adCreativeType' = 'IMAGE') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '')" }, "linkDescription": { "type": "string", "description": "Link Description : A description to use for the link of your ad. \nThis field appears only when 'adCreativeType' = 'IMAGE') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '')" }, "message": { "type": "string", "description": "Message : The body of the post included with the image. \nThis field appears only when 'adCreativeType' = 'IMAGE') \nThis field appears only when 'type' = '')" }, "additionalField": { "type": "object", "description": "Additional Fields : Specify any other fields that should be included in the post, as fields of AdCreativeLinkData (https://developers.facebook.com/docs/marketing-api/reference/ad-creative-link-data/). (example: \"{\n \"call_to_action\": { ... },\n \"child_attachments\": [{ ... }]\n}\") \nThis field appears only when 'adCreativeType' = 'IMAGE') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '') \nThis field appears only when 'type' = '')", "properties": {} }, "leadGenFormId": { "type": "string", "description": "Lead Gen Form ID : The ID of the lead gen form to use with this creative. \nThis field appears only when 'adCreativeType' = 'LEAD_GEN_FORM_ID')" }, "callToActionType": { "type": "string", "description": "Call to Action Type \nThis field appears only when 'adCreativeType' = 'LEAD_GEN_FORM_ID')", "enum": [ "APPLY_NOW", "DOWNLOAD", "GET_QUOTE", "LEARN_MORE", "SIGN_UP", "SUBSCRIBE" ] } }, "required": [ "adCreativeType", "imageURL", "linkURL", "additionalField", "leadGenFormId" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_AD_CREATIVE": { "post": { "summary": "Create Ad Creative", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_CREATE_AD_CREATIVE" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : The name of the ad creative, which appears in the ad account’s library. This field is required." }, "page": { "type": "string", "description": "The Facebook Page that the creative will be uploaded for" }, "adCreativeJson": { "type": "object", "description": "Ad Creative JSON : Use the Build Ad Creative Object step to generate an object to use as a creative. (example: \"{\n \"link_data\": {...},\n \"text_data\": {...},\n}\")", "properties": {} } }, "required": [ "name", "page", "adCreativeJson" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_LEAD_GEN_FORM": { "post": { "summary": "Create Lead Gen Form", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_CREATE_LEAD_GEN_FORM" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "page": { "type": "string", "description": "The Facebook Page that the creative will be uploaded for" }, "followUpActionText": { "type": "string", "description": "Follow Up Action Text : The displayed label on the follow up action when the user completes the form." }, "followUpActionUrl": { "type": "string", "description": "Follow-up Action URL : Set a destination for the Follow Up Action Text when clicked." }, "privacyPolicyUrl": { "type": "string", "description": "Privacy Policy URL : Set a destination for the Privacy Policy." }, "contextCard": { "type": "object", "description": "Form Greeting/Context Card JSON : Specify a context card to be included at the beginning of this form, using the LeadGenContextCard (https://github.com/nmggithub/fbsdk-ts/blob/master/src/graph-api/types.ts#L2387-L2400) object. (example: \"{\n \"title\": \"\",\n \"style\": \"PARAGRAPH_STYLE\",\n \"content\": {}\n}\")", "properties": {} }, "questionJson": { "type": "object", "description": "Questions JSON : Specify questions to be included in this form, using the LeadGenQuestion (https://developers.facebook.com/docs/marketing-api/guides/lead-ads/create#adding_questions) object. (example: \"[\n { \"type\": \"EMAIL\" },\n { \"type\": \"CUSTOM\" }\n ]\")", "properties": {} } }, "required": [ "name", "page", "followUpActionText", "followUpActionUrl", "privacyPolicyUrl", "questionJson" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_SEND_PURCHASE_EVENT": { "post": { "summary": "Send Purchase Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_SEND_PURCHASE_EVENT" }, "parameters": { "type": "object", "properties": { "actionSource": { "type": "string", "description": "Action Source", "enum": [ "website", "chat", "app", "email", "phone_call", "system_generated", "other" ] }, "pixel": { "type": "string", "description": "The Facebook Pixel that will receive the event" }, "eventTime": { "type": "string", "description": "Event Time : Time when the event occurred (ISO 8601 timestamp). Defaults to the time of the workflow execution if left blank (example: \"2020-03-31T12:02:00Z\")" }, "eventId": { "type": "string", "description": "Event ID : Used to remove duplicates when sending the same event from more than one source." }, "eventSourceUrl": { "type": "string", "description": "Event Source URL : The URL where the event occurred. Required if the Action Source is Website." }, "customerEmail": { "type": "string", "description": "Customer Email : The email of the customer associated with the event, so they can be matched to a Facebook account and used for ads attribution and delivery optimization." }, "customerFirstName": { "type": "string", "description": "Customer first name" }, "customerLastName": { "type": "string", "description": "Customer last name" }, "customerCity": { "type": "string", "description": "Customer city" }, "customerState": { "type": "string", "description": "Customer state" }, "customerCountryCode": { "type": "string", "description": "Customer country code" }, "customerExternalId": { "type": "string", "description": "Customer External ID : A custom ID for the prospect, often referencing an ID in an external system." }, "customerClientIpAddress": { "type": "string", "description": "Customer client IP address : The IP address of the browser corresponding to the event." }, "customerClientUserAgent": { "type": "string", "description": "Customer client user agent : The user agent for the browser corresponding to the event." }, "clickId": { "type": "string", "description": "Click ID (fbc) : The Facebook click ID value stored in the _fbc browser cookie." }, "browserId": { "type": "string", "description": "Browser ID (fbc) : The Facebook browser ID value stored in the _fbp browser cookie." }, "value": { "type": "string", "description": "Value : A numeric value associated with this event. This could be a monetary value or a value in some other metric." }, "currency": { "type": "string", "description": "Currency : The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code. Example: 'USD'" }, "contentId": { "type": "string", "description": "Content ID : The content IDs associated with the event, such as product SKUs for items in an AddToCart event. Accepts an array of IDs. (example: \"['ABC123', 'XYZ789']\")" }, "contentName": { "type": "string", "description": "Content Name : The name of the page or product associated with the event. (example: \"Lettuce\")" }, "contentCategory": { "type": "string", "description": "Content Category : The category of the content associated with the event. (example: \"Grocery\")" } }, "required": [ "actionSource", "pixel" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_SEND_LEAD_EVENT": { "post": { "summary": "Send Lead Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_SEND_LEAD_EVENT" }, "parameters": { "type": "object", "properties": { "actionSource": { "type": "string", "description": "Action Source", "enum": [ "website", "chat", "app", "email", "phone_call", "system_generated", "other" ] }, "pixel": { "type": "string", "description": "The Facebook Pixel that will receive the event" }, "eventTime": { "type": "string", "description": "Event Time : Time when the event occurred (ISO 8601 timestamp). Defaults to the time of the workflow execution if left blank (example: \"2020-03-31T12:02:00Z\")" }, "eventId": { "type": "string", "description": "Event ID : Used to remove duplicates when sending the same event from more than one source." }, "eventSourceUrl": { "type": "string", "description": "Event Source URL : The URL where the event occurred. Required if the Action Source is Website." }, "customerEmail": { "type": "string", "description": "Customer Email : The email of the customer associated with the event, so they can be matched to a Facebook account and used for ads attribution and delivery optimization." }, "customerFirstName": { "type": "string", "description": "Customer first name" }, "customerLastName": { "type": "string", "description": "Customer last name" }, "customerCity": { "type": "string", "description": "Customer city" }, "customerState": { "type": "string", "description": "Customer state" }, "customerCountryCode": { "type": "string", "description": "Customer country code" }, "customerExternalId": { "type": "string", "description": "Customer External ID : A custom ID for the prospect, often referencing an ID in an external system." }, "customerClientIpAddress": { "type": "string", "description": "Customer client IP address : The IP address of the browser corresponding to the event." }, "customerClientUserAgent": { "type": "string", "description": "Customer client user agent : The user agent for the browser corresponding to the event." }, "clickId": { "type": "string", "description": "Click ID (fbc) : The Facebook click ID value stored in the _fbc browser cookie." }, "browserId": { "type": "string", "description": "Browser ID (fbc) : The Facebook browser ID value stored in the _fbp browser cookie." }, "contentId": { "type": "string", "description": "Content ID : The content IDs associated with the event, such as product SKUs for items in an AddToCart event. Accepts an array of IDs. (example: \"['ABC123', 'XYZ789']\")" }, "contentName": { "type": "string", "description": "Content Name : The name of the page or product associated with the event. (example: \"Lettuce\")" }, "contentCategory": { "type": "string", "description": "Content Category : The category of the content associated with the event. (example: \"Grocery\")" } }, "required": [ "actionSource", "pixel" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FACEBOOK_ADS_SEND_FUNNEL_EVENT": { "post": { "summary": "Send Funnel Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FACEBOOK_ADS_SEND_FUNNEL_EVENT" }, "parameters": { "type": "object", "properties": { "eventName": { "type": "string", "description": "Event Name" }, "actionSource": { "type": "string", "description": "Action Source", "enum": [ "website", "chat", "app", "email", "phone_call", "system_generated", "other" ] }, "pixel": { "type": "string", "description": "The Facebook Pixel that will receive the event" }, "eventTime": { "type": "string", "description": "Event Time : Time when the event occurred (ISO 8601 timestamp). Defaults to the time of the workflow execution if left blank (example: \"2020-03-31T12:02:00Z\")" }, "eventId": { "type": "string", "description": "Event ID : Used to remove duplicates when sending the same event from more than one source." }, "eventSourceUrl": { "type": "string", "description": "Event Source URL : The URL where the event occurred. Required if the Action Source is Website." }, "customerEmail": { "type": "string", "description": "Customer Email : The email of the customer associated with the event, so they can be matched to a Facebook account and used for ads attribution and delivery optimization." }, "customerFirstName": { "type": "string", "description": "Customer first name" }, "customerLastName": { "type": "string", "description": "Customer last name" }, "customerCity": { "type": "string", "description": "Customer city" }, "customerState": { "type": "string", "description": "Customer state" }, "customerCountryCode": { "type": "string", "description": "Customer country code" }, "customerExternalId": { "type": "string", "description": "Customer External ID : A custom ID for the prospect, often referencing an ID in an external system." }, "customerClientIpAddress": { "type": "string", "description": "Customer client IP address : The IP address of the browser corresponding to the event." }, "customerClientUserAgent": { "type": "string", "description": "Customer client user agent : The user agent for the browser corresponding to the event." }, "clickId": { "type": "string", "description": "Click ID (fbc) : The Facebook click ID value stored in the _fbc browser cookie." }, "browserId": { "type": "string", "description": "Browser ID (fbc) : The Facebook browser ID value stored in the _fbp browser cookie." }, "contentId": { "type": "string", "description": "Content ID : The content IDs associated with the event, such as product SKUs for items in an AddToCart event. Accepts an array of IDs. (example: \"['ABC123', 'XYZ789']\")" }, "contentName": { "type": "string", "description": "Content Name : The name of the page or product associated with the event. (example: \"Lettuce\")" }, "contentCategory": { "type": "string", "description": "Content Category : The category of the content associated with the event. (example: \"Grocery\")" } }, "required": [ "eventName", "actionSource", "pixel" ], "x-integration": "facebookAds" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRESHDESK_CREATE_TICKET": { "post": { "summary": "Create Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRESHDESK_CREATE_TICKET" }, "parameters": { "type": "object", "properties": { "source": { "type": "string", "description": "Source : The channel through which the ticket was created. The default value is Portal. 1: Email, 2: Portal, 3: Phone, 7: Chat, 9: Feedback Widget, 10: Outbound Email", "enum": [ "1", "2", "3", "7", "9", "10" ] }, "status": { "type": "string", "description": "Status : The status of the ticket. 2: Open, 3: Pending, 4: Resolved, 5: Closed", "enum": [ "2", "3", "4", "5" ] }, "priority": { "type": "string", "description": "Priority : The priority of the ticket. 1: Low, 2: Medium, 3: High, 4: Urgent", "enum": [ "1", "2", "3", "4" ] }, "requesterId": { "type": "string", "description": "Requester ID : User ID of the requester. Required if a contact is already present." }, "subject": { "type": "string", "description": "Subject : Subject of the ticket." }, "description": { "type": "string", "description": "Description : Content of the Ticket." }, "name": { "type": "string", "description": "Name : Name of the requester. If the phone number is set and the email address is not, then the name attribute is mandatory." }, "email": { "type": "string", "description": "Email : Email address of the requester. If no contact exists a new contact will be created. At least one of Email, Phone, Twitter ID or Unique external ID is required for creating a new contact." }, "phone": { "type": "string", "description": "Phone : Phone number of the requester. If no contact exists a new contact will be created. At least one of Email, Phone, Twitter ID or Unique external ID is required for creating a new contact." }, "uniqueExternalId": { "type": "string", "description": "Unique External ID : External ID of the requester. If no contact exists a new contact will be created. At least one of Email, Phone, Twitter ID or Unique external ID is required for creating a new contact." }, "twitterId": { "type": "string", "description": "Twitter ID : Twitter handle of the requester. If no contact exists a new contact will be created. At least one of Email, Phone, Twitter ID or Unique external ID is required for creating a new contact." } }, "required": [ "source", "status", "priority", "subject", "description" ], "x-integration": "freshdesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRESHDESK_UPDATE_TICKET": { "post": { "summary": "Update Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRESHDESK_UPDATE_TICKET" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Unique ID of the Ticket." }, "source": { "type": "string", "description": "Source : The channel through which the ticket was created. The default value is Portal. 1: Email, 2: Portal, 3: Phone, 7: Chat, 9: Feedback Widget, 10: Outbound Email", "enum": [ "1", "2", "3", "7", "9", "10" ] }, "status": { "type": "string", "description": "Status : The status of the ticket. 2: Open, 3: Pending, 4: Resolved, 5: Closed", "enum": [ "2", "3", "4", "5" ] }, "priority": { "type": "string", "description": "Priority : The priority of the ticket. 1: Low, 2: Medium, 3: High, 4: Urgent", "enum": [ "1", "2", "3", "4" ] }, "requesterId": { "type": "string", "description": "Requester ID : User ID of the requester. Required if a contact is already present." }, "subject": { "type": "string", "description": "Subject : Subject of the ticket." }, "description": { "type": "string", "description": "Description : Content of the Ticket." }, "name": { "type": "string", "description": "Name : Name of the requester. If the phone number is set and the email address is not, then the name attribute is mandatory." }, "email": { "type": "string", "description": "Email : Email address of the requester. If no contact exists a new contact will be created. At least one of Email, Phone, Twitter ID or Unique external ID is required for creating a new contact." }, "phone": { "type": "string", "description": "Phone : Phone number of the requester. If no contact exists a new contact will be created. At least one of Email, Phone, Twitter ID or Unique external ID is required for creating a new contact." }, "uniqueExternalId": { "type": "string", "description": "Unique External ID : External ID of the requester. If no contact exists a new contact will be created. At least one of Email, Phone, Twitter ID or Unique external ID is required for creating a new contact." }, "twitterId": { "type": "string", "description": "Twitter ID : Twitter handle of the requester. If no contact exists a new contact will be created. At least one of Email, Phone, Twitter ID or Unique external ID is required for creating a new contact." } }, "required": [ "ticketId", "source", "status", "priority" ], "x-integration": "freshdesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRESHDESK_GET_TICKET_BY_ID": { "post": { "summary": "Get Ticket By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRESHDESK_GET_TICKET_BY_ID" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Unique ID of the Ticket." }, "embeddedFields": { "type": "string", "description": "Embedded Fields : Will return additional data like Conversations, Company, Requester, Stats.", "enum": [ "conversations", "requester", "company", "stats" ] } }, "required": [ "ticketId" ], "x-integration": "freshdesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRESHDESK_DELETE_TICKET": { "post": { "summary": "Delete Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRESHDESK_DELETE_TICKET" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Unique ID of the Ticket." } }, "required": [ "ticketId" ], "x-integration": "freshdesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_CREATE_ACCOUNT": { "post": { "summary": "Create Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_CREATE_ACCOUNT" }, "parameters": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Account Name : Name of the Account (example: \"Enter Name\")" }, "description": { "type": "string", "description": "Account Description : Description of the Account (example: \"Enter Description\")" }, "domains": { "type": "string", "description": "Domains : Add Domains (example: \"Enter Domains\")" }, "externalId": { "type": "string", "description": "External ID : ID of the Account in an external system (example: \"Enter External ID\")" }, "customFields": { "type": "object", "description": "Custom Fields : Custom field (https://dev.frontapp.com/reference/post_accounts) attributes for this account", "properties": {} } }, "required": [ "accountName" ], "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_UPDATE_ACCOUNT": { "post": { "summary": "Update Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_UPDATE_ACCOUNT" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : Specify the ID of the Account to Update. (example: \"acc_cs65p0\")" }, "accountName": { "type": "string", "description": "Account Name : Name of the Account (example: \"Enter Name\")" }, "description": { "type": "string", "description": "Account Description : Description of the Account (example: \"Enter Description\")" }, "domains": { "type": "string", "description": "Domains : Add Domains (example: \"Enter Domains\")" }, "externalId": { "type": "string", "description": "External ID : ID of the Account in an external system (example: \"Enter External ID\")" }, "customFields": { "type": "object", "description": "Custom Fields : Custom field (https://dev.frontapp.com/reference/post_accounts) attributes for this account", "properties": {} } }, "required": [ "accountId" ], "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_GET_ACCOUNT_BY_ID": { "post": { "summary": "Get Account By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_GET_ACCOUNT_BY_ID" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : Specify the ID of the Account to Retrieve. (example: \"acc_cs65p0\")" } }, "required": [ "accountId" ], "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_SEARCH_ACCOUNTS": { "post": { "summary": "Search Accounts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_SEARCH_ACCOUNTS" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "sort_by", "sort_order" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit (default 50, max 100, recommended <= 50)" }, "nextPageToken": { "type": "string", "description": "Next Page Token" } } } }, "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_DELETE_ACCOUNT": { "post": { "summary": "Delete Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_DELETE_ACCOUNT" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : Specify the ID of the Account to Delete. (example: \"acc_cs65p0\")" } }, "required": [ "accountId" ], "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_CREATE_CONTACT": { "post": { "summary": "Create Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_CREATE_CONTACT" }, "parameters": { "type": "object", "properties": { "handles": { "type": "object", "description": "Handles : Handles (https://dev.frontapp.com/reference/post_contacts) attributes for this contact (example: \"[\n {\n \"handle\": \"xyz@paragon.com\",\n \"source\": \"email\",\n },\n {\n \"handle\": \"abc@gmail.com\",\n \"source\": \"email\",\n },\n]\")", "properties": {} }, "contactName": { "type": "string", "description": "Contact Name : Name of the Contact (example: \"Enter Contact Name\")" }, "description": { "type": "string", "description": "Contact Description : Specify a description of the Contact (example: \"Enter Description\")" }, "avatar": { "type": "string", "description": "Avatar : Avatar Url (example: \"https://picsum.photos/200/300\")" }, "links": { "type": "string", "description": "Links : Add links for the contact (example: \"Enter Links\")" }, "contactListNames": { "type": "string", "description": "Contact List Names : Add contact list names for the contact (example: \"Enter Contact List Names\")" }, "customFieldsContact": { "type": "object", "description": "Custom Fields : Custom field (https://dev.frontapp.com/reference/post_contacts) attributes for this contact", "properties": {} } }, "required": [ "handles" ], "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_UPDATE_CONTACT": { "post": { "summary": "Update Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_UPDATE_CONTACT" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID : Specify the ID of the Contact to Update. (example: \"crd_37onqj8\")" }, "contactName": { "type": "string", "description": "Contact Name : Name of the Contact (example: \"Enter Contact Name\")" }, "description": { "type": "string", "description": "Contact Description : Specify a description of the Contact (example: \"Enter Description\")" }, "avatar": { "type": "string", "description": "Avatar : Avatar Url (example: \"https://picsum.photos/200/300\")" }, "links": { "type": "string", "description": "Links : Add links for the contact (example: \"Enter Links\")" }, "contactListNames": { "type": "string", "description": "Contact List Names : Add contact list names for the contact (example: \"Enter Contact List Names\")" }, "customFieldsContact": { "type": "object", "description": "Custom Fields : Custom field (https://dev.frontapp.com/reference/post_contacts) attributes for this contact", "properties": {} } }, "required": [ "contactId" ], "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_GET_CONTACT_BY_ID": { "post": { "summary": "Get Contact By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_GET_CONTACT_BY_ID" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID : Specify the ID of the Contact to Retrieve. (example: \"crd_37onqj8\")" } }, "required": [ "contactId" ], "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_SEARCH_CONTACTS": { "post": { "summary": "Search Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_SEARCH_CONTACTS" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "q[updated_after]", "q[updated_before]", "sort_by", "sort_order" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit (default 50, max 100, recommended <= 50)" }, "nextPageToken": { "type": "string", "description": "Next Page Token" } } } }, "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#FRONT_DELETE_CONTACT": { "post": { "summary": "Delete Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "FRONT_DELETE_CONTACT" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID : Specify the ID of the Contact to Delete. (example: \"crd_37onqj8\")" } }, "required": [ "contactId" ], "x-integration": "front" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_CREATE_ISSUE": { "post": { "summary": "Create Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_CREATE_ISSUE" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "title": { "type": "string", "description": "Issue Title : Specify the title of the issue to create." }, "body": { "type": "string", "description": "Issue Body : Specify the body contents of the issue to create." }, "assignees": { "type": "string", "description": "Assignees : Specify the assignee(s)' GitHub login as an array of strings for this issue. (example: \"[\"octocat\"]\")" } }, "required": [ "owner", "repo", "title" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_UPDATE_ISSUE": { "post": { "summary": "Update Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_UPDATE_ISSUE" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "issue_number": { "type": "string", "description": "Issue Number : Specify the number of the issue to update." }, "title": { "type": "string", "description": "Issue Title : Specify the title of the issue to update." }, "body": { "type": "string", "description": "Issue Body : Specify the body contents of the issue to update." }, "assignees": { "type": "string", "description": "Assignees : Specify the assignee(s)' GitHub login as an array of strings for this issue. (example: \"[\"octocat\"]\")" }, "state": { "type": "string", "description": "State : Specify the updated state of the issue.", "enum": [ "open", "closed" ] } }, "required": [ "owner", "repo", "issue_number", "title" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_GET_ISSUE_BY_NUMBER": { "post": { "summary": "Get Issue By Number", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_GET_ISSUE_BY_NUMBER" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "issue_number": { "type": "string", "description": "Issue Number : Specify the number of the issue to be fetch." } }, "required": [ "owner", "repo", "issue_number" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_LIST_ISSUE_COMMENTS": { "post": { "summary": "List Issue Comments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_LIST_ISSUE_COMMENTS" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "issue_number": { "type": "string", "description": "Issue Number : Specify the number of the issue to list conversation comments for. Pull request numbers are valid because GitHub treats PRs as issues." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "owner", "repo", "issue_number" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_LOCK_ISSUE": { "post": { "summary": "Lock Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_LOCK_ISSUE" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "issue_number": { "type": "string", "description": "Issue Number : Specify the number of the issue to lock." }, "lock_reason": { "type": "string", "description": "Lock Reason : Specify a reason for locking the issue or pull request conversation.", "enum": [ "off-topic", "too heated", "resolved", "spam" ] } }, "required": [ "owner", "repo", "issue_number", "lock_reason" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_SEARCH_ISSUE": { "post": { "summary": "Search Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_SEARCH_ISSUE" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "filter": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "assignee", "creator", "mentioned", "labels" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "required": [ "owner", "repo" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_CREATE_RELEASE": { "post": { "summary": "Create Release", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_CREATE_RELEASE" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Release. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Release." }, "tag_name": { "type": "string", "description": "Name : Specify the name of the release tag to be created. (example: \"v1.0.0\")" }, "target_commitish": { "type": "string", "description": "Target : Specify the target of the release. This can either be a branch name or a commit SHA. Defaults to the main branch. (example: \"master\")" }, "body": { "type": "string", "description": "Body : Specify a description for this release." }, "draft": { "type": "string", "description": "Draft : Specify whether the created release should be a draft (unpublished) release.", "enum": [ "true", "false" ] }, "prerelease": { "type": "string", "description": "Prerelease : Specify whether the created release should be a prerelease.", "enum": [ "true", "false" ] }, "discussion_category_name": { "type": "string", "description": "Discussion Category Name : If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository." }, "generate_release_notes": { "type": "string", "description": "Release Notes : Specify whether the created release should automatically create release notes using the provided name and body specified.", "enum": [ "true", "false" ] } }, "required": [ "owner", "repo", "tag_name" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_UPDATE_RELEASE": { "post": { "summary": "Update Release", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_UPDATE_RELEASE" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Release. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Release." }, "id": { "type": "string", "description": "Release ID : Specify the ID of the release to update." }, "tag_name": { "type": "string", "description": "Name : Specify the name of the release tag to be updated. (example: \"v1.0.0\")" }, "target_commitish": { "type": "string", "description": "Target : Specify the target of the release. This can either be a branch name or a commit SHA. Defaults to the main branch. (example: \"master\")" }, "body": { "type": "string", "description": "Body : Specify a description for this release." }, "draft": { "type": "string", "description": "Draft : Specify whether the created release should be a draft (unpublished) release.", "enum": [ "true", "false" ] }, "prerelease": { "type": "string", "description": "Prerelease : Specify whether the created release should be a prerelease.", "enum": [ "true", "false" ] }, "discussion_category_name": { "type": "string", "description": "Discussion Category Name : If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository." }, "generate_release_notes": { "type": "string", "description": "Release Notes : Specify whether the created release should automatically create release notes using the provided name and body specified.", "enum": [ "true", "false" ] } }, "required": [ "owner", "repo", "id" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_GET_RELEASE_BY_ID": { "post": { "summary": "Get Release By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_GET_RELEASE_BY_ID" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "id": { "type": "string", "description": "Release ID : Specify the release ID of the release to fetch." } }, "required": [ "owner", "repo", "id" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_GET_RELEASE_BY_TAG_NAME": { "post": { "summary": "Get Release By Tag Name", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_GET_RELEASE_BY_TAG_NAME" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "tag_name": { "type": "string", "description": "Name : Specify the tag of the release to fetch. (example: \"v1.0.0\")" } }, "required": [ "owner", "repo", "tag_name" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_DELETE_RELEASE": { "post": { "summary": "Delete Release", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_DELETE_RELEASE" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : Specify the name of the account owner of the associated repository for this Issue. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : Specify the name of the associated repository for this Issue." }, "id": { "type": "string", "description": "Release ID : Specify the ID of the release to delete." } }, "required": [ "owner", "repo", "id" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_GET_FILES_CHANGED_IN_PR": { "post": { "summary": "Get Files Changed In PR", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_GET_FILES_CHANGED_IN_PR" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : The account or organization that owns this repository. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : The name of the repository." }, "pullNumber": { "type": "string", "description": "Pull Number : The number that identifies the pull request. (example: \"127\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "perPage": { "type": "number", "description": "perPage (default 100) to limit the number of items to return" }, "page": { "type": "number", "description": "page (default 1) to paginate the results" } } } }, "required": [ "owner", "repo", "pullNumber" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_GET_PULL_REQUEST_BY_NUMBER": { "post": { "summary": "Get Pull Request By Number", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_GET_PULL_REQUEST_BY_NUMBER" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : The account or organization that owns this repository. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : The name of the repository." }, "pullNumber": { "type": "string", "description": "Pull Number : The number that identifies the pull request. (example: \"127\")" } }, "required": [ "owner", "repo", "pullNumber" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_LIST_PR_REVIEW_COMMENTS": { "post": { "summary": "List PR Review Comments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_LIST_PR_REVIEW_COMMENTS" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : The account or organization that owns this repository. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : The name of the repository." }, "pullNumber": { "type": "string", "description": "Pull Number : The number that identifies the pull request. Returns inline review comments on the diff, not conversation comments. (example: \"127\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "owner", "repo", "pullNumber" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GITHUB_GET_FILE": { "post": { "summary": "Get File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GITHUB_GET_FILE" }, "parameters": { "type": "object", "properties": { "owner": { "type": "string", "description": "Owner : The account or organization that owns the repository. (example: \"abc\")" }, "repo": { "type": "string", "description": "Repository : The name of the repository." }, "path": { "type": "string", "description": "Path : The path of the File to fetch." }, "ref": { "type": "string", "description": "Ref : The name of the commit/branch/tag. When empty, uses the repository’s default branch." } }, "required": [ "owner", "repo", "path" ], "x-integration": "github" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_SEND_EMAIL": { "post": { "summary": "Send Email", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_SEND_EMAIL" }, "parameters": { "type": "object", "properties": { "toRecipients": { "type": "array", "description": "To : Specify the recipients as either a single string or a JSON array. (example: \"[\n \"recipient1@domain.com\",\n \"recipient2@domain.com\"\n]\")", "items": { "type": "string" } }, "from": { "type": "string", "description": "From : The email address or verified alias to send your message from. If not provided, the message will be sent from the default address of your Gmail account." }, "subject": { "type": "string", "description": "Subject : Specify the subject of the message." }, "messageContent": { "type": "string", "description": "Message Content : Specify the content of the email message as plain text or HTML." }, "attachments": { "type": "object", "description": "Specify the attachments as file object", "properties": { "name": { "type": "string", "description": "Name of the file" }, "data": { "type": "string", "description": "base64-encoded data string of the file contents" }, "mimeType": { "type": "string", "description": "MIME type of the file" }, "dataType": { "type": "string", "description": "Set to FILE", "enum": [ "FILE" ] } }, "required": [ "name", "data", "mimeType", "dataType" ] }, "additionalHeaders": { "type": "object", "description": "Additional Headers : Specify any additional header fields here. (example: \"{\n \"reply-to\": \"Sender Name \",\n}\")", "properties": {} } }, "required": [ "toRecipients", "subject", "messageContent" ], "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_GET_EMAIL_BY_ID": { "post": { "summary": "Get Email By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_GET_EMAIL_BY_ID" }, "parameters": { "type": "object", "properties": { "messageId": { "type": "string", "description": "Message ID : Specify the ID of the message to retrieve." }, "userId": { "type": "string", "description": "User ID : Specify the user’s email address. If not provided, the current user will be used. (example: \"user@domain.com\")" } }, "required": [ "messageId" ], "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_SEARCH_FOR_EMAIL": { "post": { "summary": "Search For Email", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_SEARCH_FOR_EMAIL" }, "parameters": { "type": "object", "properties": { "emailFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "from", "to", "date", "label", "subject", "cc", "bcc", "category", "deliveredto:", "size", "filename", "older_than", "newer_than", "list", "is:important", "is:unread", "is:snoozed", "is:starred", "is:read", "has:drive", "has:document", "has:spreadsheet", "has:presentation", "has:attachment", "has:youtube", "has:userlabels" ] }, "operator": { "type": "string", "enum": [ "$stringContains", "$stringIsIn", "$stringDoesNotContain", "$stringExactlyMatches", "$dateTimeAfter", "$dateTimeBefore", "$booleanFalse", "$booleanTrue" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_DELETE_EMAIL": { "post": { "summary": "Delete Email", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_DELETE_EMAIL" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : Specify the user’s email address. (example: \"user@domain.com\")" }, "messageId": { "type": "string", "description": "Message ID : Specify the ID of the message to trash." } }, "required": [ "userId", "messageId" ], "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_CREATE_A_CONTACT": { "post": { "summary": "Create A Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_CREATE_A_CONTACT" }, "parameters": { "type": "object", "properties": { "givenName": { "type": "string", "description": "Given Name : Specify the Given Name of the Contact to create. (example: \"John\")" }, "familyName": { "type": "string", "description": "Family Name : Specify the Family Name of the Contact to create. (example: \"Doe\")" }, "email": { "type": "string", "description": "Email : Specify the Email Address of the Contact to create." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this Contact as JSON. For example, you may specify an address here. See the docs (https://developers.google.com/people/api/rest/v1/people/createContact) for available fields. (example: \"{\n \"addresses\": [\n {\n \"streetAddress\": \"1000 North St.\",\n \"city\": \"Los Angeles\"\n }\n ]\n}\")", "properties": {} } }, "required": [ "givenName", "familyName", "email" ], "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_GET_CONTACT_BY_RESOURCE_NAME": { "post": { "summary": "Get Contact By Resource Name", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_GET_CONTACT_BY_RESOURCE_NAME" }, "parameters": { "type": "object", "properties": { "resourceName": { "type": "string", "description": "Resource Name : Specify the resource name of the contact to fetch." } }, "required": [ "resourceName" ], "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_SEARCH_FOR_CONTACT": { "post": { "summary": "Search For Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_SEARCH_FOR_CONTACT" }, "parameters": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Term : Specify a search term to search for near or exact matches on the names, nickNames, emailAddresses, phoneNumbers, or organizations Contact properties." } }, "required": [ "searchTerm" ], "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_DELETE_CONTACT": { "post": { "summary": "Delete Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_DELETE_CONTACT" }, "parameters": { "type": "object", "properties": { "resourceName": { "type": "string", "description": "Resource Name : Specify the resource name of the contact to delete." } }, "required": [ "resourceName" ], "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GMAIL_CREATE_DRAFT": { "post": { "summary": "Create Draft", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GMAIL_CREATE_DRAFT" }, "parameters": { "type": "object", "properties": { "toRecipients": { "type": "array", "description": "To : Specify the recipients as either a single string or a JSON array. (example: \"[\n \"recipient1@domain.com\",\n \"recipient2@domain.com\"\n]\")", "items": { "type": "string" } }, "from": { "type": "string", "description": "From : Specify the email of the sender." }, "subject": { "type": "string", "description": "Subject : Specify the subject of the message." }, "messageContent": { "type": "string", "description": "Message Content : Specify the content of the email message as plain text or HTML." }, "attachments": { "type": "object", "description": "Specify the attachments as file object", "properties": { "name": { "type": "string", "description": "Name of the file" }, "data": { "type": "string", "description": "base64-encoded data string of the file contents" }, "mimeType": { "type": "string", "description": "MIME type of the file" }, "dataType": { "type": "string", "description": "Set to FILE", "enum": [ "FILE" ] } }, "required": [ "name", "data", "mimeType", "dataType" ] }, "additionalHeaders": { "type": "object", "description": "Additional Headers : Specify any additional header fields here. (example: \"{\n \"reply-to\": \"Sender Name \",\n}\")", "properties": {} } }, "x-integration": "gmail" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GONG_ADD_CALL": { "post": { "summary": "Add Call", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GONG_ADD_CALL" }, "parameters": { "type": "object", "properties": { "actualStart": { "type": "string", "description": "Call Start Date : Accepts ISO 8601 date format. (example: \"2022-08-01T07:00:00.000Z\")" }, "clientUniqueId": { "type": "string", "description": "Client Unique ID : A call's unique identifier in the PBX or the recording system. Gong uses this identifier to prevent repeated attempts to upload the same recording. (example: \"123abc\")" }, "direction": { "type": "string", "description": "Direction", "enum": [ "Conference", "Inbound", "Outbound", "Unknown" ] }, "parties": { "type": "string", "description": "Parties : An array list of the call's participants as objects. A party must be provided for the Primary User. See the docs (https://app.gong.io/settings/api/documentation#post-/v2/callsr) to view the complete parties object reference. (example: \"[\n {\n \"emailAddress\": \"test@test.com\",\n \"name\": \"Test User\",\n \"userId\": \"7387268041252473322\"\n }\n ]\")" }, "primaryUser": { "type": "string", "description": "Primary User : The Gong internal user ID of the team member who hosted the call. (example: \"7347263041252417409\")" }, "title": { "type": "string", "description": "Title : The title of the call. This title is available in the Gong system for indexing and search. (example: \"Call with Sales\")" }, "downloadMediaUrl": { "type": "string", "description": "Download Media URL : The URL from which Gong can download the media file. Up to 1.5 GB." }, "purpose": { "type": "string", "description": "Purpose : The purpose of the call. Limit of 255 characters." }, "duration": { "type": "string", "description": "Duration : The call duration in seconds. (example: \"3600.0\")" } }, "required": [ "actualStart", "clientUniqueId", "direction", "parties", "primaryUser" ], "x-integration": "gong" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GONG_GET_CALL_BY_ID": { "post": { "summary": "Get Call By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GONG_GET_CALL_BY_ID" }, "parameters": { "type": "object", "properties": { "id": { "type": "string", "description": "Call ID : Specify Gong's unique numeric identifier for the call (up to 20 digits). (example: \"16470009016529344\")" } }, "required": [ "id" ], "x-integration": "gong" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GONG_SEARCH_CALL": { "post": { "summary": "Search Call", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GONG_SEARCH_CALL" }, "parameters": { "type": "object", "properties": { "fromDateTime": { "type": "string", "description": "Start Date : Accepts ISO 8601 date format. (example: \"2022-08-01T07:00:00.000Z\")" }, "toDateTime": { "type": "string", "description": "End Date : Accepts ISO 8601 date format. (example: \"2022-08-01T07:00:00.000Z\")" }, "includePrivateCalls": { "type": "boolean", "description": "Include Private Calls : Whether to include private calls in the search results. Defaults to false." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "fromDateTime", "toDateTime" ], "x-integration": "gong" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_CREATE_EVENT": { "post": { "summary": "Create Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_CREATE_EVENT" }, "parameters": { "type": "object", "properties": { "eventName": { "type": "string", "description": "Event name" }, "startTime": { "type": "string", "description": "Start time : Accepts Unix timestamp or ISO8601 date formats." }, "endTime": { "type": "string", "description": "End time : Defaults to one hour after the start time if left blank." }, "calendar": { "type": "string", "description": "The calendar to add the event to. Defaults to the user's primary calendar if left blank" }, "attendees": { "type": "string", "description": "Attendees : Accepts an array of email addresses or email addresses separated by commas." }, "eventLocation": { "type": "string", "description": "Event location" }, "eventDescription": { "type": "string", "description": "Event description" }, "eventId": { "type": "string", "description": "Event ID : An ID from your application to associate this event with. You can use this ID to sync updates to this event later." }, "includeMeetLink": { "type": "boolean", "description": "Include Google Meet link? : Automatically creates Google Meet conference link for this event." } }, "required": [ "eventName", "startTime" ], "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_UPDATE_EVENT": { "post": { "summary": "Update Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_UPDATE_EVENT" }, "parameters": { "type": "object", "properties": { "eventId": { "type": "string", "description": "Event ID : The ID of the event to update." }, "eventName": { "type": "string", "description": "Event name" }, "startTime": { "type": "string", "description": "Start time : Accepts Unix timestamp or ISO8601 date formats." }, "endTime": { "type": "string", "description": "End time : Defaults to one hour after the start time if left blank." }, "calendar": { "type": "string", "description": "The calendar to add the event to. Defaults to the user's primary calendar if left blank" }, "attendees": { "type": "string", "description": "Attendees : Accepts an array of email addresses or email addresses separated by commas." }, "eventLocation": { "type": "string", "description": "Event location" }, "eventDescription": { "type": "string", "description": "Event description" } }, "required": [ "eventId" ], "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_LIST_EVENTS": { "post": { "summary": "List Events", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_LIST_EVENTS" }, "parameters": { "type": "object", "properties": { "calendar": { "type": "string", "description": "The calendar to add the event to. Defaults to the user's primary calendar if left blank" }, "after": { "type": "string", "description": "After : Filters events that start after the provided date (Unix in milliseconds or ISO timestamp). (example: \"2025-04-12T10:00:00Z or 1712908800000\")" }, "before": { "type": "string", "description": "Before : Filters events that end before the provided date (Unix in milliseconds or ISO timestamp). (example: \"2025-04-12T10:00:00Z or 1712908800000\")" } }, "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_GET_EVENT_BY_ID": { "post": { "summary": "Get Event By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_GET_EVENT_BY_ID" }, "parameters": { "type": "object", "properties": { "eventId": { "type": "string", "description": "Event ID" }, "calendar": { "type": "string", "description": "The calendar to add the event to. Defaults to the user's primary calendar if left blank" } }, "required": [ "eventId" ], "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_DELETE_EVENT": { "post": { "summary": "Delete Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_DELETE_EVENT" }, "parameters": { "type": "object", "properties": { "eventId": { "type": "string", "description": "Event ID : The ID of the calendar event to be deleted." }, "calendar": { "type": "string", "description": "The calendar to add the event to. Defaults to the user's primary calendar if left blank" } }, "required": [ "eventId" ], "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_GET_CONTACTS": { "post": { "summary": "Get Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_GET_CONTACTS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_SEARCH_CONTACTS": { "post": { "summary": "Search Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_SEARCH_CONTACTS" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to search contacts" } }, "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_LIST_DIRECTORY_PEOPLE": { "post": { "summary": "List Directory People", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_LIST_DIRECTORY_PEOPLE" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_SEARCH_DIRECTORY_PEOPLE": { "post": { "summary": "Search Directory People", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_SEARCH_DIRECTORY_PEOPLE" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to search contacts" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "query" ], "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_LIST_OTHER_CONTACTS": { "post": { "summary": "List Other Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_LIST_OTHER_CONTACTS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_SEARCH_OTHER_CONTACTS": { "post": { "summary": "Search Other Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_SEARCH_OTHER_CONTACTS" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query to search contacts" } }, "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_CALENDAR_GET_AVAILABILITY": { "post": { "summary": "Get Availability", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_CALENDAR_GET_AVAILABILITY" }, "parameters": { "type": "object", "properties": { "timeMin": { "type": "string", "description": "The start of the interval. In ISO format", "format": "date" }, "timeMax": { "type": "string", "description": "The end of the interval. In ISO format", "format": "date" }, "timeZone": { "type": "string", "description": "Time zone used in the response. Optional. The default is UTC." }, "items": { "type": "array", "description": "List of calendars and/or groups to query. Defaults to the user default calendar.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The calendar or group ID." } }, "required": [ "id" ] } } }, "required": [ "timeMin", "timeMax" ], "x-integration": "googleCalendar" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_GET_FILE_BY_ID": { "post": { "summary": "Get File By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_GET_FILE_BY_ID" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : The ID of the file. (example: \"1PVW0QtmQv-829KNvV3DLbYL8WrpS4zhtPx2Ok\")" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional query parameters that should be needed in the request as JSON. Refer to the Google API docs (https://developers.google.com/drive/api/reference/rest/v3/files/get) for more. (example: \"\n {\n \"supportsAllDrives\": true\n }\")", "properties": {} }, "includeFileContents": { "type": "boolean", "description": "Include File Contents" }, "fileEncoding": { "type": "string", "description": "File Encoding (Default: raw)", "enum": [ "raw" ] } }, "required": [ "fileId" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_SAVE_FILE": { "post": { "summary": "Save File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_SAVE_FILE" }, "parameters": { "type": "object", "properties": { "file": { "type": "object", "description": "File to save to Google Drive. (example: {\n \"data\": \"48656c6c6f2c20776f726c6421\",\n \"dataType\": \"FILE\",\n \"mimeType\": \"text/plain\"\n})", "properties": {} }, "parentId": { "type": "string", "description": "The folder to save files to. Defaults to the user's root folder if left blank" }, "sharedDrive": { "type": "boolean", "description": "Shared Drive : Specify whether the upload target is a shared drive. Defaults to false." }, "filename": { "type": "string", "description": "File Name : Defaults to origin file name if left blank." }, "additionalFields": { "type": "object", "description": "Additional fields to update in JSON format. (example: {\n \"supportsAllDrives\": true\n})", "properties": {} } }, "required": [ "file" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_EXPORT_DOC": { "post": { "summary": "Export Doc", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_EXPORT_DOC" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify the ID of the File to export (example: \"2HlC2Zf57zAst33ht0MEi3WA0_ig4xVKx3-RvzkbvIfE\")" }, "mimeType": { "type": "string", "description": "MIME Type : Specify the MIME type of the file to export. Refer to the Google API docs (https://developers.google.com/drive/api/guides/ref-export-formats) for valid types. (example: \"application/pdf\")" }, "fileEncoding": { "type": "string", "description": "File Encoding (Default: raw)", "enum": [ "raw" ] } }, "required": [ "fileId", "mimeType" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_CREATE_FOLDER": { "post": { "summary": "Create Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_CREATE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderName": { "type": "string", "description": "Folder Name : Specify a name for the folder. (example: \"Folder 1\")" }, "parentId": { "type": "string", "description": "Parent ID : Specify the parent ID to create folder within the parent" } }, "required": [ "folderName" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_DELETE_FOLDER": { "post": { "summary": "Delete Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_DELETE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : The ID of the folder. (example: \"1PVW0QtmQv-829KNvV3DLbYL8WrpS4zhtPx2Ok\")" } }, "required": [ "folderId" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_GET_FOLDER_BY_ID": { "post": { "summary": "Get Folder By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_GET_FOLDER_BY_ID" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : The ID of the folder. (example: \"1PVW0QtmQv-829KNvV3DLbYL8WrpS4zhtPx2Ok\")" } }, "required": [ "folderId" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_MOVE_FOLDER": { "post": { "summary": "Move Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_MOVE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : The ID of the folder. (example: \"1PVW0QtmQv-829KNvV3DLbYL8WrpS4zhtPx2Ok\")" }, "parentId": { "type": "string", "description": "Parent ID : Specify the parent ID to move folder within the parent (example: \"1PVW0QtmQv-829KNvV3DLbYL8WrpS4zhtPx2Ok\")" } }, "required": [ "folderId", "parentId" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_LIST_FILES": { "post": { "summary": "List Files", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_LIST_FILES" }, "parameters": { "type": "object", "properties": { "includeFolders": { "type": "boolean", "description": "Include Folders" }, "parentId": { "type": "string", "description": "The folder to save files to. Defaults to the user's root folder if left blank" }, "pageSize": { "type": "string", "description": "Page Size : Specify the number of files to include on a page. Accepts values from 1 to 1000. Defaults to 100 if unspecified. (example: \"100\")" }, "includeSharedItems": { "type": "boolean", "description": "Include Shared Drive Items : Specify whether search results should include files in shared drives. Defaults to false." }, "additionalFields": { "type": "object", "description": "Additional fields to update in JSON format. (example: {\n \"supportsAllDrives\": true\n})", "properties": {} }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "includeFolders" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_SEARCH_FOLDERS": { "post": { "summary": "Search Folders", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_SEARCH_FOLDERS" }, "parameters": { "type": "object", "properties": { "parentId": { "type": "string", "description": "Parent ID : Specify the parent ID to search within the parent" }, "driveId": { "type": "string", "description": "Drive ID : Search for shared drives inside shared parents" }, "pageSize": { "type": "string", "description": "Page Size : Specify the number of folders to include on a page. Accepts values from 1 to 1000. Defaults to 100 if unspecified." }, "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name", "createdTime", "modifiedTime" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_DRIVE_DOWNLOAD_FILE": { "post": { "summary": "Download File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_DRIVE_DOWNLOAD_FILE" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File ID : Specify the ID of the File to download (example: \"1PVW0QtmQv-829KNvV3DLbYL8WrpS4zhtPx2Ok\")" }, "mimeType": { "type": "string", "description": "MIME Type : Specify the MIME type of the file to download (example: \"application/pdf\")" }, "fileEncoding": { "type": "string", "description": "File Encoding (Default: raw)", "enum": [ "raw" ] } }, "required": [ "fileId" ], "x-integration": "googledrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "This Tool will respond with a byte stream of the file data from the Google Drive API.\n \nThe `Content-Type` response header will vary based on the MIME type of the file." } } } }, "/projects/{project_id}/tools/#GOOGLE_SHEETS_GET_ROW": { "post": { "summary": "Get Row", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_SHEETS_GET_ROW" }, "parameters": { "type": "object", "properties": { "spreadsheetId": { "type": "string", "description": "The spreadsheet ID to get rows from. Defaults to using the first worksheet in the selected spreadsheet" }, "limit": { "type": "string", "description": "Limit rows : Limit the maximum number of rows to return." }, "worksheet": { "type": "string", "description": "The worksheet to get rows from. Defaults to using the first worksheet in the selected spreadsheet" }, "dateTimeRenderOption": { "type": "string", "description": "How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER." }, "majorDimension": { "type": "string", "description": "The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`." }, "range": { "type": "string", "description": "The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from." }, "valueRenderOption": { "type": "string", "description": "How values should be represented in the output. The default render option is FORMATTED_VALUE." } }, "required": [ "spreadsheetId" ], "x-integration": "googlesheets" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_SHEETS_CREATE_ROW": { "post": { "summary": "Create Row", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_SHEETS_CREATE_ROW" }, "parameters": { "type": "object", "properties": { "spreadsheetId": { "type": "string", "description": "The spreadsheet ID to create a row in. Defaults to using the first worksheet in the selected spreadsheet" }, "worksheet": { "type": "string", "description": "Worksheet : Your worksheet must have column headers." }, "additionalFields": { "type": "object", "description": "Specify fields to create this row with, as an object with keys of Column Names. (example: {\n columnName1: \"columnValue1\",\n columnName2: \"columnValue2\",\n columnName3: \"columnValue3\",\n columnName4: \"columnValue4\",\n })", "properties": {} } }, "required": [ "spreadsheetId", "worksheet", "additionalFields" ], "x-integration": "googlesheets" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GOOGLE_SHEETS_UPDATE_ROW": { "post": { "summary": "Update Row", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GOOGLE_SHEETS_UPDATE_ROW" }, "parameters": { "type": "object", "properties": { "spreadsheetId": { "type": "string", "description": "The spreadsheet to update a row in. Defaults to using the first worksheet in the selected spreadsheet" }, "worksheet": { "type": "string", "description": "Worksheet : Your worksheet must have column headers." }, "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "$stringContains", "$stringDoesNotContain", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "additionalFields": { "type": "object", "description": "Specify fields to update, as an object with keys of Column Names. (example: {\n columnName1: \"columnValue1\",\n columnName2: \"columnValue2\",\n columnName3: \"columnValue3\",\n columnName4: \"columnValue4\",\n })", "properties": {} } }, "required": [ "spreadsheetId", "worksheet", "additionalFields" ], "x-integration": "googlesheets" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_CREATE_APPLICATION": { "post": { "summary": "Create Application", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_CREATE_APPLICATION" }, "parameters": { "type": "object", "properties": { "applicationType": { "type": "string", "description": "Application Type", "enum": [ "candidate", "prospect" ] }, "jobId": { "type": "string", "description": "Job ID : The ID of the job you want to create an application for this candidate. This field is required and only available when the applicationType parameter is set to \"candidate\". Example: \"4007253006\"." }, "candidateId": { "type": "string", "description": "Candidate ID : The ID of the existing candidate for application. (example: \"4981013006\")" }, "sourceId": { "type": "string", "description": "Source ID : The ID of the source to be credited for this application (example: \"7\")" }, "referrer": { "type": "object", "description": "Referrer : An object representing the referrer (example: \"{\n \"type\": \"id\",\n \"value\": 770\n}\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this application data as JSON. For example, you may associate initial_stage_id here. See the docs (https://developers.greenhouse.io/harvest.html?shell#post-add-application-to-candidate-prospect) for available fields. (example: \"{\n \"initial_stage_id\": 2708728\n}\")", "properties": {} } }, "required": [ "applicationType", "jobId", "candidateId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_UPDATE_APPLICATION": { "post": { "summary": "Update Application", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_UPDATE_APPLICATION" }, "parameters": { "type": "object", "properties": { "applicationId": { "type": "string", "description": "Application ID : The ID of the application to update. (example: \"5077244006\")" }, "customFields": { "type": "object", "description": "Custom Fields (example: \"{ \n \"id\": 123, \n \"value\": \"some value\" \n}\")", "properties": {} }, "sourceId": { "type": "string", "description": "Source ID : The ID of the source to be credited for this application (example: \"7\")" }, "referrer": { "type": "object", "description": "Referrer : An object representing the referrer (example: \"{\n \"type\": \"id\",\n \"value\": 770\n}\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this application data as JSON. For example, you may associate initial_stage_id here. See the docs (https://developers.greenhouse.io/harvest.html?shell#post-add-application-to-candidate-prospect) for available fields. (example: \"{\n \"initial_stage_id\": 2708728\n}\")", "properties": {} } }, "required": [ "applicationId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_GET_APPLICATION_BY_ID": { "post": { "summary": "Get Application By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_GET_APPLICATION_BY_ID" }, "parameters": { "type": "object", "properties": { "applicationId": { "type": "string", "description": "Application ID : The ID of the application to retrieve. (example: \"5077244006\")" } }, "required": [ "applicationId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_DELETE_APPLICATION": { "post": { "summary": "Delete Application", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_DELETE_APPLICATION" }, "parameters": { "type": "object", "properties": { "applicationId": { "type": "string", "description": "Application ID : The ID of the application to delete. (example: \"5077244006\")" } }, "required": [ "applicationId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_CREATE_CANDIDATE": { "post": { "summary": "Create Candidate", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_CREATE_CANDIDATE" }, "parameters": { "type": "object", "properties": { "applications": { "type": "object", "description": "Applications : An array of application objects. (example: \"[\n {\n \"job_id\": 215725\n }\n]\")", "properties": {} }, "firstName": { "type": "string", "description": "First Name : The candidate’s first name" }, "lastName": { "type": "string", "description": "Last Name : The candidate’s last name" }, "title": { "type": "string", "description": "Title : The candidate’s title" }, "company": { "type": "string", "description": "Company : The candidate’s company" }, "emailAddresses": { "type": "object", "description": "Email Addresses (example: \"[\n {\n \"value\": \"john.locke+work@example.com\",\n \"type\": \"work\"\n }\n]\")", "properties": {} }, "addresses": { "type": "object", "description": "Addresses (example: \"[\n {\n \"value\": \"123 Fake St.\",\n \"type\": \"home\"\n }\n]\")", "properties": {} }, "phoneNumbers": { "type": "object", "description": "Phone Numbers (example: \"[\n {\n \"value\": \"555-1212\",\n \"type\": \"mobile\"\n }\n]\")", "properties": {} }, "websiteAddresses": { "type": "object", "description": "Website Addresses (example: \"[\n {\n \"value\": \"johnlocke.example.com\",\n \"type\": \"personal\"\n }\n]\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this candidate data as JSON. For example, you may associate tags and is_private here. See the docs (https://developers.greenhouse.io/harvest.html?shell#post-add-candidate) for available fields. (example: \"{\n \"tags\": [ \n \"Walkabout\" \n ],\n \"is_private\": false\n}\")", "properties": {} } }, "required": [ "applications", "firstName", "lastName" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_UPDATE_CANDIDATE": { "post": { "summary": "Update Candidate", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_UPDATE_CANDIDATE" }, "parameters": { "type": "object", "properties": { "candidateId": { "type": "string", "description": "Candidate ID : The ID of the candidate to update. (example: \"4981013006\")" }, "firstName": { "type": "string", "description": "First Name : The candidate’s first name" }, "lastName": { "type": "string", "description": "Last Name : The candidate’s last name" }, "title": { "type": "string", "description": "Title : The candidate’s title" }, "company": { "type": "string", "description": "Company : The candidate’s company" }, "emailAddresses": { "type": "object", "description": "Email Addresses (example: \"[\n {\n \"value\": \"john.locke+work@example.com\",\n \"type\": \"work\"\n }\n]\")", "properties": {} }, "addresses": { "type": "object", "description": "Addresses (example: \"[\n {\n \"value\": \"123 Fake St.\",\n \"type\": \"home\"\n }\n]\")", "properties": {} }, "phoneNumbers": { "type": "object", "description": "Phone Numbers (example: \"[\n {\n \"value\": \"555-1212\",\n \"type\": \"mobile\"\n }\n]\")", "properties": {} }, "websiteAddresses": { "type": "object", "description": "Website Addresses (example: \"[\n {\n \"value\": \"johnlocke.example.com\",\n \"type\": \"personal\"\n }\n]\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this candidate data as JSON. For example, you may associate tags and is_private here. See the docs (https://developers.greenhouse.io/harvest.html?shell#post-add-candidate) for available fields. (example: \"{\n \"tags\": [ \n \"Walkabout\" \n ],\n \"is_private\": false\n}\")", "properties": {} } }, "required": [ "candidateId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_GET_CANDIDIDATE_BY_ID": { "post": { "summary": "Get Candididate By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_GET_CANDIDIDATE_BY_ID" }, "parameters": { "type": "object", "properties": { "candidateId": { "type": "string", "description": "Candidate ID : The ID of the candidate to retrieve. (example: \"4981013006\")" } }, "required": [ "candidateId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_DELETE_CANDIDATE": { "post": { "summary": "Delete Candidate", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_DELETE_CANDIDATE" }, "parameters": { "type": "object", "properties": { "candidateId": { "type": "string", "description": "Candidate ID : The ID of the candidate to delete. (example: \"4981013006\")" } }, "required": [ "candidateId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_CREATE_JOB_OPENING": { "post": { "summary": "Create Job Opening", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_CREATE_JOB_OPENING" }, "parameters": { "type": "object", "properties": { "jobId": { "type": "string", "description": "Job ID : The ID of the job you want to create an application to for this candidate (example: \"4007253006\")" }, "openings": { "type": "object", "description": "Openings : This an array of hashes, which can contain an opening ID and custom fields. (example: \"[\n {\n \"opening_id\": \"abc-123\",\n \"custom_fields\": [ { \"id\": 123, \"value\": \"jacob\" } ]\n }\n]\")", "properties": {} }, "openingIds": { "type": "object", "description": "Opening IDs (example: \"[\n {\n \"opening_id\": \"1213\"\n },\n {\n \"opening_id\": null\n }\n]\")", "properties": {} }, "customFields": { "type": "object", "description": "Custom Fields (example: \"[\n {\n \"id\": 123,\n \"value\": \"jacob\"\n }\n]\")", "properties": {} } }, "required": [ "jobId", "openings" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_UPDATE_JOB_OPENING": { "post": { "summary": "Update Job Opening", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_UPDATE_JOB_OPENING" }, "parameters": { "type": "object", "properties": { "jobId": { "type": "string", "description": "Job ID : The ID of the job you want to create an application to for this candidate (example: \"4007253006\")" }, "internalOpeningId": { "type": "string", "description": "ID : The ID of the opening and this is the immutable internal id. (example: \"abc-123\")" }, "openingId": { "type": "string", "description": "Opening ID : This is a string that contains an opening_id. This may be a blank string. Changing an opening_id may re-trigger approvals. For approvals to start recruiting, this will reset approvals only if the job is in draft mode. If the job is open for hiring, these approvals will not reset. For official job approvals, this will reset approvals only if the job is open. (example: \"4007253006\")" }, "status": { "type": "string", "description": "Status", "enum": [ "open", "closed" ] }, "customFields": { "type": "object", "description": "Custom Fields (example: \"[\n {\n \"id\": 123,\n \"value\": \"jacob\"\n }\n]\")", "properties": {} } }, "required": [ "jobId", "internalOpeningId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GREENHOUSE_GET_JOB_OPENING_BY_ID": { "post": { "summary": "Get Job Opening By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GREENHOUSE_GET_JOB_OPENING_BY_ID" }, "parameters": { "type": "object", "properties": { "jobId": { "type": "string", "description": "Job ID : The ID of the job for which you want to retrieve openings. (example: \"4007253006\")" }, "internalOpeningId": { "type": "string", "description": "ID : The ID of the opening and this is the immutable internal id. (example: \"4034240006\")" } }, "required": [ "jobId", "internalOpeningId" ], "x-integration": "greenhouse" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GUSTO_CREATE_EMPLOYEE": { "post": { "summary": "Create Employee", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GUSTO_CREATE_EMPLOYEE" }, "parameters": { "type": "object", "properties": { "companyId": { "type": "string", "description": "Company ID : Specify the UUID of the Company to Create." }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "middleInitial": { "type": "string", "description": "Middle Initial" }, "dateOfBirth": { "type": "string", "description": "Date Of Birth (example: \"2022-10-01\")" }, "email": { "type": "string", "description": "Email" }, "ssn": { "type": "string", "description": "SSN (example: \"123456789\")" }, "selfOnBoarding": { "type": "string", "description": "Self Onboarding : If true, employee is expected to self-onboard. If false, payroll admin is expected to enter in the employee's onboarding information. If blank, then Self Onboarding will be false as Default", "enum": [ "false", "true" ] } }, "required": [ "companyId", "firstName", "lastName" ], "x-integration": "gusto" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GUSTO_UPDATE_EMPLOYEE": { "post": { "summary": "Update Employee", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GUSTO_UPDATE_EMPLOYEE" }, "parameters": { "type": "object", "properties": { "employeeId": { "type": "string", "description": "Employee ID : Specify the UUID of the Employee to Update." }, "version": { "type": "string", "description": "Version : The current version of the object. See the versioning guide (https://docs.gusto.com/embedded-payroll/docs/api-versioning) for information on how to use this field." }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "middleInitial": { "type": "string", "description": "Middle Initial" }, "dateOfBirth": { "type": "string", "description": "Date Of Birth (example: \"2022-10-01\")" }, "email": { "type": "string", "description": "Email" }, "ssn": { "type": "string", "description": "SSN (example: \"123456789\")" } }, "required": [ "employeeId", "version" ], "x-integration": "gusto" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GUSTO_GET_EMPLOYEE_BY_ID": { "post": { "summary": "Get Employee By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GUSTO_GET_EMPLOYEE_BY_ID" }, "parameters": { "type": "object", "properties": { "employeeId": { "type": "string", "description": "Employee ID : Specify the UUID of the Employee to Get." }, "include": { "type": "string", "description": "Include : Include the requested attribute(s) in each employee response, multiple options are comma separated.", "enum": [ "all_compensations", "custom_fields" ] } }, "required": [ "employeeId" ], "x-integration": "gusto" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#GUSTO_GET_EMPLOYEE_DIRECTORY": { "post": { "summary": "Get Employee Directory", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "GUSTO_GET_EMPLOYEE_DIRECTORY" }, "parameters": { "type": "object", "properties": { "companyId": { "type": "string", "description": "Company ID : Specify the UUID of the Company to Get." }, "include": { "type": "string", "description": "Include : Include the requested attribute(s) in each employee response, multiple options are comma separated.", "enum": [ "all_compensations", "custom_fields" ] }, "terminated": { "type": "string", "description": "Terminated : Filters Terminated employees. If blank, then Terminated will be false as Default", "enum": [ "false", "true" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageNo": { "type": "number", "description": "Page Number" } } } }, "required": [ "companyId" ], "x-integration": "gusto" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_CREATE_RECORD_COMPANIES": { "post": { "summary": "Create Record Companies", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_CREATE_RECORD_COMPANIES" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "domain": { "type": "string", "description": "Company Domain Name" }, "hubspot_owner_id": { "type": "string", "description": "Company Owner : The HubSpot user who is assigned to this Company. Use Connect Portal Workflow Settings to allow users to select an Owner. (example: \"{{settings.owner}}\")" }, "lifecyclestage": { "type": "string", "description": "Lifecycle Stage : Defaults to the user’s first Lifecycle Stage if not provided. Use Connect Portal Workflow Settings to allow users to select a Lifecycle Stage. (example: \"{{settings.lifecycleStage}}\")" }, "hs_lead_status": { "type": "string", "description": "Lead Status : Defaults to the user’s first Lead Status if not provided. Use Connect Portal Workflow Settings to allow users to select a Lead Status. (example: \"{{settings.leadStatus}}\")" }, "phone": { "type": "string", "description": "Phone Number" }, "numberofemployees": { "type": "string", "description": "Number of Employees" }, "annualrevenue": { "type": "string", "description": "Annual Revenue" }, "description": { "type": "string", "description": "Description" }, "additionalFieldsJSON": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")" } }, "required": [ "name" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_CREATE_RECORD_CONTACTS": { "post": { "summary": "Create Record Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_CREATE_RECORD_CONTACTS" }, "parameters": { "type": "object", "properties": { "email": { "type": "string", "description": "Email" }, "firstname": { "type": "string", "description": "First Name" }, "lastname": { "type": "string", "description": "Last Name" }, "jobtitle": { "type": "string", "description": "Job Title" }, "company": { "type": "string", "description": "Company Name" }, "hubspot_owner_id": { "type": "string", "description": "Contact Owner : The HubSpot user who is assigned to this contact. Use Connect Portal Workflow Settings to allow users to select an Owner. (example: \"{{settings.owner}}\")" }, "lifecyclestage": { "type": "string", "description": "Lifecycle Stage : Defaults to the user’s first Lifecycle Stage if not provided. Use Connect Portal Workflow Settings to allow users to select a Lifecycle Stage. (example: \"{{settings.lifecycleStage}}\")" }, "hs_lead_status": { "type": "string", "description": "Lead Status : Defaults to the user’s first Lead Status if not provided. Use Connect Portal Workflow Settings to allow users to select a Lead Status. (example: \"{{settings.leadStatus}}\")" }, "additionalFieldsJSON": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")" } }, "required": [ "email" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_CREATE_RECORD_DEALS": { "post": { "summary": "Create Record Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_CREATE_RECORD_DEALS" }, "parameters": { "type": "object", "properties": { "dealname": { "type": "string", "description": "Name" }, "amount": { "type": "string", "description": "Deal Amount" }, "hubspot_owner_id": { "type": "string", "description": "Deal Owner : The HubSpot user who is assigned to this Deal. Use Connect Portal Workflow Settings to allow users to select an Owner. (example: \"{{settings.owner}}\")" }, "dealstage": { "type": "string", "description": "Deal Stage : Defaults to the user’s first Deal Stage if not provided. Use Connect Portal Workflow Settings to allow users to select a Deal Stage." }, "description": { "type": "string", "description": "Description" }, "closedate": { "type": "string", "description": "Close Date" }, "hs_next_step": { "type": "string", "description": "Next Step" }, "additionalFieldsJSON": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")" } }, "required": [ "dealname" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_CREATE_RECORD_ENGAGEMENTS": { "post": { "summary": "Create Record Engagements", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_CREATE_RECORD_ENGAGEMENTS" }, "parameters": { "type": "object", "properties": { "engagementType": { "type": "string", "description": "Type", "enum": [ "NOTE", "EMAIL", "CALL", "MEETING", "TASK" ] }, "noteBody": { "type": "string", "description": "Note : The body of the note. \nThis field appears only when 'engagementType' = 'NOTE')" }, "fromEmail": { "type": "string", "description": "From email : Email address of the sender. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "fromFirstName": { "type": "string", "description": "From first name : First name of the sender. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "fromLastName": { "type": "string", "description": "From last name : Last name of the sender. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "toEmail": { "type": "string", "description": "To email : Email address of the recipient. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "ccEmail": { "type": "string", "description": "CC emails : Array of email addresses for anyone cc’d on the email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "bccEmail": { "type": "string", "description": "BCC emails : Array of email addresses for anyone bcc’d on the email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "emailSubject": { "type": "string", "description": "Subject : Subject of the email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "emailText": { "type": "string", "description": "Text : Body of the text-only email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "emailHtml": { "type": "string", "description": "HTML : Body of the HTML email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "toNumber": { "type": "string", "description": "To number : The phone number that was called. \nThis field appears only when 'engagementType' = 'CALL')" }, "fromNumber": { "type": "string", "description": "From number : The phone number that was used as the from number. \nThis field appears only when 'engagementType' = 'CALL')" }, "callNotes": { "type": "string", "description": "Body : Details or notes of the call. \nThis field appears only when 'engagementType' = 'CALL')" }, "recordingUrl": { "type": "string", "description": "Recording URL : The URL of the call recording. \nThis field appears only when 'engagementType' = 'CALL')" }, "meetingTitle": { "type": "string", "description": "Title : Title or subject of the meeting. \nThis field appears only when 'engagementType' = 'MEETING')" }, "meetingNotes": { "type": "string", "description": "Body : Details or notes of the meeting. \nThis field appears only when 'engagementType' = 'MEETING')" }, "startTime": { "type": "string", "description": "Start time : Start time of the meeting (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\") \nThis field appears only when 'engagementType' = 'MEETING')" }, "endTime": { "type": "string", "description": "End time : End time of the meeting (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\") \nThis field appears only when 'engagementType' = 'MEETING')" }, "taskSubject": { "type": "string", "description": "Subject : Title or subject of the task. \nThis field appears only when 'engagementType' = 'TASK')" }, "taskNotes": { "type": "string", "description": "Body : Details or notes of the task. \nThis field appears only when 'engagementType' = 'TASK')" }, "taskStatus": { "type": "string", "description": "Status \nThis field appears only when 'engagementType' = 'TASK')", "enum": [ "NOT_STARTED", "COMPLETED", "IN_PROGRESS", "WAITING", "DEFERRED" ] }, "contactId": { "type": "string", "description": "Contact ID : ID of the Contact the Engagement is related to." }, "companyId": { "type": "string", "description": "Company ID : ID of the Company the Engagement is related to." }, "ownerId": { "type": "string", "description": "Owner ID : ID of the owner of the Engagement." } }, "required": [ "engagementType" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_CREATE_RECORD_ANY": { "post": { "summary": "Create Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_CREATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_UPDATE_RECORD_COMPANIES": { "post": { "summary": "Update Record Companies", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_UPDATE_RECORD_COMPANIES" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" }, "name": { "type": "string", "description": "Name" }, "domain": { "type": "string", "description": "Company Domain Name" }, "hubspot_owner_id": { "type": "string", "description": "Company Owner : The HubSpot user who is assigned to this Company. Use Connect Portal Workflow Settings to allow users to select an Owner. (example: \"{{settings.owner}}\")" }, "lifecyclestage": { "type": "string", "description": "Lifecycle Stage : Defaults to the user’s first Lifecycle Stage if not provided. Use Connect Portal Workflow Settings to allow users to select a Lifecycle Stage. (example: \"{{settings.lifecycleStage}}\")" }, "hs_lead_status": { "type": "string", "description": "Lead Status : Defaults to the user’s first Lead Status if not provided. Use Connect Portal Workflow Settings to allow users to select a Lead Status. (example: \"{{settings.leadStatus}}\")" }, "phone": { "type": "string", "description": "Phone Number" }, "numberofemployees": { "type": "string", "description": "Number of Employees" }, "annualrevenue": { "type": "string", "description": "Annual Revenue" }, "description": { "type": "string", "description": "Description" }, "additionalFieldsJSON": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_UPDATE_RECORD_CONTACTS": { "post": { "summary": "Update Record Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_UPDATE_RECORD_CONTACTS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" }, "email": { "type": "string", "description": "Email" }, "firstname": { "type": "string", "description": "First Name" }, "lastname": { "type": "string", "description": "Last Name" }, "jobtitle": { "type": "string", "description": "Job Title" }, "company": { "type": "string", "description": "Company Name" }, "hubspot_owner_id": { "type": "string", "description": "Contact Owner : The HubSpot user who is assigned to this contact. Use Connect Portal Workflow Settings to allow users to select an Owner. (example: \"{{settings.owner}}\")" }, "lifecyclestage": { "type": "string", "description": "Lifecycle Stage : Defaults to the user’s first Lifecycle Stage if not provided. Use Connect Portal Workflow Settings to allow users to select a Lifecycle Stage. (example: \"{{settings.lifecycleStage}}\")" }, "hs_lead_status": { "type": "string", "description": "Lead Status : Defaults to the user’s first Lead Status if not provided. Use Connect Portal Workflow Settings to allow users to select a Lead Status. (example: \"{{settings.leadStatus}}\")" }, "additionalFieldsJSON": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_UPDATE_RECORD_DEALS": { "post": { "summary": "Update Record Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_UPDATE_RECORD_DEALS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" }, "dealname": { "type": "string", "description": "Name" }, "amount": { "type": "string", "description": "Deal Amount" }, "hubspot_owner_id": { "type": "string", "description": "Deal Owner : The HubSpot user who is assigned to this Deal. Use Connect Portal Workflow Settings to allow users to select an Owner. (example: \"{{settings.owner}}\")" }, "dealstage": { "type": "string", "description": "Deal Stage : Defaults to the user’s first Deal Stage if not provided. Use Connect Portal Workflow Settings to allow users to select a Deal Stage." }, "description": { "type": "string", "description": "Description" }, "closedate": { "type": "string", "description": "Close Date" }, "hs_next_step": { "type": "string", "description": "Next Step" }, "additionalFieldsJSON": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_UPDATE_RECORD_ENGAGEMENTS": { "post": { "summary": "Update Record Engagements", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_UPDATE_RECORD_ENGAGEMENTS" }, "parameters": { "type": "object", "properties": { "engagementType": { "type": "string", "description": "Type", "enum": [ "NOTE", "EMAIL", "CALL", "MEETING", "TASK" ] }, "noteBody": { "type": "string", "description": "Note : The body of the note. \nThis field appears only when 'engagementType' = 'NOTE')" }, "fromEmail": { "type": "string", "description": "From email : Email address of the sender. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "fromFirstName": { "type": "string", "description": "From first name : First name of the sender. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "fromLastName": { "type": "string", "description": "From last name : Last name of the sender. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "toEmail": { "type": "string", "description": "To email : Email address of the recipient. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "ccEmail": { "type": "string", "description": "CC emails : Array of email addresses for anyone cc’d on the email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "bccEmail": { "type": "string", "description": "BCC emails : Array of email addresses for anyone bcc’d on the email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "emailSubject": { "type": "string", "description": "Subject : Subject of the email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "emailText": { "type": "string", "description": "Text : Body of the text-only email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "emailHtml": { "type": "string", "description": "HTML : Body of the HTML email. \nThis field appears only when 'engagementType' = 'EMAIL')" }, "toNumber": { "type": "string", "description": "To number : The phone number that was called. \nThis field appears only when 'engagementType' = 'CALL')" }, "fromNumber": { "type": "string", "description": "From number : The phone number that was used as the from number. \nThis field appears only when 'engagementType' = 'CALL')" }, "callNotes": { "type": "string", "description": "Body : Details or notes of the call. \nThis field appears only when 'engagementType' = 'CALL')" }, "recordingUrl": { "type": "string", "description": "Recording URL : The URL of the call recording. \nThis field appears only when 'engagementType' = 'CALL')" }, "meetingTitle": { "type": "string", "description": "Title : Title or subject of the meeting. \nThis field appears only when 'engagementType' = 'MEETING')" }, "meetingNotes": { "type": "string", "description": "Body : Details or notes of the meeting. \nThis field appears only when 'engagementType' = 'MEETING')" }, "startTime": { "type": "string", "description": "Start time : Start time of the meeting (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\") \nThis field appears only when 'engagementType' = 'MEETING')" }, "endTime": { "type": "string", "description": "End time : End time of the meeting (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\") \nThis field appears only when 'engagementType' = 'MEETING')" }, "taskSubject": { "type": "string", "description": "Subject : Title or subject of the task. \nThis field appears only when 'engagementType' = 'TASK')" }, "taskNotes": { "type": "string", "description": "Body : Details or notes of the task. \nThis field appears only when 'engagementType' = 'TASK')" }, "taskStatus": { "type": "string", "description": "Status \nThis field appears only when 'engagementType' = 'TASK')", "enum": [ "NOT_STARTED", "COMPLETED", "IN_PROGRESS", "WAITING", "DEFERRED" ] }, "recordId": { "type": "string", "description": "Record ID" }, "contactId": { "type": "string", "description": "Contact ID : ID of the Contact the Engagement is related to." }, "companyId": { "type": "string", "description": "Company ID : ID of the Company the Engagement is related to." }, "ownerId": { "type": "string", "description": "Owner ID : ID of the owner of the Engagement." } }, "required": [ "engagementType", "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_UPDATE_RECORD_ANY": { "post": { "summary": "Update Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_UPDATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORDS_COMPANIES": { "post": { "summary": "Get Records Companies", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORDS_COMPANIES" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORDS_CONTACTS": { "post": { "summary": "Get Records Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORDS_CONTACTS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORDS_DEALS": { "post": { "summary": "Get Records Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORDS_DEALS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORDS_ENGAGEMENTS": { "post": { "summary": "Get Records Engagements", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORDS_ENGAGEMENTS" }, "parameters": { "type": "object", "properties": { "objectName": { "type": "string", "description": "Engagements : The Name of Engagement you want to fetch. (example: \"notes\")" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "objectName" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORDS_ANY": { "post": { "summary": "Get Records Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORDS_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "recordType" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORD_BY_ID_COMPANIES": { "post": { "summary": "Get Record By ID Companies", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORD_BY_ID_COMPANIES" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORD_BY_ID_CONTACTS": { "post": { "summary": "Get Record By ID Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORD_BY_ID_CONTACTS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORD_BY_ID_DEALS": { "post": { "summary": "Get Record By ID Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORD_BY_ID_DEALS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORD_BY_ID_ENGAGEMENTS": { "post": { "summary": "Get Record By ID Engagements", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORD_BY_ID_ENGAGEMENTS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_RECORD_BY_ID_ANY": { "post": { "summary": "Get Record By ID Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_RECORD_BY_ID_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordType", "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_SEARCH_RECORDS_COMPANIES": { "post": { "summary": "Search Records Companies", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_SEARCH_RECORDS_COMPANIES" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name", "domain", "hubspot_owner_id", "lifecyclestage", "hs_lead_status", "phone", "numberofemployees", "annualrevenue", "description", "createdate", "hs_lastmodifieddate" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_SEARCH_RECORDS_CONTACTS": { "post": { "summary": "Search Records Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_SEARCH_RECORDS_CONTACTS" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "email", "firstname", "lastname", "jobtitle", "company", "hubspot_owner_id", "lifecyclestage", "hs_lead_status", "createdate", "lastmodifieddate" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_SEARCH_RECORDS_DEALS": { "post": { "summary": "Search Records Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_SEARCH_RECORDS_DEALS" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "dealname", "amount", "hubspot_owner_id", "dealstage", "description", "closedate", "hs_next_step", "createdate", "hs_lastmodifieddate" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_SEARCH_RECORDS_ENGAGEMENTS": { "post": { "summary": "Search Records Engagements", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_SEARCH_RECORDS_ENGAGEMENTS" }, "parameters": { "type": "object", "properties": { "engagementType": { "type": "string", "description": "Engagement Type", "enum": [ "CALL", "EMAIL", "MEETING", "NOTE", "TASK" ] }, "engagementTypeFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "hs_createdate", "hs_lastmodifieddate", "hs_object_id" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "engagementFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "contactIds", "companyIds", "dealIds", "ownerIds", "ticketIds" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_SEARCH_RECORDS_ANY": { "post": { "summary": "Search Records Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_SEARCH_RECORDS_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "associations.contact", "associations.company", "associations.deal", "associations.ticket", "associations.product", "associations.line_item", "associations.quote", "associations.call", "associations.email", "associations.meeting", "associations.note", "associations.task" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "recordType" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_DELETE_RECORD_COMPANIES": { "post": { "summary": "Delete Record Companies", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_DELETE_RECORD_COMPANIES" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_DELETE_RECORD_CONTACTS": { "post": { "summary": "Delete Record Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_DELETE_RECORD_CONTACTS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_DELETE_RECORD_DEALS": { "post": { "summary": "Delete Record Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_DELETE_RECORD_DEALS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_DELETE_RECORD_ENGAGEMENTS": { "post": { "summary": "Delete Record Engagements", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_DELETE_RECORD_ENGAGEMENTS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_DELETE_RECORD_ANY": { "post": { "summary": "Delete Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_DELETE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordType", "recordId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_GET_CONTACTS_BY_LIST_ID": { "post": { "summary": "Get Contacts By List ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_GET_CONTACTS_BY_LIST_ID" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "List ID : The ID of the list to get contacts from." }, "properties": { "type": "string", "description": "Properties : Comma-separated list of contact property names to include in the response (e.g. email, firstname, lastname). Leave empty to return default properties. (example: \"email, firstname, lastname\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "listId" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#HUBSPOT_DESCRIBE_ACTION_SCHEMA": { "post": { "summary": "Describe Action Schema", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "HUBSPOT_DESCRIBE_ACTION_SCHEMA" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "operation": { "type": "string", "description": "Operation Type value for example CREATE_RECORD or UPDATE_RECORD" } }, "required": [ "recordType", "operation" ], "x-integration": "hubspot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#INTERCOM_CREATE_CONTACT": { "post": { "summary": "Create Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "INTERCOM_CREATE_CONTACT" }, "parameters": { "type": "object", "properties": { "role": { "type": "string", "description": "Role", "enum": [ "user", "lead" ] }, "email": { "type": "string", "description": "Email (example: \"name@example.com\")" }, "name": { "type": "string", "description": "Name" }, "externalId": { "type": "string", "description": "External ID : A unique external identifier given to the contact (e.g. from your app) (example: \"25\")" }, "phone": { "type": "string", "description": "Phone (example: \"+1123456789\")" }, "avatar": { "type": "string", "description": "Avatar (example: \"https://example.com/avatar.jpeg\")" }, "signedUpDate": { "type": "string", "description": "Signed up at : The time specified for when a contact signed up (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "lastSeenDate": { "type": "string", "description": "Last seen at : The time when the contact was last seen (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "ownerId": { "type": "string", "description": "The Intercom Admin that has been assigned account ownership of the contact" }, "unsubscribeFromEmail": { "type": "boolean", "description": "Unsubscribed from emails : Whether the contact is unsubscribed from emails." }, "customAttribute": { "type": "object", "description": "Custom attributes (example: \"{\n\"paid_subscriber\": true,\n\"monthly_spend\": 155.5,\n\"team_mates\": 1\n}\")", "properties": {} } }, "required": [ "role", "email" ], "x-integration": "intercom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#INTERCOM_UPDATE_CONTACT": { "post": { "summary": "Update Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "INTERCOM_UPDATE_CONTACT" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID : The ID of the contact to update." }, "role": { "type": "string", "description": "Role", "enum": [ "user", "lead" ] }, "email": { "type": "string", "description": "Email (example: \"name@example.com\")" }, "name": { "type": "string", "description": "Name" }, "externalId": { "type": "string", "description": "External ID : A unique external identifier given to the contact (e.g. from your app) (example: \"25\")" }, "phone": { "type": "string", "description": "Phone (example: \"+1123456789\")" }, "avatar": { "type": "string", "description": "Avatar (example: \"https://example.com/avatar.jpeg\")" }, "signedUpDate": { "type": "string", "description": "Signed up at : The time specified for when a contact signed up (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "lastSeenDate": { "type": "string", "description": "Last seen at : The time when the contact was last seen (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "ownerId": { "type": "string", "description": "The Intercom Admin that has been assigned account ownership of the contact" }, "unsubscribeFromEmail": { "type": "boolean", "description": "Unsubscribed from emails : Whether the contact is unsubscribed from emails." }, "customAttribute": { "type": "object", "description": "Custom attributes (example: \"{\n\"paid_subscriber\": true,\n\"monthly_spend\": 155.5,\n\"team_mates\": 1\n}\")", "properties": {} } }, "required": [ "contactId" ], "x-integration": "intercom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#INTERCOM_GET_CONTACT_BY_ID": { "post": { "summary": "Get Contact By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "INTERCOM_GET_CONTACT_BY_ID" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID" } }, "required": [ "contactId" ], "x-integration": "intercom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#INTERCOM_SEARCH_CONTACTS": { "post": { "summary": "Search Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "INTERCOM_SEARCH_CONTACTS" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "external_id", "role", "email", "phone", "name", "avatar", "owner_id", "created_at", "updated_at", "last_seen_at", "signed_up_at" ] }, "operator": { "type": "string", "enum": [ "$stringContains", "$stringDoesNotContain", "$stringStartsWith", "$stringEndsWith", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberLessThan", "$numberEquals", "$numberGreaterThan", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$arrayIsIn", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "intercom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#INTERCOM_SEND_MESSAGE": { "post": { "summary": "Send Message", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "INTERCOM_SEND_MESSAGE" }, "parameters": { "type": "object", "properties": { "recipientContactType": { "type": "string", "description": "Recipient contact type", "enum": [ "user", "lead" ] }, "recepientContactId": { "type": "string", "description": "Recipient contact ID : The ID of the contact to send the message to." }, "messageType": { "type": "string", "description": "Message type", "enum": [ "inapp", "email" ] }, "fromId": { "type": "string", "description": "The Intercom Admin the message will be sent from" }, "subject": { "type": "string", "description": "Subject : Required if sending an email. (example: \"name@example.com\")" }, "body": { "type": "string", "description": "Body : The content of the message. HTML and plaintext are supported." }, "template": { "type": "string", "description": "Template : The style of the outgoing message. Required if sending an email.", "enum": [ "personal", "plain" ] } }, "required": [ "recipientContactType", "recepientContactId", "messageType", "fromId", "body" ], "x-integration": "intercom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_CREATE_ISSUE": { "post": { "summary": "Create Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_CREATE_ISSUE" }, "parameters": { "type": "object", "properties": { "summary": { "type": "string", "description": "Summary : A brief one-line summary of the issue. (example: \"The printer stopped working\")" }, "project": { "type": "string", "description": "The project which the issue belongs to. Defaults to the user's first project if not provided" }, "issueType": { "type": "string", "description": "Issue type : Defaults to Task if not provided." }, "jiraIssueStatus": { "type": "string", "description": "Status : Defaults to the project’s first status if not provided." }, "assignee": { "type": "string", "description": "Assignee : Defaults to the authenticated user if not provided." }, "descriptionType": { "type": "string", "description": "Description Type : Select the Description Type.", "enum": [ "description", "descriptionJSON" ] }, "description": { "type": "string", "description": "Description : A detailed description of the issue. \nThis field appears only when 'descriptionType' = 'description')" }, "descriptionJSON": { "type": "string", "description": "Description JSON : To use a description with formatting, specify an object in Atlassian Document Format. (https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) (example: \"{\n \"version\": 1,\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Hello\",\n \"marks\": [\n {\n \"type\": \"strong\"\n }\n ]\n }\n ]\n }\n ]\n}\") \nThis field appears only when 'descriptionType' = 'descriptionJSON')" }, "additionalFields": { "type": "object", "description": "Specify any other fields that should be included in JSON below. (example: {\"customField\": \"value\"})", "properties": {} } }, "required": [ "summary" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_UPDATE_ISSUE": { "post": { "summary": "Update Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_UPDATE_ISSUE" }, "parameters": { "type": "object", "properties": { "issueKey": { "type": "string", "description": "Issue Key (example: \"TEST-1234\")" }, "summary": { "type": "string", "description": "Summary : A brief one-line summary of the issue. (example: \"The printer stopped working\")" }, "issueType": { "type": "string", "description": "The issue type for the issue" }, "jiraIssueStatus": { "type": "string", "description": "The status for the issue" }, "assignee": { "type": "string", "description": "The assignee for the issue" }, "descriptionType": { "type": "string", "description": "Description Type : Select the Description Type.", "enum": [ "description", "descriptionJSON" ] }, "description": { "type": "string", "description": "Description : A detailed description of the issue. \nThis field appears only when 'descriptionType' = 'description')" }, "descriptionJSON": { "type": "string", "description": "Description JSON : To use a description with formatting, specify an object in Atlassian Document Format. (https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) (example: \"{\n \"version\": 1,\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Hello\",\n \"marks\": [\n {\n \"type\": \"strong\"\n }\n ]\n }\n ]\n }\n ]\n}\") \nThis field appears only when 'descriptionType' = 'descriptionJSON')" }, "additionalFields": { "type": "object", "description": "Specify any other fields that should be included in JSON below. (example: {\"customField\": \"value\"})", "properties": {} } }, "required": [ "issueKey" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_DELETE_ISSUE": { "post": { "summary": "Delete Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_DELETE_ISSUE" }, "parameters": { "type": "object", "properties": { "issueKey": { "type": "string", "description": "The issue key or ID to delete (e.g., \"PROJ-123\")" }, "deleteSubtasks": { "type": "boolean", "description": "Whether to delete subtasks along with the issue. Default: false" } }, "required": [ "issueKey" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_CREATE_COMMENT": { "post": { "summary": "Create Comment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_CREATE_COMMENT" }, "parameters": { "type": "object", "properties": { "issueKey": { "type": "string", "description": "The issue key or ID to comment on (e.g., \"PROJ-123\")" }, "body": { "type": "string", "description": "The comment body text" } }, "required": [ "issueKey", "body" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_GET_ISSUE_TRANSITIONS": { "post": { "summary": "Get Issue Transitions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_GET_ISSUE_TRANSITIONS" }, "parameters": { "type": "object", "properties": { "issueKey": { "type": "string", "description": "The issue key or ID to get available transitions for (e.g., \"PROJ-123\")" } }, "required": [ "issueKey" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_TRANSITION_ISSUE": { "post": { "summary": "Transition Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_TRANSITION_ISSUE" }, "parameters": { "type": "object", "properties": { "issueKey": { "type": "string", "description": "The issue key or ID to transition (e.g., \"PROJ-123\")" }, "transitionId": { "type": "string", "description": "The transition ID to execute. Use Get Available Issue Transitions to discover valid transition IDs." } }, "required": [ "issueKey", "transitionId" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_GET_ISSUE_BY_KEY": { "post": { "summary": "Get Issue By Key", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_GET_ISSUE_BY_KEY" }, "parameters": { "type": "object", "properties": { "issueKey": { "type": "string", "description": "Issue Key (example: \"TEST-1234\")" } }, "required": [ "issueKey" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_FILTER_ISSUES": { "post": { "summary": "Filter Issues", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_FILTER_ISSUES" }, "parameters": { "type": "object", "properties": { "jqlQuery": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringContains", "$stringDoesNotContain", "$stringGreaterThan", "$stringLessThan" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "limit": { "type": "string", "description": "Limit results : Limit the maximum number of issues to return. Defaults to 10 if left blank." } }, "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_SEARCH_BY_JQL": { "post": { "summary": "Search By JQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_SEARCH_BY_JQL" }, "parameters": { "type": "object", "properties": { "jqlQuery": { "type": "string", "description": "JQL Query (example: \"project = PROJECT\")" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (default 100)" }, "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "jqlQuery" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_UPDATE_ISSUE_ANY": { "post": { "summary": "Update Issue Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_UPDATE_ISSUE_ANY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_DESCRIBE_ACTION_SCHEMA": { "post": { "summary": "Describe Action Schema", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_DESCRIBE_ACTION_SCHEMA" }, "parameters": { "type": "object", "properties": { "issueTypeId": { "type": "string", "description": "Issue Type ID" }, "projectKey": { "type": "string", "description": "Project key" }, "operation": { "type": "string", "description": "'Operation Type value for example CREATE_ISSUE or UPDATE_ISSUE" } }, "required": [ "issueTypeId", "projectKey", "operation" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_GET_PROJECTS": { "post": { "summary": "Get Projects", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_GET_PROJECTS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters for paginated results. Defaults to the first page if not provided.", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (default 100)" }, "pageCursor": { "type": "number", "description": "The page number indicating from which page to fetch records. Starts at 0 for the first page." } } } }, "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_GET_ISSUE_TYPES_BY_PROJECT": { "post": { "summary": "Get Issue Types By Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_GET_ISSUE_TYPES_BY_PROJECT" }, "parameters": { "type": "object", "properties": { "project": { "type": "string", "description": "Project key" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters for paginated results. Defaults to the first page if not provided.", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch (default 100)" }, "pageCursor": { "type": "number", "description": "The page number indicating from which page to fetch records. Starts at 0 for the first page." } } } }, "required": [ "project" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_GET_ISSUE_TYPES": { "post": { "summary": "Get Issue Types", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_GET_ISSUE_TYPES" }, "parameters": { "type": "object", "properties": {}, "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_GET_ISSUE_STATUS_BY_PROJECT": { "post": { "summary": "Get Issue Status By Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_GET_ISSUE_STATUS_BY_PROJECT" }, "parameters": { "type": "object", "properties": { "project": { "type": "string", "description": "Project key" } }, "required": [ "project" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#JIRA_GET_ALL_ASSIGNEES_BY_PROJECT": { "post": { "summary": "Get All Assignees By Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "JIRA_GET_ALL_ASSIGNEES_BY_PROJECT" }, "parameters": { "type": "object", "properties": { "project": { "type": "string", "description": "Project key" } }, "required": [ "project" ], "x-integration": "jira" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_CREATE_CAMPAIGN": { "post": { "summary": "Create Campaign", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_CREATE_CAMPAIGN" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the list that this subscriber will be added to" }, "template": { "type": "string", "description": "The ID of the email template object that will be the content of this campaign" }, "subject": { "type": "string", "description": "Subject " }, "email": { "type": "string", "description": "The email address campaign emails will be sent from" }, "senderName": { "type": "string", "description": "The name or label associated with the email address you're sending from" }, "campaignName": { "type": "string", "description": "Campaign name " }, "smartSending": { "type": "string", "description": "Use smart sending : Limits the number of emails sent to an individual within a short period.", "enum": [ "True", "False" ] } }, "required": [ "listId", "template", "subject", "email", "senderName", "campaignName", "smartSending" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_GET_CAMPAIGN": { "post": { "summary": "Get Campaign", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_GET_CAMPAIGN" }, "parameters": { "type": "object", "properties": { "campaignName": { "type": "string", "description": "Campaign name : Only return campaigns that match the specified name." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_SEND_CAMPAIGN": { "post": { "summary": "Send Campaign", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_SEND_CAMPAIGN" }, "parameters": { "type": "object", "properties": { "campaignName": { "type": "string", "description": "The ID of the campaign that will be sent" } }, "required": [ "campaignName" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_CREATE_LIST": { "post": { "summary": "Create List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_CREATE_LIST" }, "parameters": { "type": "object", "properties": { "listName": { "type": "string", "description": "List name" } }, "required": [ "listName" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_GET_LISTS": { "post": { "summary": "Get Lists", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_GET_LISTS" }, "parameters": { "type": "object", "properties": { "listName": { "type": "string", "description": "List name : Only return lists that match the specified name." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_ADD_SUBSCRIBER_TO_LIST": { "post": { "summary": "Add Subscriber To List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_ADD_SUBSCRIBER_TO_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the list that this subscriber will be added to" }, "sendingOptions": { "type": "string", "description": "Profile Creation : Select ID to fill in Profile ID otherwise, a new profile will be created.", "enum": [ "True", "False" ] }, "profileId": { "type": "string", "description": "Profile ID \nThis field appears only when 'sendingOptions' = 'True')" }, "email": { "type": "string", "description": "Email address" }, "phoneNumber": { "type": "string", "description": "Phone number" }, "firstName": { "type": "string", "description": "First name (example: \"George\")" }, "lastName": { "type": "string", "description": "Last name (example: \"Washington\")" }, "title": { "type": "string", "description": "Title (example: \"President\")" }, "organization": { "type": "string", "description": "Organization (example: \"U.S. Government\")" }, "city": { "type": "string", "description": "City (example: \"Mount Vernon\")" }, "region": { "type": "string", "description": "Region (example: \"Virginia\")" }, "zip": { "type": "string", "description": "Zip (example: \"22121\")" }, "country": { "type": "string", "description": "Country (example: \"United States\")" }, "timezone": { "type": "string", "description": "Timezone (example: \"US/Eastern\")" }, "customProperties": { "type": "object", "description": "Custom properties (example: \"{\n\"sms_consent\": true,\n\"example_property\": \"example value\"\n}\")", "properties": {} } }, "required": [ "listId", "profileId", "email", "phoneNumber" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_GET_LIST_SUBSCRIBER": { "post": { "summary": "Get List Subscriber", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_GET_LIST_SUBSCRIBER" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the list that this subscriber will be added to" }, "emails": { "type": "string", "description": "Emails : Return subscribers with the email(s) provided. Accepts an array or comma-separated list of email addresses. " }, "phoneNumbers": { "type": "string", "description": "Phone numbers : Return subscribers with the phone number(s) provided. Accepts an array or comma-separated list of phone numbers." }, "pushTokens": { "type": "string", "description": "Push tokens : Return subscribers with the push token(s) provided. Accepts an array or comma-separated list of push tokens." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "listId" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_UNSUBSCRIBE_FROM_LIST": { "post": { "summary": "Unsubscribe From List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_UNSUBSCRIBE_FROM_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The ID of the list that this subscriber will be added to" }, "profileId": { "type": "string", "description": "Profile ID" } }, "required": [ "listId", "profileId" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_CREATE_TEMPLATE": { "post": { "summary": "Create Template", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_CREATE_TEMPLATE" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Template name " }, "html": { "type": "string", "description": "Template HTML " }, "text": { "type": "string", "description": "Text : The plaintext version of the template" } }, "required": [ "name", "html" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_GET_TEMPLATES": { "post": { "summary": "Get Templates", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_GET_TEMPLATES" }, "parameters": { "type": "object", "properties": { "templateName": { "type": "string", "description": "Template name : Only return templates that match the specified name." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_GET_PROFILE": { "post": { "summary": "Get Profile", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_GET_PROFILE" }, "parameters": { "type": "object", "properties": { "personId": { "type": "string", "description": "Person ID : The ID of the person whose profile will be retrieved." } }, "required": [ "personId" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_UPDATE_PROFILE": { "post": { "summary": "Update Profile", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_UPDATE_PROFILE" }, "parameters": { "type": "object", "properties": { "personId": { "type": "string", "description": "Person ID : The ID of the person whose profile will be retrieved." }, "email": { "type": "string", "description": "Email address" }, "phoneNumber": { "type": "string", "description": "Phone number" }, "firstName": { "type": "string", "description": "First name (example: \"George\")" }, "lastName": { "type": "string", "description": "Last name (example: \"Washington\")" }, "title": { "type": "string", "description": "Title (example: \"President\")" }, "organization": { "type": "string", "description": "Organization (example: \"U.S. Government\")" }, "city": { "type": "string", "description": "City (example: \"Mount Vernon\")" }, "region": { "type": "string", "description": "Region (example: \"Virginia\")" }, "zip": { "type": "string", "description": "Zip (example: \"22121\")" }, "country": { "type": "string", "description": "Country (example: \"United States\")" }, "timezone": { "type": "string", "description": "Timezone (example: \"US/Eastern\")" }, "customProperties": { "type": "object", "description": "Custom properties (example: \"{\n\"sms_consent\": true,\n\"example_property\": \"example value\"\n}\")", "properties": {} } }, "required": [ "personId", "email", "phoneNumber" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_GET_SEGEMENTS": { "post": { "summary": "Get Segements", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_GET_SEGEMENTS" }, "parameters": { "type": "object", "properties": { "segmentName": { "type": "string", "description": "Segment name : Only return segments that match the specified name." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#KLAVIYO_GET_SEGMENT_SUBSCRIBERS": { "post": { "summary": "Get Segment Subscribers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "KLAVIYO_GET_SEGMENT_SUBSCRIBERS" }, "parameters": { "type": "object", "properties": { "segmentId": { "type": "string", "description": "Segment ID : The ID of the Segment whose subscribers to segments." }, "emails": { "type": "string", "description": "Emails : Return subscribers with the email(s) provided. Accepts an array or comma-separated list of email addresses." }, "phoneNumbers": { "type": "string", "description": "Phone numbers : Return subscribers with the phone number(s) provided. Accepts an array or comma-separated list of phone numbers." }, "pushTokens": { "type": "string", "description": "Push tokens : Return subscribers with the push token(s) provided. Accepts an array or comma-separated list of push tokens." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "segmentId", "pushTokens" ], "x-integration": "klaviyo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_CREATE_OPPORTUNITY": { "post": { "summary": "Create Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_CREATE_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "performAs": { "type": "string", "description": "Perform As : Perform this create on behalf of a specified user. The creator and the owner of this Opportunity will default to the perform_as user. The owner can be explicitly specified in the request body if you want the owner to be a different person." }, "name": { "type": "string", "description": "Name" }, "headline": { "type": "string", "description": "Headline : Contact headline, typically a list of previous companies where the contact has worked or schools that the contact has attended This field can also be populated by parsing a provided resume file." }, "stage": { "type": "string", "description": "Stage : The stage ID of this Opportunity's current stage If omitted, the Opportunity will be placed into the \"New Lead\" stage." }, "location": { "type": "string", "description": "Location" }, "phones": { "type": "string", "description": "Phones (example: \"[{\n \"value\":\"(123) 456-7891\"\n}]\")" }, "emails": { "type": "string", "description": "Emails (example: \"[\"shane@exampleq3.com\"]\")" }, "origin": { "type": "string", "description": "Origin : The way this Opportunity was added to Lever.", "enum": [ "agency", "applied", "internal", "referred", "sourced", "university" ] }, "additionalFields": { "type": "object", "description": "Additional Fields (example: \"{\n \"archived\": {\n \"reason\": \"63dd55b2-a99f-4e7b-985f-22c7bf80ab42\"\n },\n \"postings\": [\"f2f01e16-27f8-4711-a728-7d49499795a0\"] \n}\")", "properties": {} } }, "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_GET_OPPORTUNITY_BY_ID": { "post": { "summary": "Get Opportunity By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_GET_OPPORTUNITY_BY_ID" }, "parameters": { "type": "object", "properties": { "opportunityId": { "type": "string", "description": "Opportunity ID : Specify the Opportunity ID to fetch." } }, "required": [ "opportunityId" ], "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_GET_OPPORTUNITIES": { "post": { "summary": "Get Opportunities", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_GET_OPPORTUNITIES" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageOffset": { "type": "string", "description": "Page Offset" }, "limit": { "type": "number", "description": "Limit of records to fetch" } } } }, "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_UPDATE_CONTACT": { "post": { "summary": "Update Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_UPDATE_CONTACT" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID (example: \"ac6102d2-c1cb-42a2-b8a1-5f607e0a46b4\")" }, "name": { "type": "string", "description": "Name" }, "headline": { "type": "string", "description": "Headline : Contact headline, typically a list of previous companies where the contact has worked or schools that the contact has attended This field can also be populated by parsing a provided resume file." }, "location": { "type": "string", "description": "Location" }, "emails": { "type": "string", "description": "Emails (example: \"[\"shane@exampleq3.com\"]\")" }, "phones": { "type": "string", "description": "Phones (example: \"[{\n \"type\": \"mobile\",\n \"value\": \"123-456-7890\"\n}]\")" } }, "required": [ "contactId" ], "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_GET_CONTACT_BY_ID": { "post": { "summary": "Get Contact By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_GET_CONTACT_BY_ID" }, "parameters": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Contact ID (example: \"ac6102d2-c1cb-42a2-b8a1-5f607e0a46b4\")" } }, "required": [ "contactId" ], "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_CREATE_POSTING": { "post": { "summary": "Create Posting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_CREATE_POSTING" }, "parameters": { "type": "object", "properties": { "text": { "type": "string", "description": "Text : Title of the job posting" }, "categories": { "type": "object", "description": "Categories (example: \"{\n \"team\": \"Platform\",\n \"department\": \"Engineering\",\n \"location\": \"San Francisco\",\n \"commitment\": \"Full-time\"\n}\")", "properties": {} }, "performAs": { "type": "string", "description": "Perform As : Perform this create on behalf of a specified user. The creator and the owner of this Opportunity will default to the perform_as user. The owner can be explicitly specified in the request body if you want the owner to be a different person." }, "state": { "type": "string", "description": "State : Posting's current status.", "enum": [ "published", "internal", "closed", "draft", "pending", "rejected" ] }, "distributionChannels": { "type": "string", "description": "Distribution Channels : Job sites that a published posting appears on. defaults to public and internal (example: \"[\"internal\",\"public\"]\")" }, "owner": { "type": "string", "description": "Owner : The user ID of the posting owner. The posting owner is the individual who is directly responsible for managing all candidates who are applied to that role. If no ID is provided, the posting owner defaults to perform_as." }, "hiringManager": { "type": "string", "description": "Hiring Manager : The user ID of the hiring manager for the job posting." }, "additionalFields": { "type": "object", "description": "Additional Fields (example: \"{\n \"workplaceType\": \"onsite\",\n \"tags\": [\"engineering\",\"high-priority\"]\n}\")", "properties": {} } }, "required": [ "text", "categories" ], "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_UPDATE_POSTING": { "post": { "summary": "Update Posting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_UPDATE_POSTING" }, "parameters": { "type": "object", "properties": { "postingId": { "type": "string", "description": "Posting ID" }, "text": { "type": "string", "description": "Text : Title of the job posting" }, "categories": { "type": "object", "description": "Categories (example: \"{\n \"team\": \"Platform\",\n \"department\": \"Engineering\",\n \"location\": \"San Francisco\",\n \"commitment\": \"Full-time\"\n}\")", "properties": {} }, "performAs": { "type": "string", "description": "Perform As : Perform this create on behalf of a specified user. The creator and the owner of this Opportunity will default to the perform_as user. The owner can be explicitly specified in the request body if you want the owner to be a different person." }, "state": { "type": "string", "description": "State : Posting's current status.", "enum": [ "published", "internal", "closed", "draft", "pending", "rejected" ] }, "distributionChannels": { "type": "string", "description": "Distribution Channels : Job sites that a published posting appears on. defaults to public and internal (example: \"[\"internal\",\"public\"]\")" }, "additionalFields": { "type": "object", "description": "Additional Fields (example: \"{\n \"workplaceType\": \"onsite\",\n \"tags\": [\"engineering\",\"high-priority\"]\n}\")", "properties": {} } }, "required": [ "postingId" ], "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_GET_POSTING_BY_ID": { "post": { "summary": "Get Posting By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_GET_POSTING_BY_ID" }, "parameters": { "type": "object", "properties": { "postingId": { "type": "string", "description": "Posting ID" } }, "required": [ "postingId" ], "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LEVER_GET_POSTINGS": { "post": { "summary": "Get Postings", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LEVER_GET_POSTINGS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageOffset": { "type": "string", "description": "Page Offset" }, "limit": { "type": "number", "description": "Limit of records to fetch" } } } }, "x-integration": "lever" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_CREATE_ISSUE": { "post": { "summary": "Create Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_CREATE_ISSUE" }, "parameters": { "type": "object", "properties": { "teamId": { "type": "string", "description": "Specify the team ID of the parent for this new issue" }, "title": { "type": "string", "description": "Title : Specify a title for this issue." }, "description": { "type": "string", "description": "Description : Specify a description for this issue." }, "statusId": { "type": "string", "description": "Status : Specify the state or status of this issue." }, "priority": { "type": "string", "description": "Priority : Specify the priority of this issue as an integer." }, "dueDate": { "type": "string", "description": "Due Date : Specify the due date of this issue in ISO 8601 format." }, "cycleId": { "type": "string", "description": "Cycle ID : Specify the cycle associated with this issue." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this issue as JSON. For example, you may associate an assignee or label here. See the docs (https://studio.apollographql.com/public/Linear-API/schema/reference/objects/Issue?variant=current) for available fields. (example: \"{\n assigneeId: \"a70bdf0f-530a-4887-857d-46151b52b47c\",\n labelIds: [\"a70bdf0f-530a-4887-857d-46151b52b47c\"]\n}\")", "properties": {} } }, "required": [ "teamId", "title" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_UPDATE_ISSUE": { "post": { "summary": "Update Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_UPDATE_ISSUE" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the Issue ID of the issue to update. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" }, "title": { "type": "string", "description": "Title : Specify a title for this issue." }, "description": { "type": "string", "description": "Description : Specify a description for this issue." }, "statusId": { "type": "string", "description": "Status : Specify the state or status of this issue." }, "priority": { "type": "string", "description": "Priority : Specify the priority of this issue as an integer." }, "dueDate": { "type": "string", "description": "Due Date : Specify the due date of this issue in ISO 8601 format." }, "cycleId": { "type": "string", "description": "Cycle ID : Specify the cycle associated with this issue." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this issue as JSON. For example, you may associate an assignee or label here. See the docs (https://studio.apollographql.com/public/Linear-API/schema/reference/objects/Issue?variant=current) for available fields. (example: \"{\n assigneeId: \"a70bdf0f-530a-4887-857d-46151b52b47c\",\n labelIds: [\"a70bdf0f-530a-4887-857d-46151b52b47c\"]\n}\")", "properties": {} } }, "required": [ "issueId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_CREATE_COMMENT": { "post": { "summary": "Create Comment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_CREATE_COMMENT" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the Issue ID to comment on. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" }, "body": { "type": "string", "description": "Comment Body : Specify the text content of the comment. (example: \"Investigation complete.\")" } }, "required": [ "issueId", "body" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_GET_ISSUE_COMMENTS": { "post": { "summary": "Get Issue Comments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_GET_ISSUE_COMMENTS" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the Issue ID to list comments for. Use the same Linear UUID as Create Comment. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "issueId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_GET_ISSUE_ATTACHMENTS": { "post": { "summary": "Get Issue Attachments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_GET_ISSUE_ATTACHMENTS" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the Issue ID to list attachments for, including uploaded files and linked URLs. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "issueId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_GET_ISSUE_DOCUMENTS": { "post": { "summary": "Get Issue Documents", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_GET_ISSUE_DOCUMENTS" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the Issue ID to list Linear documents for. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "issueId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_GET_STATUS_BY_TEAM": { "post": { "summary": "Get Status By Team", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_GET_STATUS_BY_TEAM" }, "parameters": { "type": "object", "properties": { "teamId": { "type": "string", "description": "Specify the team ID of the parent for this new issue" } }, "required": [ "teamId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_SET_ISSUE_STATUS": { "post": { "summary": "Set Issue Status", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_SET_ISSUE_STATUS" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the Issue ID to update the status for. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" }, "statusId": { "type": "string", "description": "Status ID : Specify the status ID to set. Use Get Statuses by Team to discover valid IDs. (example: \"a9ae25f9-01d5-40bf-b485-7d2952d2d3b4\")" } }, "required": [ "issueId", "statusId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_GET_ISSUE_BY_ID": { "post": { "summary": "Get Issue By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_GET_ISSUE_BY_ID" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the record ID of the issue to fetch. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" } }, "required": [ "issueId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_GET_ISSUE_BY_ISSUE_IDENTIFIER": { "post": { "summary": "Get Issue By Issue Identifier", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_GET_ISSUE_BY_ISSUE_IDENTIFIER" }, "parameters": { "type": "object", "properties": { "externalId": { "type": "string", "description": "External ID : Specify the human-readable Issue identifier of the issue to fetch. (example: \"ABC-1\")" } }, "required": [ "externalId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_SEARCH_ISSUE": { "post": { "summary": "Search Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_SEARCH_ISSUE" }, "parameters": { "type": "object", "properties": { "issueFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "title", "number", "project", "assignee.id", "creator.id", "createdAt", "addedToCycleAt", "addedToCyclePeriod", "ageTime", "and", "archivedAt", "assignee", "attachments", "autoArchivedAt", "autoClosedAt", "canceledAt", "children", "comments", "completedAt", "creator", "customerCount", "customerImportantCount", "cycle", "cycleTime", "delegate", "description", "dueDate", "estimate", "hasBlockedByRelations", "hasBlockingRelations", "hasDuplicateRelations", "hasRelatedRelations", "hasSuggestedAssignees", "hasSuggestedLabels", "hasSuggestedProjects", "hasSuggestedRelatedIssues", "hasSuggestedSimilarIssues", "id", "labels", "lastAppliedTemplate", "leadTime", "needs", "or", "parent", "priority", "projectMilestone", "reactions", "recurringIssueTemplate", "searchableContent", "slaStatus", "snoozedBy", "snoozedUntilAt", "sourceMetadata", "startedAt", "state", "subscribers", "suggestions", "team", "triageTime", "triagedAt", "updatedAt" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$stringContains", "$stringDoesNotContain", "$stringGreaterThan", "$stringLessThan", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$numberGreaterThan", "$numberLessThan", "$dateTimeAfter", "$dateTimeBefore" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_DELETE_ISSUE": { "post": { "summary": "Delete Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_DELETE_ISSUE" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the record ID of the issue to delete. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" } }, "required": [ "issueId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_ARCHIVE_ISSUE": { "post": { "summary": "Archive Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_ARCHIVE_ISSUE" }, "parameters": { "type": "object", "properties": { "issueId": { "type": "string", "description": "Issue ID : Specify the record ID of the issue to archive. (example: \"90fbc706-18cd-42c9-ae66-6bd344cc8977\")" } }, "required": [ "issueId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_CREATE_SUB_ISSUE": { "post": { "summary": "Create Sub Issue", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_CREATE_SUB_ISSUE" }, "parameters": { "type": "object", "properties": { "parentId": { "type": "string", "description": "Parent ID : Specify the Issue ID for the parent of this new issue." }, "teamId": { "type": "string", "description": "Specify the team ID of the parent for this new issue" }, "title": { "type": "string", "description": "Title : Specify a title for this issue." }, "description": { "type": "string", "description": "Description : Specify a description for this issue." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this project as JSON. For example, you may associate the issue with a Project Lead here. See the docs (https://studio.apollographql.com/public/Linear-API/schema/reference/objects/Project?variant=current) for available fields. (example: \"{\n lead: \n}\")", "properties": {} } }, "required": [ "parentId", "teamId", "title" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_CREATE_PROJECT": { "post": { "summary": "Create Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_CREATE_PROJECT" }, "parameters": { "type": "object", "properties": { "teamIds": { "type": "object", "description": "Specify the team ID(s) this project is associated with as a string or a JSON array. (example: [\"a70bdf0f-530a-4887-857d-46151b52b47c\", \"4ac7...\"])", "properties": {} }, "projectName": { "type": "string", "description": "Project Name : Specify the ID of the project to update. (example: \"My Linear Project\")" }, "description": { "type": "string", "description": "Project Description : Specify a description for this project." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this project as JSON. For example, you may associate the issue with a Linear Project here. See the docs (https://studio.apollographql.com/public/Linear-API/variant/current/schema/reference/objects/Mutation#issueCreate) for available fields. (example: \"{\n state: \"planned\",\n description: \"\"\n}\")", "properties": {} } }, "required": [ "teamIds", "projectName" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_UPDATE_PROJECT": { "post": { "summary": "Update Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_UPDATE_PROJECT" }, "parameters": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID : Specify the ID of the project to update. (example: \"a6634484-6061-4ac7-9739-7dc5e52c796b\")" }, "projectName": { "type": "string", "description": "Project Name : Specify the name of the project to update. (example: \"My Linear Project\")" }, "description": { "type": "string", "description": "Project Description : Specify a description for this project." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this project as JSON. For example, you may associate the issue with a Linear Project here. See the docs (https://studio.apollographql.com/public/Linear-API/variant/current/schema/reference/objects/Mutation#issueCreate) for available fields. (example: \"{\n state: \"planned\",\n description: \"\"\n}\")", "properties": {} } }, "required": [ "projectId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_GET_PROJECT_BY_ID": { "post": { "summary": "Get Project By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_GET_PROJECT_BY_ID" }, "parameters": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID : Specify the Project ID of the project to fetch. (example: \"a6634484-6061-4ac7-9739-7dc5e52c796b\")" } }, "required": [ "projectId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_DELETE_PROJECT": { "post": { "summary": "Delete Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_DELETE_PROJECT" }, "parameters": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID : Specify the Project ID of the project to delete. (example: \"a6634484-6061-4ac7-9739-7dc5e52c796b\")" } }, "required": [ "projectId" ], "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_SEARCH_PROJECTS": { "post": { "summary": "Search Projects", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_SEARCH_PROJECTS" }, "parameters": { "type": "object", "properties": { "projectFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "name", "slugId", "status.id", "status.name", "priority", "health", "createdAt", "updatedAt", "startDate", "startedAt", "targetDate", "completedAt", "canceledAt", "creator.id", "creator.name", "lead.id", "lead.name", "searchableContent", "lastAppliedTemplate.id" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$stringContains", "$stringDoesNotContain", "$stringGreaterThan", "$stringLessThan", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$numberGreaterThan", "$numberLessThan", "$dateTimeAfter", "$dateTimeBefore" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINEAR_SEARCH_TEAMS": { "post": { "summary": "Search Teams", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINEAR_SEARCH_TEAMS" }, "parameters": { "type": "object", "properties": { "teamFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "name", "and", "createdAt", "description", "issues", "key", "or", "parent", "visibility", "updatedAt" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$stringContains", "$stringDoesNotContain", "$stringGreaterThan", "$stringLessThan", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$numberGreaterThan", "$numberLessThan", "$dateTimeAfter", "$dateTimeBefore" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "linear" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINKEDIN_GET_PROFILE_BY_ID": { "post": { "summary": "Get Profile By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINKEDIN_GET_PROFILE_BY_ID" }, "parameters": { "type": "object", "properties": { "id": { "type": "string", "description": "Profile ID : Specify the ID of the profile to fetch." } }, "required": [ "id" ], "x-integration": "linkedin" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#LINKEDIN_CREATE_POST": { "post": { "summary": "Create Post", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "LINKEDIN_CREATE_POST" }, "parameters": { "type": "object", "properties": { "author": { "type": "string", "description": "Author : Specify the Author who is creating the post. (example: \"person:-OLWJgnReo\")" }, "lifecycleState": { "type": "string", "description": "Life Cycle State : Specify the state of the post, you can use \"PUBLISHED\" to make it visible to others.", "enum": [ "PUBLISHED", "DRAFT" ] }, "text": { "type": "string", "description": "Text : Specify the text of the post." }, "visibility": { "type": "string", "description": "Visibility : Specify the visibility of the post.", "enum": [ "CONNECTIONS", "PUBLIC" ] } }, "required": [ "author", "lifecycleState", "text", "visibility" ], "x-integration": "linkedin" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MARKETO_CREATE_OR_UPDATE_LEAD": { "post": { "summary": "Create Or Update Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MARKETO_CREATE_OR_UPDATE_LEAD" }, "parameters": { "type": "object", "properties": { "email": { "type": "string", "description": "Email : If there already exists a lead with this email, it will be updated." }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "company": { "type": "string", "description": "Company" }, "title": { "type": "string", "description": "Title" }, "phone": { "type": "string", "description": "Phone" }, "website": { "type": "string", "description": "Website" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. (example: \"{\n\"property_number\": \"17\",\n\"property_dropdown\": \"choice_b\",\n\"property_radio\": \"option_1\",\n\"property_string\": \"value\",\n\"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "email" ], "x-integration": "marketo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MARKETO_GET_LEADS": { "post": { "summary": "Get Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MARKETO_GET_LEADS" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "string", "description": "Filter leads based on the marketo filter formula. For example filterType=department&filterValues=val1,val2" } }, "x-integration": "marketo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MARKETO_GET_LEAD_BY_ID": { "post": { "summary": "Get Lead By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MARKETO_GET_LEAD_BY_ID" }, "parameters": { "type": "object", "properties": { "leadId": { "type": "string", "description": "Lead ID" } }, "required": [ "leadId" ], "x-integration": "marketo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MARKETO_ADD_LEADS_TO_LIST": { "post": { "summary": "Add Leads To List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MARKETO_ADD_LEADS_TO_LIST" }, "parameters": { "type": "object", "properties": { "leadIds": { "type": "string", "description": "Lead IDs : IDs of leads to be added to the List (up to 300). You can enter a single ID or an array of IDs." }, "listId": { "type": "string", "description": "Specify the List ID that the lead(s) should be added to" } }, "required": [ "leadIds" ], "x-integration": "marketo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MARKETO_CREATE_CUSTOM_OBJECT": { "post": { "summary": "Create Custom Object", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MARKETO_CREATE_CUSTOM_OBJECT" }, "parameters": { "type": "object", "properties": { "customObjectName": { "type": "string", "description": "Specify the API Name of the Object to create" }, "recordFields": { "type": "object", "description": "Specify which fields to update for the Custom Object (example: {\"property_number\": \"17\", \"property_string\": \"value\"})", "properties": {} } }, "required": [ "customObjectName", "recordFields" ], "x-integration": "marketo" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_CREATE_CAMPAIGN": { "post": { "summary": "Create Campaign", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_CREATE_CAMPAIGN" }, "parameters": { "type": "object", "properties": { "title": { "type": "string", "description": "Title : The title to describe this campaign in your Mailchimp account." }, "listId": { "type": "string", "description": "Specify the list ID to send this campaign to" }, "fromName": { "type": "string", "description": "From Name : The “From” name for this campaign (not an email address)." }, "replyTo": { "type": "string", "description": "Reply-To Email Address : The reply-to address for the email sent with this campaign." }, "subjectLine": { "type": "string", "description": "Subject Line : The subject line to be used in the email sent with this campaign." }, "previewText": { "type": "string", "description": "Preview Text : The preview text for the email of this campaign." }, "templateId": { "type": "string", "description": "Specify the template to use in the email for this campaign" } }, "required": [ "listId" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_UPDATE_CAMPAIGN": { "post": { "summary": "Update Campaign", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_UPDATE_CAMPAIGN" }, "parameters": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "Campaign ID : The ID of the campaign to update." }, "title": { "type": "string", "description": "Title : The title to describe this campaign in your Mailchimp account." }, "listId": { "type": "string", "description": "Specify the list ID to send this campaign to" }, "fromName": { "type": "string", "description": "From Name : The “From” name for this campaign (not an email address)." }, "replyTo": { "type": "string", "description": "Reply-To Email Address : The reply-to address for the email sent with this campaign." }, "subjectLine": { "type": "string", "description": "Subject Line : The subject line to be used in the email sent with this campaign." }, "previewText": { "type": "string", "description": "Preview Text : The preview text for the email of this campaign." }, "templateId": { "type": "string", "description": "Specify the template to use in the email for this campaign" } }, "required": [ "campaignId" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_SEND_CAMPAIGN": { "post": { "summary": "Send Campaign", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_SEND_CAMPAIGN" }, "parameters": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "Campaign ID : The ID of the campaign to send." } }, "required": [ "campaignId" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_SEARCH_CAMPAIGNS": { "post": { "summary": "Search Campaigns", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_SEARCH_CAMPAIGNS" }, "parameters": { "type": "object", "properties": { "campaignFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "CAMPAIGN_CREATION_DATE", "CAMPAIGN_SENT_DATE", "list_id", "folder_id", "member_id" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "count": { "type": "number", "description": "Count of records to fetch per page default is 100" }, "offset": { "type": "number", "description": "Offset of records to fetch default 0" } } } }, "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_GET_CAMPAIGN_BY_ID": { "post": { "summary": "Get Campaign By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_GET_CAMPAIGN_BY_ID" }, "parameters": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "Campaign ID : The ID of the campaign to get." } }, "required": [ "campaignId" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_DELETE_CAMPAIGN_BY_ID": { "post": { "summary": "Delete Campaign By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_DELETE_CAMPAIGN_BY_ID" }, "parameters": { "type": "object", "properties": { "campaignId": { "type": "string", "description": "Campaign ID : The ID of the campaign to delete." } }, "required": [ "campaignId" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_CREATE_LIST": { "post": { "summary": "Create List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_CREATE_LIST" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : The name for the list in your Mailchimp account." }, "fromName": { "type": "string", "description": "From Name : The default From Name for campaigns sent to this list." }, "fromEmail": { "type": "string", "description": "From Email : The default From Email for campaigns sent to this list." }, "defaultSubject": { "type": "string", "description": "Default Subject : The default subject line for campaigns sent to this list." }, "language": { "type": "string", "description": "Language : The default language for campaigns sent to this list." }, "permissionReminder": { "type": "string", "description": "Permission Reminder : A description for explaining how contacts got added to this list." }, "companyName": { "type": "string", "description": "Company Name : Part of required contact information displayed in campaign footers." }, "streetAddress": { "type": "string", "description": "Street Address : Part of required contact information displayed in campaign footers." }, "city": { "type": "string", "description": "City : Part of required contact information displayed in campaign footers." }, "state": { "type": "string", "description": "State : Part of required contact information displayed in campaign footers." }, "zip": { "type": "string", "description": "Zip Code : Part of required contact information displayed in campaign footers." }, "countryCode": { "type": "string", "description": "Country Code : Part of required contact information displayed in campaign footers. Defaults to US." } }, "required": [ "name", "fromName", "fromEmail", "defaultSubject", "language", "permissionReminder", "companyName", "streetAddress", "city", "state", "zip", "countryCode" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_GET_LIST_BY_ID": { "post": { "summary": "Get List By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_GET_LIST_BY_ID" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "Specify the list ID to send this campaign to" } }, "required": [ "listId" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_SEARCH_LISTS": { "post": { "summary": "Search Lists", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_SEARCH_LISTS" }, "parameters": { "type": "object", "properties": { "listFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "email", "LIST_CREATE_DATE", "LIST_CAMPAIGN_DATE" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "count": { "type": "number", "description": "Count of records to fetch per page default is 100" }, "offset": { "type": "number", "description": "Offset of records to fetch default 0" } } } }, "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_ADD_CONTACT_TO_LIST": { "post": { "summary": "Add Contact To List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_ADD_CONTACT_TO_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "List ID : The ID of the list to add a contact to." }, "emailAddress": { "type": "string", "description": "Email Address" }, "contactStatus": { "type": "string", "description": "Status : Select a status for the new contact. Defaults to Subscribed.", "enum": [ "subscribed", "cleaned", "pending", "transactional" ] }, "contactMergeFields": { "type": "object", "description": "Merge Fields : A dictionary of merge fields, where keys are the merge tags. See Mailchimp documentation (https://mailchimp.com/en-gb/help/all-the-merge-tags-cheat-sheet/) for available default merge tags. (example: \"{\n \"FNAME\": \"Brandon\",\n \"LNAME\": \"Foo\"\n}\")", "properties": {} } }, "required": [ "listId", "emailAddress" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_UPDATE_CONTACT_TO_LIST": { "post": { "summary": "Update Contact To List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_UPDATE_CONTACT_TO_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "List ID : The ID of the list to add a contact to." }, "listContact": { "type": "string", "description": "Email Address or Contact ID : The email address or contact ID of the contact to update." }, "emailAddress": { "type": "string", "description": "Update Email Address : Specify a new email address for this contact." }, "contactStatus": { "type": "string", "description": "Status : Select a status for the new contact. Defaults to Subscribed.", "enum": [ "subscribed", "unsubscribed", "cleaned", "pending", "transactional" ] }, "contactMergeFields": { "type": "object", "description": "Merge Fields : A dictionary of merge fields, where keys are the merge tags. See Mailchimp documentation (https://mailchimp.com/en-gb/help/all-the-merge-tags-cheat-sheet/) for available default merge tags. (example: \"{\n \"FNAME\": \"Brandon\",\n \"LNAME\": \"Foo\"\n}\")", "properties": {} } }, "required": [ "listId", "listContact" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MAILCHIMP_GET_CONTACTS_FROM_LIST": { "post": { "summary": "Get Contacts From List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MAILCHIMP_GET_CONTACTS_FROM_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "List ID : The ID of the list to get contacts from." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "count": { "type": "number", "description": "Count of records to fetch per page default is 100" }, "offset": { "type": "number", "description": "Offset of records to fetch default 0" } } } }, "required": [ "listId" ], "x-integration": "mailchimp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_OPPORTUNITY": { "post": { "summary": "Microsoft Dynamics Create Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : A subject or descriptive name, such as the expected order or company name, for the Opportunity. This field is required." }, "customerid": { "type": "string", "description": "Potential Customer ID : Select an account or contact to associate with this Opportunity. This field is required. (example: \"{{settings.customerID}}\")" }, "salesstagecode": { "type": "string", "description": "Process Stage : Use Connect Portal Workflow Settings to allow users to select a Process Stage. (example: \"{{settings.processStage}}\")" }, "estimatedclosedate": { "type": "string", "description": "Estimated Close Date : The expected closing date of the Opportunity." }, "actualclosedate": { "type": "string", "description": "Actual Close Date : The date and time when the Opportunity was closed or canceled." }, "estimatedvalue": { "type": "string", "description": "Est. Revenue : The estimated revenue amount to indicate the potential sale or value of the opportunity for revenue forecasting." }, "description": { "type": "string", "description": "Description : Additional information to describe the Opportunity, such as possible products to sell or past purchases from the customer." }, "ownerid": { "type": "string", "description": "Owner ID : The Dynamics 365 user or team assigned to this Opportunity. Use Connect Portal Workflow Settings to allow users to select an Owner (Team or User). (example: \"{{settings.ownerID}}\")" }, "transactioncurrencyid": { "type": "string", "description": "Transaction Currency : Choose the local currency for the Opportunity. Use Connect Portal Workflow Settings to allow users to select a Transaction Currency, or the first available will be used as a default. (example: \"{{settings.transactionCurrency}}\")" }, "additionalFields": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Fields to update. (example: \"{\n \"address2_city\": \"Los Angeles\",\n \"address2_stateorprovince\": \"CA\",\n \"address2_country\": \"United States\",\n \"address2_line1\": \"1700 Sawtelle Blvd\",\n \"primarycontactid@odata.bind\": \"/contacts(00000000-\n 0000-0000-0000-000000000001)\",\n}\")" } }, "required": [ "name", "customerid" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_ACCOUNT": { "post": { "summary": "Microsoft Dynamics Create Record Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_ACCOUNT" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Account Name : The company or business name for the Account. This field is required." }, "ownerid": { "type": "string", "description": "Owner ID : The Dynamics 365 user or team assigned to this Opportunity. Use Connect Portal Workflow Settings to allow users to select an Owner (Team or User). (example: \"{{settings.ownerID}}\")" }, "websiteurl": { "type": "string", "description": "Website" }, "telephone1": { "type": "string", "description": "Business Phone" }, "description": { "type": "string", "description": "Description : Additional information to describe the contact, such as an excerpt from the company's website." }, "additionalFields": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Fields to update. (example: \"{\n \"address2_city\": \"Los Angeles\",\n \"address2_stateorprovince\": \"CA\",\n \"address2_country\": \"United States\",\n \"address2_line1\": \"1700 Sawtelle Blvd\",\n \"primarycontactid@odata.bind\": \"/contacts(00000000-\n 0000-0000-0000-000000000001)\",\n}\")" } }, "required": [ "name" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_CONTACT": { "post": { "summary": "Microsoft Dynamics Create Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "firstname": { "type": "string", "description": "First Name" }, "lastname": { "type": "string", "description": "Last Name : This field is required." }, "emailaddress1": { "type": "string", "description": "Email" }, "telephone1": { "type": "string", "description": "Business Phone" }, "jobtitle": { "type": "string", "description": "Job Title : Title of the lead, such as CEO or Vice President." }, "description": { "type": "string", "description": "Description : Additional information to describe the contact, such as an excerpt from the company's website." }, "additionalFields": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Fields to update. (example: \"{\n \"address2_city\": \"Los Angeles\",\n \"address2_stateorprovince\": \"CA\",\n \"address2_country\": \"United States\",\n \"address2_line1\": \"1700 Sawtelle Blvd\",\n \"primarycontactid@odata.bind\": \"/contacts(00000000-\n 0000-0000-0000-000000000001)\",\n}\")" } }, "required": [ "lastname" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_LEAD": { "post": { "summary": "Microsoft Dynamics Create Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "subject": { "type": "string", "description": "Topic : Use a descriptive name, such as the expected order, company name, or marketing source list, to identify the lead." }, "firstname": { "type": "string", "description": "First Name" }, "lastname": { "type": "string", "description": "Last Name : This field is required." }, "emailaddress1": { "type": "string", "description": "Email" }, "telephone1": { "type": "string", "description": "Business Phone" }, "websiteurl": { "type": "string", "description": "Website" }, "jobtitle": { "type": "string", "description": "Job Title : Title of the lead, such as CEO or Vice President." }, "salesstagecode": { "type": "string", "description": "Process Stage : Use Connect Portal Workflow Settings to allow users to select a Process Stage. (example: \"{{settings.processStage}}\")" }, "description": { "type": "string", "description": "Description : Additional information to describe the lead, such as an excerpt from the company's website." }, "additionalFields": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Fields to update. (example: \"{\n \"address2_city\": \"Los Angeles\",\n \"address2_stateorprovince\": \"CA\",\n \"address2_country\": \"United States\",\n \"address2_line1\": \"1700 Sawtelle Blvd\",\n \"primarycontactid@odata.bind\": \"/contacts(00000000-\n 0000-0000-0000-000000000001)\",\n}\")" } }, "required": [ "subject", "lastname" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_CALL": { "post": { "summary": "Microsoft Dynamics Create Record Call", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_CALL" }, "parameters": { "type": "object", "properties": { "subject": { "type": "string", "description": "Subject : A description of the objective or topic of the call." }, "from": { "type": "string", "description": "From : The account, contact, lead, or user this call is from. Defaults to the currently authenticated user." }, "to": { "type": "string", "description": "To : The account, contact, lead, or user this call is to. Use Connect Portal User Settings to allow users to specify a record. (example: \"{{settings.lead}}\")" }, "directioncode": { "type": "string", "description": "Direction : Defaults to Outgoing.", "enum": [ "1", "0" ] }, "regardingobjectid": { "type": "string", "description": "Regarding : The account, contact, lead or opportunity this call is about. (example: \"{{settings.opportunity}}\")" }, "phonenumber": { "type": "string", "description": "Phone Number" }, "actualdurationminutes": { "type": "string", "description": "Duration : Specify duration in minutes. Defaults to 30 minutes." }, "description": { "type": "string", "description": "Description" }, "scheduledend": { "type": "string", "description": "Due Date/Time : Accepts Unix timestamp or ISO 8601 date formats." }, "prioritycode": { "type": "string", "description": "Priority : Defaults to Normal.", "enum": [ "0", "1", "2" ] } }, "required": [ "subject", "to" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_MEETING": { "post": { "summary": "Microsoft Dynamics Create Record Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_MEETING" }, "parameters": { "type": "object", "properties": { "subject": { "type": "string", "description": "Subject : A description of the objective or topic of the meeting." }, "scheduledstart": { "type": "string", "description": "Start Date/Time : Accepts Unix timestamp or ISO 8601 date formats." }, "scheduledend": { "type": "string", "description": "End Date/Time : Accepts Unix timestamp or ISO 8601 date formats." }, "requiredattendees": { "type": "object", "description": "Attendees : Add accounts, contacts, leads, or users to this meeting. Specify as an array of IDs. (example: \"\n [\n \"{{userSettings.accountId}}\",\n \"/systemusers(1d9e0de7-4fb2-ec11-9840-0022480b1bdf)\"\n ]\")", "properties": {} }, "regardingobjectid": { "type": "string", "description": "Regarding : The account, contact, lead or opportunity this meeting is about. (example: \"{{settings.opportunity}}\")" }, "location": { "type": "string", "description": "Location" }, "description": { "type": "string", "description": "Description" }, "prioritycode": { "type": "string", "description": "Priority : Defaults to Normal.", "enum": [ "0", "1", "2" ] } }, "required": [ "subject", "scheduledstart", "scheduledend" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_TASK": { "post": { "summary": "Microsoft Dynamics Create Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "subject": { "type": "string", "description": "Subject : A title for the task." }, "regardingobjectid": { "type": "string", "description": "Regarding : The account, contact, lead or opportunity this task is about. (example: \"{{settings.opportunity}}\")" }, "scheduledend": { "type": "string", "description": "Due Date/Time : Accepts Unix timestamp or ISO 8601 date formats." }, "ownerid": { "type": "string", "description": "Owner : Specify a user to own this task. Defaults to the currently authenticated user. (example: \"{{settings.user}}\")" }, "prioritycode": { "type": "string", "description": "Priority : Defaults to Normal.", "enum": [ "0", "1", "2" ] }, "description": { "type": "string", "description": "Description" } }, "required": [ "subject" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_NOTE": { "post": { "summary": "Microsoft Dynamics Create Record Note", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_NOTE" }, "parameters": { "type": "object", "properties": { "objectid": { "type": "string", "description": "For : The account, contact, lead, or opportunity this note is attached to. (example: \"{{settings.opportunity}}\")" }, "subject": { "type": "string", "description": "Title : A title for the note." }, "notetext": { "type": "string", "description": "Description" } }, "required": [ "objectid", "subject" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_ANY": { "post": { "summary": "Microsoft Dynamics Create Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_CREATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "entityName": { "type": "string", "description": "Entity name to perform the operation on. Use the plural form (e.g., \"accounts\", \"opportunities\") as Microsoft Dynamics API endpoints typically use plural entity names for all operations." } }, "required": [ "entityName" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_OPPORTUNITY": { "post": { "summary": "Microsoft Dynamics Update Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Opportunity ID : The ID of the Opportunity to update." }, "name": { "type": "string", "description": "Name : A subject or descriptive name, such as the expected order or company name, for the Opportunity." }, "customerid": { "type": "string", "description": "Potential Customer ID : Select an account or contact to associate with this Opportunity. (example: \"{{settings.customerID}}\")" }, "salesstagecode": { "type": "string", "description": "Process Stage : Use Connect Portal Workflow Settings to allow users to select a Process Stage. (example: \"{{settings.processStage}}\")" }, "estimatedclosedate": { "type": "string", "description": "Estimated Close Date : The expected closing date of the Opportunity." }, "actualclosedate": { "type": "string", "description": "Actual Close Date : The date and time when the Opportunity was closed or canceled." }, "estimatedvalue": { "type": "string", "description": "Est. Revenue : The estimated revenue amount to indicate the potential sale or value of the opportunity for revenue forecasting." }, "description": { "type": "string", "description": "Description : Additional information to describe the Opportunity, such as possible products to sell or past purchases from the customer." }, "ownerid": { "type": "string", "description": "Owner ID : The Dynamics 365 user or team assigned to this Opportunity. Use Connect Portal Workflow Settings to allow users to select an Owner (Team or User). (example: \"{{settings.ownerID}}\")" }, "transactioncurrencyid": { "type": "string", "description": "Transaction Currency : Choose the local currency for the Opportunity. Use Connect Portal Workflow Settings to allow users to select a Transaction Currency, or the first available will be used as a default. (example: \"{{settings.transactionCurrency}}\")" }, "additionalFields": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Fields to update. (example: \"{\n \"address2_city\": \"Los Angeles\",\n \"address2_stateorprovince\": \"CA\",\n \"address2_country\": \"United States\",\n \"address2_line1\": \"1700 Sawtelle Blvd\",\n \"primarycontactid@odata.bind\": \"/contacts(00000000-\n 0000-0000-0000-000000000001)\",\n}\")" } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_ACCOUNT": { "post": { "summary": "Microsoft Dynamics Update Record Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_ACCOUNT" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Account ID : The ID of the Account to update." }, "name": { "type": "string", "description": "Account Name : The company or business name for the Account." }, "ownerid": { "type": "string", "description": "Owner ID : The Dynamics 365 user or team assigned to this Opportunity. Use Connect Portal Workflow Settings to allow users to select an Owner (Team or User). (example: \"{{settings.ownerID}}\")" }, "websiteurl": { "type": "string", "description": "Website" }, "telephone1": { "type": "string", "description": "Business Phone" }, "description": { "type": "string", "description": "Description : Additional information to describe the contact, such as an excerpt from the company's website." }, "additionalFields": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Fields to update. (example: \"{\n \"address2_city\": \"Los Angeles\",\n \"address2_stateorprovince\": \"CA\",\n \"address2_country\": \"United States\",\n \"address2_line1\": \"1700 Sawtelle Blvd\",\n \"primarycontactid@odata.bind\": \"/contacts(00000000-\n 0000-0000-0000-000000000001)\",\n}\")" } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_CONTACT": { "post": { "summary": "Microsoft Dynamics Update Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Contact ID : The ID of the Contact to update." }, "firstname": { "type": "string", "description": "First Name" }, "lastname": { "type": "string", "description": "Last Name : This field is required." }, "emailaddress1": { "type": "string", "description": "Email" }, "telephone1": { "type": "string", "description": "Business Phone" }, "jobtitle": { "type": "string", "description": "Job Title : Title of the lead, such as CEO or Vice President." }, "description": { "type": "string", "description": "Description : Additional information to describe the contact, such as an excerpt from the company's website." }, "additionalFields": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Fields to update. (example: \"{\n \"address2_city\": \"Los Angeles\",\n \"address2_stateorprovince\": \"CA\",\n \"address2_country\": \"United States\",\n \"address2_line1\": \"1700 Sawtelle Blvd\",\n \"primarycontactid@odata.bind\": \"/contacts(00000000-\n 0000-0000-0000-000000000001)\",\n}\")" } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_LEAD": { "post": { "summary": "Microsoft Dynamics Update Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Lead ID : The ID of the Lead to update." }, "subject": { "type": "string", "description": "Topic : Use a descriptive name, such as the expected order, company name, or marketing source list, to identify the lead." }, "firstname": { "type": "string", "description": "First Name" }, "lastname": { "type": "string", "description": "Last Name : This field is required." }, "emailaddress1": { "type": "string", "description": "Email" }, "telephone1": { "type": "string", "description": "Business Phone" }, "websiteurl": { "type": "string", "description": "Website" }, "jobtitle": { "type": "string", "description": "Job Title : Title of the lead, such as CEO or Vice President." }, "salesstagecode": { "type": "string", "description": "Process Stage : Use Connect Portal Workflow Settings to allow users to select a Process Stage. (example: \"{{settings.processStage}}\")" }, "description": { "type": "string", "description": "Description : Additional information to describe the lead, such as an excerpt from the company's website." }, "additionalFields": { "type": "string", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Fields to update. (example: \"{\n \"address2_city\": \"Los Angeles\",\n \"address2_stateorprovince\": \"CA\",\n \"address2_country\": \"United States\",\n \"address2_line1\": \"1700 Sawtelle Blvd\",\n \"primarycontactid@odata.bind\": \"/contacts(00000000-\n 0000-0000-0000-000000000001)\",\n}\")" } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_CALL": { "post": { "summary": "Microsoft Dynamics Update Record Call", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_CALL" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Call ID : The ID of the Call to update." }, "subject": { "type": "string", "description": "Subject : A description of the objective or topic of the call." }, "from": { "type": "string", "description": "From : The account, contact, lead, or user this call is from. Defaults to the currently authenticated user." }, "to": { "type": "string", "description": "To : The account, contact, lead, or user this call is to. Use Connect Portal User Settings to allow users to specify a record. (example: \"{{settings.lead}}\")" }, "directioncode": { "type": "string", "description": "Direction : Defaults to Outgoing.", "enum": [ "1", "0" ] }, "regardingobjectid": { "type": "string", "description": "Regarding : The account, contact, lead or opportunity this call is about. (example: \"{{settings.opportunity}}\")" }, "phonenumber": { "type": "string", "description": "Phone Number" }, "actualdurationminutes": { "type": "string", "description": "Duration : Specify duration in minutes. Defaults to 30 minutes." }, "description": { "type": "string", "description": "Description" }, "scheduledend": { "type": "string", "description": "Due Date/Time : Accepts Unix timestamp or ISO 8601 date formats." }, "prioritycode": { "type": "string", "description": "Priority : Defaults to Normal.", "enum": [ "0", "1", "2" ] } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_MEETING": { "post": { "summary": "Microsoft Dynamics Update Record Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_MEETING" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Meeting ID : The ID of the Meeting to update." }, "subject": { "type": "string", "description": "Subject : A description of the objective or topic of the meeting." }, "scheduledstart": { "type": "string", "description": "Start Date/Time : Accepts Unix timestamp or ISO 8601 date formats." }, "scheduledend": { "type": "string", "description": "End Date/Time : Accepts Unix timestamp or ISO 8601 date formats." }, "requiredattendees": { "type": "object", "description": "Attendees : Add accounts, contacts, leads, or users to this meeting. Specify as an array of IDs. (example: \"\n [\n \"{{userSettings.accountId}}\",\n \"/systemusers(1d9e0de7-4fb2-ec11-9840-0022480b1bdf)\"\n ]\")", "properties": {} }, "regardingobjectid": { "type": "string", "description": "Regarding : The account, contact, lead or opportunity this meeting is about. (example: \"{{settings.opportunity}}\")" }, "location": { "type": "string", "description": "Location" }, "description": { "type": "string", "description": "Description" }, "prioritycode": { "type": "string", "description": "Priority : Defaults to Normal.", "enum": [ "0", "1", "2" ] } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_TASK": { "post": { "summary": "Microsoft Dynamics Update Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Task ID : The ID of the Task to update." }, "subject": { "type": "string", "description": "Subject : A title for the task." }, "regardingobjectid": { "type": "string", "description": "Regarding : The account, contact, lead or opportunity this task is about. (example: \"{{settings.opportunity}}\")" }, "scheduledend": { "type": "string", "description": "Due Date/Time : Accepts Unix timestamp or ISO 8601 date formats." }, "ownerid": { "type": "string", "description": "Owner : Specify a user to own this task. Defaults to the currently authenticated user. (example: \"{{settings.user}}\")" }, "prioritycode": { "type": "string", "description": "Priority : Defaults to Normal.", "enum": [ "0", "1", "2" ] }, "description": { "type": "string", "description": "Description" } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_NOTE": { "post": { "summary": "Microsoft Dynamics Update Record Note", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_NOTE" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Note ID : The ID of the Note to update." }, "objectid": { "type": "string", "description": "For : The account, contact, lead, or opportunity this note is attached to. (example: \"{{settings.opportunity}}\")" }, "subject": { "type": "string", "description": "Title : A title for the note." }, "notetext": { "type": "string", "description": "Description" } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_ANY": { "post": { "summary": "Microsoft Dynamics Update Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_UPDATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "entityName": { "type": "string", "description": "Entity name to perform the operation on. Use the plural form (e.g., \"accounts\", \"opportunities\") as Microsoft Dynamics API endpoints typically use plural entity names for all operations." }, "entityId": { "type": "string", "description": "Entity ID to perform the operation on" } }, "required": [ "entityName", "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_OPPORTUNITY": { "post": { "summary": "Microsoft Dynamics Get Record By ID Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Opportunity ID : The ID of the Opportunity to fetch." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ACCOUNT": { "post": { "summary": "Microsoft Dynamics Get Record By ID Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ACCOUNT" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Account ID : The ID of the Account to fetch." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CONTACT": { "post": { "summary": "Microsoft Dynamics Get Record By ID Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CONTACT" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Contact ID : The ID of the Contact to fetch." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_LEAD": { "post": { "summary": "Microsoft Dynamics Get Record By ID Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_LEAD" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Lead ID : The ID of the Lead to fetch." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CALL": { "post": { "summary": "Microsoft Dynamics Get Record By ID Call", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CALL" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Call ID : The ID of the Call to fetch." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_MEETING": { "post": { "summary": "Microsoft Dynamics Get Record By ID Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_MEETING" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Meeting ID : The ID of the Meeting to fetch." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_TASK": { "post": { "summary": "Microsoft Dynamics Get Record By ID Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_TASK" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Task ID : The ID of the Task to fetch." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_NOTE": { "post": { "summary": "Microsoft Dynamics Get Record By ID Note", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_NOTE" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Note ID : The ID of the Note to fetch." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ANY": { "post": { "summary": "Microsoft Dynamics Get Record By ID Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ANY" }, "parameters": { "type": "object", "properties": { "entityName": { "type": "string", "description": "Entity name to perform the operation on. Use the plural form (e.g., \"accounts\", \"opportunities\") as Microsoft Dynamics API endpoints typically use plural entity names for all operations." }, "entityId": { "type": "string", "description": "Entity ID to perform the operation on" } }, "required": [ "entityName", "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_OPPORTUNITY": { "post": { "summary": "Microsoft Dynamics Search Records Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name", "customerid", "salesstagecode", "estimatedclosedate", "actualclosedate", "estimatedvalue", "description", "_ownerid_value", "transactioncurrencyid" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberLessThan", "$dateTimeBefore", "$numberEquals", "$dateTimeEquals", "$numberGreaterThan", "$dateTimeAfter", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_ACCOUNT": { "post": { "summary": "Microsoft Dynamics Search Records Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_ACCOUNT" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name", "_ownerid_value", "websiteurl", "telephone1", "description" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberLessThan", "$dateTimeBefore", "$numberEquals", "$dateTimeEquals", "$numberGreaterThan", "$dateTimeAfter", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_CONTACT": { "post": { "summary": "Microsoft Dynamics Search Records Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_CONTACT" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "firstname", "lastname", "emailaddress1", "telephone1", "jobtitle", "description" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberLessThan", "$dateTimeBefore", "$numberEquals", "$dateTimeEquals", "$numberGreaterThan", "$dateTimeAfter", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_LEAD": { "post": { "summary": "Microsoft Dynamics Search Records Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_LEAD" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "firstname", "lastname", "emailaddress1", "telephone1", "websiteurl", "jobtitle", "salesstagecode", "description" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberLessThan", "$dateTimeBefore", "$numberEquals", "$dateTimeEquals", "$numberGreaterThan", "$dateTimeAfter", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_CALL": { "post": { "summary": "Microsoft Dynamics Search Records Call", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_CALL" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "directioncode", "_regardingobjectid_value", "phonenumber", "actualdurationminutes", "description", "scheduledend", "prioritycode" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberLessThan", "$dateTimeBefore", "$numberEquals", "$dateTimeEquals", "$numberGreaterThan", "$dateTimeAfter", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_MEETING": { "post": { "summary": "Microsoft Dynamics Search Records Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_MEETING" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "scheduledstart", "scheduledend", "_regardingobjectid_value", "location", "description", "prioritycode" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberLessThan", "$dateTimeBefore", "$numberEquals", "$dateTimeEquals", "$numberGreaterThan", "$dateTimeAfter", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_TASK": { "post": { "summary": "Microsoft Dynamics Search Records Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_TASK" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "_regardingobjectid_value", "scheduledend", "_ownerid_value", "prioritycode", "description" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberLessThan", "$dateTimeBefore", "$numberEquals", "$dateTimeEquals", "$numberGreaterThan", "$dateTimeAfter", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_NOTE": { "post": { "summary": "Microsoft Dynamics Search Records Note", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_NOTE" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "_objectid_value", "subject", "notetext" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$numberLessThan", "$dateTimeBefore", "$numberEquals", "$dateTimeEquals", "$numberGreaterThan", "$dateTimeAfter", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_ANY": { "post": { "summary": "Microsoft Dynamics Search Records Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_SEARCH_RECORDS_ANY" }, "parameters": { "type": "object", "properties": { "entityName": { "type": "string", "description": "Entity name to perform the operation on. Use the plural form (e.g., \"accounts\", \"opportunities\") as Microsoft Dynamics API endpoints typically use plural entity names for all operations." } }, "required": [ "entityName" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_OPPORTUNITY": { "post": { "summary": "Microsoft Dynamics Delete Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Opportunity ID : The ID of the Opportunity to delete." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_ACCOUNT": { "post": { "summary": "Microsoft Dynamics Delete Record Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_ACCOUNT" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Account ID : The ID of the Account to delete." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_CONTACT": { "post": { "summary": "Microsoft Dynamics Delete Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Contact ID : The ID of the Contact to delete." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_LEAD": { "post": { "summary": "Microsoft Dynamics Delete Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Lead ID : The ID of the Lead to delete." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_CALL": { "post": { "summary": "Microsoft Dynamics Delete Record Call", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_CALL" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Call ID : The ID of the Call to delete." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_MEETING": { "post": { "summary": "Microsoft Dynamics Delete Record Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_MEETING" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Meeting ID : The ID of the Meeting to delete." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_TASK": { "post": { "summary": "Microsoft Dynamics Delete Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Task ID : The ID of the Task to delete." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_NOTE": { "post": { "summary": "Microsoft Dynamics Delete Record Note", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_NOTE" }, "parameters": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Note ID : The ID of the Note to delete." } }, "required": [ "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_ANY": { "post": { "summary": "Microsoft Dynamics Delete Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DELETE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "entityName": { "type": "string", "description": "Entity name to perform the operation on. Use the plural form (e.g., \"accounts\", \"opportunities\") as Microsoft Dynamics API endpoints typically use plural entity names for all operations." }, "entityId": { "type": "string", "description": "Entity ID to perform the operation on" } }, "required": [ "entityName", "entityId" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DESCRIBE_ACTION_SCHEMA": { "post": { "summary": "Microsoft Dynamics Describe Action Schema", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MICROSOFT_DYNAMICS_DESCRIBE_ACTION_SCHEMA" }, "parameters": { "type": "object", "properties": { "entityName": { "type": "string", "description": "Entity name to describe the action schema for. Use the singular form (e.g., \"account\", \"opportunity\") as Microsoft Dynamics API typically uses singular entity names for describe action schema operations." }, "operation": { "type": "string", "description": "Operation Type value for example CREATE_RECORD or UPDATE_RECORD" } }, "required": [ "entityName", "operation" ], "x-integration": "microsoftDynamics" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TEAMS_SEND_MESSAGE_IN_CHANNEL": { "post": { "summary": "Send Message In Channel", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TEAMS_SEND_MESSAGE_IN_CHANNEL" }, "parameters": { "type": "object", "properties": { "channel": { "type": "string", "description": "Specify the channel id to send the message to. Use the TEAMS_CHANNEL_LIST intent to retrieve a list of available channel ids." }, "message": { "type": "string", "description": "Message : Plaintext/HTML representation of the content of the chat message." }, "subject": { "type": "string", "description": "Subject : The subject of the channel message, in plaintext." }, "summary": { "type": "string", "description": "Summary : Summary text of the chat message that could be used for push notifications and summary views or fall back views. " }, "attachments": { "type": "object", "description": "Attachments : A JSON list of attachments, such as images, videos, or rich cards. View the attachment objects available in the Microsoft Teams docs. (https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?view=azure-bot-service-4.0#attachment-object) (example: \"[\n {\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {\n \"type\": \"AdaptiveCard\",\n \"version\": \"1.0\",\n \"body\": [\n {\n \"type\": \"TextBlock\",\n \"text\": \"Hello World!\",\n \"size\": \"large\"\n },\n {\n \"type\": \"TextBlock\",\n \"text\": \"*Sincerely yours,*\"\n },\n {\n \"type\": \"TextBlock\",\n \"text\": \"Adaptive Cards\",\n \"separation\": \"none\"\n }\n ],\n \"actions\": [\n {\n \"type\": \"Action.OpenUrl\",\n \"url\": \"http://adaptivecards.io\",\n \"title\": \"Learn More\"\n }\n ]\n }\n }\n]\")", "properties": {} }, "attachmentLayout": { "type": "string", "description": "Attachment Layout : If adding multiple attachments, specify a layout to use when rendering the message.", "enum": [ "carousel", "list" ] } }, "required": [ "channel", "message" ], "x-integration": "microsoftTeams" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TEAMS_SEND_MESSAGE_IN_CHAT": { "post": { "summary": "Send Message In Chat", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TEAMS_SEND_MESSAGE_IN_CHAT" }, "parameters": { "type": "object", "properties": { "chatRecipient": { "type": "string", "description": "Specify the workspace member to send the chat message to. Format: \"{{chatType}}|{{id}}\". Use the TEAMS_MEMBER_LIST intent to get the member id and chatType." }, "message": { "type": "string", "description": "Message : Plaintext/HTML representation of the content of the chat message." }, "subject": { "type": "string", "description": "Subject : The subject of the chat message, in plaintext." }, "summary": { "type": "string", "description": "Summary : Summary text of the chat message that could be used for push notifications and summary views or fall back views. " }, "attachments": { "type": "object", "description": "Attachments : A JSON list of attachments, such as images, videos, or rich cards. View the attachment objects available in the Microsoft Teams docs. (https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?view=azure-bot-service-4.0#attachment-object) (example: \"[\n {\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {\n \"type\": \"AdaptiveCard\",\n \"version\": \"1.0\",\n \"body\": [\n {\n \"type\": \"TextBlock\",\n \"text\": \"Hello World!\",\n \"size\": \"large\"\n },\n {\n \"type\": \"TextBlock\",\n \"text\": \"*Sincerely yours,*\"\n },\n {\n \"type\": \"TextBlock\",\n \"text\": \"Adaptive Cards\",\n \"separation\": \"none\"\n }\n ],\n \"actions\": [\n {\n \"type\": \"Action.OpenUrl\",\n \"url\": \"http://adaptivecards.io\",\n \"title\": \"Learn More\"\n }\n ]\n }\n }\n]\")", "properties": {} }, "attachmentLayout": { "type": "string", "description": "Attachment Layout : If adding multiple attachments, specify a layout to use when rendering the message.", "enum": [ "carousel", "list" ] } }, "required": [ "chatRecipient", "message" ], "x-integration": "microsoftTeams" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TEAMS_GET_USER_BY_EMAIL": { "post": { "summary": "Get User By Email", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TEAMS_GET_USER_BY_EMAIL" }, "parameters": { "type": "object", "properties": { "teamId": { "type": "string", "description": "Specify the ID of the Team to search for users in. (example: e4da8430-de80-4815-9785-9c2441c24a7b)" }, "emailId": { "type": "string", "description": "Email : The email address of the user. (example: \"sean@example.com\")" } }, "required": [ "teamId", "emailId" ], "x-integration": "microsoftTeams" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TEAMS_JOINED_TEAM_LIST": { "post": { "summary": "Joined Team List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TEAMS_JOINED_TEAM_LIST" }, "parameters": { "type": "object", "properties": {}, "x-integration": "microsoftTeams" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TEAMS_CHANNEL_LIST": { "post": { "summary": "Channel List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TEAMS_CHANNEL_LIST" }, "parameters": { "type": "object", "properties": { "teamId": { "type": "string", "description": "Team ID" }, "channelFilterFormula": { "type": "string", "description": "Channel filter formula" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "teamId" ], "x-integration": "microsoftTeams" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TEAMS_MEMBER_LIST": { "post": { "summary": "Member List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TEAMS_MEMBER_LIST" }, "parameters": { "type": "object", "properties": {}, "x-integration": "microsoftTeams" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TEAMS_LIST_MESSAGES_IN_CHAT": { "post": { "summary": "List Messages In Chat", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TEAMS_LIST_MESSAGES_IN_CHAT" }, "parameters": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Chat ID : Specify a chat ID to fetch messages from a Group, Meeting, One on One Chat. (example: \"19:meeting_abc123@thread.v2\")" }, "messageFilterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "createdDateTime", "lastModifiedDateTime" ] }, "operator": { "type": "string", "enum": [ "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "chatId" ], "x-integration": "microsoftTeams" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_CREATE_ITEM": { "post": { "summary": "Create Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_CREATE_ITEM" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "boardId": { "type": "string", "description": "Board ID" }, "groupId": { "type": "string", "description": "Group ID" }, "externalId": { "type": "string", "description": "External ID : An ID from your application to associate this item with. You can use this ID to sync updates to this task later." }, "columnValues": { "type": "object", "description": "Specify the column values of the item. (example: {\"status\": \"Done\", \"person\": {\"personsAndTeams\": [{\"id\": 12345678, \"kind\": \"person\"}]}})", "properties": {} } }, "required": [ "name", "boardId" ], "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_UPDATE_ITEM": { "post": { "summary": "Update Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_UPDATE_ITEM" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Item ID : The ID of the item to update." }, "name": { "type": "string", "description": "Name" }, "boardId": { "type": "string", "description": "Board ID" }, "externalId": { "type": "string", "description": "External ID : An ID from your application to associate this item with. You can use this ID to sync updates to this task later." }, "columnValues": { "type": "object", "description": "Specify the column values of the item. (example: {\"status\": \"Done\", \"person\": {\"personsAndTeams\": [{\"id\": 12345678, \"kind\": \"person\"}]}})", "properties": {} } }, "required": [ "itemId", "boardId" ], "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_GET_ITEM_BY_ID": { "post": { "summary": "Get Item By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_GET_ITEM_BY_ID" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Item ID : The ID of the item to get." } }, "required": [ "itemId" ], "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_GET_ITEM_BY_EXTERNAL_ID": { "post": { "summary": "Get Item By External ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_GET_ITEM_BY_EXTERNAL_ID" }, "parameters": { "type": "object", "properties": { "boardId": { "type": "string", "description": "Board ID" }, "externalId": { "type": "string", "description": "External ID : The ID that this task is associated or synced with, from your application." } }, "required": [ "boardId", "externalId" ], "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_SEARCH_ITEMS": { "post": { "summary": "Search Items", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_SEARCH_ITEMS" }, "parameters": { "type": "object", "properties": { "boardId": { "type": "string", "description": "Board ID" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" }, "limit": { "type": "number", "description": "Number of items to return per page" } } } }, "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_DELETE_ITEM": { "post": { "summary": "Delete Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_DELETE_ITEM" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Item ID : The ID of the item to delete." } }, "required": [ "itemId" ], "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_ARCHIVE_ITEM": { "post": { "summary": "Archive Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_ARCHIVE_ITEM" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Item ID : The ID of the item to archive." } }, "required": [ "itemId" ], "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_CREATE_SUBITEM": { "post": { "summary": "Create Subitem", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_CREATE_SUBITEM" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "parentItemId": { "type": "string", "description": "Parent Item ID" }, "columnValues": { "type": "object", "description": "Specify the column values of the item. (example: {\"status\": \"Done\", \"person\": {\"personsAndTeams\": [{\"id\": 12345678, \"kind\": \"person\"}]}})", "properties": {} } }, "required": [ "name", "parentItemId" ], "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#MONDAY_SEARCH_USERS": { "post": { "summary": "Search Users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "MONDAY_SEARCH_USERS" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID" } }, "x-integration": "monday.com" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_CREATE_VENDOR": { "post": { "summary": "Create Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_CREATE_VENDOR" }, "parameters": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Company Name" }, "subsidiary": { "type": "string", "description": "Primary Subsidiary" }, "isPerson": { "type": "string", "description": "Type", "enum": [ "company", "individual" ] }, "firstName": { "type": "string", "description": "First Name \nThis field appears only when 'isPerson' = 'individual')" }, "lastName": { "type": "string", "description": "Last Name \nThis field appears only when 'isPerson' = 'individual')" }, "email": { "type": "string", "description": "Email (example: \"primary@vendor.com\")" }, "altEmail": { "type": "string", "description": "Alternative Email (example: \"secondary@vendor.com\")" }, "defaultTaxReg": { "type": "string", "description": "Default Tax Registration Number" }, "expenseAccount": { "type": "string", "description": "Expense Account : Specify an account associated with this vendor." }, "terms": { "type": "string", "description": "Term : The ID of the payment term for this vendor." }, "addr1": { "type": "string", "description": "Address Line 1" }, "addr2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State : Use state or province." }, "zip": { "type": "string", "description": "Zip : Use ZIP or postal code, if applicable." }, "country": { "type": "string", "description": "Country : Accepts ISO-3166 country codes. (example: \"US\")" }, "vendorAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this vendor as JSON. For example, you may specify a different billing address here. See the docs (https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html#/definitions/vendor) for available fields. (example: \"[\n {\n \"addressBookAddress\": {\n \"addr1\": \"2500 Durant Ave\",\n \"addr2\": \"Unit A\",\n \"addrPhone\": \"5101112222\",\n \"addrText\": \"2500 Durant Ave Unit A, Berkeley, CA, 94704\",\n \"addressee\": \"John Appleseed\",\n \"city\": \"Berkeley\",\n \"state\": \"CA\",\n \"defaultBilling\": true,\n \"defaultShipping\": true\n }\n },\n ]\")" } }, "required": [ "companyName", "firstName", "lastName" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_UPDATE_VENDOR": { "post": { "summary": "Update Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_UPDATE_VENDOR" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : The ID of the vendor to update." }, "companyName": { "type": "string", "description": "Company Name" }, "subsidiary": { "type": "string", "description": "Primary Subsidiary" }, "isPerson": { "type": "string", "description": "Type", "enum": [ "company", "individual" ] }, "firstName": { "type": "string", "description": "First Name \nThis field appears only when 'isPerson' = 'individual')" }, "lastName": { "type": "string", "description": "Last Name \nThis field appears only when 'isPerson' = 'individual')" }, "email": { "type": "string", "description": "Email (example: \"primary@vendor.com\")" }, "altEmail": { "type": "string", "description": "Alternative Email (example: \"secondary@vendor.com\")" }, "defaultTaxReg": { "type": "string", "description": "Default Tax Registration Number" }, "expenseAccount": { "type": "string", "description": "Expense Account : Specify an account associated with this vendor." }, "terms": { "type": "string", "description": "Term : The ID of the payment term for this vendor." }, "addr1": { "type": "string", "description": "Address Line 1" }, "addr2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State : Use state or province." }, "zip": { "type": "string", "description": "Zip : Use ZIP or postal code, if applicable." }, "country": { "type": "string", "description": "Country : Accepts ISO-3166 country codes. (example: \"US\")" }, "vendorAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this vendor as JSON. For example, you may specify a different billing address here. See the docs (https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html#/definitions/vendor) for available fields. (example: \"[\n {\n \"addressBookAddress\": {\n \"addr1\": \"2500 Durant Ave\",\n \"addr2\": \"Unit A\",\n \"addrPhone\": \"5101112222\",\n \"addrText\": \"2500 Durant Ave Unit A, Berkeley, CA, 94704\",\n \"addressee\": \"John Appleseed\",\n \"city\": \"Berkeley\",\n \"state\": \"CA\",\n \"defaultBilling\": true,\n \"defaultShipping\": true\n }\n },\n ]\")" } }, "required": [ "vendorId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_GET_VENDOR_BY_ID": { "post": { "summary": "Get Vendor By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_GET_VENDOR_BY_ID" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor : The ID of the vendor to fetch." } }, "required": [ "vendorId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_SEARCH_VENDORS": { "post": { "summary": "Search Vendors", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_SEARCH_VENDORS" }, "parameters": { "type": "object", "properties": { "vendorFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "companyName", "isPerson", "email", "defaultTaxReg" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$numberEquals", "$numberDoesNotEqual", "$stringStartsWith", "$stringEndsWith", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch default 100" }, "offset": { "type": "number", "description": "Offset of records to fetch default 0" } } } }, "required": [ "vendorFilterFormula" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_DELETE_VENDOR": { "post": { "summary": "Delete Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_DELETE_VENDOR" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : The ID of the vendor to delete." } }, "required": [ "vendorId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_CREATE_BILL": { "post": { "summary": "Create Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_CREATE_BILL" }, "parameters": { "type": "object", "properties": { "entity": { "type": "string", "description": "Vendor : The vendor ID this bill is associated with." }, "tranDate": { "type": "string", "description": "Date : Accepts ISO 8601 date format. (example: \"2022-01-31\")" }, "postingPeriod": { "type": "string", "description": "Posting Period : Select the period to which you want to post this transaction." }, "subsidiary": { "type": "string", "description": "Subsidiary : Enter the subsidiary ID to associate with this transaction. By default, the bill will use the Parent Company subsidiary." }, "tranId": { "type": "string", "description": "Reference Number : Enter additional information to identify this transaction, such as the vendor's invoice number. This reference appears on reports such as the Accounts Payable Register." }, "dueDate": { "type": "string", "description": "Due Date : Accepts ISO 8601 date format. (example: \"2022-01-31\")" }, "userTotal": { "type": "string", "description": "Amount (example: \"25.00\")" }, "approvalStatus": { "type": "string", "description": "Approval Status (example: \"Approved\")", "enum": [ "2", "1" ] }, "memo": { "type": "string", "description": "Memo : Enter a memo that will appear on such reports as the 2-line Accounts Payable Register." }, "itemsInput": { "type": "object", "description": "Expenses and Items : Enter an array of Expenses including the description, quantity, and amount for each Line item. See the docs (https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html#/definitions/vendorBill-expenseCollection) for available fields. (example: \"[\n {\n \"account:\"58\",\n \"amount\": 30.99,\n \"memo\":\"test\"\n }\n ]\")", "properties": {} }, "billAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this Bill as JSON. See the docs (https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html#/definitions/vendorBill) for available fields. (example: \"[\n {\n \"vendorTaxItem\": 10\n },\n ]\")" } }, "required": [ "entity", "tranDate", "postingPeriod", "itemsInput" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_UPDATE_BILL": { "post": { "summary": "Update Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_UPDATE_BILL" }, "parameters": { "type": "object", "properties": { "billId": { "type": "string", "description": "Bill ID : The ID of the bill to update." }, "entity": { "type": "string", "description": "Vendor : The vendor ID this bill is associated with." }, "tranDate": { "type": "string", "description": "Date : Accepts ISO 8601 date format. (example: \"2022-01-31\")" }, "postingPeriod": { "type": "string", "description": "Posting Period : Select the period to which you want to post this transaction." }, "subsidiary": { "type": "string", "description": "Subsidiary : Enter the subsidiary ID to associate with this transaction. By default, the bill will use the Parent Company subsidiary." }, "tranId": { "type": "string", "description": "Reference Number : Enter additional information to identify this transaction, such as the vendor's invoice number. This reference appears on reports such as the Accounts Payable Register." }, "dueDate": { "type": "string", "description": "Due Date : Accepts ISO 8601 date format. (example: \"2022-01-31\")" }, "userTotal": { "type": "string", "description": "Amount (example: \"25.00\")" }, "approvalStatus": { "type": "string", "description": "Approval Status (example: \"Approved\")", "enum": [ "2", "1" ] }, "memo": { "type": "string", "description": "Memo : Enter a memo that will appear on such reports as the 2-line Accounts Payable Register." }, "itemsInput": { "type": "object", "description": "Expenses and Items : Enter an array of Expenses including the description, quantity, and amount for each Line item. See the docs (https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html#/definitions/vendorBill-expenseCollection) for available fields. (example: \"[\n {\n \"account:\"58\",\n \"amount\": 30.99,\n \"memo\":\"test\"\n }\n ]\")", "properties": {} }, "billAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this Bill as JSON. See the docs (https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html#/definitions/vendorBill) for available fields. (example: \"[\n {\n \"vendorTaxItem\": 10\n },\n ]\")" } }, "required": [ "billId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_GET_BILL_BY_ID": { "post": { "summary": "Get Bill By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_GET_BILL_BY_ID" }, "parameters": { "type": "object", "properties": { "billId": { "type": "string", "description": "Bill ID : The ID of the bill to update." } }, "required": [ "billId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_SEARCH_BILLS": { "post": { "summary": "Search Bills", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_SEARCH_BILLS" }, "parameters": { "type": "object", "properties": { "billFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "entity", "id", "tranId", "tranDate", "dueDate", "approvalStatus", "memo" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$stringStartsWith", "$stringEndsWith", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch default 100" }, "offset": { "type": "number", "description": "Offset of records to fetch default 0" } } } }, "required": [ "billFilterFormula" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_DELETE_BILL": { "post": { "summary": "Delete Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_DELETE_BILL" }, "parameters": { "type": "object", "properties": { "billId": { "type": "string", "description": "Bill ID : The ID of the bill to delete." } }, "required": [ "billId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_CREATE_ACCOUNT": { "post": { "summary": "Create Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_CREATE_ACCOUNT" }, "parameters": { "type": "object", "properties": { "acctNumber": { "type": "string", "description": "Number : Enter the number to identify this account. (example: \"6000\")" }, "acctName": { "type": "string", "description": "Name : Enter up to 31 characters for an account name that will appear on all reports. (example: \"Expenses\")" }, "subsidiaries": { "type": "string", "description": "Subsidiaries : Select one or more subsidiaries by subsidiary ID to restrict the use of this account." }, "acctType": { "type": "string", "description": "Type : Select a GAAP category for the type of account you are creating.", "enum": [ "Bank", "AcctRec", "OthCurrAsset", "FixedAsset", "OthAsset", "AcctPay", "CredCard" ] }, "parent": { "type": "string", "description": "Sub-Account Of : Select the parent account if this account is a sub-account of another." }, "accountAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this Account as JSON. See the docs (https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html#/definitions/account) for available fields. (example: \"[\n {\n \"availableBalance\": 10\n }\n ]\")" } }, "required": [ "acctNumber", "acctName", "subsidiaries", "acctType" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_UPDATE_ACCOUNT": { "post": { "summary": "Update Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_UPDATE_ACCOUNT" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : The ID of the account to update." }, "acctNumber": { "type": "string", "description": "Number : Enter the number to identify this account. (example: \"6000\")" }, "acctName": { "type": "string", "description": "Name : Enter up to 31 characters for an account name that will appear on all reports. (example: \"Expenses\")" }, "subsidiaries": { "type": "string", "description": "Subsidiaries : Select one or more subsidiaries by subsidiary ID to restrict the use of this account." }, "acctType": { "type": "string", "description": "Type : Select a GAAP category for the type of account you are creating.", "enum": [ "Bank", "OthCurrAsset", "FixedAsset", "OthAsset", "CredCard" ] }, "parent": { "type": "string", "description": "Sub-Account Of : Select the parent account if this account is a sub-account of another." }, "accountAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this Account as JSON. See the docs (https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html#/definitions/account) for available fields. (example: \"[\n {\n \"availableBalance\": 10\n }\n ]\")" } }, "required": [ "accountId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_GET_ACCOUNT_BY_ID": { "post": { "summary": "Get Account By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_GET_ACCOUNT_BY_ID" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : The ID of the account to fetch." } }, "required": [ "accountId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_SEARCH_ACCOUNTS": { "post": { "summary": "Search Accounts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_SEARCH_ACCOUNTS" }, "parameters": { "type": "object", "properties": { "accountFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "acctNumber", "acctType" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$stringStartsWith", "$stringEndsWith", "$numberEquals", "$numberDoesNotEqual", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch default 100" }, "offset": { "type": "number", "description": "Offset of records to fetch default 0" } } } }, "required": [ "accountFilterFormula" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_DELETE_ACCOUNT": { "post": { "summary": "Delete Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_DELETE_ACCOUNT" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : The ID of the account to delete." } }, "required": [ "accountId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_CREATE_TAX_GROUP": { "post": { "summary": "Create Tax Group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_CREATE_TAX_GROUP" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Name : Enter a name for this Tax Group. You select this name on transactions." }, "taxCode": { "type": "string", "description": "Tax Code : Specify the ID of the Tax Code to associate with this Tax Group." }, "county": { "type": "string", "description": "Country : Enter the county where this tax should be applied. This value is used by NetSuite to automatically determine the correct tax when an order is entered or a customer places an order on your website. (example: \"US\")" } }, "required": [ "itemId", "taxCode" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_UPDATE_TAX_GROUP": { "post": { "summary": "Update Tax Group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_UPDATE_TAX_GROUP" }, "parameters": { "type": "object", "properties": { "taxGroupId": { "type": "string", "description": "Tax Group ID : The ID of the Tax Group to fetch." }, "itemId": { "type": "string", "description": "Name : Enter a name for this Tax Group. You select this name on transactions." }, "taxCode": { "type": "string", "description": "Tax Code : Specify the ID of the Tax Code to associate with this Tax Group." }, "county": { "type": "string", "description": "Country : Enter the county where this tax should be applied. This value is used by NetSuite to automatically determine the correct tax when an order is entered or a customer places an order on your website. (example: \"US\")" } }, "required": [ "taxGroupId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_GET_TAX_GROUP_BY_ID": { "post": { "summary": "Get Tax Group By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_GET_TAX_GROUP_BY_ID" }, "parameters": { "type": "object", "properties": { "taxGroupId": { "type": "string", "description": "Tax Group ID : The ID of the Tax Group to fetch." } }, "required": [ "taxGroupId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_DELETE_TAX_GROUP": { "post": { "summary": "Delete Tax Group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_DELETE_TAX_GROUP" }, "parameters": { "type": "object", "properties": { "taxGroupId": { "type": "string", "description": "Tax Group ID : The ID of the Tax Group to delete." } }, "required": [ "taxGroupId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_SEARCH_TAX_CODES": { "post": { "summary": "Search Tax Codes", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_SEARCH_TAX_CODES" }, "parameters": { "type": "object", "properties": { "taxCodeFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id" ] }, "operator": { "type": "string", "enum": [ "$numberEquals", "$numberDoesNotEqual" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "required": [ "taxCodeFilterFormula" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_SEARCH_PAYMENT_TERMS": { "post": { "summary": "Search Payment Terms", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_SEARCH_PAYMENT_TERMS" }, "parameters": { "type": "object", "properties": { "termFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name", "discountPercent" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$numberEquals", "$numberDoesNotEqual", "$stringStartsWith", "$stringEndsWith" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "required": [ "termFilterFormula" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_GET_PAYMENT_TERM_BY_ID": { "post": { "summary": "Get Payment Term By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_GET_PAYMENT_TERM_BY_ID" }, "parameters": { "type": "object", "properties": { "termId": { "type": "string", "description": "Terms : The ID of the term to get." } }, "required": [ "termId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_SEARCH_POSTING_PERIODS": { "post": { "summary": "Search Posting Periods", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_SEARCH_POSTING_PERIODS" }, "parameters": { "type": "object", "properties": { "postingPeriodFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "startDate", "endDate" ] }, "operator": { "type": "string", "enum": [ "$dateTimeEquals", "$dateTimeAfter", "$dateTimeBefore" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_SEARCH_CONTACTS_BY_SAVED_SEARCH_ID": { "post": { "summary": "Search Contacts By Saved Search ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_SEARCH_CONTACTS_BY_SAVED_SEARCH_ID" }, "parameters": { "type": "object", "properties": { "savedSearchId": { "type": "string", "description": "Saved Search ID : Specify the ID of the saved search to use for finding contacts. (example: \"1234\")" } }, "required": [ "savedSearchId" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_LIST_SAVED_SEARCHES": { "post": { "summary": "List Saved Searches", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_LIST_SAVED_SEARCHES" }, "parameters": { "type": "object", "properties": { "searchType": { "type": "string", "description": "Search Type : Record Type to list saved searches for (example: \"contact\")" } }, "required": [ "searchType" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NETSUITE_ACCESS_SOAP_API_WITH_BODY": { "post": { "summary": "Access Soap Api With Body", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NETSUITE_ACCESS_SOAP_API_WITH_BODY" }, "parameters": { "type": "object", "properties": { "soapBody": { "type": "object", "description": "SOAP Body : Specify the body of the SOAP request. (example: \"\n \n \n John\n contains\n \n \n\")", "properties": {} } }, "required": [ "soapBody" ], "x-integration": "netsuite" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_CREATE_PAGE": { "post": { "summary": "Create Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_CREATE_PAGE" }, "parameters": { "type": "object", "properties": { "parent": { "type": "object", "description": "Parent : The parent page or database where the new page is inserted, represented as a JSON object with a page_id or database_id key, and the corresponding ID. (example: \"{\n \"database_id\":\"{{DATABASE_ID}}\"\n}\")", "properties": {} }, "properties": { "type": "object", "description": "Properties : The values of the page’s properties. If the parent is a database, then the schema must match the parent database’s properties. If the parent is a page, then the only valid object key is title. (example: \"{\n \"title\":[\n {\n \"text\":{\n \"content\":\"My Page\"\n }\n }\n ]\n}\")", "properties": {} }, "children": { "type": "object", "description": "Children : The content to be rendered on the new page, represented as an array of block objects (https://developers.notion.com/reference/block). (example: \"[\n {\n \"object\":\"block\",\n \"type\":\"heading_2\",\n \"heading_2\":{\n \"rich_text\":[\n {\n \"type\":\"text\",\n \"text\":{\n \"content\":\"Lacinato kale\"\n }\n }\n ]\n }\n }\n]\")", "properties": {} }, "cover": { "type": "object", "description": "Cover : The cover image of the new page, represented as an file object (https://developers.notion.com/reference/file-object). (example: \"{\n \"external\":{\n \"url\":\"https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg\"\n }\n}\")", "properties": {} }, "icon": { "type": "object", "description": "Icon : The icon of the new page. Either an emoji object (https://developers.notion.com/reference/emoji-object) or an external file object (https://developers.notion.com/reference/file-object). (example: \"{\n \"emoji\":\"🥬\"\n}\")", "properties": {} } }, "required": [ "parent", "properties" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_UPDATE_PAGE": { "post": { "summary": "Update Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_UPDATE_PAGE" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : Specify the ID of the Page to Update. (example: \"59833787-2cf9-4fdf-8782-e53db20768a5\")" }, "archived": { "type": "boolean", "description": "Archived : Whether the page is archived (deleted). Set to true to archive a page. Set to false to un-archive (restore) a page." }, "properties": { "type": "object", "description": "Properties : The property values to update for the page. The keys are the names or IDs of the property and the values are property values. If a page property ID is not included, then it is not changed. (example: \"{\n \"title\":[\n {\n \"text\":{\n \"content\":\"My Page\"\n }\n }\n ]\n}\")", "properties": {} }, "cover": { "type": "object", "description": "Cover : The cover image of the new page, represented as an file object (https://developers.notion.com/reference/file-object). (example: \"{\n \"external\":{\n \"url\":\"https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg\"\n }\n}\")", "properties": {} }, "icon": { "type": "object", "description": "Icon : The icon of the new page. Either an emoji object (https://developers.notion.com/reference/emoji-object) or an external file object (https://developers.notion.com/reference/file-object). (example: \"{\n \"emoji\":\"🥬\"\n}\")", "properties": {} } }, "required": [ "pageId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_GET_PAGE_BY_ID": { "post": { "summary": "Get Page By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_GET_PAGE_BY_ID" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : Specify the ID of the Page to Get. (example: \"59833787-2cf9-4fdf-8782-e53db20768a5\")" } }, "required": [ "pageId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_ARCHIVE_PAGE": { "post": { "summary": "Archive Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_ARCHIVE_PAGE" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : Specify the ID of the Page to Archive. (example: \"59833787-2cf9-4fdf-8782-e53db20768a5\")" } }, "required": [ "pageId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_SEARCH_PAGES": { "post": { "summary": "Search Pages", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_SEARCH_PAGES" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "Query : The text that the API compares page and database titles against." }, "objectType": { "type": "string", "description": "Object Type : The type of object to search for.", "enum": [ "page", "database" ] }, "direction": { "type": "string", "description": "Direction : The direction to sort the results by.", "enum": [ "ascending", "descending" ] }, "pageSize": { "type": "number", "description": "Limit : The number of records to return, returns all records if not specified." } }, "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_GET_PAGE_CONTENT": { "post": { "summary": "Get Page Content", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_GET_PAGE_CONTENT" }, "parameters": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Page ID : Specify a Block or Page ID to receive all of its block’s children in order. (example: \"59833787-2cf9-4fdf-8782-e53db20768a5\")" } }, "required": [ "blockId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_UPDATE_BLOCK": { "post": { "summary": "Update Block", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_UPDATE_BLOCK" }, "parameters": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block ID : Specify the ID of the Block to Update. (example: \"9bc30ad4-9373-46a5-84ab-0a7845ee52e6\")" }, "archived": { "type": "boolean", "description": "Archived : Set to true to archive (delete) a block. Set to false to un-archive (restore) a block." }, "paragraph": { "type": "object", "description": "Paragraph : Paragraph block objects contain the information within the paragraph property see the docs (https://developers.notion.com/reference/block#paragraph). (example: \"{\n \"rich_text\":[\n {\n \"type\":\"text\",\n \"text\":{\n \"content\":\"Lacinato kale\",\n \"link\":null\n }\n }\n ],\n \"color\":\"default\"\n}\")", "properties": {} }, "image": { "type": "object", "description": "Image : Image block objects contain a file object (https://developers.notion.com/reference/file-object)detailing information about the image. (example: \"{\n \"type\":\"external\",\n \"external\":{\n \"url\":\"https://website.domain/images/image.png\"\n }\n}\")", "properties": {} }, "bookmark": { "type": "object", "description": "Bookmark : Bookmark block objects contain the following information within the bookmark property see the docs (https://developers.notion.com/reference/block#bookmark) (example: \"{\n \"caption\":[],\n \"url\":\"https://companywebsite.com\"\n}\")", "properties": {} }, "code": { "type": "object", "description": "Code : Code block objects contain the following information within the code property see the docs (https://developers.notion.com/reference/block#code) (example: \"{\n \"rich_text\":[\n {\n \"type\":\"text\",\n \"text\":{\n \"content\":\"const a = 3\"\n }\n }\n ],\n \"language\":\"javascript\"\n}\")", "properties": {} }, "pdf": { "type": "object", "description": "PDF : A PDF block object represents a PDF that has been embedded within a Notion page. It contains the following fields see the docs (https://developers.notion.com/reference/block#pdf) (example: \"{\n \"type\": \"external\",\n \"external\": {\n \"url\": \"https://website.domain/files/doc.pdf\"\n }\n}\")", "properties": {} }, "table": { "type": "object", "description": "Table : Table block objects are parent blocks for table row children. Table block objects contain the following fields within the table property see the docs (https://developers.notion.com/reference/block#table) (example: \"{\n \"table_width\":2,\n \"has_column_header\":false,\n \"has_row_header\":false\n}\")", "properties": {} }, "tableOfContent": { "type": "object", "description": "Table of Contents : Table of contents block objects contain the following information within the table_of_contents property see the docs (https://developers.notion.com/reference/block#table-of-contents) (example: \"{\n \"color\":\"default\"\n}\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this block as JSON see the docs (https://developers.notion.com/reference/block) (example: \"{\n \"child_page\":{\n \"title\":\"Lacinato kale\"\n },\n \"child_database\":{\n \"title\":\"My database\"\n }\n}\")", "properties": {} } }, "required": [ "blockId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_GET_BLOCK_BY_ID": { "post": { "summary": "Get Block By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_GET_BLOCK_BY_ID" }, "parameters": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block ID : Specify the ID of the Block to Get. (example: \"9bc30ad4-9373-46a5-84ab-0a7845ee52e6\")" } }, "required": [ "blockId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_DELETE_BLOCK": { "post": { "summary": "Delete Block", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_DELETE_BLOCK" }, "parameters": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block ID : Specify the ID of the Block to Delete. (example: \"9bc30ad4-9373-46a5-84ab-0a7845ee52e6\")" } }, "required": [ "blockId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_GET_PAGE_AS_MARKDOWN": { "post": { "summary": "Get Page As Markdown", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_GET_PAGE_AS_MARKDOWN" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : Specify the ID of the Page to get as Markdown. (example: \"59833787-2cf9-4fdf-8782-e53db20768a5\")" } }, "required": [ "pageId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_CREATE_PAGE_WITH_MARKDOWN": { "post": { "summary": "Create Page With Markdown", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_CREATE_PAGE_WITH_MARKDOWN" }, "parameters": { "type": "object", "properties": { "parent": { "type": "object", "description": "Parent : The parent page or database where the new page is inserted, represented as a JSON object with a page_id or database_id key, and the corresponding ID. (example: \"{\n \"database_id\":\"{{DATABASE_ID}}\"\n}\")", "properties": {} }, "title": { "type": "string", "description": "Title : The title of the page. Required if no properties are provided. Ignored if properties are provided with title." }, "properties": { "type": "object", "description": "Properties : The values of the page’s properties. If the parent is a database, then the schema must match the parent database’s properties. If the parent is a page, then the only valid object key is title. (example: \"{\n \"title\":[\n {\n \"text\":{\n \"content\":\"My Page\"\n }\n }\n ]\n}\")", "properties": {} }, "markdownContent": { "type": "string", "description": "Markdown Content : The content to create the page with, in Markdown format. (example: \"# My Page\n\nThis is the content of my page in **Markdown** format.\n\n- List item 1\n- List item 2\")" }, "cover": { "type": "object", "description": "Cover : The cover image of the new page, represented as an file object (https://developers.notion.com/reference/file-object). (example: \"{\n \"external\":{\n \"url\":\"https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg\"\n }\n}\")", "properties": {} }, "icon": { "type": "object", "description": "Icon : The icon of the new page. Either an emoji object (https://developers.notion.com/reference/emoji-object) or an external file object (https://developers.notion.com/reference/file-object). (example: \"{\n \"emoji\":\"🥬\"\n}\")", "properties": {} } }, "required": [ "parent", "title" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_UPDATE_PAGE_WITH_MARKDOWN": { "post": { "summary": "Update Page With Markdown", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_UPDATE_PAGE_WITH_MARKDOWN" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : Specify the ID of the Page to Update. (example: \"59833787-2cf9-4fdf-8782-e53db20768a5\")" }, "title": { "type": "string", "description": "Title : The title of the page. Required if no properties are provided. Ignored if properties are provided with title." }, "properties": { "type": "object", "description": "Properties : The property values to update for the page. The keys are the names or IDs of the property and the values are property values. If a page property ID is not included, then it is not changed. (example: \"{\n \"title\":[\n {\n \"text\":{\n \"content\":\"My Page\"\n }\n }\n ]\n}\")", "properties": {} }, "markdownContent": { "type": "string", "description": "Markdown Content : The content to update the page with, in Markdown format. If Replace Existing Content is True, this will replace the existing content. If Replace Existing Content is False, this will append to the existing content. (example: \"# My Page\n\nThis is the content of my page in **Markdown** format.\n\n- List item 1\n- List item 2\")" }, "replaceExisting": { "type": "boolean", "description": "Replace Existing Content : If Yes, existing page content will be replaced. If No, new content will be appended." }, "cover": { "type": "object", "description": "Cover : The cover image of the new page, represented as an file object (https://developers.notion.com/reference/file-object). (example: \"{\n \"external\":{\n \"url\":\"https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg\"\n }\n}\")", "properties": {} }, "icon": { "type": "object", "description": "Icon : The icon of the new page. Either an emoji object (https://developers.notion.com/reference/emoji-object) or an external file object (https://developers.notion.com/reference/file-object). (example: \"{\n \"emoji\":\"🥬\"\n}\")", "properties": {} }, "archived": { "type": "boolean", "description": "Archived : Whether the page is archived (deleted). Set to true to archive a page. Set to false to un-archive (restore) a page." } }, "required": [ "pageId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_CREATE_COMMENT": { "post": { "summary": "Create Comment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_CREATE_COMMENT" }, "parameters": { "type": "object", "properties": { "pageId": { "type": "string", "description": "Page ID : The ID of the page to comment on. Provide exactly one of Page ID, Block ID, or Discussion ID. (example: \"59833787-2cf9-4fdf-8782-e53db20768a5\")" }, "blockId": { "type": "string", "description": "Block ID : The ID of the block to attach a comment to. Provide exactly one of Page ID, Block ID, or Discussion ID. (example: \"d40e767c-d7af-4b18-a86d-55c61f1e39a4\")" }, "discussionId": { "type": "string", "description": "Discussion ID : The ID of an existing discussion thread to reply to. Provide exactly one of Page ID, Block ID, or Discussion ID. The API cannot start a new selected-text discussion. (example: \"8fa6e3ec-bebf-494b-94ba-e5e9737842fb\")" }, "richText": { "type": "object", "description": "Rich Text : Comment body as a JSON array of Notion rich text objects. Provide exactly one of Rich Text or Markdown. (example: \"[\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Hello from Paragon.\"\n }\n }\n]\")", "properties": {} }, "markdown": { "type": "string", "description": "Markdown : Comment body as Markdown (inline formatting only). Provide exactly one of Rich Text or Markdown. (example: \"Hello from **Paragon**.\")" }, "attachments": { "type": "object", "description": "Attachments : Optional JSON array of file attachments (max 3). Each item requires file_upload_id from a Notion File Upload with status uploaded. (example: \"[\n {\n \"file_upload_id\": \"e9c27f5e-c3ed-4f3f-8eba-984581ff6d8c\",\n \"type\": \"file_upload\"\n }\n]\")", "properties": {} } }, "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_UPDATE_COMMENT": { "post": { "summary": "Update Comment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_UPDATE_COMMENT" }, "parameters": { "type": "object", "properties": { "commentId": { "type": "string", "description": "Comment ID : The ID of the comment to update. Integrations can typically only update comments they created. (example: \"ce18f8c6-ef2a-427f-b416-43531fc7c117\")" }, "richText": { "type": "object", "description": "Rich Text : Updated comment body as a JSON array of Notion rich text objects. Provide exactly one of Rich Text or Markdown. (example: \"[\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Updated comment text.\"\n }\n }\n]\")", "properties": {} }, "markdown": { "type": "string", "description": "Markdown : Updated comment body as Markdown (inline formatting only). Provide exactly one of Rich Text or Markdown. (example: \"Updated comment with **bold** text.\")" } }, "required": [ "commentId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_DELETE_COMMENT": { "post": { "summary": "Delete Comment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_DELETE_COMMENT" }, "parameters": { "type": "object", "properties": { "commentId": { "type": "string", "description": "Comment ID : The ID of the comment to delete. Integrations can typically only delete comments they created. (example: \"ce18f8c6-ef2a-427f-b416-43531fc7c117\")" } }, "required": [ "commentId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#NOTION_LIST_COMMENTS": { "post": { "summary": "List Comments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "NOTION_LIST_COMMENTS" }, "parameters": { "type": "object", "properties": { "blockId": { "type": "string", "description": "Block ID : The page or block ID to list unresolved comments for. Page IDs are valid because pages are blocks. For ActionKit, paginate with paginationParameters.pageCursor / limit; workflows auto-paginate. (example: \"5c6a2821-6bb1-4a7e-b6e1-c50111515c3d\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "required": [ "blockId" ], "x-integration": "notion" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_GET_FILE_BY_ID": { "post": { "summary": "Get File By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_GET_FILE_BY_ID" }, "parameters": { "type": "object", "properties": { "fileId": { "type": "string", "description": "File Path or Item ID : Provide either the file system path(root or root:/filename.pdf) or Item ID. (example: \"Choose a file\")" } }, "required": [ "fileId" ], "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_SAVE_FILE": { "post": { "summary": "Save File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_SAVE_FILE" }, "parameters": { "type": "object", "properties": { "file": { "type": "object", "description": "File to save to OneDrive. (example: {\n \"data\": \"48656c6c6f2c20776f726c6421\",\n \"dataType\": \"FILE\",\n \"mimeType\": \"text/plain\"\n})", "properties": {} }, "fileName": { "type": "string", "description": "File Name (example: \"filename.pdf\")" }, "folder": { "type": "string", "description": "Folder : Use Connect Portal Workflow Settings to allow users to select which Folder to save files to. Defaults to the user’s root folder if left blank. (example: \"{{settings.folder}}\")" } }, "required": [ "file", "fileName" ], "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_LIST_CONTENTS": { "post": { "summary": "List Contents", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_LIST_CONTENTS" }, "parameters": { "type": "object", "properties": { "filePath": { "type": "string", "description": "Specify which folder to list files from" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor to paginate the results." } } } }, "required": [ "filePath" ], "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_CREATE_FOLDER": { "post": { "summary": "Create Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_CREATE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderName": { "type": "string", "description": "Folder Name : Specify the Folder Name (example: \"example folder\")" }, "parentId": { "type": "string", "description": "Parent Folder ID : Specify the Parent Folder ID. (example: \"01MCUCZUFVXTSCIFNST5HJ4BDTK3YQYYCF\")" } }, "required": [ "folderName" ], "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_GET_FOLDER_BY_ID": { "post": { "summary": "Get Folder By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_GET_FOLDER_BY_ID" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : Specify the Folder ID. (example: \"01MCUCZUFVXTSCIFNST5HJ4BDTK3YQYYCF\")" } }, "required": [ "folderId" ], "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_SEARCH_FOLDERS": { "post": { "summary": "Search Folders", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_SEARCH_FOLDERS" }, "parameters": { "type": "object", "properties": { "folderName": { "type": "string", "description": "Folder Name : Specify the Folder Name (example: \"example folder\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor to paginate the results." } } } }, "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_MOVE_FOLDER": { "post": { "summary": "Move Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_MOVE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : Specify the Folder ID. (example: \"01MCUCZUFVXTSCIFNST5HJ4BDTK3YQYYCF\")" }, "parentId": { "type": "string", "description": "Parent Folder ID : Specify the Parent Folder ID. (example: \"01MCUCZUFVXTSCIFNST5HJ4BDTK3YQYYCF\")" } }, "required": [ "folderId", "parentId" ], "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_DELETE_FOLDER": { "post": { "summary": "Delete Folder", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_DELETE_FOLDER" }, "parameters": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Folder ID : Specify the Folder ID to delete (example: \"01MCUCZUFVXTSCIFNST5HJ4BDTK3YQYYCF\")" } }, "required": [ "folderId" ], "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONEDRIVE_DOWNLOAD_FILE": { "post": { "summary": "Download File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONEDRIVE_DOWNLOAD_FILE" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Item ID : Specify the Item ID of the drive File to fetch. (example: \"01MCUCZsDUeM7T5BUNXNDLPZAP6OBVJT82\")" } }, "required": [ "itemId" ], "x-integration": "onedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "201": { "description": "**Response with File URL**", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "A temporary signed download URL from the OneDrive API. Send a request to this URL from your request client or provide the URL to an LLM provider to download or use the file contents." } } } } } } } } }, "/projects/{project_id}/tools/#ONENOTE_CREATE_PAGE": { "post": { "summary": "Create Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONENOTE_CREATE_PAGE" }, "parameters": { "type": "object", "properties": { "type": { "type": "string", "description": "Type : Select the Type of your operation.", "enum": [ "users", "groups", "sites", "me" ] }, "userId": { "type": "string", "description": "User ID : Specify the ID of the User to Create Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'users')" }, "groupId": { "type": "string", "description": "Group ID : Specify the ID of the Group to Create Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'groups')" }, "siteId": { "type": "string", "description": "Site ID : Specify the ID of the Site to Create Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'sites')" }, "contentType": { "type": "string", "description": "Content Type : Select the Content Type of your Content.", "enum": [ "html", "multipart" ] }, "presentationContent": { "type": "object", "description": "Presentation Content : Specify Presentation content for page as HTML see the docs (https://learn.microsoft.com/en-us/graph/onenote-images-files#add-a-public-image-from-the-web). (example: \"\n\n \n A page with a block of HTML\n \n \n \n

Here's an image from an online source:

\n \"an\n

Here's an image uploaded as binary data:

\n \"an\n

Here's a file attachment:

\n \n \n\") \nThis field appears only when 'contentType' = 'multipart')", "properties": {} }, "multipartcontent": { "type": "object", "description": "Multipart Content : Specify Multipart content for page as JSON see the docs (https://learn.microsoft.com/en-us/graph/onenote-create-page). (example: \"{\n \"imageBlock1\": {\n \"content\": ,\n \"contentType\": \"image/jpeg\",\n \"fileName\": \"imageBlock1\"\n },\n \"fileBlock1\": {\n \"content\": ,\n \"contentType\": \"application/pdf\",\n \"fileName\": \"fileBlock1\"\n }\n}\") \nThis field appears only when 'contentType' = 'multipart')", "properties": {} }, "htmlcontent": { "type": "object", "description": "Content (example: \"\n\n \n A page with a block of HTML\n \n \n \n

This page contains some formatted text and an image.

\n \"an\n \n\"). Should only appear when contentType is html.", "properties": {} }, "sectionId": { "type": "string", "description": "Section ID : Specify the ID of the Section to Create Page. (example: \"1-q3259d12-4211-459f-bdf0-2a2a21054865\"). Should be required when type is sites or groups. Optional when type is users or me." } }, "required": [ "type", "userId", "groupId", "siteId", "contentType", "presentationContent", "htmlcontent", "sectionId" ], "x-integration": "onenote" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONENOTE_UPDATE_PAGE": { "post": { "summary": "Update Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONENOTE_UPDATE_PAGE" }, "parameters": { "type": "object", "properties": { "type": { "type": "string", "description": "Type : Select the Type of your operation.", "enum": [ "users", "groups", "sites", "me" ] }, "userId": { "type": "string", "description": "User ID : Specify the ID of the User to Update Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'users')" }, "groupId": { "type": "string", "description": "Group ID : Specify the ID of the Group to Update Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'groups')" }, "siteId": { "type": "string", "description": "Site ID : Specify the ID of the Site to Update Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'sites')" }, "pageId": { "type": "string", "description": "Page ID : Specify the ID of the Page to Update. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\")" }, "jsonContent": { "type": "object", "description": "Content : Specify content for updating the page as JSON see the docs (https://learn.microsoft.com/en-us/graph/onenote-update-page). (example: \"[\n {\n 'target':'#para-id',\n 'action':'insert',\n 'position':'before',\n 'content':'\"Image'\n }, \n {\n 'target':'#list-id',\n 'action':'append',\n 'content':'
  • Item at the end of the list
    • '\n }\n]\")", "properties": {} } }, "required": [ "type", "userId", "groupId", "siteId", "pageId", "jsonContent" ], "x-integration": "onenote" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONENOTE_GET_PAGE_BY_ID": { "post": { "summary": "Get Page By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONENOTE_GET_PAGE_BY_ID" }, "parameters": { "type": "object", "properties": { "type": { "type": "string", "description": "Type : Select the Type of your operation.", "enum": [ "users", "groups", "sites", "me" ] }, "userId": { "type": "string", "description": "User ID : Specify the ID of the User to Get Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'users')" }, "groupId": { "type": "string", "description": "Group ID : Specify the ID of the Group to Get Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'groups')" }, "siteId": { "type": "string", "description": "Site ID : Specify the ID of the Site to Get Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'sites')" }, "pageId": { "type": "string", "description": "Page ID : Specify the ID of the Page to Get. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\")" } }, "required": [ "type", "userId", "groupId", "siteId", "pageId" ], "x-integration": "onenote" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONENOTE_DELETE_PAGE": { "post": { "summary": "Delete Page", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONENOTE_DELETE_PAGE" }, "parameters": { "type": "object", "properties": { "type": { "type": "string", "description": "Type : Select the Type of your operation.", "enum": [ "users", "groups", "sites", "me" ] }, "userId": { "type": "string", "description": "User ID : Specify the ID of the User to Delete Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'users')" }, "groupId": { "type": "string", "description": "Group ID : Specify the ID of the Group to Delete Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'groups')" }, "siteId": { "type": "string", "description": "Site ID : Specify the ID of the Site to Delete Page. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'sites')" }, "pageId": { "type": "string", "description": "Page ID : Specify the ID of the Page to Delete. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\")" } }, "required": [ "type", "userId", "groupId", "siteId", "pageId" ], "x-integration": "onenote" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ONENOTE_SEARCH_PAGES": { "post": { "summary": "Search Pages", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ONENOTE_SEARCH_PAGES" }, "parameters": { "type": "object", "properties": { "type": { "type": "string", "description": "Type : Select the Type of your operation.", "enum": [ "users", "groups", "sites", "me" ] }, "userId": { "type": "string", "description": "User ID : Specify the ID of the User to Search Pages. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'users')" }, "groupId": { "type": "string", "description": "Group ID : Specify the ID of the Group to Search Pages. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'groups')" }, "siteId": { "type": "string", "description": "Site ID : Specify the ID of the Site to Search Pages. (example: \"1-22db9939679d4eada2698a4e983f7a63!245-45b54f25-123d-4db3-a286-b82791117671\") \nThis field appears only when 'type' = 'sites')" }, "pagesFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "title", "createdDateTime", "lastModifiedDateTime", "level", "order", "self", "contentUrl" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$stringDoesNotEndWith", "$stringEndsWith", "$stringStartsWith", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanFalse", "$booleanTrue" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "skip": { "type": "number", "description": "Skip($skip) for skip the number of items to return" }, "limit": { "type": "number", "description": "Limit($top) to limit the number of items to return. Using this parameter will not return a nextPageCursor, which means it does not indicate whether there are more records to fetch. By default, oneNote API returns 20 items." } } } }, "required": [ "type", "userId", "groupId", "siteId" ], "x-integration": "onenote" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTLOOK_CREATE_EVENT": { "post": { "summary": "Create Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTLOOK_CREATE_EVENT" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : Specify a user ID to perform this action if you are working with an application token. (example: \"1b671a64-40d5-491e-99b0-da01ff1f3341\")" }, "subject": { "type": "string", "description": "Subject : The text of the event’s subject line." }, "startTime": { "type": "string", "description": "Start Time : Accepts YYYY-MM-DD[T]HH:MM:SS date formats." }, "timeZone": { "type": "string", "description": "Specify which timezone the event will be added to. Defaults to the UTC timezone if left blank" }, "endTime": { "type": "string", "description": "End Time : Accepts date in YYYY-MM-DD[T]HH:MM:SS format. Defaults to one hour after the start time if left blank." }, "calendarId": { "type": "string", "description": "Specify which calendar the event will be added to. Defaults to the user's primary calendar if left blank" }, "description": { "type": "string", "description": "Description : The message associated with the event." }, "contentType": { "type": "string", "description": "Content Type", "enum": [ "text", "html" ] }, "locationName": { "type": "string", "description": "Location Name : Display name of the event location." }, "locationUrl": { "type": "string", "description": "Location URL : URL representing the location." }, "attendees": { "type": "string", "description": "Attendees : Accepts an array of email addresses or email addresses separated by commas." } }, "x-integration": "outlook" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTLOOK_UPDATE_EVENT": { "post": { "summary": "Update Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTLOOK_UPDATE_EVENT" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : Specify a user ID to perform this action if you are working with an application token. (example: \"1b671a64-40d5-491e-99b0-da01ff1f3341\")" }, "eventId": { "type": "string", "description": "Event ID : The ID of the event to update." }, "subject": { "type": "string", "description": "Subject : The text of the event’s subject line." }, "startTime": { "type": "string", "description": "Start Time : Accepts YYYY-MM-DD[T]HH:MM:SS date formats." }, "timeZone": { "type": "string", "description": "Specify which timezone the event will be added to. Defaults to the UTC timezone if left blank" }, "endTime": { "type": "string", "description": "End Time : Accepts date in YYYY-MM-DD[T]HH:MM:SS format." }, "calendarId": { "type": "string", "description": "Specify which calendar the event will be added to. Defaults to the user's primary calendar if left blank" }, "description": { "type": "string", "description": "Description : The message associated with the event." }, "contentType": { "type": "string", "description": "Content Type", "enum": [ "text", "html" ] }, "locationName": { "type": "string", "description": "Location Name : Display name of the event location." }, "locationUrl": { "type": "string", "description": "Location URL : URL representing the location." }, "attendees": { "type": "string", "description": "Attendees : Accepts an array of email addresses or email addresses separated by commas." } }, "required": [ "eventId" ], "x-integration": "outlook" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTLOOK_GET_EVENT_BY_ID": { "post": { "summary": "Get Event By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTLOOK_GET_EVENT_BY_ID" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : Specify a user ID to perform this action if you are working with an application token. (example: \"1b671a64-40d5-491e-99b0-da01ff1f3341\")" }, "eventId": { "type": "string", "description": "Event ID : The ID of the event to get." }, "calendarId": { "type": "string", "description": "Specify which calendar the event will be added to. Defaults to the user's primary calendar if left blank" } }, "required": [ "eventId" ], "x-integration": "outlook" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTLOOK_GET_EVENTS": { "post": { "summary": "Get Events", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTLOOK_GET_EVENTS" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : Specify a user ID to perform this action if you are working with an application token. (example: \"1b671a64-40d5-491e-99b0-da01ff1f3341\")" }, "calendarId": { "type": "string", "description": "Specify which calendar the event will be added to. Defaults to the user's primary calendar if left blank" }, "eventsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "importance", "sensitivity", "start/dateTime", "end/dateTime", "location/displayName", "organizer/emailAddress/name" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanFalse", "$booleanTrue" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "outlook" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTLOOK_DELETE_EVENT": { "post": { "summary": "Delete Event", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTLOOK_DELETE_EVENT" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : Specify a user ID to perform this action if you are working with an application token. (example: \"1b671a64-40d5-491e-99b0-da01ff1f3341\")" }, "eventId": { "type": "string", "description": "Event ID : The ID of the event to delete." }, "calendarId": { "type": "string", "description": "Specify which calendar the event will be added to. Defaults to the user's primary calendar if left blank" } }, "required": [ "eventId" ], "x-integration": "outlook" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTLOOK_GET_MESSAGES": { "post": { "summary": "Get Messages", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTLOOK_GET_MESSAGES" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : Specify a user ID to perform this action if you are working with an application token. (example: \"1b671a64-40d5-491e-99b0-da01ff1f3341\")" }, "mailFolder": { "type": "string", "description": "Specify which mail folder to get messages from. Defaults to the user's primary mail folder if left blank" }, "messagesFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "sender/emailAddress/address", "isDraft", "isRead" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$booleanTrue", "$booleanFalse", "$stringContains", "$stringEndsWith", "$stringStartsWith" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "limitResults": { "type": "string", "description": "Limit Results : Limit the maximum number of messages to return. Defaults to 10 if left blank. Maximum is 1,000." } }, "x-integration": "outlook" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTLOOK_GET_MESSAGE_BY_ID": { "post": { "summary": "Get Message By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTLOOK_GET_MESSAGE_BY_ID" }, "parameters": { "type": "object", "properties": { "id": { "type": "string", "description": "Message ID : Specify a Message ID to fetch its contents." } }, "required": [ "id" ], "x-integration": "outlook" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTLOOK_SEND_MESSAGE": { "post": { "summary": "Send Message", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTLOOK_SEND_MESSAGE" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : Specify a user ID to perform this action if you are working with an application token. (example: \"1b671a64-40d5-491e-99b0-da01ff1f3341\")" }, "subject": { "type": "string", "description": "Subject : The text of the event’s subject line." }, "messageBody": { "type": "string", "description": "Message Body" }, "contentType": { "type": "string", "description": "Content Type", "enum": [ "text", "html" ] }, "attachments": { "type": "string", "description": "Attachments : Accepts either a single file object or a JSON array of file objects. Data can be encoded in base64 or hex format. (example: \"[{\n name: 'hello.txt',\n mimeType: 'text/plain',\n data: 'SGVsbG8gV29ybGQ=',\n}]\")" }, "toRecipients": { "type": "string", "description": "To recipients : Accepts an array of email addresses or email addresses separated by commas." }, "ccRecipients": { "type": "string", "description": "CC recipients : Accepts an array of email addresses or email addresses separated by commas." }, "bccRecipients": { "type": "string", "description": "BCC recipients : Accepts an array of email addresses or email addresses separated by commas." }, "mailFolder": { "type": "string", "description": "Specify which mail folder to get messages from. Defaults to the user's primary mail folder if left blank" } }, "required": [ "subject", "messageBody", "contentType", "toRecipients" ], "x-integration": "outlook" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_CREATE_ACCOUNT": { "post": { "summary": "Create Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_CREATE_ACCOUNT" }, "parameters": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Account name" }, "websiteUrl": { "type": "string", "description": "Website URL" }, "description": { "type": "string", "description": "Description" }, "companyType": { "type": "string", "description": "Company type : A description of the company’s type (e.g. \"Public Company\")." }, "industry": { "type": "string", "description": "Industry" }, "numberOfEmployees": { "type": "string", "description": "Number of employees" }, "customId": { "type": "string", "description": "Custom ID : A custom ID for the account, often referencing an ID in an external system." } }, "required": [ "accountName" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_UPDATE_ACCOUNT": { "post": { "summary": "Update Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_UPDATE_ACCOUNT" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : The ID of the account to update." }, "accountName": { "type": "string", "description": "Account name" }, "websiteUrl": { "type": "string", "description": "Website URL" }, "description": { "type": "string", "description": "Description" }, "companyType": { "type": "string", "description": "Company type : A description of the company’s type (e.g. \"Public Company\")." }, "industry": { "type": "string", "description": "Industry" }, "numberOfEmployees": { "type": "string", "description": "Number of employees" }, "customId": { "type": "string", "description": "Custom ID : A custom ID for the account, often referencing an ID in an external system." } }, "required": [ "accountId" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_GET_ACCOUNTS": { "post": { "summary": "Get Accounts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_GET_ACCOUNTS" }, "parameters": { "type": "object", "properties": { "accountsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "customId", "domain", "name", "createdAt", "updatedAt" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$numberEquals", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Page size to fetch records default is 100" }, "pageCursor": { "type": "string", "description": "Page cursor to fetch records. Use the page[after] value from the previous response to fetch the next page of records. Example: \"eyJjbiI6IkFwaVYyOjpQcm9zcGVjdHNDb250cm9sbGVyIiwic3AiOm51bGwsInN2IjpbXSwiaWQiOjEwMiwidiI6MX0%3D\"" } } } }, "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_GET_ACCOUNT_BY_ID": { "post": { "summary": "Get Account By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_GET_ACCOUNT_BY_ID" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID" } }, "required": [ "accountId" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_CREATE_OPPORTUNITY": { "post": { "summary": "Create Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_CREATE_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "opportunityName": { "type": "string", "description": "Opportunity Name" }, "amount": { "type": "string", "description": "Amount" }, "accountId": { "type": "string", "description": "Account ID : The Account that the opportunity belongs to." }, "opportunityStage": { "type": "string", "description": "Specify an opportunity stage" }, "closeDate": { "type": "string", "description": "Close date (example: \"YYYY-MM-DD\")" }, "description": { "type": "string", "description": "Description" } }, "required": [ "opportunityName" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_UPDATE_OPPORTUNITY": { "post": { "summary": "Update Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_UPDATE_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "opportunityId": { "type": "string", "description": "Opportunity ID : The ID of the opportunity to update." }, "opportunityName": { "type": "string", "description": "Opportunity Name" }, "amount": { "type": "string", "description": "Amount" }, "accountId": { "type": "string", "description": "Account ID : The Account that the opportunity belongs to." }, "opportunityStage": { "type": "string", "description": "Specify an opportunity stage" }, "closeDate": { "type": "string", "description": "Close date (example: \"YYYY-MM-DD\")" }, "description": { "type": "string", "description": "Description" } }, "required": [ "opportunityId" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_GET_OPPORTUNITIES": { "post": { "summary": "Get Opportunities", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_GET_OPPORTUNITIES" }, "parameters": { "type": "object", "properties": { "opportunityFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "probability", "riskScore", "name", "mapStatus", "createdAt", "updatedAt" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$numberEquals", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Page size to fetch records default is 100" }, "pageCursor": { "type": "string", "description": "Page cursor to fetch records. Use the page[after] value from the previous response to fetch the next page of records. Example: \"eyJjbiI6IkFwaVYyOjpQcm9zcGVjdHNDb250cm9sbGVyIiwic3AiOm51bGwsInN2IjpbXSwiaWQiOjEwMiwidiI6MX0%3D\"" } } } }, "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_GET_OPPORTUNITY_BY_ID": { "post": { "summary": "Get Opportunity By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_GET_OPPORTUNITY_BY_ID" }, "parameters": { "type": "object", "properties": { "opportunityId": { "type": "string", "description": "Opportunity ID" } }, "required": [ "opportunityId" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_CREATE_PROSPECT": { "post": { "summary": "Create Prospect", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_CREATE_PROSPECT" }, "parameters": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address" }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "accountId": { "type": "string", "description": "Account ID : The Account that the prospect belongs to." }, "phone": { "type": "string", "description": "Phone number : A list of voip phone numbers associated with the prospect. (example: \"[\"+1 444 555 6666\",\"+1 444 555 7777\"]\")" }, "company": { "type": "string", "description": "Company" }, "occupation": { "type": "string", "description": "Occupation" }, "websiteUrl": { "type": "string", "description": "Website URL" }, "externalId": { "type": "string", "description": "External ID : A custom ID for the prospect, often referencing an ID in an external system." } }, "required": [ "email" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_UPDATE_PROSPECT": { "post": { "summary": "Update Prospect", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_UPDATE_PROSPECT" }, "parameters": { "type": "object", "properties": { "prospectId": { "type": "string", "description": "Prospect ID : The ID of the prospect to update." }, "email": { "type": "string", "description": "Email address" }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "accountId": { "type": "string", "description": "Account ID : The Account that the prospect belongs to." }, "phone": { "type": "string", "description": "Phone number : A list of voip phone numbers associated with the prospect. (example: \"[\"+1 444 555 6666\",\"+1 444 555 7777\"]\")" }, "company": { "type": "string", "description": "Company" }, "occupation": { "type": "string", "description": "Occupation" }, "websiteUrl": { "type": "string", "description": "Website URL" }, "externalId": { "type": "string", "description": "External ID : A custom ID for the prospect, often referencing an ID in an external system." } }, "required": [ "prospectId" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_GET_PROSPECTS": { "post": { "summary": "Get Prospects", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_GET_PROSPECTS" }, "parameters": { "type": "object", "properties": { "prospectsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "emails", "engagedScore", "lastName", "title", "mapStatus", "createdAt", "updatedAt", "engagedAt" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$numberEquals", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Page size to fetch records default is 100" }, "pageCursor": { "type": "string", "description": "Page cursor to fetch records. Use the page[after] value from the previous response to fetch the next page of records. Example: \"eyJjbiI6IkFwaVYyOjpQcm9zcGVjdHNDb250cm9sbGVyIiwic3AiOm51bGwsInN2IjpbXSwiaWQiOjEwMiwidiI6MX0%3D\"" } } } }, "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_GET_PROSPECT_BY_ID": { "post": { "summary": "Get Prospect By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_GET_PROSPECT_BY_ID" }, "parameters": { "type": "object", "properties": { "prospectId": { "type": "string", "description": "Prospect ID" } }, "required": [ "prospectId" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#OUTREACH_ADD_PROSPECT_TO_SEQUENCE": { "post": { "summary": "Add Prospect To Sequence", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "OUTREACH_ADD_PROSPECT_TO_SEQUENCE" }, "parameters": { "type": "object", "properties": { "sequence": { "type": "string", "description": "The sequence that the prospect should be added to" }, "prospectId": { "type": "string", "description": "Prospect ID : ID of prospect to be added to the Sequence." } }, "required": [ "sequence", "prospectId" ], "x-integration": "outreach" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PANDA_DOC_CREATE_DOCUMENT": { "post": { "summary": "Create Document", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PANDA_DOC_CREATE_DOCUMENT" }, "parameters": { "type": "object", "properties": { "from": { "type": "string", "description": "From : Create a document from", "enum": [ "pandadoc_template", "file" ] }, "name": { "type": "string", "description": "Name : Name the document you are creating. \nThis field appears only when 'from' = 'pandadoc_template')" }, "templateUuid": { "type": "string", "description": "Template UUID : The ID of a template you want to use. You can copy it from an in app template url such as https://app.pandadoc.com/a/#/templates/{ID}/content. A template ID is also obtained by listing templates. (example: \"hryJY9mqYZHjQCYQuSjRQg\") \nThis field appears only when 'from' = 'pandadoc_template')" }, "recipients": { "type": "object", "description": "Recipients : Update already existing recipients using Recipient ID from document details or add new recipients to the document (example: \"[\n {\n \"id\": \"MiySpPNiyhhmFXnDDrrawC\",\n \"email\": \"john.doe@gmail.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n]\") \nThis field appears only when 'from' = 'pandadoc_template')", "properties": {} }, "folderUuid": { "type": "string", "description": "Folder UUID : The ID of the folder where the created document should be stored. (example: \"QMDSzwabfFzTgjW4kUijqQ\") \nThis field appears only when 'from' = 'pandadoc_template')" }, "tags": { "type": "string", "description": "Tags : Mark your document with new tags (example: \"[\n \"created_via_api\",\n \"test_document\" \n]\") \nThis field appears only when 'from' = 'pandadoc_template')" }, "tokens": { "type": "object", "description": "Tokens : Update tokens or add new ones (example: \"[\n {\n \"name\": \"Favorite.Pet\",\n \"value\": \"New Panda\"\n }\n]\") \nThis field appears only when 'from' = 'pandadoc_template')", "properties": {} }, "fields": { "type": "object", "description": "Fields : Update field values (example: \"{\n \"Like\": {\n \"value\": false\n },\n \"Date\": {\n \"value\": \"2022-08-24T00:00:00.000Z\"\n }\n}\") \nThis field appears only when 'from' = 'pandadoc_template')", "properties": {} }, "metadata": { "type": "object", "description": "Metadata : Update or add metadata (example: \"{\n \"my_favorite_pet\": \"New Panda\"\n}\") \nThis field appears only when 'from' = 'pandadoc_template')", "properties": {} }, "pricingTable": { "type": "object", "description": "Pricing Table : Update or add metadata. See reference (https://developers.pandadoc.com/reference/create-document-from-pandadoc-template#pricing-table) (example: \"[\n {\n \"name\": \"Pricing Table 1\",\n \"sections\": [\n {\n \"title\": \"Sample Section\",\n \"default\": true\n }\n ]\n }\n]\") \nThis field appears only when 'from' = 'pandadoc_template')", "properties": {} }, "contentPlaceholders": { "type": "object", "description": "Content Placeholders : You may replace Content Library Item Placeholders with a few content library items each and pre fill fields/variables values, pricing table items, and assign recipients to roles from there. See reference (https://developers.pandadoc.com/reference/create-document-from-pandadoc-template#content-placeholder) (example: \"[\n {\n \"block_id\": \"{{block_id}}\",\n \"content_library_items\": [...]\n } \n]\") \nThis field appears only when 'from' = 'pandadoc_template')", "properties": {} }, "images": { "type": "object", "description": "Images : You may pass a list of images to image blocks (one image per block) for replacement. See a note about linking images to templates below. Image formats supported: GIF, JPG, PNG. (example: \"[\n {\n \"name\": \"Image 1\",\n \"urls\": [\n \"https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png\"\n ]\n }\n]\") \nThis field appears only when 'from' = 'pandadoc_template')", "properties": {} }, "fileUrl": { "type": "string", "description": "File URL : Specify a PDF/DocX/RTF File URL. (example: \"https://cdn2.hubspot.net/hubfs/2127247/public-templates/SamplePandaDocPdf_FormFields.pdf\") \nThis field appears only when 'from' = 'file')" }, "data": { "type": "object", "description": "Data : Specify data fields that should be used in this document as JSON. (example: \"{\n \"name\": \"Public Document\", \n \"recipients\": [ \n { \n \"email\": \"john.doe@useparagon.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Dow\",\n \"role\": \"user\"\n }\n ],\n \"fields\": { \n \"userName\": { \n \"value\": \"John\",\n \"role\": \"user\"\n }\n },\n \"metadata\": {\n \"my_favorite_pet\": \"Panda\"\n },\n \"tags\": [\n \"created_via_api\"\n ], \n \"parse_form_fields\": true\n}\") \nThis field appears only when 'from' = 'file')", "properties": {} } }, "required": [ "from", "name", "templateUuid", "recipients", "fileUrl", "data" ], "x-integration": "pandadoc" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PANDA_DOC_UPDATE_DOCUMENT": { "post": { "summary": "Update Document", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PANDA_DOC_UPDATE_DOCUMENT" }, "parameters": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Document ID : Specify the ID of the Document to Update." }, "tags": { "type": "string", "description": "Tags : Mark your document with new tags (example: \"[\n \"created_via_api\",\n \"test_document\" \n]\")" }, "recipients": { "type": "object", "description": "Recipients : Update already existing recipients using Recipient ID from document details or add new recipients to the document (example: \"[\n {\n \"id\": \"MiySpPNiyhhmFXnDDrrawC\",\n \"email\": \"john.doe@gmail.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n]\")", "properties": {} }, "tokens": { "type": "object", "description": "Tokens : Update tokens or add new ones (example: \"[\n {\n \"name\": \"Favorite.Pet\",\n \"value\": \"New Panda\"\n }\n]\")", "properties": {} }, "fields": { "type": "object", "description": "Fields : Update field values (example: \"{\n \"Like\": {\n \"value\": false\n },\n \"Date\": {\n \"value\": \"2022-08-24T00:00:00.000Z\"\n }\n}\")", "properties": {} }, "pricingTable": { "type": "object", "description": "Pricing Table : Update or add metadata. See reference (https://developers.pandadoc.com/reference/create-document-from-pandadoc-template#pricing-table) (example: \"[\n {\n \"name\": \"Pricing Table 1\",\n \"sections\": [\n {\n \"title\": \"Sample Section\",\n \"default\": true\n }\n ]\n }\n]\")", "properties": {} } }, "required": [ "documentId" ], "x-integration": "pandadoc" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PANDA_DOC_GET_DOCUMENT_BY_ID": { "post": { "summary": "Get Document By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PANDA_DOC_GET_DOCUMENT_BY_ID" }, "parameters": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Document ID : Specify the ID of the Document to Get." } }, "required": [ "documentId" ], "x-integration": "pandadoc" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PANDA_DOC_DELETE_DOCUMENT": { "post": { "summary": "Delete Document", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PANDA_DOC_DELETE_DOCUMENT" }, "parameters": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Document ID : Specify the ID of the Document to Delete." } }, "required": [ "documentId" ], "x-integration": "pandadoc" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PANDA_DOC_SEND_DOCUMENT": { "post": { "summary": "Send Document", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PANDA_DOC_SEND_DOCUMENT" }, "parameters": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Document ID : Specify the ID of the Document to Send." }, "subject": { "type": "string", "description": "Subject : Value that will be used as the email subject." }, "message": { "type": "string", "description": "Message : A message which will be sent by email with a link to a document to sign." }, "silent": { "type": "string", "description": "Silent : Disables sent, viewed, comment and completed email notifications for document recipients and the document sender. By default, notifications emails are sent for specific actions. If set as true, it won't affect \"Approve document\" email notification sent to the Approver.", "enum": [ "false", "true" ] }, "sender": { "type": "object", "description": "Sender : Set a sender of the document. (example: \"{\n \"membership_id\": \"gEy74Zx4VjNfV3Q2rHdgZW\"\n}\")", "properties": {} } }, "required": [ "documentId" ], "x-integration": "pandadoc" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PANDA_DOC_SEARCH_DOCUMENTS": { "post": { "summary": "Search Documents", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PANDA_DOC_SEARCH_DOCUMENTS" }, "parameters": { "type": "object", "properties": { "documentFilterSearch": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "template_id", "folder_uuid", "form_id", "membership_id", "contact_id", "q", "tag", "status", "count", "page", "metadata", "deleted", "order_by", "created_from", "created_to", "modified_from", "modified_to", "completed_from", "completed_to" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "count": { "type": "number", "description": "Count to fetch records default is 100" }, "page": { "type": "number", "description": "Paginates the search result. Increase value to get the next page of results. Default is 1" } } } }, "x-integration": "pandadoc" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PARDOT_CREATE_OR_UPDATE_PROSPECT": { "post": { "summary": "Create Or Update Prospect", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PARDOT_CREATE_OR_UPDATE_PROSPECT" }, "parameters": { "type": "object", "properties": { "prospectId": { "type": "string", "description": "Prospect ID : Id of prospect to be updated. If left blank, creates a new prospect" }, "email": { "type": "string", "description": "Email : If there already exists a lead with this email, it will be updated." }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "company": { "type": "string", "description": "Company" }, "jobTitle": { "type": "string", "description": "Job Title : Lead’s job title." }, "phone": { "type": "string", "description": "Phone" }, "website": { "type": "string", "description": "Website" }, "additionalFields": { "type": "object", "description": "Specify any other fields that should be updated in JSON format. (example: {\"property_number\": \"17\", \"property_dropdown\": \"choice_b\", \"property_radio\": \"option_1\", \"property_string\": \"value\", \"property_date\": \"1572480000000\"})", "properties": {} } }, "required": [ "prospectId", "email" ], "x-integration": "pardot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PARDOT_SEARCH_PROSPECTS": { "post": { "summary": "Search Prospects", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PARDOT_SEARCH_PROSPECTS" }, "parameters": { "type": "object", "properties": { "prospectFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "assigned", "assigned_to_user", "created_after", "created_before", "deleted", "grade_equal_to", "grade_greater_than", "grade_less_than", "id_greater_than", "id_less_than", "is_starred", "last_activity_before", "last_activity_after", "last_activity_never", "list_id", "new", "score_equal_to", "score_greater_than", "score_less_than", "updated_after", "updated_before" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$numberEquals", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch default 100, maximum 200" }, "offset": { "type": "number", "description": "Offset of records to fetch default 0" } } } }, "x-integration": "pardot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PARDOT_GET_PROSPECT_BY_ID": { "post": { "summary": "Get Prospect By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PARDOT_GET_PROSPECT_BY_ID" }, "parameters": { "type": "object", "properties": { "prospectId": { "type": "string", "description": "Prospect ID" } }, "required": [ "prospectId" ], "x-integration": "pardot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PARDOT_DELETE_PROSPECT_BY_ID": { "post": { "summary": "Delete Prospect By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PARDOT_DELETE_PROSPECT_BY_ID" }, "parameters": { "type": "object", "properties": { "prospectId": { "type": "string", "description": "Prospect ID" } }, "required": [ "prospectId" ], "x-integration": "pardot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PARDOT_ADD_PROSPECT_TO_LIST": { "post": { "summary": "Add Prospect To List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PARDOT_ADD_PROSPECT_TO_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The list that the prospect should be added to" }, "prospectId": { "type": "string", "description": "Prospect ID : ID of prospect to be added to the List." } }, "required": [ "listId", "prospectId" ], "x-integration": "pardot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PARDOT_REMOVE_PROSPECT_FROM_LIST": { "post": { "summary": "Remove Prospect From List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PARDOT_REMOVE_PROSPECT_FROM_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The list that the prospect should be added to" }, "prospectId": { "type": "string", "description": "Prospect ID : ID of prospect to be removed to the List." } }, "required": [ "listId", "prospectId" ], "x-integration": "pardot" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_ACTIVITIES_V2": { "post": { "summary": "Create Record Activities", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_CREATE_RECORD_ACTIVITIES_V2" }, "parameters": { "type": "object", "properties": { "subject": { "type": "string", "description": "Subject" }, "note": { "type": "string", "description": "Note" }, "type": { "type": "string", "description": "Type : Defaults to Call if left blank.", "enum": [ "call", "meeting", "task", "deadline", "email", "lunch" ] }, "dueDate": { "type": "string", "description": "Due Date : Accepts Unix timestamp or ISO8601 date formats." }, "location": { "type": "object", "description": "Location : The address of the activity. (example: \"{\n \"value\": \"123 Main St\",\n \"country\": \"USA\",\n \"locality\": \"Sunnyvale\",\n \"route\": \"Main St\",\n \"street_number\": \"123\",\n \"postal_code\": \"94085\"\n}\")", "properties": {} }, "done": { "type": "boolean", "description": "Done" }, "userId": { "type": "string", "description": "User ID : The ID of the user whom the activity is assigned to. Defaults to the currently authenticated user if left blank." }, "dealId": { "type": "string", "description": "Deal ID : The ID of the deal this activity is associated with." }, "leadId": { "type": "string", "description": "Lead ID : The ID of the Lead this activity is associated with." }, "ownerId": { "type": "string", "description": "Owner ID : The ID of the user who the deal will be the owner of the lead. Defaults to the currently authenticated user if left blank." }, "participants": { "type": "object", "description": "Participants : The participants of the activity. (example: \"[{\n \"person_id\": 1,\n \"primary\": true\n}]\")", "properties": {} }, "organizationId": { "type": "string", "description": "Organization ID : The ID of the Organization this activity is associated with." } }, "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_DEALS_V2": { "post": { "summary": "Create Record Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_CREATE_RECORD_DEALS_V2" }, "parameters": { "type": "object", "properties": { "title": { "type": "string", "description": "Title" }, "value": { "type": "string", "description": "Value" }, "status": { "type": "string", "description": "Status : Defaults to Open if left blank.", "enum": [ "open", "won", "lost", "deleted" ] }, "expectedCloseDate": { "type": "string", "description": "Expected Close Date : Accepts Unix timestamp or ISO8601 date formats." }, "ownerId": { "type": "string", "description": "Owner ID : The ID of the user who the deal will be assigned to. Defaults to the currently authenticated user if left blank." }, "personId": { "type": "string", "description": "Person ID : The ID of the person who the deal will be assigned to." }, "organizationId": { "type": "string", "description": "Organization ID : The ID of an organization which this deal will be linked to." }, "pipelineId": { "type": "string", "description": "Pipeline ID : Use Connect Portal Workflow Settings to allow users to select which pipeline the deal will be added to. By default, the deal will be added to the first stage of the specified pipeline." }, "stageId": { "type": "string", "description": "Stage ID : Use Connect Portal Workflow Settings to allow users to select which stage the deal will be added to. A pipeline will be assigned automatically based on the Stage ID. If left blank, the deal will be placed in the first stage of the default pipeline." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which deal fields to update. (example: \"{\n\"property_number\": \"17\",\n\"property_dropdown\": \"choice_b\",\n\"property_radio\": \"option_1\",\n\"property_string\": \"value\",\n\"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "title" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_LEADS_V2": { "post": { "summary": "Create Record Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_CREATE_RECORD_LEADS_V2" }, "parameters": { "type": "object", "properties": {}, "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_NOTES": { "post": { "summary": "Create Record Notes", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_CREATE_RECORD_NOTES" }, "parameters": { "type": "object", "properties": { "content": { "type": "string", "description": "Content : The content of the note. Supports HTML." }, "leadId": { "type": "string", "description": "Lead ID : The ID of the lead the note will be attached to. Required unless Person ID, Organization ID, or Deal ID is provided." }, "personId": { "type": "string", "description": "Person ID : The ID of the person the note will be attached to. Required unless Lead ID, Organization ID, or Deal ID is provided." }, "organizationId": { "type": "string", "description": "Organization ID : The ID of the organization the note will be attached to. Required unless Lead ID, Person ID, or Deal ID is provided." }, "dealId": { "type": "string", "description": "Deal ID : The ID of the Deal the note will be attached to. Required unless Lead ID, Person ID, or Organization ID is provided." } }, "required": [ "content" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_ORGANIZATIONS_V2": { "post": { "summary": "Create Record Organizations", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_CREATE_RECORD_ORGANIZATIONS_V2" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "ownerId": { "type": "string", "description": "Owner ID : The ID of the user who will be marked as the owner of the organization. Defaults to the currently authenticated user if left blank." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which organization fields to update. (example: \"{\n\"property_number\": \"17\",\n\"property_dropdown\": \"choice_b\",\n\"property_radio\": \"option_1\",\n\"property_string\": \"value\",\n\"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "name" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_PERSONS_V2": { "post": { "summary": "Create Record Persons", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_CREATE_RECORD_PERSONS_V2" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "emails": { "type": "string", "description": "Emails (example: \"[{\"value\": \"email@example.com\", \"primary\": true, \"label\": \"Work\"}]\")" }, "phones": { "type": "string", "description": "Phones (example: \"[{\"value\": \"+1234567890\", \"primary\": true, \"label\": \"Work\"}]\")" }, "organizationId": { "type": "string", "description": "Organization ID : The ID of the organization this person will belong to." }, "ownerId": { "type": "string", "description": "Owner ID : The ID of the user who will be marked as the owner of the person. Defaults to the currently authenticated user if left blank." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which persons fields to update. (example: \"{\n\"property_number\": \"17\",\n\"property_dropdown\": \"choice_b\",\n\"property_radio\": \"option_1\",\n\"property_string\": \"value\",\n\"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "name" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_USERS": { "post": { "summary": "Create Record Users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_CREATE_RECORD_USERS" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "email": { "type": "string", "description": "Email" }, "activeStatus": { "type": "string", "description": "Active Status", "enum": [ "true", "false" ] } }, "required": [ "name", "email", "activeStatus" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_ANY": { "post": { "summary": "Create Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_CREATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_ACTIVITIES_V2": { "post": { "summary": "Update Record Activities", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_UPDATE_RECORD_ACTIVITIES_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the activity that will be updated." }, "subject": { "type": "string", "description": "Subject" }, "note": { "type": "string", "description": "Note" }, "type": { "type": "string", "description": "Type", "enum": [ "call", "meeting", "task", "deadline", "email", "lunch" ] }, "dueDate": { "type": "string", "description": "Due Date : Accepts Unix timestamp or ISO8601 date formats." }, "location": { "type": "object", "description": "Location : The address of the activity. (example: \"{\n \"value\": \"123 Main St\",\n \"country\": \"USA\",\n \"locality\": \"Sunnyvale\",\n \"route\": \"Main St\",\n \"street_number\": \"123\",\n \"postal_code\": \"94085\"\n}\")", "properties": {} }, "done": { "type": "boolean", "description": "Done" }, "userId": { "type": "string", "description": "User ID : The ID of the user whom the activity is assigned to." }, "dealId": { "type": "string", "description": "Deal ID : The ID of the deal this activity is associated with." }, "leadId": { "type": "string", "description": "Lead ID : The ID of the Lead this activity is associated with." }, "ownerId": { "type": "string", "description": "Owner ID : The ID of the user who the deal will be the owner of the lead. Defaults to the currently authenticated user if left blank." }, "participants": { "type": "object", "description": "Participants : The participants of the activity. (example: \"[{\n \"person_id\": 1,\n \"primary\": true\n}]\")", "properties": {} }, "organizationId": { "type": "string", "description": "Organization ID : The ID of the Organization this activity is associated with." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_DEALS_V2": { "post": { "summary": "Update Record Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_UPDATE_RECORD_DEALS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the deal that will be updated." }, "title": { "type": "string", "description": "Title" }, "value": { "type": "string", "description": "Value" }, "status": { "type": "string", "description": "Status : Defaults to Open if left blank.", "enum": [ "open", "won", "lost", "deleted" ] }, "expectedCloseDate": { "type": "string", "description": "Expected Close Date : Accepts Unix timestamp or ISO8601 date formats." }, "ownerId": { "type": "string", "description": "Owner ID : The ID of the user who the deal will be assigned to." }, "personId": { "type": "string", "description": "Person ID : The ID of the person who the deal will be assigned to." }, "organizationId": { "type": "string", "description": "Organization ID : The ID of an organization which this deal will be linked to." }, "pipelineId": { "type": "string", "description": "Pipeline ID : Use Connect Portal Workflow Settings to allow users to select which pipeline the deal will be added to." }, "stageId": { "type": "string", "description": "Stage ID : Use Connect Portal Workflow Settings to allow users to select which stage the deal will be added to. A pipeline will be assigned automatically based on the Stage ID." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which deal fields to update. (example: \"{\n\"property_number\": \"17\",\n\"property_dropdown\": \"choice_b\",\n\"property_radio\": \"option_1\",\n\"property_string\": \"value\",\n\"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_LEADS_V2": { "post": { "summary": "Update Record Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_UPDATE_RECORD_LEADS_V2" }, "parameters": { "type": "object", "properties": {}, "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_NOTES": { "post": { "summary": "Update Record Notes", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_UPDATE_RECORD_NOTES" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the note that will be updated." }, "content": { "type": "string", "description": "Content : The content of the note. Supports HTML." }, "leadId": { "type": "string", "description": "Lead ID : The ID of the lead the note will be attached to." }, "personId": { "type": "string", "description": "Person ID : The ID of the person the note will be attached to." }, "organizationId": { "type": "string", "description": "Organization ID : The ID of the organization the note will be attached to." }, "dealId": { "type": "string", "description": "Deal ID : The ID of the Deal the note will be attached to." } }, "required": [ "recordId", "content" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_ORGANIZATIONS_V2": { "post": { "summary": "Update Record Organizations", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_UPDATE_RECORD_ORGANIZATIONS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the organization that will be updated." }, "name": { "type": "string", "description": "Name" }, "ownerId": { "type": "string", "description": "Owner ID : The ID of the user who will be marked as the owner of the organization." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which organization fields to update. (example: \"{\n\"property_number\": \"17\",\n\"property_dropdown\": \"choice_b\",\n\"property_radio\": \"option_1\",\n\"property_string\": \"value\",\n\"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "recordId", "name" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_PERSONS_V2": { "post": { "summary": "Update Record Persons", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_UPDATE_RECORD_PERSONS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the person that will be updated." }, "name": { "type": "string", "description": "Name" }, "emails": { "type": "string", "description": "Emails (example: \"[{\"value\": \"email@example.com\", \"primary\": true, \"label\": \"Work\"}]\")" }, "phones": { "type": "string", "description": "Phones (example: \"[{\"value\": \"+1234567890\", \"primary\": true, \"label\": \"Work\"}]\")" }, "organizationId": { "type": "string", "description": "Organization ID : The ID of the organization this person will belong to." }, "ownerId": { "type": "string", "description": "Owner ID : The ID of the user who will be marked as the owner of the person." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which persons fields to update. (example: \"{\n\"property_number\": \"17\",\n\"property_dropdown\": \"choice_b\",\n\"property_radio\": \"option_1\",\n\"property_string\": \"value\",\n\"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_USERS": { "post": { "summary": "Update Record Users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_UPDATE_RECORD_USERS" }, "parameters": { "type": "object", "properties": {}, "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_ANY": { "post": { "summary": "Update Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_UPDATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_ACTIVITIES_V2": { "post": { "summary": "Get Record By ID Activities", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORD_BY_ID_ACTIVITIES_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the activity that will be updated." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_DEALS_V2": { "post": { "summary": "Get Record By ID Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORD_BY_ID_DEALS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the activity that will be updated." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_LEADS_V2": { "post": { "summary": "Get Record By ID Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORD_BY_ID_LEADS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record Id" } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_NOTES": { "post": { "summary": "Get Record By ID Notes", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORD_BY_ID_NOTES" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the activity that will be updated." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_ORGANIZATIONS_V2": { "post": { "summary": "Get Record By ID Organizations", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORD_BY_ID_ORGANIZATIONS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the activity that will be updated." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_PERSONS_V2": { "post": { "summary": "Get Record By ID Persons", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORD_BY_ID_PERSONS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the activity that will be updated." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_USERS": { "post": { "summary": "Get Record By ID Users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORD_BY_ID_USERS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the activity that will be updated." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_ANY": { "post": { "summary": "Get Record By ID Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORD_BY_ID_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordType", "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_ACTIVITIES_V2": { "post": { "summary": "Get Records Activities", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORDS_ACTIVITIES_V2" }, "parameters": { "type": "object", "properties": { "term": { "type": "string", "description": "Term" }, "recordFilterFormula": { "type": "string", "description": "Record Filter Formula" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "term" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_DEALS_V2": { "post": { "summary": "Get Records Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORDS_DEALS_V2" }, "parameters": { "type": "object", "properties": { "term": { "type": "string", "description": "Term : The search term to look for." }, "recordFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "person_id", "organization_id" ] }, "operator": { "type": "string", "enum": [ "$numberEquals", "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "required": [ "term" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_LEADS_V2": { "post": { "summary": "Get Records Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORDS_LEADS_V2" }, "parameters": { "type": "object", "properties": { "term": { "type": "string", "description": "Term : The search term to look for." }, "recordFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "person_id", "organization_id" ] }, "operator": { "type": "string", "enum": [ "$numberEquals", "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "required": [ "term" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_NOTES": { "post": { "summary": "Get Records Notes", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORDS_NOTES" }, "parameters": { "type": "object", "properties": { "term": { "type": "string", "description": "Term" }, "recordFilterFormula": { "type": "string", "description": "Record Filter Formula" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "term" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_ORGANIZATIONS_V2": { "post": { "summary": "Get Records Organizations", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORDS_ORGANIZATIONS_V2" }, "parameters": { "type": "object", "properties": { "term": { "type": "string", "description": "Term : The search term to look for." }, "recordFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "person_id", "organization_id" ] }, "operator": { "type": "string", "enum": [ "$numberEquals", "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "required": [ "term" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_PERSONS_V2": { "post": { "summary": "Get Records Persons", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORDS_PERSONS_V2" }, "parameters": { "type": "object", "properties": { "term": { "type": "string", "description": "Term : The search term to look for." }, "recordFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "person_id", "organization_id" ] }, "operator": { "type": "string", "enum": [ "$numberEquals", "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "required": [ "term" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_USERS": { "post": { "summary": "Get Records Users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORDS_USERS" }, "parameters": { "type": "object", "properties": { "term": { "type": "string", "description": "Term" }, "recordFilterFormula": { "type": "string", "description": "Record Filter Formula" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "term" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_ANY": { "post": { "summary": "Get Records Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_GET_RECORDS_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordFilterFormula": { "type": "string", "description": "Filter Search" }, "term": { "type": "string", "description": "Search Term" } }, "required": [ "recordType", "term" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_ACTIVITIES_V2": { "post": { "summary": "Delete Record Activities", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DELETE_RECORD_ACTIVITIES_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the event to delete." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_DEALS_V2": { "post": { "summary": "Delete Record Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DELETE_RECORD_DEALS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the event to delete." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_LEADS_V2": { "post": { "summary": "Delete Record Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DELETE_RECORD_LEADS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record Id" } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_NOTES": { "post": { "summary": "Delete Record Notes", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DELETE_RECORD_NOTES" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the event to delete." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_ORGANIZATIONS_V2": { "post": { "summary": "Delete Record Organizations", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DELETE_RECORD_ORGANIZATIONS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the event to delete." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_PERSONS_V2": { "post": { "summary": "Delete Record Persons", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DELETE_RECORD_PERSONS_V2" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the event to delete." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_USERS": { "post": { "summary": "Delete Record Users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DELETE_RECORD_USERS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the event to delete." } }, "required": [ "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_ANY": { "post": { "summary": "Delete Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DELETE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordType", "recordId" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PIPEDRIVE_DESCRIBE_ACTION_SCHEMA": { "post": { "summary": "Describe Action Schema", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PIPEDRIVE_DESCRIBE_ACTION_SCHEMA" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "operation": { "type": "string", "description": "Operation Type value for example CREATE_RECORD or UPDATE_RECORD" } }, "required": [ "recordType", "operation" ], "x-integration": "pipedrive" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PRODUCTBOARD_CREATE_FEATURE": { "post": { "summary": "Create Feature", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PRODUCTBOARD_CREATE_FEATURE" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : Specify a name for this feature. (example: \"My feature\")" }, "description": { "type": "string", "description": "Description : Specify a description for this feature. The format is a limited subset of HTML defined by this\n XML schema. (https://developer.productboard.com/page/schema) (example: \"

    Custom branding for the agent and user portals.

    \")" }, "type": { "type": "string", "description": "Type : Specify the type of this feature.", "enum": [ "feature", "subfeature" ] }, "status": { "type": "object", "description": "Status : Specify the status of this feature. It is not possible to specify both ID and name, only one of them can be used. (example: \"{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"In Progress\"\n}\")", "properties": {} }, "parentId": { "type": "string", "description": "Parent ID : Specify the record ID of the parent entity of this feature. This can be either a feature ID, component ID, or product ID. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" }, "email": { "type": "string", "description": "Owner Email : Specify the email of a member to own the feature. A member is a Productboard user that has access to a space. (example: \"user@domain.com\")" } }, "required": [ "name", "description", "type", "status", "parentId" ], "x-integration": "productboard" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PRODUCTBOARD_UPDATE_FEATURE": { "post": { "summary": "Update Feature", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PRODUCTBOARD_UPDATE_FEATURE" }, "parameters": { "type": "object", "properties": { "featureId": { "type": "string", "description": "Feature ID : Specify the feature ID of the feature to update. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" }, "name": { "type": "string", "description": "Name : Specify a name for this feature. (example: \"My feature\")" }, "description": { "type": "string", "description": "Description : Specify a description for this feature. The format is a limited subset of HTML defined by this\n XML schema. (https://developer.productboard.com/page/schema) (example: \"

    Custom branding for the agent and user portals.

    \")" }, "status": { "type": "object", "description": "Status : Specify the status of this feature. It is not possible to specify both ID and name, only one of them can be used. (example: \"{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"In Progress\"\n}\")", "properties": {} }, "parentId": { "type": "string", "description": "Parent ID : Specify the record ID of the parent entity of this feature. This can be either a feature ID, component ID, or product ID. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" }, "email": { "type": "string", "description": "Owner Email : Specify the email of a member to own the feature. A member is a Productboard user that has access to a space. (example: \"user@domain.com\")" } }, "required": [ "featureId" ], "x-integration": "productboard" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PRODUCTBOARD_GET_FEATURE_BY_ID": { "post": { "summary": "Get Feature By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PRODUCTBOARD_GET_FEATURE_BY_ID" }, "parameters": { "type": "object", "properties": { "featureId": { "type": "string", "description": "Feature ID : Specify the feature ID of the feature to fetch. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" } }, "required": [ "featureId" ], "x-integration": "productboard" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PRODUCTBOARD_DELETE_FEATURE": { "post": { "summary": "Delete Feature", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PRODUCTBOARD_DELETE_FEATURE" }, "parameters": { "type": "object", "properties": { "featureId": { "type": "string", "description": "Feature ID : Specify the feature ID of the feature to delete. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" } }, "required": [ "featureId" ], "x-integration": "productboard" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PRODUCTBOARD_CREATE_COMPONENT": { "post": { "summary": "Create Component", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PRODUCTBOARD_CREATE_COMPONENT" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : Specify the name of the component to create." }, "description": { "type": "string", "description": "Description : Specify a description for this component. The format is a limited subset of HTML defined by this\n XML schema. (https://developer.productboard.com/page/schema) (example: \"

    Custom branding for the agent and user portals.

    \")" }, "parentId": { "type": "string", "description": "Parent ID : Specify the record ID of the parent entity of this feature. This can be either a component ID, or product ID. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" }, "email": { "type": "string", "description": "Owner Email : Specify the email of a member to own the component. A member is a Productboard user that has access to a space. (example: \"user@domain.com\")" } }, "required": [ "name", "description", "parentId" ], "x-integration": "productboard" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PRODUCTBOARD_UPDATE_COMPONENT": { "post": { "summary": "Update Component", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PRODUCTBOARD_UPDATE_COMPONENT" }, "parameters": { "type": "object", "properties": { "componentId": { "type": "string", "description": "Component ID : Specify the component ID of the component to update. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" }, "name": { "type": "string", "description": "Name : Specify the name of the component to create." }, "description": { "type": "string", "description": "Description : Specify a description for this component. The format is a limited subset of HTML defined by this\n XML schema. (https://developer.productboard.com/page/schema) (example: \"

    Custom branding for the agent and user portals.

    \")" }, "email": { "type": "string", "description": "Owner Email : Specify the email of a member to own the component. A member is a Productboard user that has access to a space. (example: \"user@domain.com\")" } }, "required": [ "componentId" ], "x-integration": "productboard" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PRODUCTBOARD_GET_COMPONENT_BY_ID": { "post": { "summary": "Get Component By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PRODUCTBOARD_GET_COMPONENT_BY_ID" }, "parameters": { "type": "object", "properties": { "componentId": { "type": "string", "description": "Component ID : Specify the component ID of the feature to fetch. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" } }, "required": [ "componentId" ], "x-integration": "productboard" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#PRODUCTBOARD_GET_PRODUCT_BY_ID": { "post": { "summary": "Get Product By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "PRODUCTBOARD_GET_PRODUCT_BY_ID" }, "parameters": { "type": "object", "properties": { "productId": { "type": "string", "description": "Product ID : Specify the product ID of the product to fetch. (example: \"1d5112af-4195-43d2-9939-ddb9c3de1cd6\")" } }, "required": [ "productId" ], "x-integration": "productboard" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_GET_ACCOUNTS": { "post": { "summary": "Get Accounts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_GET_ACCOUNTS" }, "parameters": { "type": "object", "properties": { "accountsFilterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Id", "name", "SubAccount", "FullyQualifiedName", "ParentRef", "Active", "Classification", "AccountType", "AccountSubType", "CurrentBalance", "CurrentBalanceWithSubAccounts", "MetaData.LastUpdatedTime", "MetaData.CreateTime" ] }, "operator": { "type": "string", "enum": [ "$numberLessThan", "$numberEquals", "$numberGreaterThan", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$stringIsIn", "$stringGreaterThan", "$stringLessThan", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "startPosition": { "type": "number", "description": "Start Position" }, "limit": { "type": "number", "description": "Limit" } } } }, "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_GET_CUSTOMERS": { "post": { "summary": "Get Customers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_GET_CUSTOMERS" }, "parameters": { "type": "object", "properties": { "customersFilterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Active", "Id", "Job", "Balance", "BalanceWithJobs", "GivenName", "FamilyName", "FullyQualifiedName", "CompanyName", "DisplayName", "PrintOnCheckName", "MetaData.LastUpdatedTime", "MetaData.CreateTime", "PrimaryEmailAddr" ] }, "operator": { "type": "string", "enum": [ "$numberLessThan", "$numberEquals", "$numberGreaterThan", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$stringIsIn", "$stringGreaterThan", "$stringLessThan", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "startPosition": { "type": "number", "description": "Start Position" }, "limit": { "type": "number", "description": "Limit" } } } }, "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_CREATE_CUSTOMER": { "post": { "summary": "Create Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_CREATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "givenName": { "type": "string", "description": "Given name" }, "familyName": { "type": "string", "description": "Family name" }, "displayName": { "type": "string", "description": "Display name" }, "email": { "type": "string", "description": "Email address" }, "phoneNumber": { "type": "string", "description": "Phone number" }, "billingAddressLine1": { "type": "string", "description": "Billing street address" }, "billingAddressLine2": { "type": "string", "description": "Billing street address line 2" }, "billingCity": { "type": "string", "description": "Billing city" }, "billingStateSubdivisionCode": { "type": "string", "description": "Billing State or country subdivision code" }, "billingCountry": { "type": "string", "description": "Billing country" }, "billingPostalCode": { "type": "string", "description": "Billing postal code" } }, "required": [ "givenName", "familyName" ], "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_UPDATE_CUSTOMER": { "post": { "summary": "Update Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_UPDATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "updateCustomerId": { "type": "string", "description": "Customer : The ID of the customer to update. (example: \"Customer ID\")" }, "givenName": { "type": "string", "description": "Given name" }, "familyName": { "type": "string", "description": "Family name" }, "displayName": { "type": "string", "description": "Display name" }, "email": { "type": "string", "description": "Email address" }, "phoneNumber": { "type": "string", "description": "Phone number" }, "billingAddressLine1": { "type": "string", "description": "Billing street address" }, "billingAddressLine2": { "type": "string", "description": "Billing street address line 2" }, "billingCity": { "type": "string", "description": "Billing city" }, "billingStateSubdivisionCode": { "type": "string", "description": "Billing State or country subdivision code" }, "billingCountry": { "type": "string", "description": "Billing country" }, "billingPostalCode": { "type": "string", "description": "Billing postal code" }, "syncToken": { "type": "string", "description": "Sync Token : Current version number of the object, which will be incremented for the update. The Sync Token value can be retrieved from any QuickBooks object. Defaults to incrementing the previous Sync Token value." } }, "required": [ "updateCustomerId", "givenName", "familyName" ], "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_GET_INVOICES": { "post": { "summary": "Get Invoices", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_GET_INVOICES" }, "parameters": { "type": "object", "properties": { "invoicesFilterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Id", "CustomerRef", "Balance", "TotalAmt", "TxnDate", "DocNumber", "SalesTermRef", "DueDate", "MetaData.LastUpdatedTime", "MetaData.CreateTime" ] }, "operator": { "type": "string", "enum": [ "$numberLessThan", "$numberEquals", "$numberGreaterThan", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$stringIsIn", "$stringGreaterThan", "$stringLessThan", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "startPosition": { "type": "number", "description": "Start Position" }, "limit": { "type": "number", "description": "Limit" } } } }, "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_CREATE_INVOICE": { "post": { "summary": "Create Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_CREATE_INVOICE" }, "parameters": { "type": "object", "properties": { "CustomerId": { "type": "string", "description": "Customer : The customer this invoice is associated with. (example: \"Customer ID\")" }, "invoiceLinesV1": { "type": "object", "description": "Line items : Enter an array of Line items including the description, quantity, and amount for each Line item. (example: \"[\n {\n \"DetailType\": \"SalesItemLineDetail\", \n \"Amount\": 100.0, \n \"SalesItemLineDetail\": {\n \"ItemRef\": {\n \"name\": \"Services\", \n \"value\": \"1\"\n }\n }\n }\n]\")", "properties": {} }, "customerMemo": { "type": "string", "description": "Customer memo : Message to the customer that appears on their invoice." }, "currencyId": { "type": "string", "description": "Currency", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] } }, "required": [ "CustomerId", "invoiceLinesV1" ], "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_UPDATE_INVOICE": { "post": { "summary": "Update Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_UPDATE_INVOICE" }, "parameters": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "Invoice ID : The ID of the invoice to update. (example: \"Invoice ID\")" }, "syncToken": { "type": "string", "description": "Sync Token : Current version number of the object, which will be incremented for the update. The Sync Token value can be retrieved from any QuickBooks object. Defaults to incrementing the previous Sync Token value." }, "customerMemo": { "type": "string", "description": "Customer memo : Message to the customer that appears on their invoice." } }, "required": [ "invoiceId" ], "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_SEND_INVOICE": { "post": { "summary": "Send Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_SEND_INVOICE" }, "parameters": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "Invoice ID (example: \"Enter invoice ID\")" }, "email": { "type": "string", "description": "Send to email address : Updates the invoice’s billing email address to the email provided. If left blank, sends to the invoice’s existing billing email address. (example: \"name@example.com\")" } }, "required": [ "invoiceId" ], "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_GET_PAYMENTS": { "post": { "summary": "Get Payments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_GET_PAYMENTS" }, "parameters": { "type": "object", "properties": { "paymentsFilterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Id", "CustomerRef", "TotalAmt", "TxnDate", "MetaData.LastUpdatedTime", "MetaData.CreateTime" ] }, "operator": { "type": "string", "enum": [ "$numberLessThan", "$numberEquals", "$numberGreaterThan", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringContains", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$stringIsIn", "$stringGreaterThan", "$stringLessThan", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "startPosition": { "type": "number", "description": "Start Position" }, "limit": { "type": "number", "description": "Limit" } } } }, "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#QUICKBOOKS_CREATE_PAYMENT": { "post": { "summary": "Create Payment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "QUICKBOOKS_CREATE_PAYMENT" }, "parameters": { "type": "object", "properties": { "totalAmount": { "type": "string", "description": "Total amount (example: \"25.0\")" }, "customerId": { "type": "string", "description": "Customer : The Customer this payment is associated with. (example: \"Customer ID\")" }, "currencyId": { "type": "string", "description": "Currency", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] } }, "required": [ "totalAmount", "customerId" ], "x-integration": "quickbooks" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#RAMP_CREATE_VENDOR": { "post": { "summary": "Create Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "RAMP_CREATE_VENDOR" }, "parameters": { "type": "object", "properties": { "country": { "type": "string", "description": "Country : Specify the ISO 3166-1 alpha-2 country code (e.g. US, CA, GB). (example: \"US\")" }, "email": { "type": "string", "description": "Contact Email : Specify the email address of the primary vendor contact. (example: \"contact@vendor.com\")" }, "name": { "type": "string", "description": "Business Name : Specify the legal business name of the vendor. (example: \"e.g., Acme Corp\")" }, "vendorNumber": { "type": "string", "description": "Vendor Number : Specify your system's vendor identifier. Recommended for cross-system linking; maps to Ramp's external_vendor_id. (example: \"Your system's vendor ID\")" }, "firstName": { "type": "string", "description": "Contact First Name : Specify the first name of the primary vendor contact. (example: \"e.g., Jane\")" }, "lastName": { "type": "string", "description": "Contact Last Name : Specify the last name of the primary vendor contact. (example: \"e.g., Smith\")" }, "phone": { "type": "string", "description": "Contact Phone : Specify the phone number of the primary vendor contact." }, "address": { "type": "object", "description": "Address : Specify the vendor address as JSON, using Ramp snake_case keys (address_line_1, city, state, postal_code, country). (example: \"{\n \"address_line_1\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"US\"\n}\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Optional JSON object of any other Ramp vendor fields (e.g. request_tax_details, request_payment_details, vendor_owner_id, accounting_vendor_remote_id, vendor_tracking_category_option_id, state). Shallow-merged into the request body; values here override the dedicated inputs above. (example: \"{\n \"request_tax_details\": true,\n \"request_payment_details\": true,\n \"vendor_owner_id\": \"...\"\n}\")", "properties": {} } }, "required": [ "country", "email", "name" ], "x-integration": "ramp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#RAMP_UPDATE_VENDOR": { "post": { "summary": "Update Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "RAMP_UPDATE_VENDOR" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : Specify the Ramp vendor ID. (example: \"e.g., 3f24a891-...\")" }, "name": { "type": "string", "description": "Business Name : Specify the legal business name of the vendor. (example: \"e.g., Acme Corp\")" }, "vendorNumber": { "type": "string", "description": "Vendor Number : Specify your system's vendor identifier. Recommended for cross-system linking; maps to Ramp's external_vendor_id. (example: \"Your system's vendor ID\")" }, "address": { "type": "object", "description": "Address : Specify the vendor address as JSON, using Ramp snake_case keys (address_line_1, city, state, postal_code, country). (example: \"{\n \"address_line_1\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"US\"\n}\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Optional JSON object of any other Ramp vendor fields (e.g. request_tax_details, request_payment_details, vendor_owner_id, accounting_vendor_remote_id, vendor_tracking_category_option_id, state). Shallow-merged into the request body; values here override the dedicated inputs above. (example: \"{\n \"request_tax_details\": true,\n \"request_payment_details\": true,\n \"vendor_owner_id\": \"...\"\n}\")", "properties": {} } }, "required": [ "vendorId" ], "x-integration": "ramp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#RAMP_GET_VENDOR_BY_ID": { "post": { "summary": "Get Vendor By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "RAMP_GET_VENDOR_BY_ID" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : Specify the Ramp vendor ID. (example: \"e.g., 3f24a891-...\")" } }, "required": [ "vendorId" ], "x-integration": "ramp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#RAMP_LIST_VENDORS": { "post": { "summary": "List Vendors", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "RAMP_LIST_VENDORS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Specify the number of items to return per page" }, "pageCursor": { "type": "string", "description": "Specify the cursor / start token for the next page" } } } }, "x-integration": "ramp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#RAMP_GET_LOCATION_BY_ID": { "post": { "summary": "Get Location By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "RAMP_GET_LOCATION_BY_ID" }, "parameters": { "type": "object", "properties": { "locationId": { "type": "string", "description": "Location ID : Specify the Ramp location ID. (example: \"e.g., 3f24a891-...\")" } }, "required": [ "locationId" ], "x-integration": "ramp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#RAMP_LIST_LOCATIONS": { "post": { "summary": "List Locations", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "RAMP_LIST_LOCATIONS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Specify the number of items to return per page" }, "pageCursor": { "type": "string", "description": "Specify the cursor / start token for the next page" } } } }, "x-integration": "ramp" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_CREATE_VENDOR": { "post": { "summary": "Create Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_CREATE_VENDOR" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : The name of the vendor." }, "status": { "type": "string", "description": "Status : Defaults to Active.", "enum": [ "active", "inactive" ] }, "printAs": { "type": "string", "description": "Primary Contact: Print As : The display name to print as the contact info for the vendor. (example: \"Acme Widget Company, Inc.\")" }, "firstName": { "type": "string", "description": "Primary Contact: First Name" }, "lastName": { "type": "string", "description": "Primary Contact: Last Name" }, "phoneNumber": { "type": "string", "description": "Primary Contact: Phone Number" }, "email": { "type": "string", "description": "Primary Contact: Email Address (example: \"sean@example.com\")" }, "url": { "type": "string", "description": "Company URL (example: \"https://example.com\")" }, "addressLine1": { "type": "string", "description": "Address Line 1" }, "addressLine2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State : Use state or province." }, "zip": { "type": "string", "description": "ZIP : Use ZIP or postal code, if applicable." }, "country": { "type": "string", "description": "Country" }, "vendorType": { "type": "string", "description": "The name of the vendor type. (example: Commercial & Retail Products)" }, "parent": { "type": "string", "description": "Parent : The ID of the parent vendor, if applicable." }, "glGroup": { "type": "string", "description": "GL Group : The name of the GL group this vendor should be included in." }, "taxId": { "type": "string", "description": "Tax ID (example: \"12-3456789\")" }, "form1099Name": { "type": "string", "description": "Form 1099 Name (example: \"Acme Co Inc.\")" }, "form1099Type": { "type": "string", "description": "Form 1099 Type (example: \"MISC\")" }, "form1099Box": { "type": "string", "description": "Form 1099 Box (example: \"3\")" }, "defaultExpenseAccount": { "type": "string", "description": "The GL account used for expenses from this vendor. (example: 1000)" }, "creditLimit": { "type": "string", "description": "Credit Limit (example: \"1234.56\")" }, "onHold": { "type": "boolean", "description": "On Hold" }, "doNotPay": { "type": "boolean", "description": "Do Not Pay" }, "billingComments": { "type": "string", "description": "Billing Comments" }, "taxable": { "type": "boolean", "description": "Taxable" }, "contactTaxGroup": { "type": "string", "description": "Contact Tax Group : The name of the tax group this vendor should be included in." }, "preferredPaymentMethod": { "type": "string", "description": "Preferred Payment Method", "enum": [ "Printed Check", "Charge Card", "EFT", "Cash", "ACH" ] }, "paymentPriority": { "type": "string", "description": "Payment Priority", "enum": [ "Urgent", "High", "Normal", "Low" ] }, "billingType": { "type": "string", "description": "Billing Type", "enum": [ "openitem", "balanceforward" ] }, "term": { "type": "string", "description": "The name of the payment term for this vendor. (example: Net 30)" }, "mergePaymentRequests": { "type": "boolean", "description": "Merge Payment Requests" }, "sendPaymentNotification": { "type": "boolean", "description": "Send Automatic Payment Notification" }, "displayTermDiscount": { "type": "boolean", "description": "Display Term Discount : Determines if term discount appears on the check stub." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields to be included in this vendor. (example: \"{\n \"ACHENABLED\": true,\n \"ACHBANKROUTINGNUMBER\": \"xxx\",\n \"ACHACCOUNTNUMBER\": \"xxx\"\n}\")", "properties": {} } }, "required": [ "name", "printAs" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_UPDATE_VENDOR": { "post": { "summary": "Update Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_UPDATE_VENDOR" }, "parameters": { "type": "object", "properties": { "recordNumber": { "type": "string", "description": "Record Number : The record number of the vendor to update. (example: \"123\")" }, "name": { "type": "string", "description": "Name : The name of the vendor." }, "status": { "type": "string", "description": "Status : Defaults to Active.", "enum": [ "active", "inactive" ] }, "printAs": { "type": "string", "description": "Primary Contact: Print As : The display name to print as the contact info for the vendor. (example: \"Acme Widget Company, Inc.\")" }, "firstName": { "type": "string", "description": "Primary Contact: First Name" }, "lastName": { "type": "string", "description": "Primary Contact: Last Name" }, "phoneNumber": { "type": "string", "description": "Primary Contact: Phone Number" }, "email": { "type": "string", "description": "Primary Contact: Email Address (example: \"sean@example.com\")" }, "url": { "type": "string", "description": "Company URL (example: \"https://example.com\")" }, "addressLine1": { "type": "string", "description": "Address Line 1" }, "addressLine2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State : Use state or province." }, "zip": { "type": "string", "description": "ZIP : Use ZIP or postal code, if applicable." }, "country": { "type": "string", "description": "Country" }, "vendorType": { "type": "string", "description": "The name of the vendor type. (example: Commercial & Retail Products)" }, "parent": { "type": "string", "description": "Parent : The ID of the parent vendor, if applicable." }, "glGroup": { "type": "string", "description": "GL Group : The name of the GL group this vendor should be included in." }, "taxId": { "type": "string", "description": "Tax ID (example: \"12-3456789\")" }, "form1099Name": { "type": "string", "description": "Form 1099 Name (example: \"Acme Co Inc.\")" }, "form1099Type": { "type": "string", "description": "Form 1099 Type (example: \"MISC\")" }, "form1099Box": { "type": "string", "description": "Form 1099 Box (example: \"3\")" }, "defaultExpenseAccount": { "type": "string", "description": "The GL account used for expenses from this vendor. (example: 1000)" }, "creditLimit": { "type": "string", "description": "Credit Limit (example: \"1234.56\")" }, "onHold": { "type": "boolean", "description": "On Hold" }, "doNotPay": { "type": "boolean", "description": "Do Not Pay" }, "billingComments": { "type": "string", "description": "Billing Comments" }, "taxable": { "type": "boolean", "description": "Taxable" }, "contactTaxGroup": { "type": "string", "description": "Contact Tax Group : The name of the tax group this vendor should be included in." }, "preferredPaymentMethod": { "type": "string", "description": "Preferred Payment Method", "enum": [ "Printed Check", "Charge Card", "EFT", "Cash", "ACH" ] }, "paymentPriority": { "type": "string", "description": "Payment Priority", "enum": [ "Urgent", "High", "Normal", "Low" ] }, "billingType": { "type": "string", "description": "Billing Type", "enum": [ "openitem", "balanceforward" ] }, "term": { "type": "string", "description": "The name of the payment term for this vendor. (example: Net 30)" }, "mergePaymentRequests": { "type": "boolean", "description": "Merge Payment Requests" }, "sendPaymentNotification": { "type": "boolean", "description": "Send Automatic Payment Notification" }, "displayTermDiscount": { "type": "boolean", "description": "Display Term Discount : Determines if term discount appears on the check stub." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields to be included in this vendor. (example: \"{\n \"ACHENABLED\": true,\n \"ACHBANKROUTINGNUMBER\": \"xxx\",\n \"ACHACCOUNTNUMBER\": \"xxx\"\n}\")", "properties": {} } }, "required": [ "recordNumber" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_DELETE_VENDOR": { "post": { "summary": "Delete Vendor", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_DELETE_VENDOR" }, "parameters": { "type": "object", "properties": { "recordNumber": { "type": "string", "description": "Record Number : The record number of the vendor to delete. (example: \"123\")" } }, "required": [ "recordNumber" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_VENDORS": { "post": { "summary": "Search Vendors", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_SEARCH_VENDORS" }, "parameters": { "type": "object", "properties": { "vendorFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringLessThan", "$numberLessThanOrEqualTo", "$stringGreaterThan", "$numberGreaterThanOrEqualTo", "$exists", "$doesNotExist", "$stringContains", "$stringDoesNotContain" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "offset": { "type": "integer", "description": "Page Offset" }, "pageSize": { "type": "integer", "description": "Page Size" } } } }, "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_GET_VENDOR_BY_ID": { "post": { "summary": "Get Vendor By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_GET_VENDOR_BY_ID" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : ID of the vendor to get." }, "recordNumber": { "type": "string", "description": "Record Number : The record number of the vendor to get. (example: \"123\")" } }, "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_VENDOR_TYPES": { "post": { "summary": "Search Vendor Types", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_SEARCH_VENDOR_TYPES" }, "parameters": { "type": "object", "properties": { "vendorTypesFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "NAME", "STATUS" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringLessThan", "$numberLessThanOrEqualTo", "$stringGreaterThan", "$numberGreaterThanOrEqualTo", "$exists", "$doesNotExist", "$stringContains", "$stringDoesNotContain" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "offset": { "type": "integer", "description": "Page Offset" }, "pageSize": { "type": "integer", "description": "Page Size" } } } }, "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_CREATE_BILL": { "post": { "summary": "Create Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_CREATE_BILL" }, "parameters": { "type": "object", "properties": { "vendorId": { "type": "string", "description": "Vendor ID : The vendor ID this bill is for." }, "date": { "type": "string", "description": "Date : Transaction date for when this bill was created. Format as MM/DD/YYYY. (example: \"12/15/2030\")" }, "dueDate": { "type": "string", "description": "Due Date : Due date for this bill. Format as MM/DD/YYYY. (example: \"12/15/2030\")" }, "billItems": { "type": "object", "description": "Bill Items : Specify Bill Items as a JSON array. See all available fields in the documentation. (https://developer.intacct.com/api/accounts-payable/bills/#:~:text=with%20%23~%23.-,APBILL.APBILLITEMS.APBILLITEM,-Name) (example: \"[{\n ACCOUNTNO: \"1010\",\n TRX_AMOUNT: 500.00,\n ENTRYDESCRIPTION: \"Bill line 1\"\n}]\")", "properties": {} }, "payTo": { "type": "string", "description": "Pay To : Name of contact to pay to." }, "returnTo": { "type": "string", "description": "Return To : Name of contact to return to." }, "billNumber": { "type": "string", "description": "Bill Number : ID for the bill." }, "referenceNumber": { "type": "string", "description": "Reference Number : Reference number for the bill." }, "paymentTerm": { "type": "string", "description": "The payment term for this bill. (example: Net 30)" }, "recommendPaymentDate": { "type": "string", "description": "Recommended Payment Date : Format as MM/DD/YYYY." }, "onHold": { "type": "boolean", "description": "On Hold" }, "attachment": { "type": "string", "description": "Attachment : Specify an ID for an attachment to include in this bill." }, "description": { "type": "string", "description": "Description" } }, "required": [ "vendorId", "date", "dueDate", "billItems" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_UPDATE_BILL": { "post": { "summary": "Update Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_UPDATE_BILL" }, "parameters": { "type": "object", "properties": { "recordNumber": { "type": "string", "description": "Record Number : The record number of the bill to update." }, "vendorId": { "type": "string", "description": "Vendor ID : The vendor ID this bill is for." }, "date": { "type": "string", "description": "Date : Transaction date for when this bill was created. Format as MM/DD/YYYY. (example: \"12/15/2030\")" }, "dueDate": { "type": "string", "description": "Due Date : Due date for this bill. Format as MM/DD/YYYY. (example: \"12/15/2030\")" }, "billItems": { "type": "object", "description": "Bill Items : Specify Bill Items as a JSON array. If specified, these bill items will replace the current items in the bill. See all available fields in the documentation. (https://developer.intacct.com/api/accounts-payable/bills/#:~:text=with%20%23~%23.-,APBILL.APBILLITEMS.APBILLITEM,-Name). (example: \"[{\n ACCOUNTNO: \"1010\",\n TRX_AMOUNT: 500.00,\n ENTRYDESCRIPTION: \"Bill line 1\"\n}]\")", "properties": {} }, "payTo": { "type": "string", "description": "Pay To : Name of contact to pay to." }, "returnTo": { "type": "string", "description": "Return To : Name of contact to return to." }, "billNumber": { "type": "string", "description": "Bill Number : ID for the bill." }, "referenceNumber": { "type": "string", "description": "Reference Number : Reference number for the bill." }, "paymentTerm": { "type": "string", "description": "The payment term for this bill. (example: Net 30)" }, "recommendPaymentDate": { "type": "string", "description": "Recommended Payment Date : Format as MM/DD/YYYY." }, "onHold": { "type": "boolean", "description": "On Hold" }, "attachment": { "type": "string", "description": "Attachment : Specify an ID for an attachment to include in this bill." }, "description": { "type": "string", "description": "Description" } }, "required": [ "recordNumber", "dueDate" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_DELETE_BILL": { "post": { "summary": "Delete Bill", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_DELETE_BILL" }, "parameters": { "type": "object", "properties": { "recordNumber": { "type": "string", "description": "Record Number : The record number of the bill to delete." } }, "required": [ "recordNumber" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_BILLS": { "post": { "summary": "Search Bills", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_SEARCH_BILLS" }, "parameters": { "type": "object", "properties": { "billFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "VENDORID", "RECORDNO", "RECORDID", "DOCNUMBER", "WHENCREATED", "WHENDUE", "ONHOLD", "STATE" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringLessThan", "$numberLessThanOrEqualTo", "$stringGreaterThan", "$numberGreaterThanOrEqualTo", "$exists", "$doesNotExist", "$stringContains", "$stringDoesNotContain" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "offset": { "type": "integer", "description": "Page Offset" }, "pageSize": { "type": "integer", "description": "Page Size" } } } }, "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_GET_BILLS_BY_ID": { "post": { "summary": "Get Bills By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_GET_BILLS_BY_ID" }, "parameters": { "type": "object", "properties": { "recordNumber": { "type": "string", "description": "Record Number : The record number of the bill to get." } }, "required": [ "recordNumber" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_PAYMENT_TERMS": { "post": { "summary": "Search Payment Terms", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_SEARCH_PAYMENT_TERMS" }, "parameters": { "type": "object", "properties": { "paymentTermsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "NAME", "DESCRIPTION" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringLessThan", "$numberLessThanOrEqualTo", "$stringGreaterThan", "$numberGreaterThanOrEqualTo", "$exists", "$doesNotExist", "$stringContains", "$stringDoesNotContain" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "offset": { "type": "integer", "description": "Page Offset" }, "pageSize": { "type": "integer", "description": "Page Size" } } } }, "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_GET_PAYMENT_TERM_BY_ID": { "post": { "summary": "Get Payment Term By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_GET_PAYMENT_TERM_BY_ID" }, "parameters": { "type": "object", "properties": { "paymentTerm": { "type": "string", "description": "Payment Term ID : The ID of the term to get. (example: \"Net 30\")" } }, "required": [ "paymentTerm" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_ACCOUNTS": { "post": { "summary": "Search Accounts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_SEARCH_ACCOUNTS" }, "parameters": { "type": "object", "properties": { "accountFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "ACCOUNTNO", "ACCOUNTTYPE", "TITLE", "CATEGORY" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringLessThan", "$numberLessThanOrEqualTo", "$stringGreaterThan", "$numberGreaterThanOrEqualTo", "$exists", "$doesNotExist", "$stringContains", "$stringDoesNotContain" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "offset": { "type": "integer", "description": "Page Offset" }, "pageSize": { "type": "integer", "description": "Page Size" } } } }, "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_GET_ACCOUNT_BY_ID": { "post": { "summary": "Get Account By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_GET_ACCOUNT_BY_ID" }, "parameters": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account ID : The ID of the account to get. (example: \"6700\")" } }, "required": [ "accountId" ], "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAGE_INTACCT_GET_DIMENSIONS": { "post": { "summary": "Get Dimensions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAGE_INTACCT_GET_DIMENSIONS" }, "parameters": { "type": "object", "properties": {}, "x-integration": "sageintacct" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_CREATE_SUPPLIER_INVOICE": { "post": { "summary": "Create Supplier Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_CREATE_SUPPLIER_INVOICE" }, "parameters": { "type": "object", "properties": { "CompanyCode": { "type": "string", "description": "Company Code (example: \"1710\")" }, "DocumentDate": { "type": "string", "description": "Document Date (example: \"2022-01-01\")" }, "PostingDate": { "type": "string", "description": "Posting Date (example: \"2022-01-01\")" }, "DocumentCurrency": { "type": "string", "description": "Document Currency (example: \"USD\")" }, "InvoiceGrossAmount": { "type": "string", "description": "Invoice GrossAmount (example: \"1511.6\")" }, "supplierInvoiceAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this Supplier Invoice as JSON. For example, you may specify a NetPaymentDays here. See the docs (https://api.sap.com/api/API_SUPPLIERINVOICE_PROCESS_SRV/resource) for available fields. (example: \"\n {\n \"CashDiscount1Percent\": \"0\",\n \"CashDiscount1Days\": \"0\",\n \"CashDiscount2Percent\": \"0\",\n \"CashDiscount2Days\": \"0\",\n \"NetPaymentDays\": \"0\",\n \"PaymentBlockingReason\": \"s\",\n \"AccountingDocumentType\": \"st\", \n }\")" } }, "required": [ "CompanyCode", "DocumentDate", "PostingDate", "DocumentCurrency", "InvoiceGrossAmount" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_GET_SUPPLIER_INVOICE_BY_ID": { "post": { "summary": "Get Supplier Invoice By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_GET_SUPPLIER_INVOICE_BY_ID" }, "parameters": { "type": "object", "properties": { "SupplierInvoice": { "type": "string", "description": "Supplier Invoice : The ID of the Supplier Invoice to fetch. (example: \"5100000001\")" }, "FiscalYear": { "type": "string", "description": "Fiscal Year : Specify the Fiscal Year to fetch. (example: \"2016\")" } }, "required": [ "SupplierInvoice", "FiscalYear" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_SEARCH_SUPPLIER_INVOICES": { "post": { "summary": "Search Supplier Invoices", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_SEARCH_SUPPLIER_INVOICES" }, "parameters": { "type": "object", "properties": { "supplierInvoiceFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "SupplierInvoice", "FiscalYear", "CreationDate", "InvoicingParty" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberEquals", "$numberDoesNotEqual", "$numberGreaterThan", "$numberLessThan", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$stringStartsWith", "$stringEndsWith" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Page Size" }, "offset": { "type": "number", "description": "Offset" } } } }, "required": [ "supplierInvoiceFilterFormula" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_DELETE_SUPPLIER_INVOICE": { "post": { "summary": "Delete Supplier Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_DELETE_SUPPLIER_INVOICE" }, "parameters": { "type": "object", "properties": { "SupplierInvoice": { "type": "string", "description": "Supplier Invoice : The ID of the Supplier Invoice to delete. (example: \"5100000001\")" }, "FiscalYear": { "type": "string", "description": "Fiscal Year : Specify the Fiscal Year to delete. (example: \"2016\")" } }, "required": [ "SupplierInvoice", "FiscalYear" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_GET_SUPPLIER_BY_ID": { "post": { "summary": "Get Supplier By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_GET_SUPPLIER_BY_ID" }, "parameters": { "type": "object", "properties": { "Supplier": { "type": "string", "description": "Supplier ID : The ID of the Supplier to fetch. (example: \"17300001\")" } }, "required": [ "Supplier" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_SEARCH_SUPPLIERS": { "post": { "summary": "Search Suppliers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_SEARCH_SUPPLIERS" }, "parameters": { "type": "object", "properties": { "supplierFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Supplier", "Customer", "CreationDate", "SupplierName" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberEquals", "$numberDoesNotEqual", "$numberGreaterThan", "$numberLessThan", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$stringStartsWith", "$stringEndsWith" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Page Size" }, "offset": { "type": "number", "description": "Offset" } } } }, "required": [ "supplierFilterFormula" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_UPDATE_SUPPLIER": { "post": { "summary": "Update Supplier", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_UPDATE_SUPPLIER" }, "parameters": { "type": "object", "properties": { "Supplier": { "type": "string", "description": "Supplier ID : The ID of the Supplier to update. (example: \"17300001\")" }, "AlternativePayeeAccountNumber": { "type": "string", "description": "AlternativePayee AccountNumber" }, "AuthorizationGroup": { "type": "string", "description": "Authorization Group" }, "Customer": { "type": "string", "description": "Customer ID : The ID of the Customer to update. (example: \"202\")" }, "VATRegistration": { "type": "string", "description": "VAT Registration Number (example: \"ATU52375709\")" }, "FiscalAddress": { "type": "string", "description": "Fiscal Address" }, "supplierAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this Supplier as JSON. For example, you may specify a AuthorizationGroup here. See the docs (https://api.sap.com/api/API_BUSINESS_PARTNER/resource) for available fields. (example: \"\n {\n \"AuthorizationGroup\": \"group1\",\n \"PaymentIsBlockedForSupplier\": true,\n \"PostingIsBlocked\": true,\n \"PurchasingIsBlocked\": true,\n \"OrderIsBlockedForCustomer\": \"\",\n }\")" } }, "required": [ "Supplier" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_GET_CUSTOMER_BY_ID": { "post": { "summary": "Get Customer By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_GET_CUSTOMER_BY_ID" }, "parameters": { "type": "object", "properties": { "Customer": { "type": "string", "description": "Customer ID : The ID of the Customer to fetch. (example: \"202\")" } }, "required": [ "Customer" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_SEARCH_CUSTOMERS": { "post": { "summary": "Search Customers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_SEARCH_CUSTOMERS" }, "parameters": { "type": "object", "properties": { "customerFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Supplier", "Customer", "CreationDate", "CustomerName" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$numberEquals", "$numberDoesNotEqual", "$numberGreaterThan", "$numberLessThan", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$stringStartsWith", "$stringEndsWith" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Page Size" }, "offset": { "type": "number", "description": "Offset" } } } }, "required": [ "customerFilterFormula" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SAP_UPDATE_CUSTOMER": { "post": { "summary": "Update Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SAP_UPDATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "Customer": { "type": "string", "description": "Customer ID : The ID of the Customer to update. (example: \"202\")" }, "AuthorizationGroup": { "type": "string", "description": "Authorization Group" }, "CustomerClassification": { "type": "string", "description": "Customer Classification" }, "Supplier": { "type": "string", "description": "Supplier ID : The ID of the Supplier to update. (example: \"17300001\")" }, "CustomerCorporateGroup": { "type": "string", "description": "Customer CorporateGroup" }, "CustomerAccountGroup": { "type": "string", "description": "CustomerAccountGroup (example: \"CUST\")" }, "customerAdditionalFields": { "type": "string", "description": "Additional Fields : Specify additional fields to include on this Customer as JSON. For example, you may specify a AuthorizationGroup here. See the docs (https://api.sap.com/api/API_BUSINESS_PARTNER/resource) for available fields. (example: \"\n {\n \"AuthorizationGroup\": \"group1\",\n \"BillingIsBlockedForCustomer\": \"true\",\n \"CustomerAccountGroup\": \"group1\",\n \"County\": \"US\"\n \"OrderIsBlockedForCustomer\": \"\",\n }\")" } }, "required": [ "Customer", "CustomerAccountGroup" ], "x-integration": "saps4hana" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_RECORD_CONTACT": { "post": { "summary": "Create Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "FirstName": { "type": "string", "description": "First Name" }, "LastName": { "type": "string", "description": "Last Name : This field is required." }, "accountId": { "type": "string", "description": "Account ID : The Account that the Contact belongs to." }, "Email": { "type": "string", "description": "Email" }, "Title": { "type": "string", "description": "Title : Title of the contact, such as CEO or Vice President." }, "Description": { "type": "string", "description": "Description : A description of the Contact." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "LastName" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_RECORD_LEAD": { "post": { "summary": "Create Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "FirstName": { "type": "string", "description": "First Name" }, "LastName": { "type": "string", "description": "Last Name : This field is required." }, "Company": { "type": "string", "description": "Company : This field is required." }, "Email": { "type": "string", "description": "Email" }, "Phone": { "type": "string", "description": "Phone" }, "Website": { "type": "string", "description": "Website" }, "Title": { "type": "string", "description": "Title : Title of the contact, such as CEO or Vice President." }, "Status": { "type": "string", "description": "Status : Defaults to the user’s first Lead Status if not provided. Use Connect Portal Workflow Settings to allow users to select an Lead Status." }, "Description": { "type": "string", "description": "Description : A description of the Lead." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Lead fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "LastName", "Company" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_RECORD_OPPORTUNITY": { "post": { "summary": "Create Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name : The Opportunity name. This field is required." }, "StageName": { "type": "string", "description": "Stage : Defaults to the user’s first Opportunity Stage if not provided. Use Connect Portal Workflow Settings to allow users to select an Opportunity Stage." }, "CloseDate": { "type": "string", "description": "Close Date : Defaults to 30 days from the current date if not provided. (example: \"YYYY-MM-DD\")" }, "AccountId": { "type": "string", "description": "Account ID : The Account that the Opportunity belongs to." }, "Amount": { "type": "string", "description": "Amount : Estimated total sale amount." }, "Description": { "type": "string", "description": "Description : A description of the Opportunity." }, "OwnerId": { "type": "string", "description": "Owner ID : The Salesforce user assigned to work on this Opportunity." }, "NextStep": { "type": "string", "description": "Next Step : Description of next task in closing Opportunity." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Opportunity fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "Name" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_RECORD_TASK": { "post": { "summary": "Create Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "whatId": { "type": "string", "description": "Related to ID : The ID of the Account or Opportunity this Task is related to." }, "whoId": { "type": "string", "description": "Name ID : The ID of the Contact or Lead this Task is related to." }, "subject": { "type": "string", "description": "Subject" }, "activityDate": { "type": "string", "description": "Activity Date (example: \"YYYY-MM-DD\")" }, "description": { "type": "string", "description": "Description : A description of the Task." }, "taskSubtype": { "type": "string", "description": "Task Subtype", "enum": [ "task", "email", "listEmail", "call" ] }, "Status": { "type": "string", "description": "Status", "enum": [ "Not Started", "In Progress", "Completed" ] }, "ownerId": { "type": "string", "description": "Assigned To ID : The Salesforce user assigned to this Task. Use Connect Portal Workflow Settings to allow users to select an Owner. (example: \"{{settings.TaskAssignee}}\")" }, "callDurationInSeconds": { "type": "string", "description": "Call Duration" }, "isReminderSet": { "type": "boolean", "description": "Reminder Set" }, "reminderDateTime": { "type": "string", "description": "Reminder Date/Time (example: \"2019-09-15T02:06:58.147Z\")" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Task fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "subject", "taskSubtype" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_RECORD_ACCOUNT": { "post": { "summary": "Create Record Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_RECORD_ACCOUNT" }, "parameters": { "type": "object", "properties": { "Name": { "type": "string", "description": "Account Name : The Account name. This field is required." }, "OwnerId": { "type": "string", "description": "Owner ID : The Salesforce user assigned to this Account. Use Connect Portal Workflow Settings to allow users to select an Owner." }, "Website": { "type": "string", "description": "Website" }, "Phone": { "type": "string", "description": "Phone" }, "Description": { "type": "string", "description": "Description" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Account fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "Name" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_RECORD_ANY": { "post": { "summary": "Create Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_UPDATE_RECORD_CONTACT": { "post": { "summary": "Update Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_UPDATE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to update." }, "FirstName": { "type": "string", "description": "First Name" }, "LastName": { "type": "string", "description": "Last Name" }, "accountId": { "type": "string", "description": "Account ID : The Account that the Contact belongs to." }, "Email": { "type": "string", "description": "Email" }, "Title": { "type": "string", "description": "Title : Title of the contact, such as CEO or Vice President." }, "Description": { "type": "string", "description": "Description : A description of the Contact." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_UPDATE_RECORD_LEAD": { "post": { "summary": "Update Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_UPDATE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to update." }, "FirstName": { "type": "string", "description": "First Name" }, "LastName": { "type": "string", "description": "Last Name" }, "Company": { "type": "string", "description": "Company" }, "Email": { "type": "string", "description": "Email" }, "Phone": { "type": "string", "description": "Phone" }, "Website": { "type": "string", "description": "Website" }, "Title": { "type": "string", "description": "Title : Title of the contact, such as CEO or Vice President." }, "Status": { "type": "string", "description": "Status : Defaults to the user’s first Lead Status if not provided. Use Connect Portal Workflow Settings to allow users to select an Lead Status." }, "Description": { "type": "string", "description": "Description : A description of the Lead." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Lead fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_UPDATE_RECORD_OPPORTUNITY": { "post": { "summary": "Update Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_UPDATE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to update." }, "Name": { "type": "string", "description": "Name : The Opportunity name." }, "StageName": { "type": "string", "description": "Stage : Defaults to the user’s first Opportunity Stage if not provided. Use Connect Portal Workflow Settings to allow users to select an Opportunity Stage." }, "CloseDate": { "type": "string", "description": "Close Date : Defaults to 30 days from the current date if not provided. (example: \"YYYY-MM-DD\")" }, "AccountId": { "type": "string", "description": "Account ID : The Account that the Opportunity belongs to." }, "Amount": { "type": "string", "description": "Amount : Estimated total sale amount." }, "Description": { "type": "string", "description": "Description : A description of the Opportunity." }, "OwnerId": { "type": "string", "description": "Owner ID : The Salesforce user assigned to work on this Opportunity." }, "NextStep": { "type": "string", "description": "Next Step : Description of next task in closing Opportunity." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Opportunity fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_UPDATE_RECORD_TASK": { "post": { "summary": "Update Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_UPDATE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to update." }, "whatId": { "type": "string", "description": "Related to ID : The ID of the Account or Opportunity this Task is related to." }, "whoId": { "type": "string", "description": "Name ID : The ID of the Contact or Lead this Task is related to." }, "subject": { "type": "string", "description": "Subject" }, "activityDate": { "type": "string", "description": "Activity Date (example: \"YYYY-MM-DD\")" }, "description": { "type": "string", "description": "Description : A description of the Task." }, "Status": { "type": "string", "description": "Status", "enum": [ "Not Started", "In Progress", "Completed" ] }, "ownerId": { "type": "string", "description": "Assigned To ID : The Salesforce user assigned to this Task. Use Connect Portal Workflow Settings to allow users to select an Owner. (example: \"{{settings.TaskAssignee}}\")" }, "callDurationInSeconds": { "type": "string", "description": "Call Duration" }, "isReminderSet": { "type": "boolean", "description": "Reminder Set" }, "reminderDateTime": { "type": "string", "description": "Reminder Date/Time (example: \"2019-09-15T02:06:58.147Z\")" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Task fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_UPDATE_RECORD_ACCOUNT": { "post": { "summary": "Update Record Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_UPDATE_RECORD_ACCOUNT" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to update." }, "Name": { "type": "string", "description": "Account Name : The Account name." }, "OwnerId": { "type": "string", "description": "Owner ID : The Salesforce user assigned to this Account. Use Connect Portal Workflow Settings to allow users to select an Owner." }, "Website": { "type": "string", "description": "Website" }, "Phone": { "type": "string", "description": "Phone" }, "Description": { "type": "string", "description": "Description" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Account fields to update. (example: \"{\n \"property_number\": \"17\",\n \"property_dropdown\": \"choice_b\",\n \"property_radio\": \"option_1\",\n \"property_string\": \"value\",\n \"property_date\": \"1572480000000\"\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_UPDATE_RECORD_ANY": { "post": { "summary": "Update Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_UPDATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_CONTACT": { "post": { "summary": "Delete Record Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_DELETE_RECORD_CONTACT" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to delete." } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_LEAD": { "post": { "summary": "Delete Record Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_DELETE_RECORD_LEAD" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to delete." } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_OPPORTUNITY": { "post": { "summary": "Delete Record Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_DELETE_RECORD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to delete." } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_TASK": { "post": { "summary": "Delete Record Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_DELETE_RECORD_TASK" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to delete." } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_ACCOUNT": { "post": { "summary": "Delete Record Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_DELETE_RECORD_ACCOUNT" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : The ID of the record to delete." } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_ANY": { "post": { "summary": "Delete Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_DELETE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordType", "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_ID_CONTACT": { "post": { "summary": "Get Record By ID Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_ID_CONTACT" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_ID_LEAD": { "post": { "summary": "Get Record By ID Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_ID_LEAD" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_ID_OPPORTUNITY": { "post": { "summary": "Get Record By ID Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_ID_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_ID_TASK": { "post": { "summary": "Get Record By ID Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_ID_TASK" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_ID_ACCOUNT": { "post": { "summary": "Get Record By ID Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_ID_ACCOUNT" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_ID_ANY": { "post": { "summary": "Get Record By ID Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_ID_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record ID" } }, "required": [ "recordType", "recordId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_SEARCH_RECORDS_CONTACT": { "post": { "summary": "Search Records Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_SEARCH_RECORDS_CONTACT" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "FirstName", "LastName", "accountId", "Email", "Title", "Description" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringContains", "$stringDoesNotContain", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "sortBy": { "type": "string", "description": "Sort By (example: \"CreatedDate\")" }, "sortDirection": { "type": "string", "description": "Sort Direction", "enum": [ "ASC", "DESC" ] }, "includeAllFields": { "type": "boolean", "description": "Include All Fields" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_SEARCH_RECORDS_LEAD": { "post": { "summary": "Search Records Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_SEARCH_RECORDS_LEAD" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "FirstName", "LastName", "Company", "Email", "Phone", "Website", "Title", "Status", "Description" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringContains", "$stringDoesNotContain", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "sortBy": { "type": "string", "description": "Sort By (example: \"CreatedDate\")" }, "sortDirection": { "type": "string", "description": "Sort Direction", "enum": [ "ASC", "DESC" ] }, "includeAllFields": { "type": "boolean", "description": "Include All Fields" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_SEARCH_RECORDS_OPPORTUNITY": { "post": { "summary": "Search Records Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_SEARCH_RECORDS_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Name", "StageName", "AccountId", "Amount", "OwnerId", "NextStep" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringContains", "$stringDoesNotContain", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "sortBy": { "type": "string", "description": "Sort By (example: \"CreatedDate\")" }, "sortDirection": { "type": "string", "description": "Sort Direction", "enum": [ "ASC", "DESC" ] }, "includeAllFields": { "type": "boolean", "description": "Include All Fields" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_SEARCH_RECORDS_TASK": { "post": { "summary": "Search Records Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_SEARCH_RECORDS_TASK" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "taskSubtype", "Status", "ownerId", "callDurationInSeconds", "reminderDateTime" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringContains", "$stringDoesNotContain", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "sortBy": { "type": "string", "description": "Sort By (example: \"CreatedDate\")" }, "sortDirection": { "type": "string", "description": "Sort Direction", "enum": [ "ASC", "DESC" ] }, "includeAllFields": { "type": "boolean", "description": "Include All Fields" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_SEARCH_RECORDS_ACCOUNT": { "post": { "summary": "Search Records Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_SEARCH_RECORDS_ACCOUNT" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Name", "OwnerId", "Website", "Phone", "Description" ] }, "operator": { "type": "string", "enum": [ "$none", "$stringContains", "$stringDoesNotContain", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "sortBy": { "type": "string", "description": "Sort By (example: \"CreatedDate\")" }, "sortDirection": { "type": "string", "description": "Sort Direction", "enum": [ "ASC", "DESC" ] }, "includeAllFields": { "type": "boolean", "description": "Include All Fields" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_SEARCH_RECORDS_ANY": { "post": { "summary": "Search Records Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_SEARCH_RECORDS_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "filterFormula": { "type": "string", "description": "Filter Search" }, "includeAllFields": { "type": "boolean", "description": "Include All Fields" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "recordType" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_VIEW_ID_CONTACT": { "post": { "summary": "Get Record By View ID Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_VIEW_ID_CONTACT" }, "parameters": { "type": "object", "properties": { "listViewId": { "type": "string", "description": "List View ID" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "listViewId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_VIEW_ID_LEAD": { "post": { "summary": "Get Record By View ID Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_VIEW_ID_LEAD" }, "parameters": { "type": "object", "properties": { "listViewId": { "type": "string", "description": "List View ID" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "listViewId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_VIEW_ID_OPPORTUNITY": { "post": { "summary": "Get Record By View ID Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_VIEW_ID_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "listViewId": { "type": "string", "description": "List View ID" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "listViewId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_VIEW_ID_TASK": { "post": { "summary": "Get Record By View ID Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_VIEW_ID_TASK" }, "parameters": { "type": "object", "properties": { "listViewId": { "type": "string", "description": "List View ID" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "listViewId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_VIEW_ID_ACCOUNT": { "post": { "summary": "Get Record By View ID Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_VIEW_ID_ACCOUNT" }, "parameters": { "type": "object", "properties": { "listViewId": { "type": "string", "description": "List View ID" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "listViewId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_GET_RECORD_BY_VIEW_ID_ANY": { "post": { "summary": "Get Record By View ID Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_GET_RECORD_BY_VIEW_ID_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "listViewId": { "type": "string", "description": "List View ID" }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "pageCursor": { "type": "string", "description": "The cursor indicating the current page" } } } }, "required": [ "recordType", "listViewId" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_CONTACT": { "post": { "summary": "Create Custom Field Contact", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_CUSTOM_FIELD_CONTACT" }, "parameters": { "type": "object", "properties": { "label": { "type": "string", "description": "Field Label : Enter a label to be used on displays, page layouts, reports, and list views. Also determines the Field Name used for internal reference. For example, if the Field Label is “Email”, the Field Name will be “Email__c”." }, "type": { "type": "string", "description": "Field Type", "enum": [ "Checkbox", "Currency", "Date", "Email", "Number", "Percent", "Phone", "Picklist", "MultiselectPicklist", "Text", "TextArea", "LongTextArea", "Html", "Time", "Url" ] }, "defaultCheckboxValue": { "type": "boolean", "description": "Default Value \nThis field appears only when 'type' = 'Checkbox')" }, "length": { "type": "string", "description": "Length : Number of digits to the left of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent') \nThis field appears only when 'type' = 'Currency', 'Text') \nThis field appears only when 'type' = 'Currency', 'LongTextArea') \nThis field appears only when 'type' = 'Currency', 'Html')" }, "decimalPlace": { "type": "string", "description": "Decimal Places : Number of digits to the right of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent')" }, "pickListValues": { "type": "string", "description": "Values : Enter values, with each value separated by a new line \nThis field appears only when 'type' = 'Picklist') \nThis field appears only when 'type' = 'Picklist', 'MultiselectPicklist')" }, "visibleLines": { "type": "string", "description": "Visible Lines \nThis field appears only when 'type' = 'MultiselectPicklist') \nThis field appears only when 'type' = 'MultiselectPicklist', 'LongTextArea') \nThis field appears only when 'type' = 'MultiselectPicklist', 'Html')" }, "description": { "type": "string", "description": "Description" }, "helperText": { "type": "string", "description": "Helper Text : This text displays on detail and edit pages when users hover over the Info icon next to this field." }, "defaultFieldValue": { "type": "string", "description": "Default Value" } }, "required": [ "label", "type", "length", "decimalPlace", "pickListValues", "visibleLines" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_LEAD": { "post": { "summary": "Create Custom Field Lead", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_CUSTOM_FIELD_LEAD" }, "parameters": { "type": "object", "properties": { "label": { "type": "string", "description": "Field Label : Enter a label to be used on displays, page layouts, reports, and list views. Also determines the Field Name used for internal reference. For example, if the Field Label is “Email”, the Field Name will be “Email__c”." }, "type": { "type": "string", "description": "Field Type", "enum": [ "Checkbox", "Currency", "Date", "Email", "Number", "Percent", "Phone", "Picklist", "MultiselectPicklist", "Text", "TextArea", "LongTextArea", "Html", "Time", "Url" ] }, "defaultCheckboxValue": { "type": "boolean", "description": "Default Value \nThis field appears only when 'type' = 'Checkbox')" }, "length": { "type": "string", "description": "Length : Number of digits to the left of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent') \nThis field appears only when 'type' = 'Currency', 'Text') \nThis field appears only when 'type' = 'Currency', 'LongTextArea') \nThis field appears only when 'type' = 'Currency', 'Html')" }, "decimalPlace": { "type": "string", "description": "Decimal Places : Number of digits to the right of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent')" }, "pickListValues": { "type": "string", "description": "Values : Enter values, with each value separated by a new line \nThis field appears only when 'type' = 'Picklist') \nThis field appears only when 'type' = 'Picklist', 'MultiselectPicklist')" }, "visibleLines": { "type": "string", "description": "Visible Lines \nThis field appears only when 'type' = 'MultiselectPicklist') \nThis field appears only when 'type' = 'MultiselectPicklist', 'LongTextArea') \nThis field appears only when 'type' = 'MultiselectPicklist', 'Html')" }, "description": { "type": "string", "description": "Description" }, "helperText": { "type": "string", "description": "Helper Text : This text displays on detail and edit pages when users hover over the Info icon next to this field." }, "defaultFieldValue": { "type": "string", "description": "Default Value" } }, "required": [ "label", "type", "length", "decimalPlace", "pickListValues", "visibleLines" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY": { "post": { "summary": "Create Custom Field Opportunity", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY" }, "parameters": { "type": "object", "properties": { "label": { "type": "string", "description": "Field Label : Enter a label to be used on displays, page layouts, reports, and list views. Also determines the Field Name used for internal reference. For example, if the Field Label is “Email”, the Field Name will be “Email__c”." }, "type": { "type": "string", "description": "Field Type", "enum": [ "Checkbox", "Currency", "Date", "Email", "Number", "Percent", "Phone", "Picklist", "MultiselectPicklist", "Text", "TextArea", "LongTextArea", "Html", "Time", "Url" ] }, "defaultCheckboxValue": { "type": "boolean", "description": "Default Value \nThis field appears only when 'type' = 'Checkbox')" }, "length": { "type": "string", "description": "Length : Number of digits to the left of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent') \nThis field appears only when 'type' = 'Currency', 'Text') \nThis field appears only when 'type' = 'Currency', 'LongTextArea') \nThis field appears only when 'type' = 'Currency', 'Html')" }, "decimalPlace": { "type": "string", "description": "Decimal Places : Number of digits to the right of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent')" }, "pickListValues": { "type": "string", "description": "Values : Enter values, with each value separated by a new line \nThis field appears only when 'type' = 'Picklist') \nThis field appears only when 'type' = 'Picklist', 'MultiselectPicklist')" }, "visibleLines": { "type": "string", "description": "Visible Lines \nThis field appears only when 'type' = 'MultiselectPicklist') \nThis field appears only when 'type' = 'MultiselectPicklist', 'LongTextArea') \nThis field appears only when 'type' = 'MultiselectPicklist', 'Html')" }, "description": { "type": "string", "description": "Description" }, "helperText": { "type": "string", "description": "Helper Text : This text displays on detail and edit pages when users hover over the Info icon next to this field." }, "defaultFieldValue": { "type": "string", "description": "Default Value" } }, "required": [ "label", "type", "length", "decimalPlace", "pickListValues", "visibleLines" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_TASK": { "post": { "summary": "Create Custom Field Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_CUSTOM_FIELD_TASK" }, "parameters": { "type": "object", "properties": { "label": { "type": "string", "description": "Field Label : Enter a label to be used on displays, page layouts, reports, and list views. Also determines the Field Name used for internal reference. For example, if the Field Label is “Email”, the Field Name will be “Email__c”." }, "type": { "type": "string", "description": "Field Type", "enum": [ "Checkbox", "Currency", "Date", "Email", "Number", "Percent", "Phone", "Picklist", "MultiselectPicklist", "Text", "TextArea", "Time", "Url" ] }, "defaultCheckboxValue": { "type": "boolean", "description": "Default Value \nThis field appears only when 'type' = 'Checkbox')" }, "length": { "type": "string", "description": "Length : Number of digits to the left of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent') \nThis field appears only when 'type' = 'Currency', 'Text')" }, "decimalPlace": { "type": "string", "description": "Decimal Places : Number of digits to the right of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent')" }, "pickListValues": { "type": "string", "description": "Values : Enter values, with each value separated by a new line \nThis field appears only when 'type' = 'Picklist') \nThis field appears only when 'type' = 'Picklist', 'MultiselectPicklist')" }, "visibleLines": { "type": "string", "description": "Visible Lines \nThis field appears only when 'type' = 'MultiselectPicklist')" }, "description": { "type": "string", "description": "Description" }, "helperText": { "type": "string", "description": "Helper Text : This text displays on detail and edit pages when users hover over the Info icon next to this field." }, "defaultFieldValue": { "type": "string", "description": "Default Value" } }, "required": [ "label", "type", "length", "decimalPlace", "pickListValues", "visibleLines" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_ACCOUNT": { "post": { "summary": "Create Custom Field Account", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_CUSTOM_FIELD_ACCOUNT" }, "parameters": { "type": "object", "properties": { "label": { "type": "string", "description": "Field Label : Enter a label to be used on displays, page layouts, reports, and list views. Also determines the Field Name used for internal reference. For example, if the Field Label is “Email”, the Field Name will be “Email__c”." }, "type": { "type": "string", "description": "Field Type", "enum": [ "Checkbox", "Currency", "Date", "Email", "Number", "Percent", "Phone", "Picklist", "MultiselectPicklist", "Text", "TextArea", "LongTextArea", "Html", "Time", "Url" ] }, "defaultCheckboxValue": { "type": "boolean", "description": "Default Value \nThis field appears only when 'type' = 'Checkbox')" }, "length": { "type": "string", "description": "Length : Number of digits to the left of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent') \nThis field appears only when 'type' = 'Currency', 'Text') \nThis field appears only when 'type' = 'Currency', 'LongTextArea') \nThis field appears only when 'type' = 'Currency', 'Html')" }, "decimalPlace": { "type": "string", "description": "Decimal Places : Number of digits to the right of the decimal point \nThis field appears only when 'type' = 'Currency') \nThis field appears only when 'type' = 'Currency', 'Number') \nThis field appears only when 'type' = 'Currency', 'Percent')" }, "pickListValues": { "type": "string", "description": "Values : Enter values, with each value separated by a new line \nThis field appears only when 'type' = 'Picklist') \nThis field appears only when 'type' = 'Picklist', 'MultiselectPicklist')" }, "visibleLines": { "type": "string", "description": "Visible Lines \nThis field appears only when 'type' = 'MultiselectPicklist') \nThis field appears only when 'type' = 'MultiselectPicklist', 'LongTextArea') \nThis field appears only when 'type' = 'MultiselectPicklist', 'Html')" }, "description": { "type": "string", "description": "Description" }, "helperText": { "type": "string", "description": "Helper Text : This text displays on detail and edit pages when users hover over the Info icon next to this field." }, "defaultFieldValue": { "type": "string", "description": "Default Value" } }, "required": [ "label", "type", "length", "decimalPlace", "pickListValues", "visibleLines" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_ANY": { "post": { "summary": "Create Custom Field Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_CUSTOM_FIELD_ANY" }, "parameters": { "type": "object", "properties": {}, "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_WRITE_SOQL_QUERY": { "post": { "summary": "Write SOQL Query", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_WRITE_SOQL_QUERY" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "SOQL Query : Write a query using Salesforce Object Query Language (SOQL). Supports SOQL SELECT Syntax. (https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm) (example: \"SELECT Id, Name\nFROM Account\nWHERE Name = 'Ethan'\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." } } } }, "required": [ "query" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_OBJECT": { "post": { "summary": "Create Custom Object", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_CREATE_CUSTOM_OBJECT" }, "parameters": { "type": "object", "properties": { "label": { "type": "string", "description": "Label : Object Label to be used in tabs, page layouts, and reports. Also determines the Object Name used for internal reference. For example, if the Label is “Account”, the Object Name will be “Account__c”. (example: \"Account\")" }, "pluralLabel": { "type": "string", "description": "Plural Label (example: \"Accounts\")" }, "description": { "type": "string", "description": "Description : A description of the Custom Object." }, "recordName": { "type": "string", "description": "Record Name : The Record Name appears in page layouts, key lists, related lists, lookups, and search results. For example, the Record Name for Account is \"Account Name\" and for Case it is \"Case Number\". (example: \"Account Name\")" } }, "required": [ "label", "pluralLabel", "recordName" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SALESFORCE_DESCRIBE_ACTION_SCHEMA": { "post": { "summary": "Describe Action Schema", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SALESFORCE_DESCRIBE_ACTION_SCHEMA" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "operation": { "type": "string", "description": "Operation Type value for example CREATE_RECORD or UPDATE_RECORD" } }, "required": [ "recordType", "operation" ], "x-integration": "salesforce" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_CREATE_TICKET": { "post": { "summary": "Create Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_CREATE_TICKET" }, "parameters": { "type": "object", "properties": { "ticketType": { "type": "string", "description": "Ticket Type : Specify the type of the ticket to create.", "enum": [ "incident", "sn_customerservice_case" ] }, "description": { "type": "string", "description": "Full Description : Specify a long-form description of the issue." }, "severity": { "type": "string", "description": "Severity : Specify the severity of the issue described by the trouble ticket. Maps to the Priority field.", "enum": [ 1, 2, 3, 4, 5 ] }, "shortDescription": { "type": "string", "description": "Short Description : Specify a one-line description of the issue." }, "status": { "type": "string", "description": "Status : Specify the current status of the ticket. Maps to the State field. You may provide the choice label or value. (example: \"New\")" }, "channelName": { "type": "string", "description": "Channel Name : Specify the name of the contact method. (example: \"Virtual Agent\")" }, "note": { "type": "object", "description": "Notes : Specify a list of work notes and comments to add to the ticket.See the docs (https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/trouble-ticket-open-api.html#trouble-ticket-PATCH-trouble_ticket)for available properties for a note object. (example: \"\n[\n {\n \"text\": \"Note content\",\n \"@type\": \"work_notes\"\n }\n]\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this work item as JSON. (example: \"{\n \"close_code\": \"Duplicate\",\n \"close_notes\": \"Issue has been resolved successfully.\"\n}\")", "properties": {} } }, "required": [ "ticketType" ], "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_UPDATE_TICKET": { "post": { "summary": "Update Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_UPDATE_TICKET" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Specify the sys_id ID of the ticket to fetch. (example: \"9d385017c611228701d22104cc95c371\")" }, "ticketType": { "type": "string", "description": "Ticket Type : Specify the type of the ticket to create.", "enum": [ "incident", "sn_customerservice_case" ] }, "description": { "type": "string", "description": "Full Description : Specify a long-form description of the issue." }, "severity": { "type": "string", "description": "Severity : Specify the severity of the issue described by the trouble ticket. Maps to the Priority field.", "enum": [ 1, 2, 3, 4, 5 ] }, "shortDescription": { "type": "string", "description": "Short Description : Specify a one-line description of the issue." }, "status": { "type": "string", "description": "Status : Specify the current status of the ticket. Maps to the State field. You may provide the choice label or value. (example: \"New\")" }, "channelName": { "type": "string", "description": "Channel Name : Specify the name of the contact method. (example: \"Virtual Agent\")" }, "note": { "type": "object", "description": "Notes : Specify a list of work notes and comments to add to the ticket.See the docs (https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/trouble-ticket-open-api.html#trouble-ticket-PATCH-trouble_ticket)for available properties for a note object. (example: \"\n[\n {\n \"text\": \"Note content\",\n \"@type\": \"work_notes\"\n }\n]\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify any additional fields that should be created with this work item as JSON. (example: \"{\n \"close_code\": \"Duplicate\",\n \"close_notes\": \"Issue has been resolved successfully.\"\n}\")", "properties": {} } }, "required": [ "ticketId", "ticketType" ], "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_DELETE_TICKET": { "post": { "summary": "Delete Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_DELETE_TICKET" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Specify the sys_id ID of the ticket to fetch. (example: \"9d385017c611228701d22104cc95c371\")" }, "ticketType": { "type": "string", "description": "Ticket Type : Specify the type of the ticket to create.", "enum": [ "incident", "sn_customerservice_case" ] } }, "required": [ "ticketId", "ticketType" ], "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_ADD_COMMENT": { "post": { "summary": "Add Comment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_ADD_COMMENT" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Specify the sys_id of the ticket to comment on. (example: \"9d385017c611228701d22104cc95c371\")" }, "ticketType": { "type": "string", "description": "Ticket Type : Specify the type of the ticket.", "enum": [ "incident", "sn_customerservice_case" ] }, "text": { "type": "string", "description": "Comment Text : The comment or work note text to add. (example: \"Investigation complete.\")" }, "isWorkNote": { "type": "boolean", "description": "Is Work Note : If true, posts as an internal work note. If false, posts as a customer-visible comment." } }, "required": [ "ticketId", "ticketType", "text" ], "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_GET_TICKET_STATES": { "post": { "summary": "Get Ticket States", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_GET_TICKET_STATES" }, "parameters": { "type": "object", "properties": { "ticketType": { "type": "string", "description": "Ticket Type : Specify the table to list state choices for. Defaults to incident.", "enum": [ "incident", "sn_customerservice_case" ] } }, "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_SET_TICKET_STATE": { "post": { "summary": "Set Ticket State", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_SET_TICKET_STATE" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Specify the sys_id of the ticket to update. (example: \"9d385017c611228701d22104cc95c371\")" }, "ticketType": { "type": "string", "description": "Ticket Type : Specify the type of the ticket.", "enum": [ "incident", "sn_customerservice_case" ] }, "state": { "type": "string", "description": "State : The state value to set. Use Get Ticket States to discover valid values for the table. (example: \"6\")" }, "closeCode": { "type": "string", "description": "Close Code : Optional close code required by some Resolved/Closed transitions. (example: \"Solved (Permanently)\")" }, "closeNotes": { "type": "string", "description": "Close Notes : Optional close notes required by some Resolved/Closed transitions. (example: \"Issue resolved by automated investigation.\")" } }, "required": [ "ticketId", "ticketType", "state" ], "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_GET_TICKETS": { "post": { "summary": "Get Tickets", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_GET_TICKETS" }, "parameters": { "type": "object", "properties": { "ticketType": { "type": "string", "description": "Ticket Type : Specify the type of the ticket to get", "enum": [ "incident", "ticket" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageOffset": { "type": "number", "description": "Page Offset" } } } }, "required": [ "ticketType" ], "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_GET_TICKET_BY_ID": { "post": { "summary": "Get Ticket By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_GET_TICKET_BY_ID" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Specify the sys_id ID of the ticket to fetch. (example: \"9d385017c611228701d22104cc95c371\")" }, "ticketType": { "type": "string", "description": "Ticket Type : Specify the type of the ticket to create.", "enum": [ "incident", "sn_customerservice_case" ] } }, "required": [ "ticketId", "ticketType" ], "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SERVICENOW_SEARCH_RECORDS": { "post": { "summary": "Search Records", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SERVICENOW_SEARCH_RECORDS" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type : The type of record to subscribe to within the ServiceNow instance. (example: \"incident\")", "enum": [ "incident", "sn_customerservice_case" ] }, "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringStartsWith", "$stringEndsWith", "$stringContains", "$stringDoesNotContain", "$numberLessThan", "$numberEquals", "$numberGreaterThan", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$doesNotExist", "$exists", "$booleanTrue", "$booleanFalse", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageOffset": { "type": "number", "description": "Page Offset" } } } }, "required": [ "recordType" ], "x-integration": "servicenow" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_SAVE_FILE": { "post": { "summary": "Save File", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_SAVE_FILE" }, "parameters": { "type": "object", "properties": { "file": { "type": "object", "description": "File to save to SharePoint. (example: {\n \"data\": \"48656c6c6f2c20776f726c6421\",\n \"dataType\": \"FILE\",\n \"mimeType\": \"text/plain\"\n})", "properties": {} }, "fileName": { "type": "string", "description": "File Name (example: \"filename.pdf\")" }, "folder": { "type": "string", "description": "The folder to save files to. Defaults to the site's root folder if left blank" } }, "required": [ "file", "fileName" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_CREATE_ITEM": { "post": { "summary": "Create Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_CREATE_ITEM" }, "parameters": { "type": "object", "properties": { "title": { "type": "string", "description": "Title" }, "listId": { "type": "string", "description": "The list ID to perform the operation on. (example: 22e03ef3-6ef4-424d-a1d3-92a337807c30)" }, "fields": { "type": "object", "description": "The column values of the item", "properties": {} } }, "required": [ "title", "listId" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_UPDATE_ITEM": { "post": { "summary": "Update Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_UPDATE_ITEM" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Item ID : The ID of the item to update." }, "title": { "type": "string", "description": "Title" }, "listId": { "type": "string", "description": "The list ID to perform the operation on. (example: 22e03ef3-6ef4-424d-a1d3-92a337807c30)" }, "fields": { "type": "object", "description": "The column values of the item", "properties": {} } }, "required": [ "itemId", "title", "listId" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_GET_ITEM_BY_ID": { "post": { "summary": "Get Item By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_GET_ITEM_BY_ID" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Item ID : The ID of the item to get." }, "listId": { "type": "string", "description": "The list ID to perform the operation on. (example: 22e03ef3-6ef4-424d-a1d3-92a337807c30)" } }, "required": [ "itemId", "listId" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_GET_ITEMS_IN_A_LIST": { "post": { "summary": "Get Items In A List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_GET_ITEMS_IN_A_LIST" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The list ID to perform the operation on. (example: 22e03ef3-6ef4-424d-a1d3-92a337807c30)" }, "itemsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "fields/Title", "fields/Modified", "fields/Created", "fields/AuthorLookupId", "fields/EditorLookupId", "fields/LinkTitle" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$numberEquals", "$stringDoesNotExactlyMatch", "$numberGreaterThan", "$numberLessThan", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "limit": { "type": "number", "description": "Limit of records to fetch. Default is 100." }, "pageCursor": { "type": "string", "description": "Page cursor to paginate the results." } } } }, "required": [ "listId" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_DELETE_ITEM": { "post": { "summary": "Delete Item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_DELETE_ITEM" }, "parameters": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Item ID : The ID of the item to delete." }, "listId": { "type": "string", "description": "The list ID to perform the operation on. (example: 22e03ef3-6ef4-424d-a1d3-92a337807c30)" } }, "required": [ "itemId", "listId" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_CREATE_LIST": { "post": { "summary": "Create List", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_CREATE_LIST" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description : Description or acceptance criteria for this epic to be considered complete." } }, "required": [ "name" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_GET_LIST_BY_ID": { "post": { "summary": "Get List By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_GET_LIST_BY_ID" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The list ID to perform the operation on. (example: 22e03ef3-6ef4-424d-a1d3-92a337807c30)" } }, "required": [ "listId" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_GET_LISTS": { "post": { "summary": "Get Lists", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_GET_LISTS" }, "parameters": { "type": "object", "properties": { "listsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "displayName" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_GET_LIST_COLUMNS": { "post": { "summary": "Get List Columns", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_GET_LIST_COLUMNS" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The list ID to perform the operation on. (example: 22e03ef3-6ef4-424d-a1d3-92a337807c30)" } }, "required": [ "listId" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHAREPOINT_CREATE_LIST_COLUMN": { "post": { "summary": "Create List Column", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHAREPOINT_CREATE_LIST_COLUMN" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "The list ID to perform the operation on. (example: 22e03ef3-6ef4-424d-a1d3-92a337807c30)" }, "dataType": { "type": "string", "description": "Data Type : Determines what type of data the column stores", "enum": [ "boolean", "choice", "dateTime", "number", "text" ] }, "allowTextEntry": { "type": "boolean", "description": "Allow Text Entry : If true, allows custom values that aren’t in the configured choices. \nThis field appears only when 'dataType' = 'choice')" }, "choices": { "type": "object", "description": "Choices : The list of values available for this column. (example: \"[\"red\", \"blue\", \"green\"]\") \nThis field appears only when 'dataType' = 'choice')", "properties": {} }, "displayAs": { "type": "string", "description": "Display As : How the choices are to be presented in the UX.\nAvailable options by dataType:\n- 'checkBoxes': available when 'dataType' = 'choice'\n- 'dropDownMenu': available when 'dataType' = 'choice'\n- 'radioButtons': available when 'dataType' = 'choice'\n- 'default': available when 'dataType' = 'dateTime'\n- 'friendly': available when 'dataType' = 'dateTime'\n- 'standard': available when 'dataType' = 'dateTime'\n- 'number': available when 'dataType' = 'number'\n- 'percentage': available when 'dataType' = 'number'", "enum": [ "number", "percentage", "checkBoxes", "dropDownMenu", "radioButtons", "default", "friendly", "standard" ] }, "format": { "type": "string", "description": "Format : Indicates whether the value should be presented as a date only or a date and time. \nThis field appears only when 'dataType' = 'dateTime')", "enum": [ "dateOnly", "dateTime" ] }, "maximum": { "type": "string", "description": "Maximum : The maximum permitted value. \nThis field appears only when 'dataType' = 'number')" }, "minimum": { "type": "string", "description": "Minimum : The minimum permitted value. \nThis field appears only when 'dataType' = 'number')" }, "linesForEditing": { "type": "string", "description": "Lines for Editing : The size of the text box. \nThis field appears only when 'dataType' = 'text')" }, "maxLength": { "type": "string", "description": "Max Length : The maximum number of characters for the value. \nThis field appears only when 'dataType' = 'text')" }, "textType": { "type": "string", "description": "Text Type \nThis field appears only when 'dataType' = 'text')", "enum": [ "plain", "richText" ] }, "allowMultipleLines": { "type": "boolean", "description": "Allow Multiple Lines : Whether to allow multiple lines of text. \nThis field appears only when 'dataType' = 'text')" }, "displayName": { "type": "string", "description": "Display Name : The user-facing name of the column." }, "apiName": { "type": "string", "description": "Api Name : The API-facing name of the column as it appears in the fields on a List Item." }, "description": { "type": "string", "description": "Description : Description or acceptance criteria for this epic to be considered complete." }, "defaultValue": { "type": "string", "description": "Default Value : The default value for this column." }, "hidden": { "type": "boolean", "description": "Hidden" }, "readOnly": { "type": "boolean", "description": "Read-only" } }, "required": [ "listId", "dataType", "textType", "displayName", "apiName" ], "x-integration": "sharepoint" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_GET_CUSTOMERS": { "post": { "summary": "Get Customers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_GET_CUSTOMERS" }, "parameters": { "type": "object", "properties": { "customerIds": { "type": "string", "description": "Customer IDs : Only return customers matching the IDs provided. You can enter an array or a comma-separated list of IDs. (example: \"207119551, 207119552\")" }, "createdAtMin": { "type": "string", "description": "Created After : Only return customers created after the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "createdAtMax": { "type": "string", "description": "Created Before : Only return customers created before the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "updatedAtMin": { "type": "string", "description": "Updated after : Only return customers updated after the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "updatedAtMax": { "type": "string", "description": "Updated before : Only return customers updated before the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "limit": { "type": "string", "description": "Limit results : Limit the maximum number of customers to return. Defaults to 250 if left blank. Pagination only accepts the limit field. Other fields cannot be used for filtering the paginated records." } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_SEARCH_CUSTOMERS": { "post": { "summary": "Search Customers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_SEARCH_CUSTOMERS" }, "parameters": { "type": "object", "properties": { "filterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "$stringContains", "$stringDoesNotContain", "$stringStartsWith", "$stringDoesNotStartWith", "$numberLessThan", "$numberEquals", "$numberGreaterThan", "$numberDoesNotEqual", "$numberGreaterThanOrEqualTo", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "limit": { "type": "string", "description": "Limit results : Limit the maximum number of customers to return. Defaults to 250 if left blank. Pagination only accepts the limit field. Other fields cannot be used for filtering the paginated records." } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_CREATE_CUSTOMER": { "post": { "summary": "Create Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_CREATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "Email address" }, "company": { "type": "string", "description": "Company name" }, "streetAddressLine1": { "type": "string", "description": "Street address" }, "streetAddressLine2": { "type": "string", "description": "Street address line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province code" }, "country": { "type": "string", "description": "Country" }, "zipCode": { "type": "string", "description": "Zip code" }, "phone": { "type": "string", "description": "Phone" }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "note": { "type": "string", "description": "Note" }, "sendEmailInvite": { "type": "boolean", "description": "Send email invite" }, "metafields": { "type": "object", "description": "Metafields (example: \"[\n {\n \"key\": \"new\",\n \"value\": \"newvalue\",\n \"value_type\": \"string\",\n \"namespace\": \"global\"\n }\n ]\")", "properties": {} } }, "required": [ "firstName", "lastName", "email" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_UPDATE_CUSTOMER": { "post": { "summary": "Update Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_UPDATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Customer ID : The ID of the Customer to update." }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "Email address" }, "company": { "type": "string", "description": "Company name" }, "streetAddressLine1": { "type": "string", "description": "Street address" }, "streetAddressLine2": { "type": "string", "description": "Street address line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province code" }, "country": { "type": "string", "description": "Country" }, "zipCode": { "type": "string", "description": "Zip code" }, "phone": { "type": "string", "description": "Phone" }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "note": { "type": "string", "description": "Note" }, "sendEmailInvite": { "type": "boolean", "description": "Send email invite" }, "metafields": { "type": "object", "description": "Metafields (example: \"[\n {\n \"key\": \"new\",\n \"value\": \"newvalue\",\n \"value_type\": \"string\",\n \"namespace\": \"global\"\n }\n ]\")", "properties": {} } }, "required": [ "customerId" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_GET_ORDERS": { "post": { "summary": "Get Orders", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_GET_ORDERS" }, "parameters": { "type": "object", "properties": { "orderIds": { "type": "string", "description": "Order IDs : Only return orders matching the IDs provided. You can enter an array or a comma-separated list of IDs. (example: \"450789469, 450789470,\")" }, "createdAtMin": { "type": "string", "description": "Created After : Only return orders created after the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "createdAtMax": { "type": "string", "description": "Created Before : Only return orders created before the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "updatedAtMin": { "type": "string", "description": "Updated after : Only return orders updated after the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "updatedAtMax": { "type": "string", "description": "Updated before : Only return orders updated before the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "limit": { "type": "string", "description": "Limit results : Limit the maximum number of orders to return. Defaults to 250 if left blank. Pagination only accepts the limit field. Other fields cannot be used for filtering the paginated records." } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_CREATE_ORDER": { "post": { "summary": "Create Order", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_CREATE_ORDER" }, "parameters": { "type": "object", "properties": { "email": { "type": "string", "description": "Customer email" }, "lineItems": { "type": "object", "description": "Line items : View Shopify’s docs (https://shopify.dev/docs/themes/liquid/reference/objects/line_item#line_item-properties) for a list of line item properties. (example: \"[\n {\n \"title\": \"Big Brown Bear Boots\",\n \"price\": 74.99,\n \"quantity\": 3,\n \"variant_id\": 447654529\n }\n ]\")", "properties": {} }, "sendReceipt": { "type": "boolean", "description": "Send receipt" }, "fulfillmentStatus": { "type": "string", "description": "Fulfillment status", "enum": [ "fulfilled", "null", "partial", "restocked" ] }, "financialStatus": { "type": "string", "description": "Financial status", "enum": [ "pending", "authorized", "partially_paid", "paid", "partially_refunded", "refunded", "voided" ] }, "inventoryBehaviour": { "type": "string", "description": "Inventory behavior", "enum": [ "bypass", "decrement_ignoring_policy", "decrement_obeying_policy" ] }, "note": { "type": "string", "description": "Note" } }, "required": [ "email", "lineItems" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_UPDATE_ORDER": { "post": { "summary": "Update Order", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_UPDATE_ORDER" }, "parameters": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Order ID : The ID of the Order to update." }, "email": { "type": "string", "description": "Customer email" }, "lineItems": { "type": "object", "description": "Line items : View Shopify’s docs (https://shopify.dev/docs/themes/liquid/reference/objects/line_item#line_item-properties) for a list of line item properties. (example: \"[\n {\n \"title\": \"Big Brown Bear Boots\",\n \"price\": 74.99,\n \"quantity\": 3,\n \"variant_id\": 447654529\n }\n ]\")", "properties": {} }, "sendReceipt": { "type": "boolean", "description": "Send receipt" }, "fulfillmentStatus": { "type": "string", "description": "Fulfillment status", "enum": [ "fulfilled", "null", "partial", "restocked" ] }, "financialStatus": { "type": "string", "description": "Financial status", "enum": [ "pending", "authorized", "partially_paid", "paid", "partially_refunded", "refunded", "voided" ] }, "inventoryBehaviour": { "type": "string", "description": "Inventory behavior", "enum": [ "bypass", "decrement_ignoring_policy", "decrement_obeying_policy" ] }, "note": { "type": "string", "description": "Note" } }, "required": [ "orderId" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_GET_ABANDONED_CARTS": { "post": { "summary": "Get Abandoned Carts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_GET_ABANDONED_CARTS" }, "parameters": { "type": "object", "properties": { "createdWithInLast-left": { "type": "string", "description": "Created Within the Last : Restrict results to only checkouts created within the specified time.", "enum": [ "minutes", "hours", "days" ] }, "createdWithInLast-right": { "type": "string", "description": "Created Within the Last Value : Restrict results to only checkouts created within the specified time." }, "createdAfterId": { "type": "string", "description": "Created After Record ID : Restrict results to after the specified ID. (example: \"450789469\")" }, "status": { "type": "string", "description": "Status : Show only checkouts with a given status. Defaults to showing only open abandoned checkouts.", "enum": [ "open", "closed" ] }, "createdAtMin": { "type": "string", "description": "Created After : Only return orders created after the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "createdAtMax": { "type": "string", "description": "Created Before : Only return orders created before the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "limit": { "type": "string", "description": "Limit results : Limit the maximum number of orders to return. Defaults to 250 if left blank. Pagination only accepts the limit field. Other fields cannot be used for filtering the paginated records." } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_GET_PRODUCTS": { "post": { "summary": "Get Products", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_GET_PRODUCTS" }, "parameters": { "type": "object", "properties": { "productIds": { "type": "string", "description": "Product IDs : Only return products matching the IDs provided. You can enter an array or a comma-separated list of IDs. (example: \"632910392, 632910393\")" }, "title": { "type": "string", "description": "Title" }, "productType": { "type": "string", "description": "Product Type" }, "vendor": { "type": "string", "description": "Vendor" }, "status": { "type": "string", "description": "Status", "enum": [ "active", "archived", "draft" ] }, "createdAtMin": { "type": "string", "description": "Created After : Only return products created after the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "createdAtMax": { "type": "string", "description": "Created Before : Only return products created before the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "updatedAtMin": { "type": "string", "description": "Updated after : Only return products updated after the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "updatedAtMax": { "type": "string", "description": "Updated before : Only return products updated before the provided date (ISO or Unix timestamp). (example: \"2014-04-25T16:15:47-04:00\")" }, "limit": { "type": "string", "description": "Limit results : Limit the maximum number of products to return. Defaults to 250 if left blank. Pagination only accepts the limit field. Other fields cannot be used for filtering the paginated records." } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_CREATE_PRODUCT": { "post": { "summary": "Create Product", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_CREATE_PRODUCT" }, "parameters": { "type": "object", "properties": { "title": { "type": "string", "description": "Title" }, "productType": { "type": "string", "description": "Product Type" }, "vendor": { "type": "string", "description": "Vendor" }, "productDescription": { "type": "string", "description": "Product Description : Accepts plain text or HTML." }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "price": { "type": "string", "description": "Price" }, "inventoryPolicy": { "type": "string", "description": "Inventory policy", "enum": [ "deny", "continue" ] }, "imageUrl": { "type": "string", "description": "Image URL" }, "isPublished": { "type": "boolean", "description": "Is published" }, "publishToPointToSale": { "type": "boolean", "description": "Publish to point of sale" } }, "required": [ "title", "productType", "vendor" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_UPDATE_PRODUCT": { "post": { "summary": "Update Product", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_UPDATE_PRODUCT" }, "parameters": { "type": "object", "properties": { "productId": { "type": "string", "description": "Product ID : The ID of the Product to update. (example: \"gid://shopify/Product/913144112\")" }, "title": { "type": "string", "description": "Title" }, "productType": { "type": "string", "description": "Product Type" }, "vendor": { "type": "string", "description": "Vendor" }, "productDescription": { "type": "string", "description": "Product Description : Accepts plain text or HTML." }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "price": { "type": "string", "description": "Price" }, "inventoryPolicy": { "type": "string", "description": "Inventory policy", "enum": [ "deny", "continue" ] }, "imageUrl": { "type": "string", "description": "Image URL" }, "isPublished": { "type": "boolean", "description": "Is published" }, "publishToPointToSale": { "type": "boolean", "description": "Publish to point of sale" } }, "required": [ "productId" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_GET_PRODUCTS_GRAPHQL": { "post": { "summary": "Get Products GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_GET_PRODUCTS_GRAPHQL" }, "parameters": { "type": "object", "properties": { "productFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "title", "vendor", "status", "handle", "tag", "created_at", "updated_at", "published_at" ] }, "operator": { "type": "string", "enum": [ "$stringContains", "$stringStartsWith", "$numberEquals", "$numberGreaterThan", "$numberGreaterThanOrEqualTo", "$numberLessThan", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_CREATE_PRODUCT_GRAPHQL": { "post": { "summary": "Create Product GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_CREATE_PRODUCT_GRAPHQL" }, "parameters": { "type": "object", "properties": { "title": { "type": "string", "description": "Title" }, "productType": { "type": "string", "description": "Product Type" }, "vendor": { "type": "string", "description": "Vendor" }, "productDescription": { "type": "string", "description": "Product Description : Accepts plain text or HTML." }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "media": { "type": "object", "description": "Media : Specify list of new media to be added to the product. (example: \"[\n {\n alt: \"Gray helmet for bikers\",\n mediaContentType: \"IMAGE\",\n originalSource: \"https://cdn.shopify.com/shopifycloud/brochure/assets/sell/image/image-@artdirection-large-1ba8d5de56c361cec6bc487b747c8774b9ec8203f392a99f53c028df8d0fb3fc.png\"\n }\n]\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. See the docs (https://shopify.dev/docs/api/admin-graphql/2026-04/mutations/productCreate?language=cURL#top) for available fields. (example: \"{\n status: \"ACTIVE\",\n requiresSellingPlan: false,\n giftCard: false\n}\")", "properties": {} } }, "required": [ "title", "productType", "vendor" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_UPDATE_PRODUCT_GRAPHQL": { "post": { "summary": "Update Product GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_UPDATE_PRODUCT_GRAPHQL" }, "parameters": { "type": "object", "properties": { "productId": { "type": "string", "description": "Product ID : The ID of the Product to update. (example: \"gid://shopify/Product/913144112\")" }, "title": { "type": "string", "description": "Title" }, "productType": { "type": "string", "description": "Product Type" }, "vendor": { "type": "string", "description": "Vendor" }, "productDescription": { "type": "string", "description": "Product Description : Accepts plain text or HTML." }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "media": { "type": "object", "description": "Media : Specify list of new media to be updated to the product. (example: \"[\n {\n alt: \"Gray helmet for bikers\",\n mediaContentType: \"IMAGE\",\n originalSource: \"https://cdn.shopify.com/shopifycloud/brochure/assets/sell/image/image-@artdirection-large-1ba8d5de56c361cec6bc487b747c8774b9ec8203f392a99f53c028df8d0fb3fc.png\"\n }\n]\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. See the docs (https://shopify.dev/docs/api/admin-graphql/2026-04/mutations/productCreate?language=cURL#top) for available fields. (example: \"{\n status: \"ACTIVE\",\n requiresSellingPlan: false,\n giftCard: false\n}\")", "properties": {} } }, "required": [ "productId" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_CREATE_CUSTOMER_GRAPHQL": { "post": { "summary": "Create Customer GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_CREATE_CUSTOMER_GRAPHQL" }, "parameters": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "Email address" }, "streetAddressLine1": { "type": "string", "description": "Street address" }, "streetAddressLine2": { "type": "string", "description": "Street address line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province code" }, "country": { "type": "string", "description": "Country" }, "zipCode": { "type": "string", "description": "Zip code" }, "phone": { "type": "string", "description": "Phone" }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "note": { "type": "string", "description": "Note" }, "locale": { "type": "string", "description": "Locale" }, "taxExempt": { "type": "boolean", "description": "Tax Exempt" }, "taxExemptions": { "type": "string", "description": "Tax Exemptions : Accepts an array or comma-separated list of tax exemptions." }, "smsMarketingConsent": { "type": "object", "description": "SMS Marketing Consent (example: \"{\n \"marketingState\": \"SUBSCRIBED\",\n \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n}\")", "properties": {} }, "metafields": { "type": "object", "description": "Metafields (example: \"[\n {\n \"key\": \"new\",\n \"value\": \"newvalue\",\n \"value_type\": \"string\",\n \"namespace\": \"global\"\n }\n ]\")", "properties": {} } }, "required": [ "firstName", "lastName", "email" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_UPDATE_CUSTOMER_GRAPHQL": { "post": { "summary": "Update Customer GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_UPDATE_CUSTOMER_GRAPHQL" }, "parameters": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Customer ID : The ID of the Customer to update. (example: \"{{1.customer.id}}\")" }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "Email address" }, "streetAddressLine1": { "type": "string", "description": "Street address" }, "streetAddressLine2": { "type": "string", "description": "Street address line 2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province code" }, "country": { "type": "string", "description": "Country" }, "zipCode": { "type": "string", "description": "Zip code" }, "phone": { "type": "string", "description": "Phone" }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "note": { "type": "string", "description": "Note" }, "locale": { "type": "string", "description": "Locale" }, "taxExempt": { "type": "boolean", "description": "Tax Exempt" }, "taxExemptions": { "type": "string", "description": "Tax Exemptions : Accepts an array or comma-separated list of tax exemptions." }, "metafields": { "type": "object", "description": "Metafields (example: \"[\n {\n \"key\": \"new\",\n \"value\": \"newvalue\",\n \"value_type\": \"string\",\n \"namespace\": \"global\"\n }\n ]\")", "properties": {} } }, "required": [ "customerId" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_GET_CUSTOMERS_GRAPHQL": { "post": { "summary": "Get Customers GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_GET_CUSTOMERS_GRAPHQL" }, "parameters": { "type": "object", "properties": { "customerFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "id", "first_name", "last_name", "email", "phone", "tag", "created_at", "updated_at", "country", "default", "accepts_marketing", "customer_date", "last_abandoned_order_date", "order_date", "orders_count", "total_spent", "state" ] }, "operator": { "type": "string", "enum": [ "$stringContains", "$stringStartsWith", "$numberEquals", "$numberGreaterThan", "$numberGreaterThanOrEqualTo", "$numberLessThan", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_CREATE_ORDER_GRAPHQL": { "post": { "summary": "Create Order GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_CREATE_ORDER_GRAPHQL" }, "parameters": { "type": "object", "properties": { "email": { "type": "string", "description": "Customer email" }, "lineItems": { "type": "object", "description": "Line items : View Shopify’s docs (https://shopify.dev/docs/themes/liquid/reference/objects/line_item#line_item-properties) for a list of line item properties. (example: \"[\n {\n \"title\": \"Big Brown Bear Boots\",\n \"price\": 74.99,\n \"quantity\": 3,\n \"variant_id\": 447654529\n }\n ]\")", "properties": {} }, "sendReceipt": { "type": "boolean", "description": "Send receipt" }, "fulfillmentStatus": { "type": "string", "description": "Fulfillment status", "enum": [ "fulfilled", "null", "partial", "restocked" ] }, "financialStatus": { "type": "string", "description": "Financial status", "enum": [ "pending", "authorized", "partially_paid", "paid", "partially_refunded", "refunded", "voided" ] }, "inventoryBehaviour": { "type": "string", "description": "Inventory behavior", "enum": [ "bypass", "decrement_ignoring_policy", "decrement_obeying_policy" ] }, "note": { "type": "string", "description": "Note" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. See the docs (https://shopify.dev/docs/api/admin-graphql/2026-04/mutations/productCreate?language=cURL#top) for available fields. (example: \"{\n\"name\": \"test-name\",\n\"phone\": \"+122134567890\"\n}\")", "properties": {} } }, "required": [ "email", "lineItems" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_UPDATE_ORDER_GRAPHQL": { "post": { "summary": "Update Order GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_UPDATE_ORDER_GRAPHQL" }, "parameters": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Order ID : The ID of the Order to update. (example: \"{{1.order.id}}\")" }, "email": { "type": "string", "description": "Customer email" }, "note": { "type": "string", "description": "Note" }, "poNumber": { "type": "string", "description": "Purchase Order Number : The new purchase order number for the order." }, "tags": { "type": "string", "description": "Tags : Accepts an array or comma-separated list of tags." }, "metafields": { "type": "object", "description": "Metafields (example: \"[\n {\n \"key\": \"new\",\n \"value\": \"newvalue\",\n \"value_type\": \"string\",\n \"namespace\": \"global\"\n }\n ]\")", "properties": {} }, "shippingAddress": { "type": "object", "description": "Shipping Address : The new shipping address for the order. (example: \"{\n\"address1\": \"123 Main St\",\n\"city\": \"Anytown\",\n\"province\": \"CA\",\n\"country\": \"US\",\n\"zip\": \"12345\"\n}\")", "properties": {} }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. See the docs (https://shopify.dev/docs/api/admin-graphql/2026-04/mutations/productCreate?language=cURL#top) for available fields. (example: \"{\n\"customAttributes\": [\n {\n \"key\": \"key\",\n \"value\": \"123\"\n }\n ]\n}\")", "properties": {} } }, "required": [ "orderId" ], "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_GET_ORDERS_GRAPHQL": { "post": { "summary": "Get Orders GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_GET_ORDERS_GRAPHQL" }, "parameters": { "type": "object", "properties": { "orderFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "default", "cart_token", "channel", "channel_id", "chargeback_status", "checkout_token", "confirmation_number", "customer_id", "credit_card_last4", "email", "financial_status", "fulfillment_status", "id", "name", "created_at", "updated_at" ] }, "operator": { "type": "string", "enum": [ "$stringContains", "$stringStartsWith", "$numberEquals", "$numberGreaterThan", "$numberGreaterThanOrEqualTo", "$numberLessThan", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHOPIFY_GET_ABANDONED_CARTS_GRAPHQL": { "post": { "summary": "Get Abandoned Carts GRAPHQL", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHOPIFY_GET_ABANDONED_CARTS_GRAPHQL" }, "parameters": { "type": "object", "properties": { "abandonedCartFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "email_state", "recovery_state", "status", "created_at", "updated_at" ] }, "operator": { "type": "string", "enum": [ "$stringContains", "$stringStartsWith", "$numberEquals", "$numberGreaterThan", "$numberGreaterThanOrEqualTo", "$numberLessThan", "$numberLessThanOrEqualTo", "$booleanTrue", "$booleanFalse", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "shopify" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_CREATE_STORY": { "post": { "summary": "Create Story", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_CREATE_STORY" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : The name of the story. (example: \"Find Pluton\")" }, "workflow_state_id": { "type": "string", "description": "Workflow State ID : The ID of the workflow state the story will be in. (example: \"500000005\")" }, "description": { "type": "string", "description": "Description : The description of the story. (example: \"Eat Devil Fruit\")" }, "epic_id": { "type": "string", "description": "Epic ID : The ID of the epic the story belongs to. (example: \"11\")" }, "project_id": { "type": "string", "description": "Project ID : The ID of the project the story belongs to. (example: \"12\")" }, "estimate": { "type": "string", "description": "Estimate : The numeric point estimate of the story. (example: \"1\")" }, "owner_ids": { "type": "string", "description": "Owner IDs : An array of UUIDs of the owners of this story. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "follower_ids": { "type": "string", "description": "Follower IDs : An array of UUIDs of the followers of this story. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "storyAdditionalFields": { "type": "object", "description": "Additional Fields (example: \"{\n deadline: \"2023-12-24T12:30:00Z\",\n tasks: [\n {\n \"complete\":true,\n \"description\": \"To the new world.\"\n }\n ],\n custom_fields: [\n {\n \"field_id\": \"640aede4-bbfe-4e56-b325-beb89619356f\",\n \"value_id\": \"640aede4-f350-4c7f-b520-fb452896v193\",\n \"value\": \"API\"\n }\n ]\n}\"). Its important to note that we can also specify custom fields here if we want to use them. To fetch available custom fields, we can use the GET_CUSTOM_FIELDS intent.", "properties": {} } }, "required": [ "name", "workflow_state_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_UPDATE_STORY": { "post": { "summary": "Update Story", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_UPDATE_STORY" }, "parameters": { "type": "object", "properties": { "storyPublicId": { "type": "string", "description": "Story ID : The unique identifier of the story. (example: \"106\")" }, "name": { "type": "string", "description": "Name : The name of the story. (example: \"Find Pluton\")" }, "workflow_state_id": { "type": "string", "description": "Workflow State ID : The ID of the workflow state the story will be in. (example: \"500000005\")" }, "description": { "type": "string", "description": "Description : The description of the story. (example: \"Eat Devil Fruit\")" }, "epic_id": { "type": "string", "description": "Epic ID : The ID of the epic the story belongs to. (example: \"11\")" }, "project_id": { "type": "string", "description": "Project ID : The ID of the project the story belongs to. (example: \"12\")" }, "estimate": { "type": "string", "description": "Estimate : The numeric point estimate of the story. (example: \"1\")" }, "owner_ids": { "type": "string", "description": "Owner IDs : An array of UUIDs of the owners of this story. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "follower_ids": { "type": "string", "description": "Follower IDs : An array of UUIDs of the followers of this story. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "storyAdditionalFields": { "type": "object", "description": "Additional Fields (example: \"{\n deadline: \"2023-12-24T12:30:00Z\",\n tasks: [\n {\n \"complete\":true,\n \"description\": \"To the new world.\"\n }\n ],\n custom_fields: [\n {\n \"field_id\": \"640aede4-bbfe-4e56-b325-beb89619356f\",\n \"value_id\": \"640aede4-f350-4c7f-b520-fb452896v193\",\n \"value\": \"API\"\n }\n ]\n}\"). Its important to note that we can also specify custom fields here if we want to use them. To fetch available custom fields, we can use the GET_CUSTOM_FIELDS intent.", "properties": {} } }, "required": [ "storyPublicId" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_GET_STORY_BY_ID": { "post": { "summary": "Get Story By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_GET_STORY_BY_ID" }, "parameters": { "type": "object", "properties": { "storyPublicId": { "type": "string", "description": "Story ID : The unique identifier of the story. (example: \"106\")" } }, "required": [ "storyPublicId" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_GET_STORIES_BY_PROJECT": { "post": { "summary": "Get Stories By Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_GET_STORIES_BY_PROJECT" }, "parameters": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID : The unique ID of the Project. (example: \"12\")" } }, "required": [ "project_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_GET_STORIES_BY_EPIC": { "post": { "summary": "Get Stories By Epic", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_GET_STORIES_BY_EPIC" }, "parameters": { "type": "object", "properties": { "epic_id": { "type": "string", "description": "Epic ID : The unique ID of the Epic. (example: \"11\")" } }, "required": [ "epic_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_SEARCH_STORIES": { "post": { "summary": "Search Stories", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_SEARCH_STORIES" }, "parameters": { "type": "object", "properties": { "searchFilterFormula": { "type": "array", "description": "List of filter conditions to filter by (joined by AND)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "type", "estimate", "team", "title", "id" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageSize": { "type": "number", "description": "Page Size. If provided should be between 1 and 250" }, "nextPageToken": { "type": "string", "description": "Next Page Token" } } } }, "required": [ "searchFilterFormula" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_DELETE_STORY": { "post": { "summary": "Delete Story", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_DELETE_STORY" }, "parameters": { "type": "object", "properties": { "storyPublicId": { "type": "string", "description": "Story ID : The unique identifier of the story. (example: \"106\")" } }, "required": [ "storyPublicId" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_CREATE_EPIC": { "post": { "summary": "Create Epic", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_CREATE_EPIC" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : The Epic’s name. (example: \"Find Pluton\")" }, "description": { "type": "string", "description": "Description : The Epic’s description. (example: \"Eat Devil Fruit\")" }, "owner_ids": { "type": "string", "description": "Owner IDs : An array of UUIDs for any members you want to add as Owners on this new Epic. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "follower_ids": { "type": "string", "description": "Follower IDs : An array of UUIDs for any members you want to add as Owners on this new Epic. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "epicAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. For example, you may associate an deadline or labels here. See the docs (https://developer.shortcut.com/api/rest/v3#Create-Epic) for available fields. (example: \"{\n deadline: \"2023-12-24T12:30:00Z\",\n}\")", "properties": {} } }, "required": [ "name" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_UPDATE_EPIC": { "post": { "summary": "Update Epic", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_UPDATE_EPIC" }, "parameters": { "type": "object", "properties": { "epic_id": { "type": "string", "description": "Epic ID : The unique ID of the Epic. (example: \"11\")" }, "name": { "type": "string", "description": "Name : The Epic’s name. (example: \"Find Pluton\")" }, "description": { "type": "string", "description": "Description : The Epic’s description. (example: \"Eat Devil Fruit\")" }, "owner_ids": { "type": "string", "description": "Owner IDs : An array of UUIDs for any members you want to add as Owners on this new Epic. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "follower_ids": { "type": "string", "description": "Follower IDs : An array of UUIDs for any members you want to add as Owners on this new Epic. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "epicAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. For example, you may associate an deadline or labels here. See the docs (https://developer.shortcut.com/api/rest/v3#Create-Epic) for available fields. (example: \"{\n deadline: \"2023-12-24T12:30:00Z\",\n}\")", "properties": {} } }, "required": [ "epic_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_GET_EPIC_BY_ID": { "post": { "summary": "Get Epic By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_GET_EPIC_BY_ID" }, "parameters": { "type": "object", "properties": { "epic_id": { "type": "string", "description": "Epic ID : The unique ID of the Epic. (example: \"11\")" } }, "required": [ "epic_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_DELETE_EPIC": { "post": { "summary": "Delete Epic", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_DELETE_EPIC" }, "parameters": { "type": "object", "properties": { "epic_id": { "type": "string", "description": "Epic ID : The unique ID of the Epic. (example: \"11\")" } }, "required": [ "epic_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_CREATE_PROJECT": { "post": { "summary": "Create Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_CREATE_PROJECT" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : The name of the Project. (example: \"Find Pluton\")" }, "team_id": { "type": "string", "description": "Team ID : The ID of the team the project belongs to. (example: \"106\")" }, "description": { "type": "string", "description": "Description : The Project description. (example: \"Eat Devil Fruit\")" }, "follower_ids": { "type": "string", "description": "Follower IDs : An array of UUIDs for any members you want to add as Owners on this new Epic. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "projectAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. For example, you may associate an abbreviation or start time here. See the docs (https://developer.shortcut.com/api/rest/v3#Create-Project) for available fields. (example: \"{\n color: \"#6515dd\"\n}\")", "properties": {} } }, "required": [ "name", "team_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_UPDATE_PROJECT": { "post": { "summary": "Update Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_UPDATE_PROJECT" }, "parameters": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID : The unique ID of the Project. (example: \"12\")" }, "name": { "type": "string", "description": "Name : The name of the Project. (example: \"Find Pluton\")" }, "team_id": { "type": "string", "description": "Team ID : The ID of the team the project belongs to. (example: \"106\")" }, "description": { "type": "string", "description": "Description : The Project description. (example: \"Eat Devil Fruit\")" }, "follower_ids": { "type": "string", "description": "Follower IDs : An array of UUIDs for any members you want to add as Owners on this new Epic. (example: \"[\"12345678-9012-3456-7890-123456789012\"]\")" }, "projectAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. For example, you may associate an abbreviation or start time here. See the docs (https://developer.shortcut.com/api/rest/v3#Create-Project) for available fields. (example: \"{\n color: \"#6515dd\"\n}\")", "properties": {} } }, "required": [ "project_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_GET_PROJECT_BY_ID": { "post": { "summary": "Get Project By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_GET_PROJECT_BY_ID" }, "parameters": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID : The unique ID of the Project. (example: \"12\")" } }, "required": [ "project_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_DELETE_PROJECT": { "post": { "summary": "Delete Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_DELETE_PROJECT" }, "parameters": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID : The unique ID of the Project. (example: \"12\")" } }, "required": [ "project_id" ], "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SHORTCUT_GET_CUSTOM_FIELDS": { "post": { "summary": "Get Custom Fields", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SHORTCUT_GET_CUSTOM_FIELDS" }, "parameters": { "type": "object", "properties": {}, "x-integration": "shortcut" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SLACK_LIST_MEMBERS": { "post": { "summary": "List Members", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SLACK_LIST_MEMBERS" }, "parameters": { "type": "object", "properties": {}, "x-integration": "slack" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SLACK_LIST_CHANNELS": { "post": { "summary": "List Channels", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SLACK_LIST_CHANNELS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor to paginate the results." } } } }, "x-integration": "slack" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SLACK_GET_USER_BY_EMAIL": { "post": { "summary": "Get User By Email", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SLACK_GET_USER_BY_EMAIL" }, "parameters": { "type": "object", "properties": { "email": { "type": "string", "description": "Email : The email address of a user in the workspace." } }, "required": [ "email" ], "x-integration": "slack" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SLACK_SEARCH_MESSAGES": { "post": { "summary": "Search Messages", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SLACK_SEARCH_MESSAGES" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "Search Query : Search for messages that match specified Slack search query." } }, "required": [ "query" ], "x-integration": "slack" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SLACK_SEND_DIRECT_MESSAGE": { "post": { "summary": "Send Direct Message", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SLACK_SEND_DIRECT_MESSAGE" }, "parameters": { "type": "object", "properties": { "memberId": { "type": "string", "description": "Enter the member ID to send the message to. Defaults to the authenticated user if not provided." }, "message": { "type": "string", "description": "Message" }, "botName": { "type": "string", "description": "Bot name : The name of the bot that sends this message." }, "botIcon": { "type": "string", "description": "Bot icon : Can be either an image URL or an emoji available to your team (e.g. :dog:)" }, "blocks": { "type": "object", "description": "Block kit JSON : Use the Slack Block Kit Builder (https://app.slack.com/block-kit-builder) to design your message and copy the Payload here. (example: \"{\n \"blocks\": [\n {\n \"type\": \"section\",\n \"text\": {\n \"type\": \"mrkdwn\",\n \"text\": \"Hello, this is a sample message using Slack blocks!\"\n }\n },\n {\n \"type\": \"actions\",\n \"elements\": [\n {\n \"type\": \"button\",\n \"text\": {\n \"type\": \"plain_text\",\n \"text\": \"Click Me\"\n },\n \"value\": \"click_me_123\"\n }\n ]\n }\n ]\n}\")", "properties": {} }, "authenticatedUser": { "type": "boolean", "description": "Send as authenticated user : If set to true, this message will appear to come from your authenticated Slack user instead of your application. Defaults to false." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this message as JSON. Doc link: https://api.slack.com/reference/messaging/link-unfurling (example: \"{\n \"text\": \"\",\n \"unfurl_links\": true\n}\")", "properties": {} } }, "required": [ "memberId", "message" ], "x-integration": "slack" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SLACK_SEND_MESSAGE": { "post": { "summary": "Send Message", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SLACK_SEND_MESSAGE" }, "parameters": { "type": "object", "properties": { "channel": { "type": "string", "description": "Enter the channel ID to send the message to." }, "message": { "type": "string", "description": "Message" }, "botName": { "type": "string", "description": "Bot name : The name of the bot that sends this message." }, "botIcon": { "type": "string", "description": "Bot icon : Can be either an image URL or an emoji available to your team (e.g. :dog:)" }, "blocks": { "type": "object", "description": "Block kit JSON : Use the Slack Block Kit Builder (https://app.slack.com/block-kit-builder) to design your message and copy the Payload here. (example: \"{\n \"blocks\": [\n {\n \"type\": \"section\",\n \"text\": {\n \"type\": \"mrkdwn\",\n \"text\": \"Hello, this is a sample message using Slack blocks!\"\n }\n },\n {\n \"type\": \"actions\",\n \"elements\": [\n {\n \"type\": \"button\",\n \"text\": {\n \"type\": \"plain_text\",\n \"text\": \"Click Me\"\n },\n \"value\": \"click_me_123\"\n }\n ]\n }\n ]\n}\")", "properties": {} }, "authenticatedUser": { "type": "boolean", "description": "Send as authenticated user : If set to true, this message will appear to come from your authenticated Slack user instead of your application. Defaults to false." }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this message as JSON. Doc link: https://api.slack.com/reference/messaging/link-unfurling (example: \"{\n \"text\": \"\",\n \"unfurl_links\": true\n}\")", "properties": {} } }, "required": [ "channel", "message" ], "x-integration": "slack" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#SLACK_GET_USERS_BY_NAME": { "post": { "summary": "Get Users By Name", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "SLACK_GET_USERS_BY_NAME" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "displayName": { "type": "string", "description": "Display Name" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "name", "displayName" ], "x-integration": "slack" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_CREATE_CUSTOMER": { "post": { "summary": "Create Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_CREATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "emailCreateCustomer": { "type": "string", "description": "Email address" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "metadataCreateCustomer": { "type": "object", "description": "Metadata (example: \"{ “field1”: 1, “field2”: 2}\")", "properties": {} } }, "required": [ "emailCreateCustomer" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_CUSTOMER_BY_ID": { "post": { "summary": "Get Customer By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_CUSTOMER_BY_ID" }, "parameters": { "type": "object", "properties": { "idGetCustomer": { "type": "string", "description": "Customer ID" } }, "required": [ "idGetCustomer" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_CUSTOMERS": { "post": { "summary": "Get Customers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_CUSTOMERS" }, "parameters": { "type": "object", "properties": { "emailGetCustomers": { "type": "string", "description": "Email address : Filters customers based on email address." }, "createdAfter": { "type": "string", "description": "Created after : Filters customers created after the provided date (Unix timestamp)." }, "createdBefore": { "type": "string", "description": "Created before : Filters customers created before the provided date (Unix timestamp)." }, "limitGetCustomers": { "type": "string", "description": "Limit customers : Limit the maximum number of customers to return. Defaults to 10 if left blank." } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_CREATE_SUBSCRIPTION": { "post": { "summary": "Create Subscription", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_CREATE_SUBSCRIPTION" }, "parameters": { "type": "object", "properties": { "customerIdCreateSubscription": { "type": "string", "description": "Customer ID : The Customer that the Subscription will be created for." }, "plan": { "type": "string", "description": "The Plan that the Subscription will be created with." }, "metadataCreateSubscription": { "type": "object", "description": "Metadata (example: \"{ “field1”: 1, “field2”: 2}\")", "properties": {} } }, "required": [ "customerIdCreateSubscription", "plan" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_SUBSCRIPTIONS": { "post": { "summary": "Get Subscriptions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_SUBSCRIPTIONS" }, "parameters": { "type": "object", "properties": { "customerIdGetSubscriptions": { "type": "string", "description": "Customer ID : The ID of the Customer whose Subscriptions to list." }, "subscriptionStatus": { "type": "string", "description": "Status (example: \"Select a Status\")", "enum": [ "incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid" ] }, "limitGetSubscriptions": { "type": "string", "description": "Limit : Limit the maximum number of subscriptions to return. Defaults to 10 if left blank." } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_UPDATE_CUSTOMER": { "post": { "summary": "Update Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_UPDATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Customer ID : The ID of the customer to update." }, "emailUpdateCustomer": { "type": "string", "description": "Email address" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "metadataUpdateCustomer": { "type": "object", "description": "Metadata (example: \"{ “field1”: 1, “field2”: 2}\")", "properties": {} } }, "required": [ "customerId" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_CREATE_PRODUCT": { "post": { "summary": "Create Product", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_CREATE_PRODUCT" }, "parameters": { "type": "object", "properties": { "productName": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "metadataProduct": { "type": "object", "description": "Metadata (example: \"{ “field1”: 1, “field2”: 2}\")", "properties": {} } }, "required": [ "productName" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_PRODUCT_BY_ID": { "post": { "summary": "Get Product By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_PRODUCT_BY_ID" }, "parameters": { "type": "object", "properties": { "productId": { "type": "string", "description": "Product ID" } }, "required": [ "productId" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_BALANCE_TRANSACTIONS": { "post": { "summary": "Get Balance Transactions", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_BALANCE_TRANSACTIONS" }, "parameters": { "type": "object", "properties": { "balanceTransactionType": { "type": "string", "description": "Type : Only returns transactions of the given type.", "enum": [ "charge", "refund", "payment", "payment_refund" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." } } } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_PLANS": { "post": { "summary": "Get Plans", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_PLANS" }, "parameters": { "type": "object", "properties": { "isPlanActive": { "type": "boolean", "description": "Active : Select true to list all active plans or false to list all inactive plans." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." } } } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_PRODUCTS": { "post": { "summary": "Get Products", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_PRODUCTS" }, "parameters": { "type": "object", "properties": { "createdAfter": { "type": "string", "description": "Created after : Filters customers created after the provided date (Unix timestamp)." }, "createdBefore": { "type": "string", "description": "Created before : Filters customers created before the provided date (Unix timestamp)." }, "limitGetProducts": { "type": "string", "description": "Specify products per paginated page, or omit for 10 (max 100 per page)." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." } } } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_PRICES": { "post": { "summary": "Get Prices", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_PRICES" }, "parameters": { "type": "object", "properties": { "product": { "type": "string", "description": "Product ID : Filters prices for this product." }, "limitGetPrices": { "type": "string", "description": "Specify prices per paginated page, or omit for 10 (max 100 per page)." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." } } } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_CREATE_PAYMENT_LINK": { "post": { "summary": "Create Payment Link", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_CREATE_PAYMENT_LINK" }, "parameters": { "type": "object", "properties": { "lineItems": { "type": "array", "description": "Line items. Each item needs a Stripe Price ID and quantity.", "items": { "type": "object", "properties": { "price": { "type": "string", "description": "Stripe Price ID" }, "quantity": { "type": "number", "description": "Quantity" } }, "required": [ "price", "quantity" ] } } }, "required": [ "lineItems" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_CREATE_CHECKOUT_SESSION": { "post": { "summary": "Create Checkout Session", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_CREATE_CHECKOUT_SESSION" }, "parameters": { "type": "object", "properties": { "mode": { "type": "string", "description": "Checkout mode. Use payment or subscription.", "enum": [ "payment", "subscription" ] }, "successUrl": { "type": "string", "description": "Success URL : URL to redirect to after successful payment." }, "cancelUrl": { "type": "string", "description": "Cancel URL : URL to redirect to if the customer cancels checkout." }, "customer": { "type": "string", "description": "Customer ID : Optional existing Stripe Customer ID." }, "lineItems": { "type": "array", "description": "Line items. Each item needs a Stripe Price ID and quantity.", "items": { "type": "object", "properties": { "price": { "type": "string", "description": "Stripe Price ID" }, "quantity": { "type": "number", "description": "Quantity" } }, "required": [ "price", "quantity" ] } } }, "required": [ "mode", "successUrl", "lineItems" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_CREATE_INVOICE": { "post": { "summary": "Create Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_CREATE_INVOICE" }, "parameters": { "type": "object", "properties": { "customer": { "type": "string", "description": "Customer ID : The Stripe Customer to invoice." }, "daysUntilDue": { "type": "string", "description": "Days until due : Days until the invoice is due. Defaults to 30." }, "price": { "type": "string", "description": "Price ID : Optional Stripe Price ID to add as an invoice item." }, "quantity": { "type": "string", "description": "Quantity : Quantity for the optional invoice item. Defaults to 1." } }, "required": [ "customer" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_SEND_INVOICE": { "post": { "summary": "Send Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_SEND_INVOICE" }, "parameters": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "Invoice ID" } }, "required": [ "invoiceId" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_CHARGES": { "post": { "summary": "Get Charges", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_CHARGES" }, "parameters": { "type": "object", "properties": { "customer": { "type": "string", "description": "Customer ID : Filters charges for this customer." }, "limitGetCharges": { "type": "string", "description": "Specify charges per paginated page, or omit for 10 (max 100 per page)." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." } } } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_CHARGE_BY_ID": { "post": { "summary": "Get Charge By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_CHARGE_BY_ID" }, "parameters": { "type": "object", "properties": { "chargeId": { "type": "string", "description": "Charge ID" } }, "required": [ "chargeId" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_PAYMENT_INTENTS": { "post": { "summary": "Get Payment Intents", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_PAYMENT_INTENTS" }, "parameters": { "type": "object", "properties": { "customer": { "type": "string", "description": "Customer ID : Filters payment intents for this customer." }, "limitGetPaymentIntents": { "type": "string", "description": "Specify payment intents per paginated page, or omit for 10 (max 100 per page)." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." } } } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_PAYMENT_INTENT_BY_ID": { "post": { "summary": "Get Payment Intent By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_PAYMENT_INTENT_BY_ID" }, "parameters": { "type": "object", "properties": { "paymentIntentId": { "type": "string", "description": "Payment Intent ID" } }, "required": [ "paymentIntentId" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_INVOICES": { "post": { "summary": "Get Invoices", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_INVOICES" }, "parameters": { "type": "object", "properties": { "customer": { "type": "string", "description": "Customer ID : Filters invoices for this customer." }, "status": { "type": "string", "description": "Status (example: \"Select a Status\")", "enum": [ "draft", "open", "paid", "uncollectible", "void" ] }, "limitGetInvoices": { "type": "string", "description": "Specify invoices per paginated page, or omit for 10 (max 100 per page)." }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." } } } }, "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#STRIPE_GET_INVOICE_BY_ID": { "post": { "summary": "Get Invoice By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "STRIPE_GET_INVOICE_BY_ID" }, "parameters": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "Invoice ID" } }, "required": [ "invoiceId" ], "x-integration": "stripe" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_CREATE_PROJECT": { "post": { "summary": "Create Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_CREATE_PROJECT" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : Name of the project. (example: \"Akatsuki\")" }, "parent_id": { "type": "string", "description": "Parent ID : Parent project ID. (example: \"1064843106\")" }, "color": { "type": "string", "description": "Color : The color of the project icon.Refer to the name column in the Colors (https://developer.todoist.com/guides/#colors) guide for more info. (example: \"charcoal\")" }, "is_favorite": { "type": "boolean", "description": "Is Favorite : Whether the project is a favorite." }, "projectAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. For example, you may associate an color or name here. See the docs (https://developer.todoist.com/api/v1/) for available fields. (example: \"{\n color: \"red\"\n}\")", "properties": {} } }, "required": [ "name" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_UPDATE_PROJECT": { "post": { "summary": "Update Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_UPDATE_PROJECT" }, "parameters": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID : Specify the Project ID." }, "name": { "type": "string", "description": "Name : Name of the project. (example: \"Akatsuki\")" }, "color": { "type": "string", "description": "Color : The color of the project icon.Refer to the name column in the Colors (https://developer.todoist.com/guides/#colors) guide for more info. (example: \"charcoal\")" }, "is_favorite": { "type": "boolean", "description": "Is Favorite : Whether the project is a favorite." }, "projectAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. For example, you may associate an color or name here. See the docs (https://developer.todoist.com/api/v1/) for available fields. (example: \"{\n color: \"red\"\n}\")", "properties": {} } }, "required": [ "project_id" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_GET_PROJECT_BY_ID": { "post": { "summary": "Get Project By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_GET_PROJECT_BY_ID" }, "parameters": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID : Specify the Project ID." } }, "required": [ "project_id" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_GET_ALL_PROJECTS": { "post": { "summary": "Get All Projects", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_GET_ALL_PROJECTS" }, "parameters": { "type": "object", "properties": {}, "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_DELETE_PROJECT": { "post": { "summary": "Delete Project", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_DELETE_PROJECT" }, "parameters": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID : Specify the Project ID." } }, "required": [ "project_id" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_CREATE_TASK": { "post": { "summary": "Create Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_CREATE_TASK" }, "parameters": { "type": "object", "properties": { "content": { "type": "string", "description": "Content : Task content. This value may contain markdown-formatted text and hyperlinks.Details on markdown support can be found in the Text Formatting article (https://todoist.com/help/articles/how-to-format-text) in the Help Center. (example: \"Buy Sword\")" }, "description": { "type": "string", "description": "Description : A description for the task. (example: \"Pirate King\")" }, "project_id": { "type": "string", "description": "Project ID : Task project ID. If not set, task is put to user's Inbox." }, "section_id": { "type": "string", "description": "Section ID : ID of section to put task into." }, "parent_id": { "type": "string", "description": "Parent ID : Parent task ID. (example: \"1064843106\")" }, "due_string": { "type": "string", "description": "Due String : Human defined (https://todoist.com/help/articles/due-dates-and-times) task due date (ex.: 'next Monday', 'Tomorrow'). Value is set using local (not UTC) time. (example: \"tomorrow at 12:00\")" }, "due_date": { "type": "string", "description": "Due Date : Specific date in YYYY-MM-DD format relative to user’s timezone." }, "priority": { "type": "string", "description": "Priority : Task priority from 1 (normal) to 4 (urgent). (example: \"4\")" }, "taskAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. For example, you may associate an assignee or description here. See the docs (https://developer.todoist.com/api/v1/) for available fields. (example: \"{\n assignee_id: \"a70bdf0f\"\n}\")", "properties": {} } }, "required": [ "content" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_UPDATE_TASK": { "post": { "summary": "Update Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_UPDATE_TASK" }, "parameters": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID : Specify the Task ID." }, "content": { "type": "string", "description": "Content : Task content. This value may contain markdown-formatted text and hyperlinks.Details on markdown support can be found in the Text Formatting article (https://todoist.com/help/articles/how-to-format-text) in the Help Center. (example: \"Buy Sword\")" }, "description": { "type": "string", "description": "Description : A description for the task. (example: \"Pirate King\")" }, "due_string": { "type": "string", "description": "Due String : Human defined (https://todoist.com/help/articles/due-dates-and-times) task due date (ex.: 'next Monday', 'Tomorrow'). Value is set using local (not UTC) time. (example: \"tomorrow at 12:00\")" }, "due_date": { "type": "string", "description": "Due Date : Specific date in YYYY-MM-DD format relative to user’s timezone." }, "priority": { "type": "string", "description": "Priority : Task priority from 1 (normal) to 4 (urgent). (example: \"4\")" }, "taskAdditionalFields": { "type": "object", "description": "Additional Fields : Specify additional fields to include on this request as JSON. For example, you may associate an assignee or description here. See the docs (https://developer.todoist.com/api/v1/) for available fields. (example: \"{\n assignee_id: \"a70bdf0f\"\n}\")", "properties": {} } }, "required": [ "task_id" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_GET_TASK_BY_ID": { "post": { "summary": "Get Task By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_GET_TASK_BY_ID" }, "parameters": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID : Specify the Task ID." } }, "required": [ "task_id" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_SEARCH_TASKS": { "post": { "summary": "Search Tasks", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_SEARCH_TASKS" }, "parameters": { "type": "object", "properties": { "queryTerm": { "type": "string", "description": "Query Term : Filter by any supported filter. (https://todoist.com/help/articles/introduction-to-filters#filtering-based-on) (example: \"search:Buy Milk\")" } }, "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_CLOSE_TASK": { "post": { "summary": "Close Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_CLOSE_TASK" }, "parameters": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID : Specify the Task ID." } }, "required": [ "task_id" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TODOIST_DELETE_TASK": { "post": { "summary": "Delete Task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TODOIST_DELETE_TASK" }, "parameters": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID : Specify the Task ID." } }, "required": [ "task_id" ], "x-integration": "todoist" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TRELLO_CREATE_CARD": { "post": { "summary": "Create Card", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TRELLO_CREATE_CARD" }, "parameters": { "type": "object", "properties": { "listId": { "type": "string", "description": "Specify a list ID to perform the operation on" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "position": { "type": "string", "description": "Position : Set the position of the new card to top, bottom, or a positive number." }, "dueDate": { "type": "string", "description": "Due Date : Specify a date for this card to be due." }, "isDueDateComplete": { "type": "string", "description": "Due Date Complete : Specify whether or not the card’s due date should be marked complete.", "enum": [ "no", "yes" ] }, "memberIds": { "type": "string", "description": "Member IDs : Specify an array of member IDs to add to the card." }, "labelIds": { "type": "string", "description": "Label IDs : Specify an array of label IDs to add to the card." }, "address": { "type": "string", "description": "Address : For use with Trello’s Map View." }, "locationName": { "type": "string", "description": "Location Name : For use with Trello’s Map View." }, "coordinates": { "type": "string", "description": "Coordinates : For use with Trello’s Map View. Use a lat,long-formatted string." } }, "required": [ "listId" ], "x-integration": "trello" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TRELLO_UPDATE_CARD": { "post": { "summary": "Update Card", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TRELLO_UPDATE_CARD" }, "parameters": { "type": "object", "properties": { "cardId": { "type": "string", "description": "Card ID : The ID of the card to update." }, "boardId": { "type": "string", "description": "Specify a board ID to move this card into. If this field is specified, a list must also be specified" }, "listId": { "type": "string", "description": "Specify a list ID to move this card into" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "isClosed": { "type": "string", "description": "Closed : Specify whether or not the card should be archived.", "enum": [ "no", "yes" ] }, "position": { "type": "string", "description": "Position : Set the position of the new card to top, bottom, or a positive number." }, "dueDate": { "type": "string", "description": "Due Date : Specify a date for this card to be due." }, "isDueDateComplete": { "type": "string", "description": "Due Date Complete : Specify whether or not the card’s due date should be marked complete.", "enum": [ "no", "yes" ] }, "memberIds": { "type": "string", "description": "Member IDs : Specify an array of member IDs to add to the card." }, "labelIds": { "type": "string", "description": "Label IDs : Specify an array of label IDs to add to the card." }, "address": { "type": "string", "description": "Address : For use with Trello’s Map View." }, "locationName": { "type": "string", "description": "Location Name : For use with Trello’s Map View." }, "coordinates": { "type": "string", "description": "Coordinates : For use with Trello’s Map View. Use a lat,long-formatted string." } }, "required": [ "cardId" ], "x-integration": "trello" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TRELLO_GET_CARDS_IN_BOARD": { "post": { "summary": "Get Cards In Board", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TRELLO_GET_CARDS_IN_BOARD" }, "parameters": { "type": "object", "properties": { "boardId": { "type": "string", "description": "Specify a board ID to perform the operation on" } }, "required": [ "boardId" ], "x-integration": "trello" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TRELLO_DELETE_CARD": { "post": { "summary": "Delete Card", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TRELLO_DELETE_CARD" }, "parameters": { "type": "object", "properties": { "cardId": { "type": "string", "description": "Card ID : The ID of the card to delete." } }, "required": [ "cardId" ], "x-integration": "trello" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TRELLO_SEARCH_CARDS": { "post": { "summary": "Search Cards", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TRELLO_SEARCH_CARDS" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "Query" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "query" ], "x-integration": "trello" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TRELLO_GET_LISTS_IN_BOARD": { "post": { "summary": "Get Lists In Board", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TRELLO_GET_LISTS_IN_BOARD" }, "parameters": { "type": "object", "properties": { "boardId": { "type": "string", "description": "Specify a board ID to perform the operation on" } }, "required": [ "boardId" ], "x-integration": "trello" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TRELLO_SEARCH_BOARDS": { "post": { "summary": "Search Boards", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TRELLO_SEARCH_BOARDS" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "Search Query : Search for boards by a phrase in their title or other properties." } }, "required": [ "query" ], "x-integration": "trello" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#TRELLO_GET_BOARDS_MEMBER_BELONG_TO": { "post": { "summary": "Get Boards Member Belong To", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "TRELLO_GET_BOARDS_MEMBER_BELONG_TO" }, "parameters": { "type": "object", "properties": {}, "x-integration": "trello" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_GET_ACCOUNTS": { "post": { "summary": "Get Accounts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_GET_ACCOUNTS" }, "parameters": { "type": "object", "properties": { "accountsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Id", "name", "type", "CurrencyCode" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] } }, "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_GET_CONTACTS": { "post": { "summary": "Get Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_GET_CONTACTS" }, "parameters": { "type": "object", "properties": { "contactsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Id", "name", "EmailAddress", "AccountNumber", "ContactStatus" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_CREATE_CUSTOMER": { "post": { "summary": "Create Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_CREATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : Full name of contact/organization" }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "Email address" }, "phone": { "type": "string", "description": "Phone number" }, "accountNumber": { "type": "string", "description": "Account number" }, "addressLine1": { "type": "string", "description": "Billing street address" }, "addressLine2": { "type": "string", "description": "Billing street address line 2" }, "billingCity": { "type": "string", "description": "Billing city" }, "state": { "type": "string", "description": "Billing State or country subdivision code" }, "country": { "type": "string", "description": "Billing country" }, "postalCode": { "type": "string", "description": "Billing postal code" } }, "required": [ "name", "firstName", "lastName" ], "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_UPDATE_CUSTOMER": { "post": { "summary": "Update Customer", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_UPDATE_CUSTOMER" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : Full name of contact/organization" }, "customerId": { "type": "string", "description": "Customer ID : The ID of the customer to update. (example: \"Customer ID\")" }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "Email address" }, "phone": { "type": "string", "description": "Phone number" }, "accountNumber": { "type": "string", "description": "Account number" }, "addressLine1": { "type": "string", "description": "Billing street address" }, "addressLine2": { "type": "string", "description": "Billing street address line 2" }, "billingCity": { "type": "string", "description": "Billing city" }, "state": { "type": "string", "description": "Billing State or country subdivision code" }, "country": { "type": "string", "description": "Billing country" }, "postalCode": { "type": "string", "description": "Billing postal code" } }, "required": [ "name", "customerId" ], "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_GET_INVOICES": { "post": { "summary": "Get Invoices", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_GET_INVOICES" }, "parameters": { "type": "object", "properties": { "invoicesFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Id", "invoiceNumber", "Contact.Name", "name", "status", "Reference", "Date", "DueDate" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_CREATE_INVOICE": { "post": { "summary": "Create Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_CREATE_INVOICE" }, "parameters": { "type": "object", "properties": { "invoiceType": { "type": "string", "description": "Invoice Type", "enum": [ "ACCPAY", "ACCREC" ] }, "contactId": { "type": "string", "description": "Contact : The customer this invoice is associated with. (example: \"Contact ID\")" }, "lineItems": { "type": "object", "description": "Line items : Enter an array of Line items including the description, quantity, and amount for each Line item. (example: \"[\n {\n \"Description\": \"White T-Shirt\", \n \"Quantity\": \"2\",\n \"UnitAmount\": \"20.00\",\n \"AccountCode\": \"200\"\n }\n] \n \")", "properties": {} }, "invoiceStatus": { "type": "string", "description": "Status", "enum": [ "DRAFT", "SUBMITTED", "AUTHORISED" ] }, "date": { "type": "string", "description": "Date : Date the invoice was issued. (example: \"YYYY-MM-DD\")" }, "dueDate": { "type": "string", "description": "Due Date : Date the invoice is due. (example: \"YYYY-MM-DD\")" }, "currency": { "type": "string", "description": "Currency (example: \"USD\")" }, "invoiceNumber": { "type": "string", "description": "Invoice Number : Alpha numeric code identifying the invoice (example: \"OIT00546\")" }, "reference": { "type": "string", "description": "Reference" } }, "required": [ "invoiceType", "contactId", "lineItems" ], "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_UPDATE_INVOICE": { "post": { "summary": "Update Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_UPDATE_INVOICE" }, "parameters": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "Invoice ID" }, "invoiceStatus": { "type": "string", "description": "Status", "enum": [ "DRAFT", "SUBMITTED", "AUTHORISED" ] }, "reference": { "type": "string", "description": "Reference" } }, "required": [ "invoiceId" ], "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_SEND_INVOICE": { "post": { "summary": "Send Invoice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_SEND_INVOICE" }, "parameters": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "Invoice ID" }, "sendToEmail": { "type": "string", "description": "Send to email address : Updates the invoice’s billing email address to the email provided. If left blank, sends to the invoice’s existing billing email address. (example: \"name@example.com\")" } }, "required": [ "invoiceId" ], "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_GET_PAYMENTS": { "post": { "summary": "Get Payments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_GET_PAYMENTS" }, "parameters": { "type": "object", "properties": { "paymentsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "Id", "name", "status", "Invoice.InvoiceId", "Date", "Reference" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter", "$booleanTrue", "$booleanFalse" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "The cursor to use for requesting additional results. Use if you received a previous response with a page cursor and require more results." }, "limit": { "type": "number", "description": "The maximum number of records to load in one page of results." } } } }, "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_CREATE_PAYMENT": { "post": { "summary": "Create Payment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_CREATE_PAYMENT" }, "parameters": { "type": "object", "properties": { "totalAmount": { "type": "string", "description": "Total amount (example: \"25.0\")" }, "linkedInvoice": { "type": "string", "description": "Linked invoice : Applies this payment to an existing invoice in Xero." }, "accountId": { "type": "string", "description": "Account ID : ID of the Account used to make the payment." }, "currency": { "type": "string", "description": "Currency (example: \"USD\")" }, "additionalFields": { "type": "object", "description": "Additional Fields : Specify optional payment fields as JSON, such as Date, Reference, or a CreditNote identifier. (example: \"{\n \"Date\": \"2009-09-08\",\n \"Reference\": \"Direct Debit\",\n \"CreditNote\": { \"CreditNoteID\": \"8648fa8c-3d0c-4ea3-9f6b-3a3ec05d0e26\" }\n}\")", "properties": {} } }, "required": [ "totalAmount", "accountId" ], "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#XERO_DELETE_PAYMENT": { "post": { "summary": "Delete Payment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "XERO_DELETE_PAYMENT" }, "parameters": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "Payment ID : The ID of the payment to delete." } }, "required": [ "paymentId" ], "x-integration": "xero" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_CREATE_TICKET": { "post": { "summary": "Create Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_CREATE_TICKET" }, "parameters": { "type": "object", "properties": { "ticketSubject": { "type": "string", "description": "Subject (example: \"Help, my printer is on fire!\")" }, "ticketDescription": { "type": "string", "description": "Description : The first comment that appears on the ticket. (example: \"The smoke is very colorful.\")" }, "requesterName": { "type": "string", "description": "Requester Name : The name of the user who requested this ticket. If you add this field, you must also specify a Request Email in the next field. (example: \"Jane Customer\")" }, "requesterEmail": { "type": "string", "description": "Requester Email : The subtitle of the user who requested this ticket. (example: \"jane@example.com\")" }, "assigneeId": { "type": "string", "description": "Assignee ID : The Zendesk Agent assigned to this Ticket. Use Connect Portal Workflow Settings to allow users to select an Assignee. (example: \"{{settings.assignee}}\")" }, "ticketType": { "type": "string", "description": "Type", "enum": [ "problem", "incident", "question", "task" ] }, "ticketPriority": { "type": "string", "description": "Priority", "enum": [ "urgent", "high", "normal", "low" ] }, "ticketStatus": { "type": "string", "description": "Status", "enum": [ "new", "open", "pending", "hold", "solved", "closed" ] }, "ticketDueAt": { "type": "string", "description": "Due At: If this is a ticket of type \"task\" it has a due date (ISO 8601 timestamp).", "format": "date" }, "ticketTags": { "type": "string", "description": "Tags : The array of tags applied to this ticket. (example: \"[\"enterprise\", \"other_tag\"]\")" }, "ticketExternalId": { "type": "string", "description": "External ID : An ID you can use to link Zendesk Support tickets to local records" }, "ticketCustomFields": { "type": "object", "description": "Custom fields (example: \"[\n { \"id\": 27642, \"value\": \"745\" },\n { \"id\": 27648, \"value\": \"yes\" }\n ]\")", "properties": {} } }, "required": [ "ticketSubject", "ticketDescription", "requesterName", "requesterEmail" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_UPDATE_TICKET": { "post": { "summary": "Update Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_UPDATE_TICKET" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : The ID of the ticket to update. (example: \"35436\")" }, "ticketSubject": { "type": "string", "description": "Subject (example: \"Help, my printer is on fire!\")" }, "requesterName": { "type": "string", "description": "Requester Name : The name of the user who requested this ticket. If you add this field, you must also specify a Request Email in the next field. (example: \"Jane Customer\")" }, "requesterEmail": { "type": "string", "description": "Requester Email : The subtitle of the user who requested this ticket. (example: \"jane@example.com\")" }, "assigneeId": { "type": "string", "description": "Assignee ID : The Zendesk Agent assigned to this Ticket. Use Connect Portal Workflow Settings to allow users to select an Assignee. (example: \"{{settings.assignee}}\")" }, "ticketType": { "type": "string", "description": "Type", "enum": [ "problem", "incident", "question", "task" ] }, "ticketPriority": { "type": "string", "description": "Priority", "enum": [ "urgent", "high", "normal", "low" ] }, "ticketStatus": { "type": "string", "description": "Status", "enum": [ "new", "open", "pending", "hold", "solved", "closed" ] }, "ticketDueAt": { "type": "string", "description": "Due At: If this is a ticket of type \"task\" it has a due date (ISO 8601 timestamp).", "format": "date" }, "ticketTags": { "type": "string", "description": "Tags : The array of tags applied to this ticket. (example: \"[\"enterprise\", \"other_tag\"]\")" }, "ticketExternalId": { "type": "string", "description": "External ID : An ID you can use to link Zendesk Support tickets to local records" }, "ticketCustomFields": { "type": "object", "description": "Custom fields (example: \"[\n { \"id\": 27642, \"value\": \"745\" },\n { \"id\": 27648, \"value\": \"yes\" }\n ]\")", "properties": {} } }, "required": [ "ticketId", "requesterName", "requesterEmail" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_DELETE_TICKET": { "post": { "summary": "Delete Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_DELETE_TICKET" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "The ID of the ticket to delete" } }, "required": [ "ticketId" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_ADD_COMMENT_TO_TICKET": { "post": { "summary": "Add Comment To Ticket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_ADD_COMMENT_TO_TICKET" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : The ID of the ticket the comment will be added to. (example: \"35436\")" }, "commentBody": { "type": "string", "description": "Body : The comment message. Accepts plain text or HTML. (example: \"Thanks for your help!\")" }, "isInternalNote": { "type": "boolean", "description": "Create as internal note? : Set to true if the comment should be an internal note, instead of a public reply. Defaults to false." }, "isPublic": { "type": "boolean", "description": "Public : True if a public comment; false if an internal note." } }, "required": [ "ticketId", "commentBody" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SEARCH_TICKETS": { "post": { "summary": "Search Tickets", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SEARCH_TICKETS" }, "parameters": { "type": "object", "properties": { "ticketSubject": { "type": "string", "description": "Subject : Filter results by the text in the ticket’s subject." }, "ticketDescription": { "type": "string", "description": "Description : Filter results by the text in the ticket's description and comments." }, "ticketStatus": { "type": "string", "description": "Status", "enum": [ "new", "open", "pending", "hold", "solved", "closed" ] }, "ticketType": { "type": "string", "description": "Type", "enum": [ "problem", "incident", "question", "task", "no_type" ] }, "createdDate-left": { "type": "string", "description": "Created Date : Filter tickets by their created date. (example: \"YYYY-MM-DD\")", "enum": [ "EQUALS", "LESS_THAN_EQUALS", "GREATER_THAN_EQUALS" ] }, "createdDate-right": { "type": "string", "description": "Created Date Value : Filter tickets by their created date. (example: \"YYYY-MM-DD\")" }, "updatedDate-left": { "type": "string", "description": "Updated Date : Filter tickets by their updated date. (example: \"YYYY-MM-DD\")", "enum": [ "EQUALS", "LESS_THAN_EQUALS", "GREATER_THAN_EQUALS" ] }, "updatedDate-right": { "type": "string", "description": "Updated Date Value : Filter tickets by their updated date. (example: \"YYYY-MM-DD\")" }, "dueDate-left": { "type": "string", "description": "Due Date : Filter tickets by their due date. (example: \"YYYY-MM-DD\")", "enum": [ "EQUALS", "LESS_THAN_EQUALS", "GREATER_THAN_EQUALS" ] }, "dueDate-right": { "type": "string", "description": "Due Date Value : Filter tickets by their due date. (example: \"YYYY-MM-DD\")" }, "requesterId": { "type": "string", "description": "Requester ID : Filter by the user who requested this ticket." }, "assigneeId": { "type": "string", "description": "Assignee ID : Filter by the agent assigned to the ticket." }, "recipientEmail": { "type": "string", "description": "Recipient : Filter by the original recipient e-mail address of the ticket. (example: \"name@example.com\")" }, "ticketPriority": { "type": "string", "description": "Priority", "enum": [ "urgent", "high", "normal", "low", "no_priority" ] }, "ticketTags": { "type": "string", "description": "Tags : Filter tickets by their tag." }, "ticketExternalId": { "type": "string", "description": "External ID : Filter by tickets by their external ID." }, "sort_by": { "type": "string", "description": "Sort By", "enum": [ "created_at", "updated_at", "priority", "status", "ticket_type" ] }, "sort_order": { "type": "string", "description": "Sort Order", "enum": [ "asc", "desc" ] }, "dueDate": { "type": "object", "description": "Due Date", "properties": { "operator": { "type": "string", "description": "Due Date Operator", "enum": [ "EQUALS", "LESS_THAN_EQUALS", "GREATER_THAN_EQUALS" ] }, "value": { "type": "string", "description": "Due Date Value", "format": "date" } }, "required": [ "operator", "value" ] }, "createdDate": { "type": "object", "description": "Created Date", "properties": { "operator": { "type": "string", "description": "Created Date Operator", "enum": [ "EQUALS", "LESS_THAN_EQUALS", "GREATER_THAN_EQUALS" ] }, "value": { "type": "string", "description": "Created Date Value", "format": "date" } }, "required": [ "operator", "value" ] }, "updatedDate": { "type": "object", "description": "Updated Date", "properties": { "operator": { "type": "string", "description": "Updated Date operator", "enum": [ "EQUALS", "LESS_THAN_EQUALS", "GREATER_THAN_EQUALS" ] }, "value": { "type": "string", "description": "Updated Date value", "format": "date" } }, "required": [ "operator", "value" ] } }, "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_GET_TICKET_BY_ID": { "post": { "summary": "Get Ticket By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_GET_TICKET_BY_ID" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID (example: \"35436\")" } }, "required": [ "ticketId" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_CREATE_USER": { "post": { "summary": "Create User", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_CREATE_USER" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "email": { "type": "string", "description": "Email (example: \"jane@example.com\")" }, "phone": { "type": "string", "description": "Phone" }, "role": { "type": "string", "description": "Role", "enum": [ "admin", "agent", "end-user" ] }, "externalId": { "type": "string", "description": "External ID : A unique identifier from another system." }, "details": { "type": "string", "description": "Details" }, "notes": { "type": "string", "description": "Notes" } }, "required": [ "name" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_UPDATE_USER": { "post": { "summary": "Update User", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_UPDATE_USER" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : The ID of the user to update. (example: \"67890\")" }, "name": { "type": "string", "description": "Name" }, "email": { "type": "string", "description": "Email : On update, a secondary email is added. (example: \"jane@example.com\")" }, "phone": { "type": "string", "description": "Phone" }, "role": { "type": "string", "description": "Role", "enum": [ "admin", "agent", "end-user" ] }, "externalId": { "type": "string", "description": "External ID : A unique identifier from another system." }, "details": { "type": "string", "description": "Details" }, "notes": { "type": "string", "description": "Notes" } }, "required": [ "userId" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_DELETE_USER": { "post": { "summary": "Delete User", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_DELETE_USER" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "The ID of the user to delete" } }, "required": [ "userId" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SEARCH_USERS": { "post": { "summary": "Search Users", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SEARCH_USERS" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name : Filter results by the user’s name." }, "email": { "type": "string", "description": "Email : Filter results by the user’s email. (example: \"jane@example.com\")" }, "role": { "type": "string", "description": "Role", "enum": [ "admin", "agent", "end-user" ] }, "externalId": { "type": "string", "description": "External ID : Filter by users by their external ID." }, "sort_by": { "type": "string", "description": "Sort By", "enum": [ "created_at", "updated_at" ] }, "sort_order": { "type": "string", "description": "Sort Order", "enum": [ "asc", "desc" ] } }, "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_GET_USER_BY_ID": { "post": { "summary": "Get User By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_GET_USER_BY_ID" }, "parameters": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID : The ID of the user to get. (example: \"67890\")" } }, "required": [ "userId" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS": { "post": { "summary": "Get Ticket Fields", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_GET_TICKET_FIELDS" }, "parameters": { "type": "object", "properties": { "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_GET_TICKET_AUDITS": { "post": { "summary": "Get Ticket Audits", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_GET_TICKET_AUDITS" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : Get ticket audits for a specified ticket. If empty, audit records for all non-archived tickets will be retrieved. (example: \"1234\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_GET_TICKET_COMMENTS": { "post": { "summary": "Get Ticket Comments", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_GET_TICKET_COMMENTS" }, "parameters": { "type": "object", "properties": { "ticketId": { "type": "string", "description": "Ticket ID : The Ticket ID to retrieve comments from. (example: \"123456\")" }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "pageCursor": { "type": "string", "description": "Page Cursor" } } } }, "required": [ "ticketId" ], "x-integration": "zendesk" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_CREATE_RECORD_CONTACTS": { "post": { "summary": "Create Record Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_CREATE_RECORD_CONTACTS" }, "parameters": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First Name" }, "last_name": { "type": "string", "description": "Last Name" }, "email": { "type": "string", "description": "Email (example: \"mark@designservices.com\")" }, "website": { "type": "string", "description": "Website (example: \"www.designservices.com\")" }, "title": { "type": "string", "description": "Title : Title of the contact, such as CEO or Vice President. (example: \"CEO\")" }, "description": { "type": "string", "description": "Description (example: \"I know him via Tom\")" }, "contactAddress": { "type": "object", "description": "Address (example: \"{\n \"line1\": \"2726 Smith Street\",\n \"city\": \"Hyannis\",\n \"postal_code\": \"02601\",\n \"state\": \"MA\",\n \"country\": \"US\"\n}\")", "properties": {} }, "contactAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. See the doc (https://developer.zendesk.com/api-reference/sales-crm/resources/contacts)for available fields. (example: \"{\n \"name\": \"Mark Johnson\",\n \"customer_status\": \"none\",\n \"prospect_status\": \"current\",\n \"custom_fields\": {\"known_via\": \"tom\"},\n}\")", "properties": {} } }, "required": [ "last_name" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_CREATE_RECORD_DEALS": { "post": { "summary": "Create Record Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_CREATE_RECORD_DEALS" }, "parameters": { "type": "object", "properties": { "dealName": { "type": "string", "description": "Name : Specify a name for this deal. (example: \"Website Redesign\")" }, "contact_id": { "type": "string", "description": "Contact ID : Specify a contact ID to associate this deal with. (example: \"1\")" }, "dealValue": { "type": "string", "description": "Value : Specify a value of the deal. (example: \"1000.50\")" }, "dealSource": { "type": "string", "description": "Source ID : Specify a source ID to associate this deal with. (example: \"1\")" }, "dealAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. See the doc (https://developer.zendesk.com/api-reference/sales-crm/resources/deals)for available fields. (example: \"{\n \"hot\": true,\n \"currency\": \"USD\",\n}\")", "properties": {} } }, "required": [ "dealName", "contact_id" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_CREATE_RECORD_LEADS": { "post": { "summary": "Create Record Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_CREATE_RECORD_LEADS" }, "parameters": { "type": "object", "properties": { "last_name": { "type": "string", "description": "Last Name" }, "organizationName": { "type": "string", "description": "Organization Name (example: \"Design Services Company\")" }, "first_name": { "type": "string", "description": "First Name" }, "email": { "type": "string", "description": "Email (example: \"mark@designservices.com\")" }, "phone": { "type": "string", "description": "Phone" }, "website": { "type": "string", "description": "Website (example: \"www.designservices.com\")" }, "title": { "type": "string", "description": "Title : Title of the contact, such as CEO or Vice President. (example: \"CEO\")" }, "lead_status": { "type": "string", "description": "Lead Status", "enum": [ "New", "Working", "Unqualified" ] }, "description": { "type": "string", "description": "Description (example: \"I know him via Tom\")" }, "leadAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. See the doc (https://developer.zendesk.com/api-reference/sales-crm/resources/leads)for available fields. (example: \"{\n \"address\": {\n \"line1\": \"2726 Smith Street\",\n \"city\": \"Hyannis\",\n \"postal_code\": \"02601\",\n \"state\": \"MA\",\n \"country\": \"US\"\n },\n \"tags\": [\n \"important\"\n ],\n \"custom_fields\": {\n \"known_via\": \"tom\"\n }\n}\")", "properties": {} } }, "required": [ "last_name" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_CREATE_RECORD_TASKS": { "post": { "summary": "Create Record Tasks", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_CREATE_RECORD_TASKS" }, "parameters": { "type": "object", "properties": { "content": { "type": "string", "description": "Task Content (example: \"Contact Tom\")" }, "due_date": { "type": "string", "description": "Due Date (example: \"2014-09-27\")" }, "owner_id": { "type": "string", "description": "Task Owner" }, "resource_type": { "type": "string", "description": "Resource Type (example: \"lead\")" }, "resource_id": { "type": "string", "description": "Resource ID (example: \"1\")" }, "completed": { "type": "boolean", "description": "Is Completed" }, "remind_at": { "type": "string", "description": "Remind At (example: \"2014-09-29\")" } }, "required": [ "content" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_UPDATE_RECORD_TASKS": { "post": { "summary": "Update Record Tasks", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_UPDATE_RECORD_TASKS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : Specify the record ID to update." }, "content": { "type": "string", "description": "Task Content (example: \"Contact Tom\")" }, "due_date": { "type": "string", "description": "Due Date (example: \"2014-09-27\")" }, "owner_id": { "type": "string", "description": "Task Owner" }, "resource_type": { "type": "string", "description": "Resource Type (example: \"lead\")" }, "resource_id": { "type": "string", "description": "Resource ID (example: \"1\")" }, "completed": { "type": "boolean", "description": "Is Completed" }, "remind_at": { "type": "string", "description": "Remind At (example: \"2014-09-29\")" } }, "required": [ "recordId" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_UPDATE_RECORD_DEALS": { "post": { "summary": "Update Record Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_UPDATE_RECORD_DEALS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : Specify the record ID to update." }, "dealName": { "type": "string", "description": "Name : Specify a name for this deal. (example: \"Website Redesign\")" }, "contact_id": { "type": "string", "description": "Contact ID : Specify a contact ID to associate this deal with. (example: \"1\")" }, "dealValue": { "type": "string", "description": "Value : Specify a value of the deal. (example: \"1000.50\")" }, "dealSource": { "type": "string", "description": "Source ID : Specify a source ID to associate this deal with. (example: \"1\")" }, "dealAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. See the doc (https://developer.zendesk.com/api-reference/sales-crm/resources/deals)for available fields. (example: \"{\n \"hot\": true,\n \"currency\": \"USD\",\n}\")", "properties": {} } }, "required": [ "recordId", "dealName", "contact_id" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_UPDATE_RECORD_LEADS": { "post": { "summary": "Update Record Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_UPDATE_RECORD_LEADS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : Specify the record ID to update." }, "last_name": { "type": "string", "description": "Last Name" }, "organizationName": { "type": "string", "description": "Organization Name (example: \"Design Services Company\")" }, "first_name": { "type": "string", "description": "First Name" }, "email": { "type": "string", "description": "Email (example: \"mark@designservices.com\")" }, "phone": { "type": "string", "description": "Phone" }, "website": { "type": "string", "description": "Website (example: \"www.designservices.com\")" }, "title": { "type": "string", "description": "Title : Title of the contact, such as CEO or Vice President. (example: \"CEO\")" }, "lead_status": { "type": "string", "description": "Lead Status", "enum": [ "New", "Working", "Unqualified" ] }, "description": { "type": "string", "description": "Description (example: \"I know him via Tom\")" }, "leadAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. See the doc (https://developer.zendesk.com/api-reference/sales-crm/resources/leads)for available fields. (example: \"{\n \"address\": {\n \"line1\": \"2726 Smith Street\",\n \"city\": \"Hyannis\",\n \"postal_code\": \"02601\",\n \"state\": \"MA\",\n \"country\": \"US\"\n },\n \"tags\": [\n \"important\"\n ],\n \"custom_fields\": {\n \"known_via\": \"tom\"\n }\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_UPDATE_RECORD_CONTACTS": { "post": { "summary": "Update Record Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_UPDATE_RECORD_CONTACTS" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : Specify the record ID to update." }, "first_name": { "type": "string", "description": "First Name" }, "last_name": { "type": "string", "description": "Last Name" }, "email": { "type": "string", "description": "Email (example: \"mark@designservices.com\")" }, "website": { "type": "string", "description": "Website (example: \"www.designservices.com\")" }, "title": { "type": "string", "description": "Title : Title of the contact, such as CEO or Vice President. (example: \"CEO\")" }, "description": { "type": "string", "description": "Description (example: \"I know him via Tom\")" }, "contactAddress": { "type": "object", "description": "Address (example: \"{\n \"line1\": \"2726 Smith Street\",\n \"city\": \"Hyannis\",\n \"postal_code\": \"02601\",\n \"state\": \"MA\",\n \"country\": \"US\"\n}\")", "properties": {} }, "contactAdditionalFields": { "type": "object", "description": "Additional Fields : Specify any other fields that should be updated in JSON below. See the doc (https://developer.zendesk.com/api-reference/sales-crm/resources/contacts)for available fields. (example: \"{\n \"name\": \"Mark Johnson\",\n \"customer_status\": \"none\",\n \"prospect_status\": \"current\",\n \"custom_fields\": {\"known_via\": \"tom\"},\n}\")", "properties": {} } }, "required": [ "recordId" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_SEARCH_RECORDS_TASKS": { "post": { "summary": "Search Records Tasks", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_SEARCH_RECORDS_TASKS" }, "parameters": { "type": "object", "properties": { "tasksFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "content" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$stringStartsWith", "$numberEquals", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "per_page": { "type": "number", "description": "Maximum number of records to display at a time, defaults to 50" }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of records" } } } }, "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_SEARCH_RECORDS_DEALS": { "post": { "summary": "Search Records Deals", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_SEARCH_RECORDS_DEALS" }, "parameters": { "type": "object", "properties": { "dealsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$stringStartsWith", "$numberEquals", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "per_page": { "type": "number", "description": "Maximum number of records to display at a time, defaults to 50" }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of records" } } } }, "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_SEARCH_RECORDS_LEADS": { "post": { "summary": "Search Records Leads", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_SEARCH_RECORDS_LEADS" }, "parameters": { "type": "object", "properties": { "leadsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "display_name" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$stringStartsWith", "$numberEquals", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "per_page": { "type": "number", "description": "Maximum number of records to display at a time, defaults to 50" }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of records" } } } }, "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_SEARCH_RECORDS_CONTACTS": { "post": { "summary": "Search Records Contacts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_SEARCH_RECORDS_CONTACTS" }, "parameters": { "type": "object", "properties": { "contactsFilterFormula": { "type": "object", "description": "A filter in disjunctive normal form: OR of AND groups of single conditions", "properties": { "operator": { "type": "string", "description": "Top-level operator must be OR (DNF enforced)", "enum": [ "OR" ] }, "conditions": { "type": "array", "description": "Each item is an AND group (a conjunction of single conditions)", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Each group is an AND of single conditions", "enum": [ "AND" ] }, "conditions": { "type": "array", "description": "List of single conditions (AND together)", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "display_name" ] }, "operator": { "type": "string", "enum": [ "$stringExactlyMatches", "$stringContains", "$stringStartsWith", "$numberEquals", "$dateTimeEquals", "$dateTimeBefore", "$dateTimeAfter" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } } }, "required": [ "operator", "conditions" ] } } }, "required": [ "operator", "conditions" ] }, "paginationParameters": { "type": "object", "description": "Pagination Parameters", "properties": { "per_page": { "type": "number", "description": "Maximum number of records to display at a time, defaults to 50" }, "cursor": { "type": "string", "description": "Pagination cursor for the next page of records" } } } }, "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_DELETE_RECORD": { "post": { "summary": "Delete Record", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_DELETE_RECORD" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : Specify the record ID to delete." }, "recordType": { "type": "string", "description": "Specify the record type for this action", "enum": [ "contacts", "deals", "leads", "tasks" ] } }, "required": [ "recordId", "recordType" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_GET_RECORD_BY_ID": { "post": { "summary": "Get Record By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_GET_RECORD_BY_ID" }, "parameters": { "type": "object", "properties": { "recordId": { "type": "string", "description": "Record ID : Specify the record ID to fetch." }, "recordType": { "type": "string", "description": "Specify the record type for this action", "enum": [ "contacts", "deals", "leads", "tasks" ] } }, "required": [ "recordId", "recordType" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZENDESK_SELL_GET_CUSTOM_FIELDS": { "post": { "summary": "Get Custom Fields", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZENDESK_SELL_GET_CUSTOM_FIELDS" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Specify the record type for this action", "enum": [ "lead", "contact", "deal", "prospect_and_customer" ] } }, "required": [ "recordType" ], "x-integration": "zendesksell" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOHO_CRM_CREATE_RECORD_ANY": { "post": { "summary": "Create Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOHO_CRM_CREATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" } }, "required": [ "recordType" ], "x-integration": "zohocrm" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOHO_CRM_UPDATE_RECORD_ANY": { "post": { "summary": "Update Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOHO_CRM_UPDATE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record Id" } }, "required": [ "recordType", "recordId" ], "x-integration": "zohocrm" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOHO_CRM_GET_RECORD_BY_ID_ANY": { "post": { "summary": "Get Record By ID Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOHO_CRM_GET_RECORD_BY_ID_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record Id to be deleted or fetched" } }, "required": [ "recordId", "recordType" ], "x-integration": "zohocrm" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOHO_CRM_SEARCH_RECORDS_ANY": { "post": { "summary": "Search Records Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOHO_CRM_SEARCH_RECORDS_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "filterFormula": { "type": "array", "description": "One or more filter conditions to narrow the records returned. All conditions are combined with AND (every condition must match); OR across conditions is not supported.", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "The field API name to filter on" }, "operator": { "type": "string", "enum": [ "$none", "$stringContains", "$stringDoesNotContain", "$stringExactlyMatches", "$stringDoesNotExactlyMatch", "$stringIsIn", "$stringIsNotIn", "$stringStartsWith", "$stringDoesNotStartWith", "$stringEndsWith", "$stringDoesNotEndWith", "$numberGreaterThan", "$numberLessThan", "$numberEquals", "$numberDoesNotEqual", "$dateTimeAfter", "$dateTimeBefore", "$dateTimeEquals", "$booleanTrue", "$booleanFalse", "$exists", "$doesNotExist" ] }, "value": { "type": "string", "description": "Value to compare against" } }, "required": [ "field", "operator", "value" ] } }, "paginationParameters": { "type": "object", "description": "Pagination parameters for paginated results", "properties": { "offset": { "type": "number", "description": "The offset of the first record to return" }, "limit": { "type": "number", "description": "The number of records to return" } } } }, "required": [ "recordType" ], "x-integration": "zohocrm" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOHO_CRM_DELETE_RECORD_ANY": { "post": { "summary": "Delete Record Any", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOHO_CRM_DELETE_RECORD_ANY" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "recordId": { "type": "string", "description": "Record Id to be deleted or fetched" } }, "required": [ "recordId", "recordType" ], "x-integration": "zohocrm" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOHO_CRM_WRITE_COQL_QUERY": { "post": { "summary": "Write COQL Query", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOHO_CRM_WRITE_COQL_QUERY" }, "parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "COQL Query", "required": [ "query" ] } }, "required": [ "query" ], "x-integration": "zohocrm" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOHO_CRM_DESCRIBE_ACTION_SCHEMA": { "post": { "summary": "Describe Action Schema", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOHO_CRM_DESCRIBE_ACTION_SCHEMA" }, "parameters": { "type": "object", "properties": { "recordType": { "type": "string", "description": "Record Type" }, "operation": { "type": "string", "description": "Operation Type value for example CREATE_RECORD or UPDATE_RECORD" } }, "required": [ "recordType", "operation" ], "x-integration": "zohocrm" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_CREATE_MEETING": { "post": { "summary": "Create Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_CREATE_MEETING" }, "parameters": { "type": "object", "properties": { "topic": { "type": "string", "description": "Topic (example: \"Meeting name\")" }, "startTime": { "type": "string", "description": "Start Time : Meeting start time (ISO 8601 timestamp). (example: \"2020-03-31T12:02:00Z\")" }, "duration": { "type": "string", "description": "Duration : Meeting duration in minutes. (example: \"60\")" }, "timezone": { "type": "string", "description": "Timezone : Timezone for the meeting’s start time. See Zoom’s timezone (https://developers.zoom.us/docs/api/references/abbreviations/#timezones) list for reference. (example: \"America/Los_Angeles\")" }, "agenda": { "type": "string", "description": "Agenda : Meeting description." }, "password": { "type": "string", "description": "Password : Passcode to join the meeting. By default, passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ *] and have a maximum of 10 characters." }, "enableWaitingRoom": { "type": "boolean", "description": "Enable Waiting Room" }, "sendRegistrantConfirmation": { "type": "boolean", "description": "Send Registrants Confirmation Email" } }, "required": [ "topic", "startTime", "duration", "timezone" ], "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_UPDATE_MEETING": { "post": { "summary": "Update Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_UPDATE_MEETING" }, "parameters": { "type": "object", "properties": { "meetingId": { "type": "string", "description": "Meeting ID : The ID of the Meeting to update." }, "topic": { "type": "string", "description": "Topic (example: \"Meeting name\")" }, "startTime": { "type": "string", "description": "Start Time : Meeting start time (ISO 8601 timestamp). (example: \"2020-03-31T12:02:00Z\")" }, "duration": { "type": "string", "description": "Duration : Meeting duration in minutes. (example: \"60\")" }, "timezone": { "type": "string", "description": "Timezone : Timezone for the meeting’s start time. See Zoom’s timezone (https://developers.zoom.us/docs/api/references/abbreviations/#timezones) list for reference. (example: \"America/Los_Angeles\")" }, "agenda": { "type": "string", "description": "Agenda : Meeting description." } }, "required": [ "meetingId" ], "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_GET_MEETING": { "post": { "summary": "Get Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_GET_MEETING" }, "parameters": { "type": "object", "properties": {}, "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_GET_MEETING_BY_ID": { "post": { "summary": "Get Meeting By ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_GET_MEETING_BY_ID" }, "parameters": { "type": "object", "properties": { "meetingId": { "type": "string", "description": "Meeting ID" } }, "required": [ "meetingId" ], "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_DELETE_MEETING": { "post": { "summary": "Delete Meeting", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_DELETE_MEETING" }, "parameters": { "type": "object", "properties": { "meetingId": { "type": "string", "description": "Meeting ID : The ID of the Meeting to delete." } }, "required": [ "meetingId" ], "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_ADD_MEETING_REGISTRANT": { "post": { "summary": "Add Meeting Registrant", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_ADD_MEETING_REGISTRANT" }, "parameters": { "type": "object", "properties": { "meetingId": { "type": "string", "description": "Meeting ID : The ID of the Meeting to add registrants to." }, "email": { "type": "string", "description": "Email (example: \"name@example.com\")" }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last Name" }, "address": { "type": "string", "description": "Address" }, "city": { "type": "string", "description": "City" }, "country": { "type": "string", "description": "Country" }, "zip": { "type": "string", "description": "Zip" }, "state": { "type": "string", "description": "State" }, "phone": { "type": "string", "description": "Phone" }, "organization": { "type": "string", "description": "Organization" }, "jobTitle": { "type": "string", "description": "Job Title" } }, "required": [ "meetingId", "email", "firstName" ], "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_GET_MEETING_REGISTRANT": { "post": { "summary": "Get Meeting Registrant", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_GET_MEETING_REGISTRANT" }, "parameters": { "type": "object", "properties": { "meetingId": { "type": "string", "description": "Meeting ID : The ID of the Meeting whose Registrants to get." }, "registrantStatus": { "type": "string", "description": "Registrant Status (example: \"choose a user to DM or type {{ to insert a Slack user ID\")", "enum": [ "approved", "pending", "denied" ] } }, "required": [ "meetingId", "registrantStatus" ], "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_DELETE_MEETING_REGISTRANT": { "post": { "summary": "Delete Meeting Registrant", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_DELETE_MEETING_REGISTRANT" }, "parameters": { "type": "object", "properties": { "meetingId": { "type": "string", "description": "Meeting ID : The ID of the Meeting to delete a Registrant from." }, "registrantId": { "type": "string", "description": "Registrant ID : The ID of the Registrant to delete." } }, "required": [ "meetingId" ], "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_GET_RECORDING_BY_MEETING_ID": { "post": { "summary": "Get Recording By Meeting ID", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_GET_RECORDING_BY_MEETING_ID" }, "parameters": { "type": "object", "properties": { "meetingId": { "type": "string", "description": "Meeting ID" } }, "required": [ "meetingId" ], "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/projects/{project_id}/tools/#ZOOM_SEARCH_RECORDING": { "post": { "summary": "Search Recording", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string", "default": "ZOOM_SEARCH_RECORDING" }, "parameters": { "type": "object", "properties": { "searchFrom": { "type": "string", "description": "From Date : Start date in 'yyyy-mm-dd' UTC format (example: \"2022-10-22\")" }, "searchUpto": { "type": "string", "description": "To Date : End date in 'yyyy-mm-dd' UTC format (example: \"2022-11-21\")" }, "meetingId": { "type": "string", "description": "Meeting ID (example: \"6840331990\")" }, "trash": { "type": "boolean", "description": "Trash : Use in combination with Trash Type to indicate type of Cloud Recording you need to retrieve" }, "trashType": { "type": "string", "description": "Trash Type : The type of Cloud recording that you would like to retrieve from the trash", "enum": [ "meeting_recordings", "recording_file" ] } }, "x-integration": "zoom" } }, "required": [ "tool", "parameters" ] } } } }, "responses": { "200": { "description": "Success" } } } } } }