{ "swagger": "2.0", "host": "api.unified.to", "basePath": "/", "schemes": [ "http" ], "info": { "title": "Unified.to API", "version": "1.0", "description": "One API to Rule Them All", "contact": { "email": "hello@unified.to", "url": "https://unified.to/contact" }, "termsOfService": "https://unified.to/tos" }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "securityDefinitions": { "jwt": { "type": "apiKey", "name": "authorization", "in": "header" } }, "tags": [ { "name": "unifiedapi", "description": "Unified.to API" } ], "paths": { "/assessment/{connection_id}/package": { "post": { "summary": "Create an assessment package", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AssessmentPackage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "package" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AssessmentPackage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAssessmentPackage" }, "get": { "summary": "List assessment packages", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "package" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AssessmentPackage" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAssessmentPackages" } }, "/assessment/{connection_id}/package/{id}": { "get": { "summary": "Get an assessment package", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Package", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "package" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AssessmentPackage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAssessmentPackage" }, "put": { "summary": "Update an assessment package", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Package", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AssessmentPackage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "package" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AssessmentPackage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAssessmentPackage" }, "patch": { "summary": "Update an assessment package", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Package", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AssessmentPackage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "package" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AssessmentPackage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAssessmentPackage" }, "delete": { "summary": "Delete an assessment package", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Package", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "package" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAssessmentPackage" } }, "/assessment/{connection_id}/order": { "post": { "summary": "Create an order", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "workspace_id", "connection_id", "webhook_id", "package_id", "parameters", "target_url", "status", "reference", "application_id", "job_id", "company_id", "candidate_id", "employee_id", "profile_name", "profile_first_name", "profile_last_name", "profile_resume_url", "profile_ip_address", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "profile_social_media_urls", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_max_score", "response_url", "response_redirect_url", "response_download_urls", "response_details", "response_source", "response_attributes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AssessmentOrder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "order" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AssessmentOrder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAssessmentOrder" } }, "/assessment/{connection_id}/order/{id}": { "get": { "summary": "Retrieve an order", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "workspace_id", "connection_id", "webhook_id", "package_id", "parameters", "target_url", "status", "reference", "application_id", "job_id", "company_id", "candidate_id", "employee_id", "profile_name", "profile_first_name", "profile_last_name", "profile_resume_url", "profile_ip_address", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "profile_social_media_urls", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_max_score", "response_url", "response_redirect_url", "response_download_urls", "response_details", "response_source", "response_attributes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Order", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "order" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AssessmentOrder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAssessmentOrder" }, "put": { "summary": "Update an order", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "workspace_id", "connection_id", "webhook_id", "package_id", "parameters", "target_url", "status", "reference", "application_id", "job_id", "company_id", "candidate_id", "employee_id", "profile_name", "profile_first_name", "profile_last_name", "profile_resume_url", "profile_ip_address", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "profile_social_media_urls", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_max_score", "response_url", "response_redirect_url", "response_download_urls", "response_details", "response_source", "response_attributes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Order", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AssessmentOrder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "order" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AssessmentOrder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAssessmentOrder" }, "patch": { "summary": "Update an order", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "workspace_id", "connection_id", "webhook_id", "package_id", "parameters", "target_url", "status", "reference", "application_id", "job_id", "company_id", "candidate_id", "employee_id", "profile_name", "profile_first_name", "profile_last_name", "profile_resume_url", "profile_ip_address", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "profile_social_media_urls", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_max_score", "response_url", "response_redirect_url", "response_download_urls", "response_details", "response_source", "response_attributes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Order", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AssessmentOrder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "assessment", "order" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AssessmentOrder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAssessmentOrder" } }, "/messaging/{connection_id}/channel": { "post": { "summary": "Create a channel", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "has_subchannels", "members", "is_active", "is_private", "web_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MessagingChannel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "channel" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingChannel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createMessagingChannel" }, "get": { "summary": "List all channels", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "PUBLIC", "PRIVATE" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "has_subchannels", "members", "is_active", "is_private", "web_url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "channel" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/MessagingChannel" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listMessagingChannels" } }, "/messaging/{connection_id}/channel/{id}": { "get": { "summary": "Retrieve a channel", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "has_subchannels", "members", "is_active", "is_private", "web_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Channel", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "channel" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingChannel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getMessagingChannel" }, "put": { "summary": "Update a channel", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "has_subchannels", "members", "is_active", "is_private", "web_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Channel", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MessagingChannel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "channel" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingChannel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateMessagingChannel" }, "patch": { "summary": "Update a channel", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "has_subchannels", "members", "is_active", "is_private", "web_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Channel", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MessagingChannel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "channel" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingChannel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathMessagingChannel" }, "delete": { "summary": "Remove a channel", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Channel", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "channel" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeMessagingChannel" } }, "/messaging/{connection_id}/message": { "post": { "summary": "Create a message", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "channels", "parent_id", "message_thread_identifier", "author_member", "destination_members", "hidden_members", "mentioned_members", "reactions", "subject", "message", "message_html", "message_markdown", "attachments", "web_url", "reference", "has_children", "is_unread", "buttons", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MessagingMessage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "message" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingMessage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createMessagingMessage" }, "get": { "summary": "List all messages", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "channel_id", "in": "query", "required": false, "description": "The channel ID to filter by. You can also use these aliases; INBOX, SENT or DRAFT (reference to MessagingChannel)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "boolean", "name": "expand", "in": "query", "required": false, "description": "Whether to flatten grouped or recurring items into individual entries." }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "READ", "UNREAD" ] }, { "type": "string", "name": "user_mentioned_id", "in": "query", "required": false, "description": "The user/employee ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "channels", "parent_id", "message_thread_identifier", "author_member", "destination_members", "hidden_members", "mentioned_members", "reactions", "subject", "message", "message_html", "message_markdown", "attachments", "web_url", "reference", "has_children", "is_unread", "buttons", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "message" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/MessagingMessage" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listMessagingMessages" } }, "/messaging/{connection_id}/message/{id}": { "get": { "summary": "Retrieve a message", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "channels", "parent_id", "message_thread_identifier", "author_member", "destination_members", "hidden_members", "mentioned_members", "reactions", "subject", "message", "message_html", "message_markdown", "attachments", "web_url", "reference", "has_children", "is_unread", "buttons", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Message", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "message" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingMessage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getMessagingMessage" }, "put": { "summary": "Update a message", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "channels", "parent_id", "message_thread_identifier", "author_member", "destination_members", "hidden_members", "mentioned_members", "reactions", "subject", "message", "message_html", "message_markdown", "attachments", "web_url", "reference", "has_children", "is_unread", "buttons", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Message", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MessagingMessage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "message" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingMessage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateMessagingMessage" }, "patch": { "summary": "Update a message", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "channels", "parent_id", "message_thread_identifier", "author_member", "destination_members", "hidden_members", "mentioned_members", "reactions", "subject", "message", "message_html", "message_markdown", "attachments", "web_url", "reference", "has_children", "is_unread", "buttons", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Message", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MessagingMessage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "message" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingMessage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathMessagingMessage" }, "delete": { "summary": "Remove a message", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Message", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "message" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeMessagingMessage" } }, "/messaging/{connection_id}/event/{id}": { "put": { "summary": "Update an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "type", "channel", "message", "button", "user", "metadata", "raw", "is_replacing_original" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MessagingEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateMessagingEvent" }, "patch": { "summary": "Update an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "type", "channel", "message", "button", "user", "metadata", "raw", "is_replacing_original" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MessagingEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messaging", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MessagingEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathMessagingEvent" } }, "/crm/{connection_id}/deal": { "post": { "summary": "Create a deal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "amount", "currency", "closed_at", "closing_at", "stages", "pipelines", "source", "probability", "tags", "lost_reason", "won_reason", "user_id", "contact_ids", "company_ids", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmDeal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "deal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmDeal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCrmDeal" }, "get": { "summary": "List all deals", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to CrmCompany)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to CrmContact)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "pipeline_id", "in": "query", "required": false, "description": "The pipeline ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "amount", "currency", "closed_at", "closing_at", "stages", "pipelines", "source", "probability", "tags", "lost_reason", "won_reason", "user_id", "contact_ids", "company_ids", "description", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "deal" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CrmDeal" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCrmDeals" } }, "/crm/{connection_id}/deal/{id}": { "get": { "summary": "Retrieve a deal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "amount", "currency", "closed_at", "closing_at", "stages", "pipelines", "source", "probability", "tags", "lost_reason", "won_reason", "user_id", "contact_ids", "company_ids", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "deal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmDeal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCrmDeal" }, "put": { "summary": "Update a deal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "amount", "currency", "closed_at", "closing_at", "stages", "pipelines", "source", "probability", "tags", "lost_reason", "won_reason", "user_id", "contact_ids", "company_ids", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmDeal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "deal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmDeal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCrmDeal" }, "patch": { "summary": "Update a deal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "amount", "currency", "closed_at", "closing_at", "stages", "pipelines", "source", "probability", "tags", "lost_reason", "won_reason", "user_id", "contact_ids", "company_ids", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmDeal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "deal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmDeal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCrmDeal" }, "delete": { "summary": "Remove a deal", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "deal" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCrmDeal" } }, "/crm/{connection_id}/contact": { "post": { "summary": "Create a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "deal_ids", "company_ids", "address", "user_id", "link_urls", "metadata", "department", "image_url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCrmContact" }, "get": { "summary": "List all contacts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to CrmCompany)" }, { "type": "string", "name": "deal_id", "in": "query", "required": false, "description": "The deal ID to filter by (reference to CrmDeal)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "deal_ids", "company_ids", "address", "user_id", "link_urls", "metadata", "department", "image_url", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "contact" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CrmContact" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCrmContacts" } }, "/crm/{connection_id}/contact/{id}": { "get": { "summary": "Retrieve a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "deal_ids", "company_ids", "address", "user_id", "link_urls", "metadata", "department", "image_url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCrmContact" }, "put": { "summary": "Update a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "deal_ids", "company_ids", "address", "user_id", "link_urls", "metadata", "department", "image_url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCrmContact" }, "patch": { "summary": "Update a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "deal_ids", "company_ids", "address", "user_id", "link_urls", "metadata", "department", "image_url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCrmContact" }, "delete": { "summary": "Remove a contact", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "contact" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCrmContact" } }, "/crm/{connection_id}/company": { "post": { "summary": "Create a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "deal_ids", "contact_ids", "emails", "telephones", "websites", "address", "is_active", "tags", "description", "industry", "link_urls", "employees", "timezone", "user_id", "metadata", "domains", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCrmCompany" }, "get": { "summary": "List all companies", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "deal_id", "in": "query", "required": false, "description": "The deal ID to filter by (reference to CrmDeal)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to CrmContact)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "deal_ids", "contact_ids", "emails", "telephones", "websites", "address", "is_active", "tags", "description", "industry", "link_urls", "employees", "timezone", "user_id", "metadata", "domains", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "company" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CrmCompany" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCrmCompanies" } }, "/crm/{connection_id}/company/{id}": { "get": { "summary": "Retrieve a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "deal_ids", "contact_ids", "emails", "telephones", "websites", "address", "is_active", "tags", "description", "industry", "link_urls", "employees", "timezone", "user_id", "metadata", "domains", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCrmCompany" }, "put": { "summary": "Update a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "deal_ids", "contact_ids", "emails", "telephones", "websites", "address", "is_active", "tags", "description", "industry", "link_urls", "employees", "timezone", "user_id", "metadata", "domains", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCrmCompany" }, "patch": { "summary": "Update a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "deal_ids", "contact_ids", "emails", "telephones", "websites", "address", "is_active", "tags", "description", "industry", "link_urls", "employees", "timezone", "user_id", "metadata", "domains", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCrmCompany" }, "delete": { "summary": "Remove a company", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "company" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCrmCompany" } }, "/crm/{connection_id}/event": { "post": { "summary": "Create an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "note", "meeting", "email", "call", "task", "marketing_email", "form", "page_view", "deal_ids", "company_ids", "contact_ids", "lead_ids", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCrmEvent" }, "get": { "summary": "List all events", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "deal_id", "in": "query", "required": false, "description": "The deal ID to filter by (reference to CrmDeal)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to CrmContact)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to CrmCompany)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "NOTE", "EMAIL", "TASK", "MEETING", "CALL", "MARKETING_EMAIL", "FORM", "PAGE_VIEW" ] }, { "type": "string", "name": "lead_id", "in": "query", "required": false, "description": "The CRM lead ID to filter by (reference to CrmLead)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "note", "meeting", "email", "call", "task", "marketing_email", "form", "page_view", "deal_ids", "company_ids", "contact_ids", "lead_ids", "user_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "event" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CrmEvent" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCrmEvents" } }, "/crm/{connection_id}/event/{id}": { "get": { "summary": "Retrieve an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "note", "meeting", "email", "call", "task", "marketing_email", "form", "page_view", "deal_ids", "company_ids", "contact_ids", "lead_ids", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCrmEvent" }, "put": { "summary": "Update an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "note", "meeting", "email", "call", "task", "marketing_email", "form", "page_view", "deal_ids", "company_ids", "contact_ids", "lead_ids", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCrmEvent" }, "patch": { "summary": "Update an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "note", "meeting", "email", "call", "task", "marketing_email", "form", "page_view", "deal_ids", "company_ids", "contact_ids", "lead_ids", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCrmEvent" }, "delete": { "summary": "Remove an event", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "event" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCrmEvent" } }, "/crm/{connection_id}/lead": { "post": { "summary": "Create a lead", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "user_id", "creator_user_id", "contact_id", "company_id", "company_name", "is_active", "address", "emails", "telephones", "source", "status", "title", "link_urls", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmLead" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "lead" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmLead" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCrmLead" }, "get": { "summary": "List all leads", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to CrmCompany)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to CrmContact)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "user_id", "creator_user_id", "contact_id", "company_id", "company_name", "is_active", "address", "emails", "telephones", "source", "status", "title", "link_urls", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "lead" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CrmLead" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCrmLeads" } }, "/crm/{connection_id}/lead/{id}": { "get": { "summary": "Retrieve a lead", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "user_id", "creator_user_id", "contact_id", "company_id", "company_name", "is_active", "address", "emails", "telephones", "source", "status", "title", "link_urls", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Lead", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "lead" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmLead" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCrmLead" }, "put": { "summary": "Update a lead", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "user_id", "creator_user_id", "contact_id", "company_id", "company_name", "is_active", "address", "emails", "telephones", "source", "status", "title", "link_urls", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Lead", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmLead" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "lead" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmLead" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCrmLead" }, "patch": { "summary": "Update a lead", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "user_id", "creator_user_id", "contact_id", "company_id", "company_name", "is_active", "address", "emails", "telephones", "source", "status", "title", "link_urls", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Lead", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmLead" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "lead" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmLead" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCrmLead" }, "delete": { "summary": "Remove a lead", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Lead", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "lead" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCrmLead" } }, "/crm/{connection_id}/taxonomy": { "get": { "summary": "List all taxonomies", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "INDUSTRY" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "name", "label", "type", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "taxonomy" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CrmTaxonomy" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCrmTaxonomies" } }, "/crm/{connection_id}/pipeline": { "post": { "summary": "Create a pipeline", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "is_active", "deal_probability", "display_order", "stages", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmPipeline" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "pipeline" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmPipeline" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCrmPipeline" }, "get": { "summary": "List all pipelines", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "is_active", "deal_probability", "display_order", "stages", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "pipeline" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CrmPipeline" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCrmPipelines" } }, "/crm/{connection_id}/pipeline/{id}": { "get": { "summary": "Retrieve a pipeline", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "is_active", "deal_probability", "display_order", "stages", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Pipeline", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "pipeline" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmPipeline" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCrmPipeline" }, "put": { "summary": "Update a pipeline", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "is_active", "deal_probability", "display_order", "stages", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Pipeline", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmPipeline" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "pipeline" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmPipeline" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCrmPipeline" }, "patch": { "summary": "Update a pipeline", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "is_active", "deal_probability", "display_order", "stages", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Pipeline", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CrmPipeline" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "pipeline" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CrmPipeline" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCrmPipeline" }, "delete": { "summary": "Remove a pipeline", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Pipeline", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "crm", "pipeline" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCrmPipeline" } }, "/martech/{connection_id}/list": { "post": { "summary": "Create a list", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "start_at", "end_at", "user_id", "is_active", "address", "subject", "sender_name", "sender_email", "language", "sender_company", "sender_phone", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingList" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "list" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingList" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createMartechList" }, "get": { "summary": "List all lists", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "start_at", "end_at", "user_id", "is_active", "address", "subject", "sender_name", "sender_email", "language", "sender_company", "sender_phone", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "list" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/MarketingList" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listMartechLists" } }, "/martech/{connection_id}/list/{id}": { "get": { "summary": "Retrieve a list", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "start_at", "end_at", "user_id", "is_active", "address", "subject", "sender_name", "sender_email", "language", "sender_company", "sender_phone", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the List", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "list" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingList" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getMartechList" }, "put": { "summary": "Update a list", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "start_at", "end_at", "user_id", "is_active", "address", "subject", "sender_name", "sender_email", "language", "sender_company", "sender_phone", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the List", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingList" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "list" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingList" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateMartechList" }, "patch": { "summary": "Update a list", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "start_at", "end_at", "user_id", "is_active", "address", "subject", "sender_name", "sender_email", "language", "sender_company", "sender_phone", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the List", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingList" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "list" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingList" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathMartechList" }, "delete": { "summary": "Remove a list", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the List", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "list" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeMartechList" } }, "/martech/{connection_id}/member": { "post": { "summary": "Create a member", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "company", "emails", "list_ids", "tags", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingMember" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "member" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingMember" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createMartechMember" }, "get": { "summary": "List all members", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "list_id", "in": "query", "required": false, "description": "The list ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "company", "emails", "list_ids", "tags", "status", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "member" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/MarketingMember" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listMartechMembers" } }, "/martech/{connection_id}/member/{id}": { "get": { "summary": "Retrieve a member", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "company", "emails", "list_ids", "tags", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Member", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "member" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingMember" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getMartechMember" }, "put": { "summary": "Update a member", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "company", "emails", "list_ids", "tags", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Member", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingMember" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "member" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingMember" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateMartechMember" }, "patch": { "summary": "Update a member", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "company", "emails", "list_ids", "tags", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Member", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingMember" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "member" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingMember" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathMartechMember" }, "delete": { "summary": "Remove a member", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Member", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "member" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeMartechMember" } }, "/martech/{connection_id}/campaign": { "post": { "summary": "Create a campaign", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "list_ids", "subject_line", "preview_text", "from_name", "from_email", "reply_to_email", "send_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingCampaign" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "campaign" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingCampaign" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createMartechCampaign" }, "get": { "summary": "List all campaigns", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "list_id", "in": "query", "required": false, "description": "The list ID to filter by" }, { "type": "string", "name": "member_id", "in": "query", "required": false, "description": "The member ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "list_ids", "subject_line", "preview_text", "from_name", "from_email", "reply_to_email", "send_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "campaign" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/MarketingCampaign" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listMartechCampaigns" } }, "/martech/{connection_id}/campaign/{id}": { "get": { "summary": "Retrieve a campaign", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "list_ids", "subject_line", "preview_text", "from_name", "from_email", "reply_to_email", "send_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Campaign", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "campaign" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingCampaign" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getMartechCampaign" }, "put": { "summary": "Update a campaign", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "list_ids", "subject_line", "preview_text", "from_name", "from_email", "reply_to_email", "send_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Campaign", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingCampaign" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "campaign" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingCampaign" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateMartechCampaign" }, "patch": { "summary": "Update a campaign", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "list_ids", "subject_line", "preview_text", "from_name", "from_email", "reply_to_email", "send_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Campaign", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MarketingCampaign" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "campaign" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MarketingCampaign" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathMartechCampaign" }, "delete": { "summary": "Remove a campaign", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Campaign", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "campaign" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeMartechCampaign" } }, "/martech/{connection_id}/report": { "get": { "summary": "List all reports", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "campaign_id", "in": "query", "required": false, "description": "The campaign ID to filter by" }, { "type": "string", "name": "list_id", "in": "query", "required": false, "description": "The list ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "start_at", "end_at", "campaign_id", "list_id", "emails_sent", "abuse_reports", "unsubscribed", "sent_at", "hard_bounces", "soft_bounces", "syntax_errors", "forwards_count", "forwards_opens", "opens_total", "unique_opens", "open_rate", "last_open_at", "clicks_total", "unique_clicks", "unique_subscriber_clicks", "click_rate", "last_click_at", "links", "human_opens_total", "human_unique_opens", "human_open_rate", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "martech", "report" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/MarketingReport" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listMartechReports" } }, "/ticketing/{connection_id}/ticket": { "post": { "summary": "Create a ticket", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "subject", "description", "status", "closed_at", "priority", "category_id", "source", "source_ref", "tags", "user_id", "url", "attachment_ids", "due_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingTicket" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "ticket" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingTicket" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createTicketingTicket" }, "get": { "summary": "List all tickets", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "customer_id", "in": "query", "required": false, "description": "The customer ID to filter by" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "subject", "description", "status", "closed_at", "priority", "category_id", "source", "source_ref", "tags", "user_id", "url", "attachment_ids", "due_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "ticket" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TicketingTicket" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listTicketingTickets" } }, "/ticketing/{connection_id}/ticket/{id}": { "get": { "summary": "Retrieve a ticket", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "subject", "description", "status", "closed_at", "priority", "category_id", "source", "source_ref", "tags", "user_id", "url", "attachment_ids", "due_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Ticket", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "ticket" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingTicket" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getTicketingTicket" }, "put": { "summary": "Update a ticket", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "subject", "description", "status", "closed_at", "priority", "category_id", "source", "source_ref", "tags", "user_id", "url", "attachment_ids", "due_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Ticket", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingTicket" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "ticket" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingTicket" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateTicketingTicket" }, "patch": { "summary": "Update a ticket", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "subject", "description", "status", "closed_at", "priority", "category_id", "source", "source_ref", "tags", "user_id", "url", "attachment_ids", "due_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Ticket", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingTicket" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "ticket" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingTicket" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathTicketingTicket" }, "delete": { "summary": "Remove a ticket", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Ticket", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "ticket" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeTicketingTicket" } }, "/ticketing/{connection_id}/customer": { "post": { "summary": "Create a customer", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "emails", "telephones", "tags", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingCustomer" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "customer" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingCustomer" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createTicketingCustomer" }, "get": { "summary": "List all customers", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "emails", "telephones", "tags", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "customer" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TicketingCustomer" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listTicketingCustomers" } }, "/ticketing/{connection_id}/customer/{id}": { "get": { "summary": "Retrieve a customer", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "emails", "telephones", "tags", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Customer", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "customer" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingCustomer" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getTicketingCustomer" }, "put": { "summary": "Update a customer", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "emails", "telephones", "tags", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Customer", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingCustomer" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "customer" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingCustomer" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateTicketingCustomer" }, "patch": { "summary": "Update a customer", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "emails", "telephones", "tags", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Customer", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingCustomer" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "customer" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingCustomer" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathTicketingCustomer" }, "delete": { "summary": "Remove a customer", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Customer", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "customer" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeTicketingCustomer" } }, "/ticketing/{connection_id}/note": { "post": { "summary": "Create a note", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "description", "ticket_id", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingNote" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "note" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingNote" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createTicketingNote" }, "get": { "summary": "List all notes", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "ticket_id", "in": "query", "required": false, "description": "The ticket ID to filter by" }, { "type": "string", "name": "customer_id", "in": "query", "required": false, "description": "The customer ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "description", "ticket_id", "user_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "note" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TicketingNote" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listTicketingNotes" } }, "/ticketing/{connection_id}/note/{id}": { "get": { "summary": "Retrieve a note", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "description", "ticket_id", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Note", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "note" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingNote" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getTicketingNote" }, "put": { "summary": "Update a note", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "description", "ticket_id", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Note", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingNote" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "note" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingNote" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateTicketingNote" }, "patch": { "summary": "Update a note", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "customer_id", "description", "ticket_id", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Note", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingNote" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "note" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingNote" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathTicketingNote" }, "delete": { "summary": "Remove a note", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Note", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "note" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeTicketingNote" } }, "/ticketing/{connection_id}/category": { "post": { "summary": "Create a category", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingCategory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "category" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingCategory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createTicketingCategory" }, "get": { "summary": "List all categories", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "category" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TicketingCategory" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listTicketingCategories" } }, "/ticketing/{connection_id}/category/{id}": { "get": { "summary": "Retrieve a category", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Category", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "category" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingCategory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getTicketingCategory" }, "put": { "summary": "Update a category", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Category", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingCategory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "category" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingCategory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateTicketingCategory" }, "patch": { "summary": "Update a category", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Category", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TicketingCategory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "category" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TicketingCategory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathTicketingCategory" }, "delete": { "summary": "Remove a category", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Category", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ticketing", "category" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeTicketingCategory" } }, "/enrich/{connection_id}/person": { "get": { "summary": "Retrieve enrichment information for a person", "parameters": [ { "type": "string", "name": "email", "in": "query", "required": false, "description": "The email of the person to search" }, { "type": "string", "name": "twitter", "in": "query", "required": false, "description": "The twitter handle of the person to search" }, { "type": "string", "name": "name", "in": "query", "required": false, "description": "The name of the person to search" }, { "type": "string", "name": "linkedin_url", "in": "query", "required": false, "description": "The LinkedIn URL of the person to search" }, { "type": "string", "name": "company_name", "in": "query", "required": false, "description": "The name of the company the person is associated with. Not valid by itself." }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrich", "person" ], "responses": { "200": { "schema": { "$ref": "#/definitions/EnrichPerson" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listEnrichPeople" } }, "/enrich/{connection_id}/company": { "get": { "summary": "Retrieve enrichment information for a company", "parameters": [ { "type": "string", "name": "domain", "in": "query", "required": false, "description": "The domain of the company to search" }, { "type": "string", "name": "name", "in": "query", "required": false, "description": "The name of the company to search" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "enrich", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/EnrichCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listEnrichCompanies" } }, "/uc/{connection_id}/call/{id}": { "get": { "summary": "Retrieve a call", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "contact_id", "telephone", "start_at", "end_at", "user_id", "contacts", "is_private", "user_name", "user_phone", "type", "metadata", "raw", "conversation_identifier" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Call", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "call" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcCall" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUcCall" } }, "/uc/{connection_id}/call": { "get": { "summary": "List all calls", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to UcContact)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "contact_id", "telephone", "start_at", "end_at", "user_id", "contacts", "is_private", "user_name", "user_phone", "type", "metadata", "raw", "conversation_identifier" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "call" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/UcCall" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUcCalls" } }, "/uc/{connection_id}/contact": { "post": { "summary": "Create a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createUcContact" }, "get": { "summary": "List all contacts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "contact" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/UcContact" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUcContacts" } }, "/uc/{connection_id}/contact/{id}": { "get": { "summary": "Retrieve a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUcContact" }, "put": { "summary": "Update a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateUcContact" }, "patch": { "summary": "Update a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "company", "emails", "telephones", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathUcContact" }, "delete": { "summary": "Remove a contact", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "contact" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeUcContact" } }, "/uc/{connection_id}/comment": { "post": { "summary": "Create a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content", "user_id", "call_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createUcComment" }, "get": { "summary": "List all comments", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "call_id", "in": "query", "required": false, "description": "The call ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content", "user_id", "call_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "comment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/UcComment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUcComments" } }, "/uc/{connection_id}/comment/{id}": { "get": { "summary": "Retrieve a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content", "user_id", "call_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUcComment" }, "put": { "summary": "Update a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content", "user_id", "call_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateUcComment" }, "patch": { "summary": "Update a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content", "user_id", "call_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathUcComment" }, "delete": { "summary": "Remove a comment", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "comment" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeUcComment" } }, "/uc/{connection_id}/recording": { "post": { "summary": "Create a recording", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "expires_at", "call_id", "web_url", "contacts", "user_id", "media", "user_name", "user_phone", "type", "conversation_identifier", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcRecording" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "recording" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcRecording" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createUcRecording" }, "get": { "summary": "List all recordings", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "call_id", "in": "query", "required": false, "description": "The call ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to UcContact)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "expires_at", "call_id", "web_url", "contacts", "user_id", "media", "user_name", "user_phone", "type", "conversation_identifier", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "recording" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/UcRecording" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUcRecordings" } }, "/uc/{connection_id}/recording/{id}": { "get": { "summary": "Retrieve a recording", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "expires_at", "call_id", "web_url", "contacts", "user_id", "media", "user_name", "user_phone", "type", "conversation_identifier", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Recording", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "recording" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcRecording" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUcRecording" }, "put": { "summary": "Update a recording", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "expires_at", "call_id", "web_url", "contacts", "user_id", "media", "user_name", "user_phone", "type", "conversation_identifier", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Recording", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcRecording" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "recording" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcRecording" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateUcRecording" }, "patch": { "summary": "Update a recording", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "expires_at", "call_id", "web_url", "contacts", "user_id", "media", "user_name", "user_phone", "type", "conversation_identifier", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Recording", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UcRecording" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "recording" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcRecording" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathUcRecording" }, "delete": { "summary": "Remove a recording", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Recording", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "recording" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeUcRecording" } }, "/uc/{connection_id}/scorecard/{id}": { "get": { "summary": "Retrieve a scorecard", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "call_id", "scorecardtemplate_id", "name", "user_id", "reviewer_user_id", "reviewed_at", "score", "questions", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Scorecard", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "scorecard" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcScorecard" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUcScorecard" } }, "/uc/{connection_id}/scorecard": { "get": { "summary": "List all scorecards", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "call_id", "in": "query", "required": false, "description": "The call ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "call_id", "scorecardtemplate_id", "name", "user_id", "reviewer_user_id", "reviewed_at", "score", "questions", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "scorecard" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/UcScorecard" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUcScorecards" } }, "/uc/{connection_id}/scorecardtemplate/{id}": { "get": { "summary": "Retrieve a scorecardtemplate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "questions", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Scorecardtemplate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "scorecardtemplate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/UcScorecardtemplate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUcScorecardtemplate" } }, "/uc/{connection_id}/scorecardtemplate": { "get": { "summary": "List all scorecardtemplates", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "questions", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "uc", "scorecardtemplate" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/UcScorecardtemplate" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUcScorecardtemplates" } }, "/ats/{connection_id}/activity": { "post": { "summary": "Create an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "application_id", "job_id", "interview_id", "document_ids", "title", "description", "is_private", "user_ids", "type", "from", "to", "cc", "bcc", "sub_type", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsActivity" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAtsActivity" }, "get": { "summary": "List all activities", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "application_id", "in": "query", "required": false, "description": "The application ID to filter by" }, { "type": "string", "name": "candidate_id", "in": "query", "required": false, "description": "The candidate ID to filter by" }, { "type": "string", "name": "job_id", "in": "query", "required": false, "description": "The job ID to filter by" }, { "type": "string", "name": "document_id", "in": "query", "required": false, "description": "The document ID to filter by" }, { "type": "string", "name": "interview_id", "in": "query", "required": false, "description": "The interview ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "The type to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "application_id", "job_id", "interview_id", "document_ids", "title", "description", "is_private", "user_ids", "type", "from", "to", "cc", "bcc", "sub_type", "company_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "activity" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsActivity" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsActivities" } }, "/ats/{connection_id}/activity/{id}": { "get": { "summary": "Retrieve an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "application_id", "job_id", "interview_id", "document_ids", "title", "description", "is_private", "user_ids", "type", "from", "to", "cc", "bcc", "sub_type", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsActivity" }, "put": { "summary": "Update an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "application_id", "job_id", "interview_id", "document_ids", "title", "description", "is_private", "user_ids", "type", "from", "to", "cc", "bcc", "sub_type", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsActivity" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAtsActivity" }, "patch": { "summary": "Update an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "application_id", "job_id", "interview_id", "document_ids", "title", "description", "is_private", "user_ids", "type", "from", "to", "cc", "bcc", "sub_type", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsActivity" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAtsActivity" }, "delete": { "summary": "Remove an activity", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "activity" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAtsActivity" } }, "/ats/{connection_id}/candidate": { "post": { "summary": "Create a candidate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "company_name", "image_url", "tags", "address", "external_identifier", "link_urls", "origin", "company_id", "sources", "date_of_birth", "user_id", "user_ids", "web_url", "experiences", "education", "skills", "job_ids", "metadata", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsCandidate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "candidate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsCandidate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAtsCandidate" }, "get": { "summary": "List all candidates", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to AtsCompany)" }, { "type": "string", "name": "job_id", "in": "query", "required": false, "description": "The job ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "company_name", "image_url", "tags", "address", "external_identifier", "link_urls", "origin", "company_id", "sources", "date_of_birth", "user_id", "user_ids", "web_url", "experiences", "education", "skills", "job_ids", "metadata", "summary", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "candidate" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsCandidate" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsCandidates" } }, "/ats/{connection_id}/candidate/{id}": { "get": { "summary": "Retrieve a candidate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "company_name", "image_url", "tags", "address", "external_identifier", "link_urls", "origin", "company_id", "sources", "date_of_birth", "user_id", "user_ids", "web_url", "experiences", "education", "skills", "job_ids", "metadata", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Candidate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "candidate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsCandidate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsCandidate" }, "put": { "summary": "Update a candidate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "company_name", "image_url", "tags", "address", "external_identifier", "link_urls", "origin", "company_id", "sources", "date_of_birth", "user_id", "user_ids", "web_url", "experiences", "education", "skills", "job_ids", "metadata", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Candidate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsCandidate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "candidate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsCandidate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAtsCandidate" }, "patch": { "summary": "Update a candidate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "company_name", "image_url", "tags", "address", "external_identifier", "link_urls", "origin", "company_id", "sources", "date_of_birth", "user_id", "user_ids", "web_url", "experiences", "education", "skills", "job_ids", "metadata", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Candidate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsCandidate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "candidate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsCandidate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAtsCandidate" }, "delete": { "summary": "Remove a candidate", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Candidate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "candidate" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAtsCandidate" } }, "/ats/{connection_id}/job": { "post": { "summary": "Create a job", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "recruiter_ids", "hiring_manager_ids", "hiring_managers", "status", "closed_at", "addresses", "compensation", "employment_type", "remote", "language_locale", "public_job_urls", "number_of_openings", "company_id", "questions", "postings", "groups", "openings", "minimum_experience_years", "minimum_degree", "skills", "metadata", "user_id", "industry", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsJob" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "job" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsJob" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAtsJob" }, "get": { "summary": "List all jobs", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to AtsCompany)" }, { "type": "string", "name": "status", "in": "query", "required": false, "description": "The status to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "recruiter_ids", "hiring_manager_ids", "hiring_managers", "status", "closed_at", "addresses", "compensation", "employment_type", "remote", "language_locale", "public_job_urls", "number_of_openings", "company_id", "questions", "postings", "groups", "openings", "minimum_experience_years", "minimum_degree", "skills", "metadata", "user_id", "industry", "summary", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "job" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsJob" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsJobs" } }, "/ats/{connection_id}/job/{id}": { "get": { "summary": "Retrieve a job", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "recruiter_ids", "hiring_manager_ids", "hiring_managers", "status", "closed_at", "addresses", "compensation", "employment_type", "remote", "language_locale", "public_job_urls", "number_of_openings", "company_id", "questions", "postings", "groups", "openings", "minimum_experience_years", "minimum_degree", "skills", "metadata", "user_id", "industry", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Job", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "job" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsJob" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsJob" }, "put": { "summary": "Update a job", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "recruiter_ids", "hiring_manager_ids", "hiring_managers", "status", "closed_at", "addresses", "compensation", "employment_type", "remote", "language_locale", "public_job_urls", "number_of_openings", "company_id", "questions", "postings", "groups", "openings", "minimum_experience_years", "minimum_degree", "skills", "metadata", "user_id", "industry", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Job", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsJob" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "job" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsJob" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAtsJob" }, "patch": { "summary": "Update a job", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "recruiter_ids", "hiring_manager_ids", "hiring_managers", "status", "closed_at", "addresses", "compensation", "employment_type", "remote", "language_locale", "public_job_urls", "number_of_openings", "company_id", "questions", "postings", "groups", "openings", "minimum_experience_years", "minimum_degree", "skills", "metadata", "user_id", "industry", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Job", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsJob" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "job" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsJob" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAtsJob" }, "delete": { "summary": "Remove a job", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Job", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "job" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAtsJob" } }, "/ats/{connection_id}/interview": { "post": { "summary": "Create an interview", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "job_id", "application_id", "user_ids", "status", "start_at", "end_at", "location", "meeting_url", "external_event_xref", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsInterview" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "interview" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsInterview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAtsInterview" }, "get": { "summary": "List all interviews", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "application_id", "in": "query", "required": false, "description": "The application ID to filter by" }, { "type": "string", "name": "candidate_id", "in": "query", "required": false, "description": "The candidate ID to filter by" }, { "type": "string", "name": "job_id", "in": "query", "required": false, "description": "The job ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "job_id", "application_id", "user_ids", "status", "start_at", "end_at", "location", "meeting_url", "external_event_xref", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "interview" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsInterview" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsInterviews" } }, "/ats/{connection_id}/interview/{id}": { "get": { "summary": "Retrieve an interview", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "job_id", "application_id", "user_ids", "status", "start_at", "end_at", "location", "meeting_url", "external_event_xref", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Interview", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "interview" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsInterview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsInterview" }, "put": { "summary": "Update an interview", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "job_id", "application_id", "user_ids", "status", "start_at", "end_at", "location", "meeting_url", "external_event_xref", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Interview", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsInterview" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "interview" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsInterview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAtsInterview" }, "patch": { "summary": "Update an interview", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "candidate_id", "job_id", "application_id", "user_ids", "status", "start_at", "end_at", "location", "meeting_url", "external_event_xref", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Interview", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsInterview" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "interview" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsInterview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAtsInterview" }, "delete": { "summary": "Remove an interview", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Interview", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "interview" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAtsInterview" } }, "/ats/{connection_id}/document": { "post": { "summary": "Create a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "candidate_id", "application_id", "job_id", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAtsDocument" }, "get": { "summary": "List all documents", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "application_id", "in": "query", "required": false, "description": "The application ID to filter by" }, { "type": "string", "name": "candidate_id", "in": "query", "required": false, "description": "The candidate ID to filter by" }, { "type": "string", "name": "job_id", "in": "query", "required": false, "description": "The job ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "RESUME", "COVER_LETTER", "OFFER_PACKET", "OFFER_LETTER", "TAKE_HOME_TEST", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "candidate_id", "application_id", "job_id", "user_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "document" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsDocument" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsDocuments" } }, "/ats/{connection_id}/document/{id}": { "get": { "summary": "Retrieve a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "candidate_id", "application_id", "job_id", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsDocument" }, "put": { "summary": "Update a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "candidate_id", "application_id", "job_id", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAtsDocument" }, "patch": { "summary": "Update a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "candidate_id", "application_id", "job_id", "user_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAtsDocument" }, "delete": { "summary": "Remove a document", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "document" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAtsDocument" } }, "/ats/{connection_id}/applicationstatus/{id}": { "get": { "summary": "Retrieve an applicationstatus", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "job_id", "status", "original_status", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Applicationstatus", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "applicationstatus" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsStatus" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsApplicationstatus" } }, "/ats/{connection_id}/applicationstatus": { "get": { "summary": "List all applicationstatuses", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "job_id", "in": "query", "required": false, "description": "The job ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "job_id", "status", "original_status", "description", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "applicationstatus" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsStatus" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsApplicationstatuses" } }, "/ats/{connection_id}/application": { "post": { "summary": "Create an application", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "candidate_id", "job_id", "created_at", "updated_at", "applied_at", "hired_at", "rejected_at", "rejected_reason", "source", "status", "original_status", "answers", "offers", "user_id", "metadata", "original_substatus", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsApplication" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "application" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsApplication" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAtsApplication" }, "get": { "summary": "List all applications", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "job_id", "in": "query", "required": false, "description": "The job ID to filter by" }, { "type": "string", "name": "candidate_id", "in": "query", "required": false, "description": "The candidate ID to filter by" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to AtsCompany)" }, { "type": "string", "name": "status", "in": "query", "required": false, "description": "The status to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "candidate_id", "job_id", "created_at", "updated_at", "applied_at", "hired_at", "rejected_at", "rejected_reason", "source", "status", "original_status", "answers", "offers", "user_id", "metadata", "original_substatus", "summary", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "application" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsApplication" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsApplications" } }, "/ats/{connection_id}/application/{id}": { "get": { "summary": "Retrieve an application", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "candidate_id", "job_id", "created_at", "updated_at", "applied_at", "hired_at", "rejected_at", "rejected_reason", "source", "status", "original_status", "answers", "offers", "user_id", "metadata", "original_substatus", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Application", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "application" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsApplication" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsApplication" }, "put": { "summary": "Update an application", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "candidate_id", "job_id", "created_at", "updated_at", "applied_at", "hired_at", "rejected_at", "rejected_reason", "source", "status", "original_status", "answers", "offers", "user_id", "metadata", "original_substatus", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Application", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsApplication" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "application" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsApplication" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAtsApplication" }, "patch": { "summary": "Update an application", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "candidate_id", "job_id", "created_at", "updated_at", "applied_at", "hired_at", "rejected_at", "rejected_reason", "source", "status", "original_status", "answers", "offers", "user_id", "metadata", "original_substatus", "summary", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Application", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsApplication" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "application" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsApplication" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAtsApplication" }, "delete": { "summary": "Remove an application", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Application", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "application" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAtsApplication" } }, "/ats/{connection_id}/scorecard": { "post": { "summary": "Create a scorecard", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "application_id", "interviewer_id", "interview_id", "candidate_id", "job_id", "recommendation", "comment", "questions", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsScorecard" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "scorecard" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsScorecard" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAtsScorecard" }, "get": { "summary": "List all scorecards", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "candidate_id", "in": "query", "required": false, "description": "The candidate ID to filter by" }, { "type": "string", "name": "application_id", "in": "query", "required": false, "description": "The application ID to filter by" }, { "type": "string", "name": "interview_id", "in": "query", "required": false, "description": "The interview ID to filter by" }, { "type": "string", "name": "job_id", "in": "query", "required": false, "description": "The job ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "application_id", "interviewer_id", "interview_id", "candidate_id", "job_id", "recommendation", "comment", "questions", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "scorecard" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsScorecard" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsScorecards" } }, "/ats/{connection_id}/scorecard/{id}": { "get": { "summary": "Retrieve a scorecard", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "application_id", "interviewer_id", "interview_id", "candidate_id", "job_id", "recommendation", "comment", "questions", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Scorecard", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "scorecard" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsScorecard" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsScorecard" }, "put": { "summary": "Update a scorecard", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "application_id", "interviewer_id", "interview_id", "candidate_id", "job_id", "recommendation", "comment", "questions", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Scorecard", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsScorecard" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "scorecard" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsScorecard" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAtsScorecard" }, "patch": { "summary": "Update a scorecard", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "application_id", "interviewer_id", "interview_id", "candidate_id", "job_id", "recommendation", "comment", "questions", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Scorecard", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsScorecard" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "scorecard" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsScorecard" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAtsScorecard" }, "delete": { "summary": "Remove a scorecard", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Scorecard", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "scorecard" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAtsScorecard" } }, "/ats/{connection_id}/company": { "post": { "summary": "Create a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "website_url", "phone", "parent_id", "recruiter_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAtsCompany" }, "get": { "summary": "List all companies", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "website_url", "phone", "parent_id", "recruiter_ids", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "company" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AtsCompany" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAtsCompanies" } }, "/ats/{connection_id}/company/{id}": { "get": { "summary": "Retrieve a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "website_url", "phone", "parent_id", "recruiter_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAtsCompany" }, "put": { "summary": "Update a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "website_url", "phone", "parent_id", "recruiter_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAtsCompany" }, "patch": { "summary": "Update a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "website_url", "phone", "parent_id", "recruiter_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AtsCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AtsCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAtsCompany" }, "delete": { "summary": "Remove a company", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ats", "company" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAtsCompany" } }, "/hris/{connection_id}/employee": { "post": { "summary": "Create an employee", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "job_id", "manager_id", "employment_status", "gender", "telephones", "date_of_birth", "employee_number", "hired_at", "terminated_at", "termination_reason", "marital_status", "employment_type", "address", "language_locale", "currency", "timezone", "image_url", "company_id", "pronouns", "employee_roles", "compensation", "salutation", "bio", "ssn_sin", "groups", "locations", "metadata", "storage_quota_allocated", "storage_quota_used", "storage_quota_available", "relationships", "has_mfa", "timeoff_days_total", "timeoff_days_used", "flsa_status", "pay_frequency", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisEmployee" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "employee" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisEmployee" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisEmployee" }, "get": { "summary": "List all employees", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by (reference to HrisLocation)" }, { "type": "string", "name": "job_id", "in": "query", "required": false, "description": "The job ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "job_id", "manager_id", "employment_status", "gender", "telephones", "date_of_birth", "employee_number", "hired_at", "terminated_at", "termination_reason", "marital_status", "employment_type", "address", "language_locale", "currency", "timezone", "image_url", "company_id", "pronouns", "employee_roles", "compensation", "salutation", "bio", "ssn_sin", "groups", "locations", "metadata", "storage_quota_allocated", "storage_quota_used", "storage_quota_available", "relationships", "has_mfa", "timeoff_days_total", "timeoff_days_used", "flsa_status", "pay_frequency", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "employee" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisEmployee" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisEmployees" } }, "/hris/{connection_id}/employee/{id}": { "get": { "summary": "Retrieve an employee", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "job_id", "manager_id", "employment_status", "gender", "telephones", "date_of_birth", "employee_number", "hired_at", "terminated_at", "termination_reason", "marital_status", "employment_type", "address", "language_locale", "currency", "timezone", "image_url", "company_id", "pronouns", "employee_roles", "compensation", "salutation", "bio", "ssn_sin", "groups", "locations", "metadata", "storage_quota_allocated", "storage_quota_used", "storage_quota_available", "relationships", "has_mfa", "timeoff_days_total", "timeoff_days_used", "flsa_status", "pay_frequency", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Employee", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "employee" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisEmployee" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisEmployee" }, "put": { "summary": "Update an employee", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "job_id", "manager_id", "employment_status", "gender", "telephones", "date_of_birth", "employee_number", "hired_at", "terminated_at", "termination_reason", "marital_status", "employment_type", "address", "language_locale", "currency", "timezone", "image_url", "company_id", "pronouns", "employee_roles", "compensation", "salutation", "bio", "ssn_sin", "groups", "locations", "metadata", "storage_quota_allocated", "storage_quota_used", "storage_quota_available", "relationships", "has_mfa", "timeoff_days_total", "timeoff_days_used", "flsa_status", "pay_frequency", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Employee", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisEmployee" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "employee" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisEmployee" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisEmployee" }, "patch": { "summary": "Update an employee", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "job_id", "manager_id", "employment_status", "gender", "telephones", "date_of_birth", "employee_number", "hired_at", "terminated_at", "termination_reason", "marital_status", "employment_type", "address", "language_locale", "currency", "timezone", "image_url", "company_id", "pronouns", "employee_roles", "compensation", "salutation", "bio", "ssn_sin", "groups", "locations", "metadata", "storage_quota_allocated", "storage_quota_used", "storage_quota_available", "relationships", "has_mfa", "timeoff_days_total", "timeoff_days_used", "flsa_status", "pay_frequency", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Employee", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisEmployee" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "employee" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisEmployee" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisEmployee" }, "delete": { "summary": "Remove an employee", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Employee", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "employee" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisEmployee" } }, "/hris/{connection_id}/company": { "post": { "summary": "Create a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "legal_name", "address", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisCompany" }, "get": { "summary": "List all companies", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "legal_name", "address", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "company" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisCompany" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisCompanies" } }, "/hris/{connection_id}/company/{id}": { "get": { "summary": "Retrieve a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "legal_name", "address", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisCompany" }, "put": { "summary": "Update a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "legal_name", "address", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisCompany" }, "patch": { "summary": "Update a company", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "legal_name", "address", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisCompany" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "company" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisCompany" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisCompany" }, "delete": { "summary": "Remove a company", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Company", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "company" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisCompany" } }, "/hris/{connection_id}/location": { "post": { "summary": "Create a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "address", "parent_id", "external_identifier", "telephones", "timezone", "currency", "language_locale", "is_active", "is_hq", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisLocation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisLocation" }, "get": { "summary": "List all locations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "address", "parent_id", "external_identifier", "telephones", "timezone", "currency", "language_locale", "is_active", "is_hq", "company_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "location" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisLocation" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisLocations" } }, "/hris/{connection_id}/location/{id}": { "get": { "summary": "Retrieve a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "address", "parent_id", "external_identifier", "telephones", "timezone", "currency", "language_locale", "is_active", "is_hq", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisLocation" }, "put": { "summary": "Update a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "address", "parent_id", "external_identifier", "telephones", "timezone", "currency", "language_locale", "is_active", "is_hq", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisLocation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisLocation" }, "patch": { "summary": "Update a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "address", "parent_id", "external_identifier", "telephones", "timezone", "currency", "language_locale", "is_active", "is_hq", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisLocation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisLocation" }, "delete": { "summary": "Remove a location", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "location" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisLocation" } }, "/hris/{connection_id}/group": { "post": { "summary": "Create a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "type", "user_ids", "manager_ids", "is_active", "company_id", "pay_frequency", "next_paid_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisGroup" }, "get": { "summary": "List all groups", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "The type to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "type", "user_ids", "manager_ids", "is_active", "company_id", "pay_frequency", "next_paid_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "group" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisGroup" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisGroups" } }, "/hris/{connection_id}/group/{id}": { "get": { "summary": "Retrieve a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "type", "user_ids", "manager_ids", "is_active", "company_id", "pay_frequency", "next_paid_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisGroup" }, "put": { "summary": "Update a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "type", "user_ids", "manager_ids", "is_active", "company_id", "pay_frequency", "next_paid_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisGroup" }, "patch": { "summary": "Update a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "type", "user_ids", "manager_ids", "is_active", "company_id", "pay_frequency", "next_paid_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisGroup" }, "delete": { "summary": "Remove a group", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "group" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisGroup" } }, "/hris/{connection_id}/job": { "post": { "summary": "Create a job", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "code", "is_active", "employment_type", "company_id", "groups", "locations", "parent_id", "users", "compensation", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisJob" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "job" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisJob" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisJob" }, "get": { "summary": "List all jobs", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by (reference to HrisLocation)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "code", "is_active", "employment_type", "company_id", "groups", "locations", "parent_id", "users", "compensation", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "job" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisJob" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisJobs" } }, "/hris/{connection_id}/job/{id}": { "get": { "summary": "Retrieve a job", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "code", "is_active", "employment_type", "company_id", "groups", "locations", "parent_id", "users", "compensation", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Job", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "job" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisJob" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisJob" }, "put": { "summary": "Update a job", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "code", "is_active", "employment_type", "company_id", "groups", "locations", "parent_id", "users", "compensation", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Job", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisJob" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "job" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisJob" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisJob" }, "patch": { "summary": "Update a job", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "code", "is_active", "employment_type", "company_id", "groups", "locations", "parent_id", "users", "compensation", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Job", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisJob" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "job" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisJob" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisJob" }, "delete": { "summary": "Remove a job", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Job", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "job" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisJob" } }, "/hris/{connection_id}/timeoff": { "post": { "summary": "Create a timeoff", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "start_at", "end_at", "is_paid", "status", "approver_user_id", "approved_at", "comments", "reason", "original_type", "type", "duration", "duration_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisTimeoff" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeoff" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTimeoff" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisTimeoff" }, "get": { "summary": "List all timeoffs", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "VACATION", "SICK", "HOLIDAY", "BEREAVEMENT", "PARENTAL", "UNPAID", "IN_LIEU", "OTHER" ] }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "APPROVED", "PENDING", "DENIED", "CANCELLED" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "start_at", "end_at", "is_paid", "status", "approver_user_id", "approved_at", "comments", "reason", "original_type", "type", "duration", "duration_type", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeoff" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisTimeoff" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisTimeoffs" } }, "/hris/{connection_id}/timeoff/{id}": { "get": { "summary": "Retrieve a timeoff", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "start_at", "end_at", "is_paid", "status", "approver_user_id", "approved_at", "comments", "reason", "original_type", "type", "duration", "duration_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeoff", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeoff" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTimeoff" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisTimeoff" }, "put": { "summary": "Update a timeoff", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "start_at", "end_at", "is_paid", "status", "approver_user_id", "approved_at", "comments", "reason", "original_type", "type", "duration", "duration_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeoff", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisTimeoff" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeoff" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTimeoff" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisTimeoff" }, "patch": { "summary": "Update a timeoff", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "start_at", "end_at", "is_paid", "status", "approver_user_id", "approved_at", "comments", "reason", "original_type", "type", "duration", "duration_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeoff", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisTimeoff" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeoff" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTimeoff" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisTimeoff" }, "delete": { "summary": "Remove a timeoff", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeoff", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeoff" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisTimeoff" } }, "/hris/{connection_id}/payslip/{id}": { "get": { "summary": "Retrieve a payslip", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "payment_reference", "payment_type", "paid_at", "start_at", "end_at", "currency", "gross_amount", "net_amount", "details", "deduction", "payroll_id", "group_id", "type", "hours", "employee_tax_amount", "employer_tax_amount", "deduction_amount", "employer_contribution_amount", "gross_ytd_amount", "net_ytd_amount", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Payslip", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "payslip" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisPayslip" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisPayslip" } }, "/hris/{connection_id}/payslip": { "get": { "summary": "List all payslips", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "payment_reference", "payment_type", "paid_at", "start_at", "end_at", "currency", "gross_amount", "net_amount", "details", "deduction", "payroll_id", "group_id", "type", "hours", "employee_tax_amount", "employer_tax_amount", "deduction_amount", "employer_contribution_amount", "gross_ytd_amount", "net_ytd_amount", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "payslip" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisPayslip" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisPayslips" } }, "/hris/{connection_id}/payroll/{id}": { "get": { "summary": "Retrieve a payroll", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "company_id", "group_id", "status", "type", "start_at", "end_at", "paid_at", "approved_at", "currency", "gross_amount", "net_amount", "employee_tax_amount", "employer_tax_amount", "deduction_amount", "employer_contribution_amount", "total_cost_amount", "user_ids", "payslip_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Payroll", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "payroll" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisPayroll" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisPayroll" } }, "/hris/{connection_id}/payroll": { "get": { "summary": "List all payrolls", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "REGULAR", "OFF_CYCLE", "BONUS", "CORRECTION", "TERMINATION", "CONTRACTOR" ] }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "company_id", "group_id", "status", "type", "start_at", "end_at", "paid_at", "approved_at", "currency", "gross_amount", "net_amount", "employee_tax_amount", "employer_tax_amount", "deduction_amount", "employer_contribution_amount", "total_cost_amount", "user_ids", "payslip_ids", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "payroll" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisPayroll" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisPayrolls" } }, "/hris/{connection_id}/paycode/{id}": { "get": { "summary": "Retrieve a paycode", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "company_id", "name", "code", "description", "type", "detail_type", "is_pre_tax", "is_employer", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Paycode", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "paycode" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisPaycode" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisPaycode" } }, "/hris/{connection_id}/paycode": { "get": { "summary": "List all paycodes", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "EARNING", "DEDUCTION", "TAX", "CONTRIBUTION", "REIMBURSEMENT" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "company_id", "name", "code", "description", "type", "detail_type", "is_pre_tax", "is_employer", "is_active", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "paycode" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisPaycode" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisPaycodes" } }, "/hris/{connection_id}/earning": { "post": { "summary": "Create an earning", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "paycode_id", "amount", "currency", "hours", "rate_amount", "frequency", "start_at", "end_at", "status", "payroll_id", "payslip_id", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisEarning" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "earning" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisEarning" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisEarning" }, "get": { "summary": "List all earnings", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "PENDING", "ACTIVE", "PROCESSED", "ENDED", "CANCELLED", "FAILED" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "paycode_id", "amount", "currency", "hours", "rate_amount", "frequency", "start_at", "end_at", "status", "payroll_id", "payslip_id", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "earning" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisEarning" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisEarnings" } }, "/hris/{connection_id}/earning/{id}": { "get": { "summary": "Retrieve an earning", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "paycode_id", "amount", "currency", "hours", "rate_amount", "frequency", "start_at", "end_at", "status", "payroll_id", "payslip_id", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Earning", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "earning" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisEarning" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisEarning" }, "put": { "summary": "Update an earning", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "paycode_id", "amount", "currency", "hours", "rate_amount", "frequency", "start_at", "end_at", "status", "payroll_id", "payslip_id", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Earning", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisEarning" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "earning" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisEarning" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisEarning" }, "patch": { "summary": "Update an earning", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "paycode_id", "amount", "currency", "hours", "rate_amount", "frequency", "start_at", "end_at", "status", "payroll_id", "payslip_id", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Earning", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisEarning" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "earning" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisEarning" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisEarning" }, "delete": { "summary": "Remove an earning", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Earning", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "earning" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisEarning" } }, "/hris/{connection_id}/device": { "post": { "summary": "Create a device", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "asset_tag", "version", "manufacturer", "model", "os", "os_version", "user_ids", "admin_user_ids", "location_id", "has_antivirus", "has_password_manager", "has_firewall", "has_hd_encrypted", "has_screenlock", "is_missing", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDevice" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "device" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDevice" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisDevice" }, "get": { "summary": "List all devices", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "string", "name": "email", "in": "query", "required": false, "description": "The email address to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "asset_tag", "version", "manufacturer", "model", "os", "os_version", "user_ids", "admin_user_ids", "location_id", "has_antivirus", "has_password_manager", "has_firewall", "has_hd_encrypted", "has_screenlock", "is_missing", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "device" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisDevice" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisDevices" } }, "/hris/{connection_id}/device/{id}": { "get": { "summary": "Retrieve a device", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "asset_tag", "version", "manufacturer", "model", "os", "os_version", "user_ids", "admin_user_ids", "location_id", "has_antivirus", "has_password_manager", "has_firewall", "has_hd_encrypted", "has_screenlock", "is_missing", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Device", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "device" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDevice" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisDevice" }, "put": { "summary": "Update a device", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "asset_tag", "version", "manufacturer", "model", "os", "os_version", "user_ids", "admin_user_ids", "location_id", "has_antivirus", "has_password_manager", "has_firewall", "has_hd_encrypted", "has_screenlock", "is_missing", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Device", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDevice" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "device" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDevice" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisDevice" }, "patch": { "summary": "Update a device", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "asset_tag", "version", "manufacturer", "model", "os", "os_version", "user_ids", "admin_user_ids", "location_id", "has_antivirus", "has_password_manager", "has_firewall", "has_hd_encrypted", "has_screenlock", "is_missing", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Device", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDevice" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "device" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDevice" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisDevice" }, "delete": { "summary": "Remove a device", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Device", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "device" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisDevice" } }, "/hris/{connection_id}/timeshift": { "post": { "summary": "Create a timeshift", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "location_id", "company_id", "group_id", "compensation", "approver_user_id", "approved_at", "hours", "is_approved", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisTimeshift" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeshift" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTimeshift" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisTimeshift" }, "get": { "summary": "List all timeshifts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by (reference to HrisLocation)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "location_id", "company_id", "group_id", "compensation", "approver_user_id", "approved_at", "hours", "is_approved", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeshift" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisTimeshift" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisTimeshifts" } }, "/hris/{connection_id}/timeshift/{id}": { "get": { "summary": "Retrieve a timeshift", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "location_id", "company_id", "group_id", "compensation", "approver_user_id", "approved_at", "hours", "is_approved", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeshift", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeshift" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTimeshift" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisTimeshift" }, "put": { "summary": "Update a timeshift", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "location_id", "company_id", "group_id", "compensation", "approver_user_id", "approved_at", "hours", "is_approved", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeshift", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisTimeshift" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeshift" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTimeshift" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisTimeshift" }, "patch": { "summary": "Update a timeshift", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "location_id", "company_id", "group_id", "compensation", "approver_user_id", "approved_at", "hours", "is_approved", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeshift", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisTimeshift" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeshift" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTimeshift" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisTimeshift" }, "delete": { "summary": "Remove a timeshift", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeshift", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "timeshift" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisTimeshift" } }, "/hris/{connection_id}/attendance": { "post": { "summary": "Create an attendance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "timeshift_id", "location_id", "company_id", "group_id", "timezone", "address", "hours", "currency", "status", "breaks", "declared_tips_amount", "non_cash_tips_amount", "job_name", "hourly_rate", "approver_user_id", "approved_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisAttendance" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "attendance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisAttendance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisAttendance" }, "get": { "summary": "List all attendances", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by (reference to HrisLocation)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "timeshift_id", "location_id", "company_id", "group_id", "timezone", "address", "hours", "currency", "status", "breaks", "declared_tips_amount", "non_cash_tips_amount", "job_name", "hourly_rate", "approver_user_id", "approved_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "attendance" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisAttendance" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisAttendances" } }, "/hris/{connection_id}/attendance/{id}": { "get": { "summary": "Retrieve an attendance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "timeshift_id", "location_id", "company_id", "group_id", "timezone", "address", "hours", "currency", "status", "breaks", "declared_tips_amount", "non_cash_tips_amount", "job_name", "hourly_rate", "approver_user_id", "approved_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Attendance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "attendance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisAttendance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisAttendance" }, "put": { "summary": "Update an attendance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "timeshift_id", "location_id", "company_id", "group_id", "timezone", "address", "hours", "currency", "status", "breaks", "declared_tips_amount", "non_cash_tips_amount", "job_name", "hourly_rate", "approver_user_id", "approved_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Attendance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisAttendance" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "attendance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisAttendance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisAttendance" }, "patch": { "summary": "Update an attendance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "employee_user_id", "start_at", "end_at", "timeshift_id", "location_id", "company_id", "group_id", "timezone", "address", "hours", "currency", "status", "breaks", "declared_tips_amount", "non_cash_tips_amount", "job_name", "hourly_rate", "approver_user_id", "approved_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Attendance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisAttendance" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "attendance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisAttendance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisAttendance" }, "delete": { "summary": "Remove an attendance", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Attendance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "attendance" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisAttendance" } }, "/hris/{connection_id}/benefit": { "post": { "summary": "Create a benefit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "company_id", "type", "tax", "frequency", "is_active", "employer_contribution_type", "employer_contribution_amount", "employer_contribution_max_amount", "coverage_level", "currency", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisBenefit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "benefit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisBenefit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisBenefit" }, "get": { "summary": "List all benefits", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "company_id", "type", "tax", "frequency", "is_active", "employer_contribution_type", "employer_contribution_amount", "employer_contribution_max_amount", "coverage_level", "currency", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "benefit" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisBenefit" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisBenefits" } }, "/hris/{connection_id}/benefit/{id}": { "get": { "summary": "Retrieve a benefit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "company_id", "type", "tax", "frequency", "is_active", "employer_contribution_type", "employer_contribution_amount", "employer_contribution_max_amount", "coverage_level", "currency", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Benefit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "benefit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisBenefit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisBenefit" }, "put": { "summary": "Update a benefit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "company_id", "type", "tax", "frequency", "is_active", "employer_contribution_type", "employer_contribution_amount", "employer_contribution_max_amount", "coverage_level", "currency", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Benefit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisBenefit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "benefit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisBenefit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisBenefit" }, "patch": { "summary": "Update a benefit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "company_id", "type", "tax", "frequency", "is_active", "employer_contribution_type", "employer_contribution_amount", "employer_contribution_max_amount", "coverage_level", "currency", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Benefit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisBenefit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "benefit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisBenefit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisBenefit" }, "delete": { "summary": "Remove a benefit", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Benefit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "benefit" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisBenefit" } }, "/hris/{connection_id}/deduction": { "post": { "summary": "Create a deduction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "benefit_id", "amount", "type", "coverage_level", "frequency", "start_at", "end_at", "is_active", "notes", "employer_amount", "employer_type", "max_amount", "paycode_id", "garnishment_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDeduction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "deduction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDeduction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisDeduction" }, "get": { "summary": "List all deductions", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "payslip_id", "in": "query", "required": false, "description": "The payslip ID to filter by" }, { "type": "string", "name": "benefit_id", "in": "query", "required": false, "description": "The benefit ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "benefit_id", "amount", "type", "coverage_level", "frequency", "start_at", "end_at", "is_active", "notes", "employer_amount", "employer_type", "max_amount", "paycode_id", "garnishment_type", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "deduction" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisDeduction" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisDeductions" } }, "/hris/{connection_id}/deduction/{id}": { "get": { "summary": "Retrieve a deduction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "benefit_id", "amount", "type", "coverage_level", "frequency", "start_at", "end_at", "is_active", "notes", "employer_amount", "employer_type", "max_amount", "paycode_id", "garnishment_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deduction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "deduction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDeduction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisDeduction" }, "put": { "summary": "Update a deduction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "benefit_id", "amount", "type", "coverage_level", "frequency", "start_at", "end_at", "is_active", "notes", "employer_amount", "employer_type", "max_amount", "paycode_id", "garnishment_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deduction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDeduction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "deduction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDeduction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisDeduction" }, "patch": { "summary": "Update a deduction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "benefit_id", "amount", "type", "coverage_level", "frequency", "start_at", "end_at", "is_active", "notes", "employer_amount", "employer_type", "max_amount", "paycode_id", "garnishment_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deduction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDeduction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "deduction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDeduction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisDeduction" }, "delete": { "summary": "Remove a deduction", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deduction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "deduction" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisDeduction" } }, "/hris/{connection_id}/bankaccount": { "post": { "summary": "Create a bankaccount", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "account_type", "bank_name", "routing_number", "account_number", "account_number_last4", "name", "is_primary", "iban", "bic", "country_code", "currency", "split_type", "split_amount", "priority", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisBankaccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "bankaccount" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisBankaccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisBankaccount" }, "get": { "summary": "List all bankaccounts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "account_type", "bank_name", "routing_number", "account_number", "account_number_last4", "name", "is_primary", "iban", "bic", "country_code", "currency", "split_type", "split_amount", "priority", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "bankaccount" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisBankaccount" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisBankaccounts" } }, "/hris/{connection_id}/bankaccount/{id}": { "get": { "summary": "Retrieve a bankaccount", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "account_type", "bank_name", "routing_number", "account_number", "account_number_last4", "name", "is_primary", "iban", "bic", "country_code", "currency", "split_type", "split_amount", "priority", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankaccount", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "bankaccount" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisBankaccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisBankaccount" }, "put": { "summary": "Update a bankaccount", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "account_type", "bank_name", "routing_number", "account_number", "account_number_last4", "name", "is_primary", "iban", "bic", "country_code", "currency", "split_type", "split_amount", "priority", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankaccount", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisBankaccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "bankaccount" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisBankaccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisBankaccount" }, "patch": { "summary": "Update a bankaccount", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "company_id", "account_type", "bank_name", "routing_number", "account_number", "account_number_last4", "name", "is_primary", "iban", "bic", "country_code", "currency", "split_type", "split_amount", "priority", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankaccount", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisBankaccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "bankaccount" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisBankaccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisBankaccount" }, "delete": { "summary": "Remove a bankaccount", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankaccount", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "bankaccount" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisBankaccount" } }, "/hris/{connection_id}/taxonomy": { "post": { "summary": "Create a taxonomy", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "name", "description", "domain", "category", "subcategory", "parent_id", "alternative_names", "url", "role_ids", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisTaxonomy" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "taxonomy" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTaxonomy" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisTaxonomy" }, "get": { "summary": "List all taxonomies", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "SKILL", "KNOWLEDGE", "COMPETENCE", "ABILITY", "CERTIFICATION", "ROLE", "HOLIDAY", "LEAVE" ] }, { "type": "string", "name": "role_id", "in": "query", "required": false, "description": "The role ID to filter by" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "name", "description", "domain", "category", "subcategory", "parent_id", "alternative_names", "url", "role_ids", "is_active", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "taxonomy" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisTaxonomy" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisTaxonomies" } }, "/hris/{connection_id}/taxonomy/{id}": { "get": { "summary": "Retrieve a taxonomy", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "name", "description", "domain", "category", "subcategory", "parent_id", "alternative_names", "url", "role_ids", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Taxonomy", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "taxonomy" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisTaxonomy" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisTaxonomy" } }, "/hris/{connection_id}/document": { "post": { "summary": "Create a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "user_id", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHrisDocument" }, "get": { "summary": "List all documents", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "CONTRACT", "OFFER_LETTER", "POLICY", "TAX", "ID", "VISA", "PAYSLIP", "BENEFITS", "CERTIFICATION", "PERFORMANCE_REVIEW", "ONBOARDING", "TERMINATION", "MEDICAL", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "user_id", "company_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "document" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HrisDocument" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHrisDocuments" } }, "/hris/{connection_id}/document/{id}": { "get": { "summary": "Retrieve a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "user_id", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHrisDocument" }, "put": { "summary": "Update a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "user_id", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHrisDocument" }, "patch": { "summary": "Update a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_url", "document_data", "filename", "type", "user_id", "company_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HrisDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HrisDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHrisDocument" }, "delete": { "summary": "Remove a document", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "hris", "document" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHrisDocument" } }, "/verification/{connection_id}/package/{id}": { "get": { "summary": "Retrieve a package", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "aliases", "tags", "description", "parameters", "average_processing_times", "has_redirect_url", "has_target_url", "needs_ip_address", "cost_amount", "currency", "max_score", "info_url", "valid_regions", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Package", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "verification", "package" ], "responses": { "200": { "schema": { "$ref": "#/definitions/VerificationPackage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getVerificationPackage" } }, "/verification/{connection_id}/package": { "get": { "summary": "List all packages", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "aliases", "tags", "description", "parameters", "average_processing_times", "has_redirect_url", "has_target_url", "needs_ip_address", "cost_amount", "currency", "max_score", "info_url", "valid_regions", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "verification", "package" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/VerificationPackage" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listVerificationPackages" } }, "/verification/{connection_id}/request": { "post": { "summary": "Create a request", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "package_id", "parameters", "target_url", "candidate_id", "profile_ip_address", "profile_name", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_redirect_url", "response_download_urls", "response_details", "response_source", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/VerificationRequest" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "verification", "request" ], "responses": { "200": { "schema": { "$ref": "#/definitions/VerificationRequest" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createVerificationRequest" }, "get": { "summary": "List all requests", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "package_id", "in": "query", "required": false, "description": "The package ID to filter by" }, { "type": "string", "name": "candidate_id", "in": "query", "required": false, "description": "The candidate ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "package_id", "parameters", "target_url", "candidate_id", "profile_ip_address", "profile_name", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_redirect_url", "response_download_urls", "response_details", "response_source", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "verification", "request" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/VerificationRequest" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listVerificationRequests" } }, "/verification/{connection_id}/request/{id}": { "get": { "summary": "Retrieve a request", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "package_id", "parameters", "target_url", "candidate_id", "profile_ip_address", "profile_name", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_redirect_url", "response_download_urls", "response_details", "response_source", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Request", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "verification", "request" ], "responses": { "200": { "schema": { "$ref": "#/definitions/VerificationRequest" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getVerificationRequest" }, "put": { "summary": "Update a request", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "package_id", "parameters", "target_url", "candidate_id", "profile_ip_address", "profile_name", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_redirect_url", "response_download_urls", "response_details", "response_source", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Request", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/VerificationRequest" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "verification", "request" ], "responses": { "200": { "schema": { "$ref": "#/definitions/VerificationRequest" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateVerificationRequest" }, "patch": { "summary": "Update a request", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "package_id", "parameters", "target_url", "candidate_id", "profile_ip_address", "profile_name", "profile_date_of_birth", "profile_addresses", "profile_gender", "profile_emails", "profile_telephones", "profile_national_identifier", "response_completed_at", "response_expires_at", "response_issued_at", "response_status", "response_score", "response_redirect_url", "response_download_urls", "response_details", "response_source", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Request", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/VerificationRequest" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "verification", "request" ], "responses": { "200": { "schema": { "$ref": "#/definitions/VerificationRequest" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathVerificationRequest" }, "delete": { "summary": "Remove a request", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Request", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "verification", "request" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeVerificationRequest" } }, "/passthrough/{connection_id}/{path}": { "post": { "summary": "Passthrough POST", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "name": "path", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Payload" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "passthrough" ], "responses": { "200": { "schema": {}, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createPassthrough" }, "put": { "summary": "Passthrough PUT", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "name": "path", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Payload" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "passthrough" ], "responses": { "200": { "schema": {}, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updatePassthrough" }, "patch": { "summary": "Passthrough PUT", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "name": "path", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Payload" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "passthrough" ], "responses": { "200": { "schema": {}, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathPassthrough" }, "get": { "summary": "Passthrough GET", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "name": "path", "in": "path", "required": true } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "passthrough" ], "responses": { "200": { "schema": {}, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPassthroughs" }, "delete": { "summary": "Passthrough DELETE", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "name": "path", "in": "path", "required": true } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "passthrough" ], "responses": { "200": { "schema": {}, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removePassthrough" } }, "/accounting/{connection_id}/account": { "post": { "summary": "Create an account", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "status", "balance", "currency", "customer_defined_code", "is_payable", "parent_id", "taxonomy", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingAccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "account" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingAccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingAccount" }, "get": { "summary": "List all accounts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "The type to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "status", "balance", "currency", "customer_defined_code", "is_payable", "parent_id", "taxonomy", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "account" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingAccount" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingAccounts" } }, "/accounting/{connection_id}/account/{id}": { "get": { "summary": "Retrieve an account", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "status", "balance", "currency", "customer_defined_code", "is_payable", "parent_id", "taxonomy", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Account", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "account" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingAccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingAccount" }, "put": { "summary": "Update an account", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "status", "balance", "currency", "customer_defined_code", "is_payable", "parent_id", "taxonomy", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Account", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingAccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "account" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingAccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingAccount" }, "patch": { "summary": "Update an account", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "status", "balance", "currency", "customer_defined_code", "is_payable", "parent_id", "taxonomy", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Account", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingAccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "account" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingAccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingAccount" }, "delete": { "summary": "Remove an account", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Account", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "account" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingAccount" } }, "/accounting/{connection_id}/journal": { "post": { "summary": "Create a journal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "reference", "tax_amount", "currency", "lineitems", "taxrate_id", "description", "posted_at", "source", "organization_id", "category_ids", "project_id", "attachments", "total_amount", "exchange_rate", "status", "is_inclusive_of_tax", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingJournal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "journal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingJournal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingJournal" }, "get": { "summary": "List all journals", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "account_id", "in": "query", "required": false, "description": "The account ID to filter by (reference to AccountingAccount)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "reference", "tax_amount", "currency", "lineitems", "taxrate_id", "description", "posted_at", "source", "organization_id", "category_ids", "project_id", "attachments", "total_amount", "exchange_rate", "status", "is_inclusive_of_tax", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "journal" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingJournal" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingJournals" } }, "/accounting/{connection_id}/journal/{id}": { "get": { "summary": "Retrieve a journal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "reference", "tax_amount", "currency", "lineitems", "taxrate_id", "description", "posted_at", "source", "organization_id", "category_ids", "project_id", "attachments", "total_amount", "exchange_rate", "status", "is_inclusive_of_tax", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Journal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "journal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingJournal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingJournal" }, "put": { "summary": "Update a journal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "reference", "tax_amount", "currency", "lineitems", "taxrate_id", "description", "posted_at", "source", "organization_id", "category_ids", "project_id", "attachments", "total_amount", "exchange_rate", "status", "is_inclusive_of_tax", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Journal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingJournal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "journal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingJournal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingJournal" }, "patch": { "summary": "Update a journal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "reference", "tax_amount", "currency", "lineitems", "taxrate_id", "description", "posted_at", "source", "organization_id", "category_ids", "project_id", "attachments", "total_amount", "exchange_rate", "status", "is_inclusive_of_tax", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Journal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingJournal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "journal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingJournal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingJournal" }, "delete": { "summary": "Remove a journal", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Journal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "journal" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingJournal" } }, "/accounting/{connection_id}/transaction": { "post": { "summary": "Create a transaction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "memo", "total_amount", "tax_amount", "account_id", "reference", "sub_total_amount", "split_account_id", "payment_method", "payment_terms", "customer_message", "type", "lineitems", "currency", "contacts", "organization_id", "category_ids", "project_id", "transaction_at", "exchange_rate", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingTransaction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "transaction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTransaction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingTransaction" }, "get": { "summary": "List all transactions", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "account_id", "in": "query", "required": false, "description": "The account ID to filter by (reference to AccountingAccount)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "memo", "total_amount", "tax_amount", "account_id", "reference", "sub_total_amount", "split_account_id", "payment_method", "payment_terms", "customer_message", "type", "lineitems", "currency", "contacts", "organization_id", "category_ids", "project_id", "transaction_at", "exchange_rate", "status", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "transaction" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingTransaction" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingTransactions" } }, "/accounting/{connection_id}/transaction/{id}": { "get": { "summary": "Retrieve a transaction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "memo", "total_amount", "tax_amount", "account_id", "reference", "sub_total_amount", "split_account_id", "payment_method", "payment_terms", "customer_message", "type", "lineitems", "currency", "contacts", "organization_id", "category_ids", "project_id", "transaction_at", "exchange_rate", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Transaction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "transaction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTransaction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingTransaction" }, "put": { "summary": "Update a transaction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "memo", "total_amount", "tax_amount", "account_id", "reference", "sub_total_amount", "split_account_id", "payment_method", "payment_terms", "customer_message", "type", "lineitems", "currency", "contacts", "organization_id", "category_ids", "project_id", "transaction_at", "exchange_rate", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Transaction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingTransaction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "transaction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTransaction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingTransaction" }, "patch": { "summary": "Update a transaction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "memo", "total_amount", "tax_amount", "account_id", "reference", "sub_total_amount", "split_account_id", "payment_method", "payment_terms", "customer_message", "type", "lineitems", "currency", "contacts", "organization_id", "category_ids", "project_id", "transaction_at", "exchange_rate", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Transaction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingTransaction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "transaction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTransaction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingTransaction" }, "delete": { "summary": "Remove a transaction", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Transaction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "transaction" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingTransaction" } }, "/accounting/{connection_id}/contact": { "post": { "summary": "Create a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "currency", "billing_address", "shipping_address", "is_active", "tax_exemption", "tax_number", "is_customer", "is_supplier", "portal_url", "payment_methods", "company_name", "identification", "associated_contacts", "organization_id", "payment_terms", "paymentterm_id", "balance_amount", "website", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingContact" }, "get": { "summary": "List all contacts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "CUSTOMER", "SUPPLIER" ] }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "currency", "billing_address", "shipping_address", "is_active", "tax_exemption", "tax_number", "is_customer", "is_supplier", "portal_url", "payment_methods", "company_name", "identification", "associated_contacts", "organization_id", "payment_terms", "paymentterm_id", "balance_amount", "website", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "contact" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingContact" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingContacts" } }, "/accounting/{connection_id}/contact/{id}": { "get": { "summary": "Retrieve a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "currency", "billing_address", "shipping_address", "is_active", "tax_exemption", "tax_number", "is_customer", "is_supplier", "portal_url", "payment_methods", "company_name", "identification", "associated_contacts", "organization_id", "payment_terms", "paymentterm_id", "balance_amount", "website", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingContact" }, "put": { "summary": "Update a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "currency", "billing_address", "shipping_address", "is_active", "tax_exemption", "tax_number", "is_customer", "is_supplier", "portal_url", "payment_methods", "company_name", "identification", "associated_contacts", "organization_id", "payment_terms", "paymentterm_id", "balance_amount", "website", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingContact" }, "patch": { "summary": "Update a contact", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "currency", "billing_address", "shipping_address", "is_active", "tax_exemption", "tax_number", "is_customer", "is_supplier", "portal_url", "payment_methods", "company_name", "identification", "associated_contacts", "organization_id", "payment_terms", "paymentterm_id", "balance_amount", "website", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingContact" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "contact" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingContact" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingContact" }, "delete": { "summary": "Remove a contact", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Contact", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "contact" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingContact" } }, "/accounting/{connection_id}/invoice": { "post": { "summary": "Create an invoice", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "invoice_number", "reference", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "term", "payment_terms", "paymentterm_id", "lineitems", "status", "url", "payment_collection_method", "type", "attachments", "send", "organization_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "is_inclusive_of_tax", "salesorder_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingInvoice" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "invoice" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingInvoice" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingInvoice" }, "get": { "summary": "List all invoices", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "INVOICE", "CREDITMEMO" ] }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "invoice_number", "reference", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "term", "payment_terms", "paymentterm_id", "lineitems", "status", "url", "payment_collection_method", "type", "attachments", "send", "organization_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "is_inclusive_of_tax", "salesorder_ids", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "invoice" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingInvoice" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingInvoices" } }, "/accounting/{connection_id}/invoice/{id}": { "get": { "summary": "Retrieve an invoice", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "invoice_number", "reference", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "term", "payment_terms", "paymentterm_id", "lineitems", "status", "url", "payment_collection_method", "type", "attachments", "send", "organization_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "is_inclusive_of_tax", "salesorder_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Invoice", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "invoice" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingInvoice" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingInvoice" }, "put": { "summary": "Update an invoice", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "invoice_number", "reference", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "term", "payment_terms", "paymentterm_id", "lineitems", "status", "url", "payment_collection_method", "type", "attachments", "send", "organization_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "is_inclusive_of_tax", "salesorder_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Invoice", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingInvoice" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "invoice" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingInvoice" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingInvoice" }, "patch": { "summary": "Update an invoice", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "invoice_number", "reference", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "term", "payment_terms", "paymentterm_id", "lineitems", "status", "url", "payment_collection_method", "type", "attachments", "send", "organization_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "is_inclusive_of_tax", "salesorder_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Invoice", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingInvoice" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "invoice" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingInvoice" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingInvoice" }, "delete": { "summary": "Remove an invoice", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Invoice", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "invoice" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingInvoice" } }, "/accounting/{connection_id}/bill": { "post": { "summary": "Create a bill", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "bill_number", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "term", "payment_terms", "paymentterm_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "purchaseorder_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBill" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bill" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBill" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingBill" }, "get": { "summary": "List all bills", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "bill_number", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "term", "payment_terms", "paymentterm_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "purchaseorder_ids", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bill" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingBill" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingBills" } }, "/accounting/{connection_id}/bill/{id}": { "get": { "summary": "Retrieve a bill", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "bill_number", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "term", "payment_terms", "paymentterm_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "purchaseorder_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bill", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bill" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBill" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingBill" }, "put": { "summary": "Update a bill", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "bill_number", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "term", "payment_terms", "paymentterm_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "purchaseorder_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bill", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBill" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bill" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBill" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingBill" }, "patch": { "summary": "Update a bill", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "bill_number", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "contact_id", "currency", "notes", "extended_notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "term", "payment_terms", "paymentterm_id", "payments", "category_ids", "project_id", "metadata", "sub_total_amount", "exchange_rate", "purchaseorder_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bill", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBill" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bill" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBill" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingBill" }, "delete": { "summary": "Remove a bill", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bill", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bill" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingBill" } }, "/accounting/{connection_id}/creditmemo": { "post": { "summary": "Create a creditmemo", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "creditmemo_number", "contact_id", "invoice_id", "currency", "notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "apply_amount", "applications", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingCreditmemo" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "creditmemo" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCreditmemo" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingCreditmemo" }, "get": { "summary": "List all creditmemoes", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "creditmemo_number", "contact_id", "invoice_id", "currency", "notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "apply_amount", "applications", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "creditmemo" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingCreditmemo" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingCreditmemoes" } }, "/accounting/{connection_id}/creditmemo/{id}": { "get": { "summary": "Retrieve a creditmemo", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "creditmemo_number", "contact_id", "invoice_id", "currency", "notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "apply_amount", "applications", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Creditmemo", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "creditmemo" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCreditmemo" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingCreditmemo" }, "put": { "summary": "Update a creditmemo", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "creditmemo_number", "contact_id", "invoice_id", "currency", "notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "apply_amount", "applications", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Creditmemo", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingCreditmemo" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "creditmemo" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCreditmemo" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingCreditmemo" }, "patch": { "summary": "Update a creditmemo", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "paid_at", "refunded_at", "cancelled_at", "posted_at", "total_amount", "paid_amount", "refund_amount", "tax_amount", "discount_amount", "balance_amount", "creditmemo_number", "contact_id", "invoice_id", "currency", "notes", "refund_reason", "lineitems", "status", "url", "payment_collection_method", "attachments", "send", "organization_id", "apply_amount", "applications", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Creditmemo", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingCreditmemo" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "creditmemo" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCreditmemo" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingCreditmemo" }, "delete": { "summary": "Remove a creditmemo", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Creditmemo", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "creditmemo" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingCreditmemo" } }, "/accounting/{connection_id}/vendorcredit": { "post": { "summary": "Create a vendorcredit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "posted_at", "total_amount", "balance_amount", "account_id", "currency", "contact_id", "bill_id", "notes", "lineitems", "status", "organization_id", "apply_amount", "applications", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingVendorcredit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "vendorcredit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingVendorcredit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingVendorcredit" }, "get": { "summary": "List all vendorcredits", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "posted_at", "total_amount", "balance_amount", "account_id", "currency", "contact_id", "bill_id", "notes", "lineitems", "status", "organization_id", "apply_amount", "applications", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "vendorcredit" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingVendorcredit" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingVendorcredits" } }, "/accounting/{connection_id}/vendorcredit/{id}": { "get": { "summary": "Retrieve a vendorcredit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "posted_at", "total_amount", "balance_amount", "account_id", "currency", "contact_id", "bill_id", "notes", "lineitems", "status", "organization_id", "apply_amount", "applications", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Vendorcredit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "vendorcredit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingVendorcredit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingVendorcredit" }, "put": { "summary": "Update a vendorcredit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "posted_at", "total_amount", "balance_amount", "account_id", "currency", "contact_id", "bill_id", "notes", "lineitems", "status", "organization_id", "apply_amount", "applications", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Vendorcredit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingVendorcredit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "vendorcredit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingVendorcredit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingVendorcredit" }, "patch": { "summary": "Update a vendorcredit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "due_at", "posted_at", "total_amount", "balance_amount", "account_id", "currency", "contact_id", "bill_id", "notes", "lineitems", "status", "organization_id", "apply_amount", "applications", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Vendorcredit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingVendorcredit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "vendorcredit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingVendorcredit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingVendorcredit" }, "delete": { "summary": "Remove a vendorcredit", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Vendorcredit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "vendorcredit" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingVendorcredit" } }, "/accounting/{connection_id}/taxrate": { "post": { "summary": "Create a taxrate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "rate", "is_active", "organization_id", "metadata", "effective_rate", "total_rate", "components", "type", "is_compound", "country", "region", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingTaxrate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "taxrate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTaxrate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingTaxrate" }, "get": { "summary": "List all taxrates", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "rate", "is_active", "organization_id", "metadata", "effective_rate", "total_rate", "components", "type", "is_compound", "country", "region", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "taxrate" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingTaxrate" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingTaxrates" } }, "/accounting/{connection_id}/taxrate/{id}": { "get": { "summary": "Retrieve a taxrate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "rate", "is_active", "organization_id", "metadata", "effective_rate", "total_rate", "components", "type", "is_compound", "country", "region", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Taxrate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "taxrate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTaxrate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingTaxrate" }, "put": { "summary": "Update a taxrate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "rate", "is_active", "organization_id", "metadata", "effective_rate", "total_rate", "components", "type", "is_compound", "country", "region", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Taxrate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingTaxrate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "taxrate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTaxrate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingTaxrate" }, "patch": { "summary": "Update a taxrate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "rate", "is_active", "organization_id", "metadata", "effective_rate", "total_rate", "components", "type", "is_compound", "country", "region", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Taxrate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingTaxrate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "taxrate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTaxrate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingTaxrate" }, "delete": { "summary": "Remove a taxrate", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Taxrate", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "taxrate" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingTaxrate" } }, "/accounting/{connection_id}/paymentterm": { "post": { "summary": "Create a paymentterm", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "category", "is_active", "due_days", "discount_days", "discount_percent", "day_of_month_due", "discount_day_of_month", "due_next_month_days", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingPaymentterm" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "paymentterm" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPaymentterm" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingPaymentterm" }, "get": { "summary": "List all paymentterms", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "STANDARD", "DATE_DRIVEN", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "category", "is_active", "due_days", "discount_days", "discount_percent", "day_of_month_due", "discount_day_of_month", "due_next_month_days", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "paymentterm" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingPaymentterm" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingPaymentterms" } }, "/accounting/{connection_id}/paymentterm/{id}": { "get": { "summary": "Retrieve a paymentterm", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "category", "is_active", "due_days", "discount_days", "discount_percent", "day_of_month_due", "discount_day_of_month", "due_next_month_days", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Paymentterm", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "paymentterm" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPaymentterm" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingPaymentterm" }, "put": { "summary": "Update a paymentterm", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "category", "is_active", "due_days", "discount_days", "discount_percent", "day_of_month_due", "discount_day_of_month", "due_next_month_days", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Paymentterm", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingPaymentterm" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "paymentterm" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPaymentterm" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingPaymentterm" }, "patch": { "summary": "Update a paymentterm", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "category", "is_active", "due_days", "discount_days", "discount_percent", "day_of_month_due", "discount_day_of_month", "due_next_month_days", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Paymentterm", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingPaymentterm" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "paymentterm" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPaymentterm" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingPaymentterm" }, "delete": { "summary": "Remove a paymentterm", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Paymentterm", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "paymentterm" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingPaymentterm" } }, "/accounting/{connection_id}/organization/{id}": { "get": { "summary": "Retrieve an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "legal_name", "currency", "address", "tax_number", "timezone", "website", "parent_id", "fiscal_year_end_month", "organization_code", "type", "is_elimination", "books_close_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingOrganization" } }, "/accounting/{connection_id}/organization": { "get": { "summary": "List all organizations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "legal_name", "currency", "address", "tax_number", "timezone", "website", "parent_id", "fiscal_year_end_month", "organization_code", "type", "is_elimination", "books_close_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "organization" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingOrganization" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingOrganizations" } }, "/accounting/{connection_id}/order": { "post": { "summary": "Create an order", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "type", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingOrder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "order" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingOrder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingOrder" }, "get": { "summary": "List all orders", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "PURCHASE", "SALES" ] }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "type", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "order" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingOrder" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingOrders" } }, "/accounting/{connection_id}/order/{id}": { "get": { "summary": "Retrieve an order", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "type", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Order", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "order" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingOrder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingOrder" }, "put": { "summary": "Update an order", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "type", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Order", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingOrder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "order" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingOrder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingOrder" }, "patch": { "summary": "Update an order", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "type", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Order", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingOrder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "order" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingOrder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingOrder" }, "delete": { "summary": "Remove an order", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Order", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "order" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingOrder" } }, "/accounting/{connection_id}/purchaseorder": { "post": { "summary": "Create a purchaseorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "category_ids", "metadata", "attachments", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingPurchaseorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "purchaseorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPurchaseorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingPurchaseorder" }, "get": { "summary": "List all purchaseorders", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "category_ids", "metadata", "attachments", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "purchaseorder" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingPurchaseorder" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingPurchaseorders" } }, "/accounting/{connection_id}/purchaseorder/{id}": { "get": { "summary": "Retrieve a purchaseorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "category_ids", "metadata", "attachments", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Purchaseorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "purchaseorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPurchaseorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingPurchaseorder" }, "put": { "summary": "Update a purchaseorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "category_ids", "metadata", "attachments", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Purchaseorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingPurchaseorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "purchaseorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPurchaseorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingPurchaseorder" }, "patch": { "summary": "Update a purchaseorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "organization_id", "category_ids", "metadata", "attachments", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Purchaseorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingPurchaseorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "purchaseorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPurchaseorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingPurchaseorder" }, "delete": { "summary": "Remove a purchaseorder", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Purchaseorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "purchaseorder" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingPurchaseorder" } }, "/accounting/{connection_id}/salesorder": { "post": { "summary": "Create a salesorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "sales_channel", "organization_id", "fees", "category_ids", "metadata", "order_number", "location_id", "employee_user_id", "device_id", "fulfillment_type", "guest_count", "subtotal_amount", "tax_amount", "discount_amount", "tip_amount", "service_charge_amount", "refunded_amount", "closed_at", "subscription_id", "payments", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingSalesorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "salesorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingSalesorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingSalesorder" }, "get": { "summary": "List all salesorders", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "sales_channel", "organization_id", "fees", "category_ids", "metadata", "order_number", "location_id", "employee_user_id", "device_id", "fulfillment_type", "guest_count", "subtotal_amount", "tax_amount", "discount_amount", "tip_amount", "service_charge_amount", "refunded_amount", "closed_at", "subscription_id", "payments", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "salesorder" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingSalesorder" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingSalesorders" } }, "/accounting/{connection_id}/salesorder/{id}": { "get": { "summary": "Retrieve a salesorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "sales_channel", "organization_id", "fees", "category_ids", "metadata", "order_number", "location_id", "employee_user_id", "device_id", "fulfillment_type", "guest_count", "subtotal_amount", "tax_amount", "discount_amount", "tip_amount", "service_charge_amount", "refunded_amount", "closed_at", "subscription_id", "payments", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Salesorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "salesorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingSalesorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingSalesorder" }, "put": { "summary": "Update a salesorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "sales_channel", "organization_id", "fees", "category_ids", "metadata", "order_number", "location_id", "employee_user_id", "device_id", "fulfillment_type", "guest_count", "subtotal_amount", "tax_amount", "discount_amount", "tip_amount", "service_charge_amount", "refunded_amount", "closed_at", "subscription_id", "payments", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Salesorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingSalesorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "salesorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingSalesorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingSalesorder" }, "patch": { "summary": "Update a salesorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "posted_at", "contact_id", "account_id", "currency", "total_amount", "shipping_address", "billing_address", "status", "lineitems", "sales_channel", "organization_id", "fees", "category_ids", "metadata", "order_number", "location_id", "employee_user_id", "device_id", "fulfillment_type", "guest_count", "subtotal_amount", "tax_amount", "discount_amount", "tip_amount", "service_charge_amount", "refunded_amount", "closed_at", "subscription_id", "payments", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Salesorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingSalesorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "salesorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingSalesorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingSalesorder" }, "delete": { "summary": "Remove a salesorder", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Salesorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "salesorder" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingSalesorder" } }, "/accounting/{connection_id}/salesreceipt/{id}": { "get": { "summary": "Retrieve a salesreceipt", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "metadata", "raw", "receipt_number", "reference", "contact_id", "account_id", "posted_at", "currency", "exchange_rate", "sub_total_amount", "tax_amount", "discount_amount", "total_amount", "is_inclusive_of_tax", "payment_method", "notes", "lineitems", "billing_address", "shipping_address", "category_ids", "project_id", "attachments", "status" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Salesreceipt", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "salesreceipt" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingSalesreceipt" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingSalesreceipt" } }, "/accounting/{connection_id}/salesreceipt": { "get": { "summary": "List all salesreceipts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "metadata", "raw", "receipt_number", "reference", "contact_id", "account_id", "posted_at", "currency", "exchange_rate", "sub_total_amount", "tax_amount", "discount_amount", "total_amount", "is_inclusive_of_tax", "payment_method", "notes", "lineitems", "billing_address", "shipping_address", "category_ids", "project_id", "attachments", "status" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "salesreceipt" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingSalesreceipt" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingSalesreceipts" } }, "/accounting/{connection_id}/balancesheet/{id}": { "get": { "summary": "Retrieve a balancesheet", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "name", "currency", "net_assets_amount", "assets", "liabilities", "equity", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Balancesheet", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "balancesheet" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBalancesheet" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingBalancesheet" } }, "/accounting/{connection_id}/balancesheet": { "get": { "summary": "List all balancesheets", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "category_id", "in": "query", "required": false, "description": "The category ID to filter by (reference to AccountingCategory)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "name", "currency", "net_assets_amount", "assets", "liabilities", "equity", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "balancesheet" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingBalancesheet" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingBalancesheets" } }, "/accounting/{connection_id}/trialbalance/{id}": { "get": { "summary": "Retrieve a trialbalance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "name", "currency", "end_at", "total_debit_amount", "total_credit_amount", "sub_items", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Trialbalance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "trialbalance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingTrialbalance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingTrialbalance" } }, "/accounting/{connection_id}/trialbalance": { "get": { "summary": "List all trialbalances", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "name", "currency", "end_at", "total_debit_amount", "total_credit_amount", "sub_items", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "trialbalance" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingTrialbalance" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingTrialbalances" } }, "/accounting/{connection_id}/profitloss/{id}": { "get": { "summary": "Retrieve a profitloss", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "category_ids", "start_at", "end_at", "name", "currency", "income_total_amount", "net_income_amount", "expenses_total_amount", "cost_of_goods_sold_total_amount", "income_sections", "expenses_sections", "cost_of_goods_sold_sections", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Profitloss", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "profitloss" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingProfitloss" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingProfitloss" } }, "/accounting/{connection_id}/profitloss": { "get": { "summary": "List all profitlosses", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "category_id", "in": "query", "required": false, "description": "The category ID to filter by (reference to AccountingCategory)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "category_ids", "start_at", "end_at", "name", "currency", "income_total_amount", "net_income_amount", "expenses_total_amount", "cost_of_goods_sold_total_amount", "income_sections", "expenses_sections", "cost_of_goods_sold_sections", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "profitloss" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingProfitloss" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingProfitlosses" } }, "/accounting/{connection_id}/cashflow/{id}": { "get": { "summary": "Retrieve a cashflow", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "category_ids", "contact_id", "name", "currency", "cash_beginning_amount", "cash_ending_amount", "net_change_in_cash_amount", "operating_sections", "investing_sections", "financing_sections", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Cashflow", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "cashflow" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCashflow" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingCashflow" } }, "/accounting/{connection_id}/cashflow": { "get": { "summary": "List all cashflows", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "category_id", "in": "query", "required": false, "description": "The category ID to filter by (reference to AccountingCategory)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "category_ids", "contact_id", "name", "currency", "cash_beginning_amount", "cash_ending_amount", "net_change_in_cash_amount", "operating_sections", "investing_sections", "financing_sections", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "cashflow" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingCashflow" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingCashflows" } }, "/accounting/{connection_id}/category": { "post": { "summary": "Create a category", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "type", "code", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingCategory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "category" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCategory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingCategory" }, "get": { "summary": "List all categories", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "type", "code", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "category" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingCategory" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingCategories" } }, "/accounting/{connection_id}/category/{id}": { "get": { "summary": "Retrieve a category", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "type", "code", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Category", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "category" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCategory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingCategory" }, "put": { "summary": "Update a category", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "type", "code", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Category", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingCategory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "category" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCategory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingCategory" }, "patch": { "summary": "Update a category", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "parent_id", "type", "code", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Category", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingCategory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "category" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingCategory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingCategory" }, "delete": { "summary": "Remove a category", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Category", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "category" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingCategory" } }, "/accounting/{connection_id}/expense": { "post": { "summary": "Create an expense", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "contact_id", "account_id", "name", "payment_method", "posted_at", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "approver_user_id", "lineitems", "attachments", "organization_id", "users", "approver_users", "status", "external_number", "category_ids", "project_id", "metadata", "taxrate_id", "exchange_rate", "type", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingExpense" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expense" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingExpense" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingExpense" }, "get": { "summary": "List all expenses", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "approver_user_id", "in": "query", "required": false, "description": "The expense approver user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "category_id", "in": "query", "required": false, "description": "The category ID to filter by (reference to AccountingCategory)" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "DRAFT", "SUBMITTED", "PENDING", "APPROVED", "REJECTED", "PAID" ] }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "USER", "COMPANY" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "contact_id", "account_id", "name", "payment_method", "posted_at", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "approver_user_id", "lineitems", "attachments", "organization_id", "users", "approver_users", "status", "external_number", "category_ids", "project_id", "metadata", "taxrate_id", "exchange_rate", "type", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expense" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingExpense" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingExpenses" } }, "/accounting/{connection_id}/expense/{id}": { "get": { "summary": "Retrieve an expense", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "contact_id", "account_id", "name", "payment_method", "posted_at", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "approver_user_id", "lineitems", "attachments", "organization_id", "users", "approver_users", "status", "external_number", "category_ids", "project_id", "metadata", "taxrate_id", "exchange_rate", "type", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expense", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expense" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingExpense" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingExpense" }, "put": { "summary": "Update an expense", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "contact_id", "account_id", "name", "payment_method", "posted_at", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "approver_user_id", "lineitems", "attachments", "organization_id", "users", "approver_users", "status", "external_number", "category_ids", "project_id", "metadata", "taxrate_id", "exchange_rate", "type", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expense", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingExpense" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expense" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingExpense" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingExpense" }, "patch": { "summary": "Update an expense", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "contact_id", "account_id", "name", "payment_method", "posted_at", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "approver_user_id", "lineitems", "attachments", "organization_id", "users", "approver_users", "status", "external_number", "category_ids", "project_id", "metadata", "taxrate_id", "exchange_rate", "type", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expense", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingExpense" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expense" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingExpense" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingExpense" }, "delete": { "summary": "Remove an expense", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expense", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expense" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingExpense" } }, "/accounting/{connection_id}/expensereport": { "post": { "summary": "Create an expensereport", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "user_id", "approver_user_id", "approver_users", "status", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "posted_at", "external_number", "lineitems", "attachments", "category_ids", "project_id", "users", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingExpensereport" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expensereport" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingExpensereport" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingExpensereport" }, "get": { "summary": "List all expensereports", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "approver_user_id", "in": "query", "required": false, "description": "The expense approver user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "category_id", "in": "query", "required": false, "description": "The category ID to filter by (reference to AccountingCategory)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "DRAFT", "SUBMITTED", "PENDING", "APPROVED", "REJECTED", "PAID" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "user_id", "approver_user_id", "approver_users", "status", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "posted_at", "external_number", "lineitems", "attachments", "category_ids", "project_id", "users", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expensereport" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingExpensereport" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingExpensereports" } }, "/accounting/{connection_id}/expensereport/{id}": { "get": { "summary": "Retrieve an expensereport", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "user_id", "approver_user_id", "approver_users", "status", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "posted_at", "external_number", "lineitems", "attachments", "category_ids", "project_id", "users", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expensereport", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expensereport" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingExpensereport" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingExpensereport" }, "put": { "summary": "Update an expensereport", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "user_id", "approver_user_id", "approver_users", "status", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "posted_at", "external_number", "lineitems", "attachments", "category_ids", "project_id", "users", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expensereport", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingExpensereport" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expensereport" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingExpensereport" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingExpensereport" }, "patch": { "summary": "Update an expensereport", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "user_id", "approver_user_id", "approver_users", "status", "total_amount", "currency", "tax_amount", "reimbursed_amount", "reimbursed_at", "approved_at", "posted_at", "external_number", "lineitems", "attachments", "category_ids", "project_id", "users", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expensereport", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingExpensereport" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expensereport" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingExpensereport" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingExpensereport" }, "delete": { "summary": "Remove an expensereport", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expensereport", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "expensereport" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingExpensereport" } }, "/accounting/{connection_id}/purchasereceipt/{id}": { "get": { "summary": "Retrieve a purchasereceipt", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "metadata", "raw", "receipt_number", "contact_id", "purchaseorder_id", "posted_at", "status", "currency", "total_amount", "notes", "lineitems", "attachments" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Purchasereceipt", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "purchasereceipt" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingPurchasereceipt" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingPurchasereceipt" } }, "/accounting/{connection_id}/purchasereceipt": { "get": { "summary": "List all purchasereceipts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "metadata", "raw", "receipt_number", "contact_id", "purchaseorder_id", "posted_at", "status", "currency", "total_amount", "notes", "lineitems", "attachments" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "purchasereceipt" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingPurchasereceipt" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingPurchasereceipts" } }, "/accounting/{connection_id}/quote": { "post": { "summary": "Create a quote", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "quote_number", "reference", "title", "summary", "payment_terms", "customer_message", "memo", "contact_id", "contacts", "issued_at", "expires_at", "sent_at", "accepted_at", "declined_at", "status", "currency", "currency_rate", "sub_total_amount", "tax_amount", "discount_amount", "total_amount", "tax_mode", "lineitems", "invoice_id", "project_id", "group_id", "category_ids", "url", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingQuote" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "quote" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingQuote" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingQuote" }, "get": { "summary": "List all quotes", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "project_id", "in": "query", "required": false, "description": "The project ID to filter by (reference to TaskProject)" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "DRAFT", "SENT", "ACCEPTED", "DECLINED", "INVOICED", "EXPIRED", "VOIDED", "DELETED" ] }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "quote_number", "reference", "title", "summary", "payment_terms", "customer_message", "memo", "contact_id", "contacts", "issued_at", "expires_at", "sent_at", "accepted_at", "declined_at", "status", "currency", "currency_rate", "sub_total_amount", "tax_amount", "discount_amount", "total_amount", "tax_mode", "lineitems", "invoice_id", "project_id", "group_id", "category_ids", "url", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "quote" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingQuote" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingQuotes" } }, "/accounting/{connection_id}/quote/{id}": { "get": { "summary": "Retrieve a quote", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "quote_number", "reference", "title", "summary", "payment_terms", "customer_message", "memo", "contact_id", "contacts", "issued_at", "expires_at", "sent_at", "accepted_at", "declined_at", "status", "currency", "currency_rate", "sub_total_amount", "tax_amount", "discount_amount", "total_amount", "tax_mode", "lineitems", "invoice_id", "project_id", "group_id", "category_ids", "url", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Quote", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "quote" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingQuote" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingQuote" }, "put": { "summary": "Update a quote", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "quote_number", "reference", "title", "summary", "payment_terms", "customer_message", "memo", "contact_id", "contacts", "issued_at", "expires_at", "sent_at", "accepted_at", "declined_at", "status", "currency", "currency_rate", "sub_total_amount", "tax_amount", "discount_amount", "total_amount", "tax_mode", "lineitems", "invoice_id", "project_id", "group_id", "category_ids", "url", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Quote", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingQuote" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "quote" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingQuote" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingQuote" }, "patch": { "summary": "Update a quote", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "quote_number", "reference", "title", "summary", "payment_terms", "customer_message", "memo", "contact_id", "contacts", "issued_at", "expires_at", "sent_at", "accepted_at", "declined_at", "status", "currency", "currency_rate", "sub_total_amount", "tax_amount", "discount_amount", "total_amount", "tax_mode", "lineitems", "invoice_id", "project_id", "group_id", "category_ids", "url", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Quote", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingQuote" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "quote" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingQuote" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingQuote" }, "delete": { "summary": "Remove a quote", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Quote", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "quote" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingQuote" } }, "/accounting/{connection_id}/agedreceivable/{id}": { "get": { "summary": "Retrieve an agedreceivable", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "currency", "start_at", "end_at", "total_current_amount", "total_overdue_amount", "total_amount", "periods", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Agedreceivable", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "agedreceivable" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingAgedreceivable" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingAgedreceivable" } }, "/accounting/{connection_id}/agedreceivable": { "get": { "summary": "List all agedreceivables", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "currency", "start_at", "end_at", "total_current_amount", "total_overdue_amount", "total_amount", "periods", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "agedreceivable" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingAgedreceivable" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingAgedreceivables" } }, "/accounting/{connection_id}/agedpayable/{id}": { "get": { "summary": "Retrieve an agedpayable", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "currency", "start_at", "end_at", "total_current_amount", "total_overdue_amount", "total_amount", "periods", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Agedpayable", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "agedpayable" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingAgedpayable" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingAgedpayable" } }, "/accounting/{connection_id}/agedpayable": { "get": { "summary": "List all agedpayables", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "currency", "start_at", "end_at", "total_current_amount", "total_overdue_amount", "total_amount", "periods", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "agedpayable" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingAgedpayable" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingAgedpayables" } }, "/accounting/{connection_id}/project": { "post": { "summary": "Create a project", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "description", "status", "is_active", "is_billable", "contact_id", "parent_id", "manager_user_id", "started_at", "due_at", "ended_at", "currency", "estimate_amount", "estimated_cost_amount", "actual_cost_amount", "invoiced_amount", "to_be_invoiced_amount", "expense_amount", "deposit_amount", "deposit_applied_amount", "credit_note_amount", "minutes_logged", "minutes_to_be_invoiced", "percent_complete", "billing_type", "category_ids", "location_id", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingProject" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "project" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingProject" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingProject" }, "get": { "summary": "List all projects", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "NOT_STARTED", "IN_PROGRESS", "ON_HOLD", "COMPLETED", "CANCELLED", "CLOSED" ] }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "description", "status", "is_active", "is_billable", "contact_id", "parent_id", "manager_user_id", "started_at", "due_at", "ended_at", "currency", "estimate_amount", "estimated_cost_amount", "actual_cost_amount", "invoiced_amount", "to_be_invoiced_amount", "expense_amount", "deposit_amount", "deposit_applied_amount", "credit_note_amount", "minutes_logged", "minutes_to_be_invoiced", "percent_complete", "billing_type", "category_ids", "location_id", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "project" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingProject" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingProjects" } }, "/accounting/{connection_id}/project/{id}": { "get": { "summary": "Retrieve a project", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "description", "status", "is_active", "is_billable", "contact_id", "parent_id", "manager_user_id", "started_at", "due_at", "ended_at", "currency", "estimate_amount", "estimated_cost_amount", "actual_cost_amount", "invoiced_amount", "to_be_invoiced_amount", "expense_amount", "deposit_amount", "deposit_applied_amount", "credit_note_amount", "minutes_logged", "minutes_to_be_invoiced", "percent_complete", "billing_type", "category_ids", "location_id", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Project", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "project" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingProject" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingProject" }, "put": { "summary": "Update a project", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "description", "status", "is_active", "is_billable", "contact_id", "parent_id", "manager_user_id", "started_at", "due_at", "ended_at", "currency", "estimate_amount", "estimated_cost_amount", "actual_cost_amount", "invoiced_amount", "to_be_invoiced_amount", "expense_amount", "deposit_amount", "deposit_applied_amount", "credit_note_amount", "minutes_logged", "minutes_to_be_invoiced", "percent_complete", "billing_type", "category_ids", "location_id", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Project", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingProject" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "project" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingProject" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingProject" }, "patch": { "summary": "Update a project", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "description", "status", "is_active", "is_billable", "contact_id", "parent_id", "manager_user_id", "started_at", "due_at", "ended_at", "currency", "estimate_amount", "estimated_cost_amount", "actual_cost_amount", "invoiced_amount", "to_be_invoiced_amount", "expense_amount", "deposit_amount", "deposit_applied_amount", "credit_note_amount", "minutes_logged", "minutes_to_be_invoiced", "percent_complete", "billing_type", "category_ids", "location_id", "organization_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Project", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingProject" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "project" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingProject" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingProject" }, "delete": { "summary": "Remove a project", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Project", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "project" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingProject" } }, "/accounting/{connection_id}/bankfeedaccount": { "post": { "summary": "Create a bankfeedaccount", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "name", "bank_name", "account_number", "account_number_last4", "routing_number", "account_type", "account_id", "currency", "balance", "feed_start_at", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBankfeedaccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedaccount" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBankfeedaccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingBankfeedaccount" }, "get": { "summary": "List all bankfeedaccounts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "CHECKING", "SAVINGS", "CREDIT_CARD", "LOAN", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "name", "bank_name", "account_number", "account_number_last4", "routing_number", "account_type", "account_id", "currency", "balance", "feed_start_at", "status", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedaccount" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingBankfeedaccount" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingBankfeedaccounts" } }, "/accounting/{connection_id}/bankfeedaccount/{id}": { "get": { "summary": "Retrieve a bankfeedaccount", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "name", "bank_name", "account_number", "account_number_last4", "routing_number", "account_type", "account_id", "currency", "balance", "feed_start_at", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankfeedaccount", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedaccount" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBankfeedaccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingBankfeedaccount" }, "put": { "summary": "Update a bankfeedaccount", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "name", "bank_name", "account_number", "account_number_last4", "routing_number", "account_type", "account_id", "currency", "balance", "feed_start_at", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankfeedaccount", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBankfeedaccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedaccount" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBankfeedaccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingBankfeedaccount" }, "patch": { "summary": "Update a bankfeedaccount", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "name", "bank_name", "account_number", "account_number_last4", "routing_number", "account_type", "account_id", "currency", "balance", "feed_start_at", "status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankfeedaccount", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBankfeedaccount" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedaccount" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBankfeedaccount" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingBankfeedaccount" }, "delete": { "summary": "Remove a bankfeedaccount", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankfeedaccount", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedaccount" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingBankfeedaccount" } }, "/accounting/{connection_id}/bankfeedtransaction": { "post": { "summary": "Create a bankfeedtransaction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "bankfeedaccount_id", "transaction_at", "posted_at", "amount", "type", "bank_category", "description", "merchant_name", "is_pending", "reference", "currency", "contact_id", "account_id", "category_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBankfeedtransaction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedtransaction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBankfeedtransaction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAccountingBankfeedtransaction" }, "get": { "summary": "List all bankfeedtransactions", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "bankfeedaccount_id", "in": "query", "required": false, "description": "The BankfeedAccount ID to filter by" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "account_id", "in": "query", "required": false, "description": "The account ID to filter by (reference to AccountingAccount)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "bankfeedaccount_id", "transaction_at", "posted_at", "amount", "type", "bank_category", "description", "merchant_name", "is_pending", "reference", "currency", "contact_id", "account_id", "category_ids", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedtransaction" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountingBankfeedtransaction" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAccountingBankfeedtransactions" } }, "/accounting/{connection_id}/bankfeedtransaction/{id}": { "get": { "summary": "Retrieve a bankfeedtransaction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "bankfeedaccount_id", "transaction_at", "posted_at", "amount", "type", "bank_category", "description", "merchant_name", "is_pending", "reference", "currency", "contact_id", "account_id", "category_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankfeedtransaction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedtransaction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBankfeedtransaction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAccountingBankfeedtransaction" }, "put": { "summary": "Update a bankfeedtransaction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "bankfeedaccount_id", "transaction_at", "posted_at", "amount", "type", "bank_category", "description", "merchant_name", "is_pending", "reference", "currency", "contact_id", "account_id", "category_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankfeedtransaction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBankfeedtransaction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedtransaction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBankfeedtransaction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAccountingBankfeedtransaction" }, "patch": { "summary": "Update a bankfeedtransaction", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "bankfeedaccount_id", "transaction_at", "posted_at", "amount", "type", "bank_category", "description", "merchant_name", "is_pending", "reference", "currency", "contact_id", "account_id", "category_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankfeedtransaction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AccountingBankfeedtransaction" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedtransaction" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AccountingBankfeedtransaction" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAccountingBankfeedtransaction" }, "delete": { "summary": "Remove a bankfeedtransaction", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Bankfeedtransaction", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounting", "bankfeedtransaction" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAccountingBankfeedtransaction" } }, "/storage/{connection_id}/file": { "post": { "summary": "Create a file", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "user_id", "size", "type", "mime_type", "permissions", "download_url", "hash", "data", "version", "web_url", "references", "tags", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/StorageFile" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "storage", "file" ], "responses": { "200": { "schema": { "$ref": "#/definitions/StorageFile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createStorageFile" }, "get": { "summary": "List all files", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "reference", "in": "query", "required": false, "description": "The referenced entity ID to filter by (e.g. linked accounting record for storage_file)" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "The type to filter by" }, { "type": "boolean", "name": "expand", "in": "query", "required": false, "description": "Whether to flatten grouped or recurring items into individual entries." }, { "type": "string", "name": "fulltext", "in": "query", "required": false, "description": "The fulltext to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "user_id", "size", "type", "mime_type", "permissions", "download_url", "hash", "data", "version", "web_url", "references", "tags", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "storage", "file" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/StorageFile" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listStorageFiles" } }, "/storage/{connection_id}/file/{id}": { "get": { "summary": "Retrieve a file", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "user_id", "size", "type", "mime_type", "permissions", "download_url", "hash", "data", "version", "web_url", "references", "tags", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the File", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "storage", "file" ], "responses": { "200": { "schema": { "$ref": "#/definitions/StorageFile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getStorageFile" }, "put": { "summary": "Update a file", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "user_id", "size", "type", "mime_type", "permissions", "download_url", "hash", "data", "version", "web_url", "references", "tags", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the File", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/StorageFile" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "storage", "file" ], "responses": { "200": { "schema": { "$ref": "#/definitions/StorageFile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateStorageFile" }, "patch": { "summary": "Update a file", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "user_id", "size", "type", "mime_type", "permissions", "download_url", "hash", "data", "version", "web_url", "references", "tags", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the File", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/StorageFile" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "storage", "file" ], "responses": { "200": { "schema": { "$ref": "#/definitions/StorageFile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathStorageFile" }, "delete": { "summary": "Remove a file", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the File", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "storage", "file" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeStorageFile" } }, "/commerce/{connection_id}/item": { "post": { "summary": "Create an item", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "slug", "description", "global_code", "public_description", "is_active", "is_taxable", "vendor_name", "type", "is_visible", "is_featured", "weight", "weight_unit", "requires_shipping", "prices", "inventory_id", "total_stock", "tags", "media", "account_id", "metadata", "collections", "taxrate_id", "location_id", "duration", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceItem" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "item" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceItem" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCommerceItem" }, "get": { "summary": "List all items", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "collection_id", "in": "query", "required": false, "description": "The collection ID to filter by (reference to CommerceCollection)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "slug", "description", "global_code", "public_description", "is_active", "is_taxable", "vendor_name", "type", "is_visible", "is_featured", "weight", "weight_unit", "requires_shipping", "prices", "inventory_id", "total_stock", "tags", "media", "account_id", "metadata", "collections", "taxrate_id", "location_id", "duration", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "item" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceItem" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceItems" } }, "/commerce/{connection_id}/item/{id}": { "get": { "summary": "Retrieve an item", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "slug", "description", "global_code", "public_description", "is_active", "is_taxable", "vendor_name", "type", "is_visible", "is_featured", "weight", "weight_unit", "requires_shipping", "prices", "inventory_id", "total_stock", "tags", "media", "account_id", "metadata", "collections", "taxrate_id", "location_id", "duration", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Item", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "item" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceItem" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCommerceItem" }, "put": { "summary": "Update an item", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "slug", "description", "global_code", "public_description", "is_active", "is_taxable", "vendor_name", "type", "is_visible", "is_featured", "weight", "weight_unit", "requires_shipping", "prices", "inventory_id", "total_stock", "tags", "media", "account_id", "metadata", "collections", "taxrate_id", "location_id", "duration", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Item", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceItem" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "item" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceItem" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCommerceItem" }, "patch": { "summary": "Update an item", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "slug", "description", "global_code", "public_description", "is_active", "is_taxable", "vendor_name", "type", "is_visible", "is_featured", "weight", "weight_unit", "requires_shipping", "prices", "inventory_id", "total_stock", "tags", "media", "account_id", "metadata", "collections", "taxrate_id", "location_id", "duration", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Item", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceItem" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "item" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceItem" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCommerceItem" }, "delete": { "summary": "Remove an item", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Item", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "item" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCommerceItem" } }, "/commerce/{connection_id}/collection": { "post": { "summary": "Create a collection", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "media", "is_visible", "is_active", "is_featured", "tags", "type", "parent_id", "metadata", "item_metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceCollection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "collection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceCollection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCommerceCollection" }, "get": { "summary": "List all collections", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "COLLECTION", "SAVED_SEARCH", "CATEGORY" ] }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "saleschannel_id", "in": "query", "required": false, "description": "The saleschannel ID to filter by (reference to CommerceSaleschannel)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "media", "is_visible", "is_active", "is_featured", "tags", "type", "parent_id", "metadata", "item_metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "collection" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceCollection" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceCollections" } }, "/commerce/{connection_id}/collection/{id}": { "get": { "summary": "Retrieve a collection", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "media", "is_visible", "is_active", "is_featured", "tags", "type", "parent_id", "metadata", "item_metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Collection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "collection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceCollection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCommerceCollection" }, "put": { "summary": "Update a collection", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "media", "is_visible", "is_active", "is_featured", "tags", "type", "parent_id", "metadata", "item_metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Collection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceCollection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "collection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceCollection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCommerceCollection" }, "patch": { "summary": "Update a collection", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "media", "is_visible", "is_active", "is_featured", "tags", "type", "parent_id", "metadata", "item_metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Collection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceCollection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "collection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceCollection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCommerceCollection" }, "delete": { "summary": "Remove a collection", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Collection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "collection" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCommerceCollection" } }, "/commerce/{connection_id}/inventory": { "post": { "summary": "Create an inventory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "updated_at", "item_id", "item_variant_id", "item_option_id", "location_id", "available", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceInventory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "inventory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceInventory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCommerceInventory" }, "get": { "summary": "List all inventories", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "item_variant_id", "in": "query", "required": false, "description": "The item variant ID to filter by (reference to CommerceCommerceItemvariant)" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by (reference to CommerceLocation)" }, { "type": "string", "name": "item_id", "in": "query", "required": false, "description": "The item ID to filter by (reference to CommerceItem)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "updated_at", "item_id", "item_variant_id", "item_option_id", "location_id", "available", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "inventory" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceInventory" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceInventories" } }, "/commerce/{connection_id}/inventory/{id}": { "get": { "summary": "Retrieve an inventory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "updated_at", "item_id", "item_variant_id", "item_option_id", "location_id", "available", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Inventory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "inventory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceInventory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCommerceInventory" }, "put": { "summary": "Update an inventory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "updated_at", "item_id", "item_variant_id", "item_option_id", "location_id", "available", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Inventory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceInventory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "inventory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceInventory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCommerceInventory" }, "patch": { "summary": "Update an inventory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "updated_at", "item_id", "item_variant_id", "item_option_id", "location_id", "available", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Inventory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceInventory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "inventory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceInventory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCommerceInventory" }, "delete": { "summary": "Remove an inventory", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Inventory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "inventory" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCommerceInventory" } }, "/commerce/{connection_id}/location": { "post": { "summary": "Create a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "description", "is_active", "language_locale", "parent_id", "currency", "location_type", "telephones", "rating", "review_count", "price_level", "latitude", "longitude", "image_url", "web_url", "media", "metadata", "raw", "categories" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceLocation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCommerceLocation" }, "get": { "summary": "List all locations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "description", "is_active", "language_locale", "parent_id", "currency", "location_type", "telephones", "rating", "review_count", "price_level", "latitude", "longitude", "image_url", "web_url", "media", "metadata", "raw", "categories" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "location" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceLocation" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceLocations" } }, "/commerce/{connection_id}/location/{id}": { "get": { "summary": "Retrieve a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "description", "is_active", "language_locale", "parent_id", "currency", "location_type", "telephones", "rating", "review_count", "price_level", "latitude", "longitude", "image_url", "web_url", "media", "metadata", "raw", "categories" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCommerceLocation" }, "put": { "summary": "Update a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "description", "is_active", "language_locale", "parent_id", "currency", "location_type", "telephones", "rating", "review_count", "price_level", "latitude", "longitude", "image_url", "web_url", "media", "metadata", "raw", "categories" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceLocation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCommerceLocation" }, "patch": { "summary": "Update a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "address", "description", "is_active", "language_locale", "parent_id", "currency", "location_type", "telephones", "rating", "review_count", "price_level", "latitude", "longitude", "image_url", "web_url", "media", "metadata", "raw", "categories" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceLocation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCommerceLocation" }, "delete": { "summary": "Remove a location", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "location" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCommerceLocation" } }, "/commerce/{connection_id}/review": { "post": { "summary": "Create a review", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "item_id", "item_variant_id", "location_id", "rating", "title", "content", "author_name", "author_email", "author_avatar_url", "author_location", "verified_purchase", "helpful_votes", "unhelpful_votes", "media", "status", "is_verified", "is_featured", "is_public", "comments", "metadata", "url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceReview" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "review" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceReview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCommerceReview" }, "get": { "summary": "List all reviews", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "item_id", "in": "query", "required": false, "description": "The item ID to filter by (reference to CommerceItem)" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by (reference to CommerceLocation)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "item_id", "item_variant_id", "location_id", "rating", "title", "content", "author_name", "author_email", "author_avatar_url", "author_location", "verified_purchase", "helpful_votes", "unhelpful_votes", "media", "status", "is_verified", "is_featured", "is_public", "comments", "metadata", "url", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "review" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceReview" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceReviews" } }, "/commerce/{connection_id}/review/{id}": { "get": { "summary": "Retrieve a review", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "item_id", "item_variant_id", "location_id", "rating", "title", "content", "author_name", "author_email", "author_avatar_url", "author_location", "verified_purchase", "helpful_votes", "unhelpful_votes", "media", "status", "is_verified", "is_featured", "is_public", "comments", "metadata", "url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Review", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "review" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceReview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCommerceReview" }, "put": { "summary": "Update a review", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "item_id", "item_variant_id", "location_id", "rating", "title", "content", "author_name", "author_email", "author_avatar_url", "author_location", "verified_purchase", "helpful_votes", "unhelpful_votes", "media", "status", "is_verified", "is_featured", "is_public", "comments", "metadata", "url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Review", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceReview" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "review" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceReview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCommerceReview" }, "patch": { "summary": "Update a review", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "item_id", "item_variant_id", "location_id", "rating", "title", "content", "author_name", "author_email", "author_avatar_url", "author_location", "verified_purchase", "helpful_votes", "unhelpful_votes", "media", "status", "is_verified", "is_featured", "is_public", "comments", "metadata", "url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Review", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceReview" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "review" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceReview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCommerceReview" }, "delete": { "summary": "Remove a review", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Review", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "review" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCommerceReview" } }, "/commerce/{connection_id}/reservation": { "post": { "summary": "Create a reservation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "location_id", "start_at", "end_at", "size", "status", "guest_name", "guest_phone", "guest_email", "notes", "item_id", "item_name", "staff_user_id", "staff_name", "created_at", "updated_at", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceReservation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "reservation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceReservation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCommerceReservation" }, "get": { "summary": "List all reservations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by (reference to CommerceLocation)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "item_id", "in": "query", "required": false, "description": "The item ID to filter by (reference to CommerceItem)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "location_id", "start_at", "end_at", "size", "status", "guest_name", "guest_phone", "guest_email", "notes", "item_id", "item_name", "staff_user_id", "staff_name", "created_at", "updated_at", "url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "reservation" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceReservation" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceReservations" } }, "/commerce/{connection_id}/reservation/{id}": { "get": { "summary": "Retrieve a reservation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "location_id", "start_at", "end_at", "size", "status", "guest_name", "guest_phone", "guest_email", "notes", "item_id", "item_name", "staff_user_id", "staff_name", "created_at", "updated_at", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Reservation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "reservation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceReservation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCommerceReservation" }, "put": { "summary": "Update a reservation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "location_id", "start_at", "end_at", "size", "status", "guest_name", "guest_phone", "guest_email", "notes", "item_id", "item_name", "staff_user_id", "staff_name", "created_at", "updated_at", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Reservation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceReservation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "reservation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceReservation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCommerceReservation" }, "patch": { "summary": "Update a reservation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "location_id", "start_at", "end_at", "size", "status", "guest_name", "guest_phone", "guest_email", "notes", "item_id", "item_name", "staff_user_id", "staff_name", "created_at", "updated_at", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Reservation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceReservation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "reservation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceReservation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCommerceReservation" }, "delete": { "summary": "Remove a reservation", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Reservation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "reservation" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCommerceReservation" } }, "/commerce/{connection_id}/availability": { "get": { "summary": "List all availabilities", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by (reference to CommerceLocation)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "item_id", "in": "query", "required": false, "description": "The item ID to filter by (reference to CommerceItem)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "size", "in": "query", "required": false, "description": "Filter by party size (dining)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "location_id", "start_at", "end_at", "size", "item_id", "staff_user_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "availability" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceAvailability" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceAvailabilities" } }, "/commerce/{connection_id}/saleschannel": { "post": { "summary": "Create a saleschannel", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "slug", "description", "is_active", "collections", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceSaleschannel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "saleschannel" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceSaleschannel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCommerceSaleschannel" }, "get": { "summary": "List all saleschannels", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "slug", "description", "is_active", "collections", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "saleschannel" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceSaleschannel" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceSaleschannels" } }, "/commerce/{connection_id}/saleschannel/{id}": { "get": { "summary": "Retrieve a saleschannel", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "slug", "description", "is_active", "collections", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Saleschannel", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "saleschannel" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceSaleschannel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCommerceSaleschannel" }, "put": { "summary": "Update a saleschannel", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "slug", "description", "is_active", "collections", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Saleschannel", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceSaleschannel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "saleschannel" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceSaleschannel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCommerceSaleschannel" }, "patch": { "summary": "Update a saleschannel", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "slug", "description", "is_active", "collections", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Saleschannel", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceSaleschannel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "saleschannel" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceSaleschannel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCommerceSaleschannel" }, "delete": { "summary": "Remove a saleschannel", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Saleschannel", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "saleschannel" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCommerceSaleschannel" } }, "/commerce/{connection_id}/itemvariant": { "post": { "summary": "Create an itemvariant", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "sku", "is_active", "is_visible", "is_featured", "media", "available_at", "tags", "width", "height", "length", "weight", "size_unit", "weight_unit", "total_stock", "prices", "options", "inventory_id", "requires_shipping", "metadata", "items", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceItemvariant" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "itemvariant" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceItemvariant" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCommerceItemvariant" }, "get": { "summary": "List all itemvariants", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "item_id", "in": "query", "required": false, "description": "The item ID to filter by (reference to CommerceItem)" }, { "type": "string", "name": "collection_id", "in": "query", "required": false, "description": "The collection ID to filter by (reference to CommerceCollection)" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "sku", "is_active", "is_visible", "is_featured", "media", "available_at", "tags", "width", "height", "length", "weight", "size_unit", "weight_unit", "total_stock", "prices", "options", "inventory_id", "requires_shipping", "metadata", "items", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "itemvariant" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemvariant" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCommerceItemvariants" } }, "/commerce/{connection_id}/itemvariant/{id}": { "get": { "summary": "Retrieve an itemvariant", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "sku", "is_active", "is_visible", "is_featured", "media", "available_at", "tags", "width", "height", "length", "weight", "size_unit", "weight_unit", "total_stock", "prices", "options", "inventory_id", "requires_shipping", "metadata", "items", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Itemvariant", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "itemvariant" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceItemvariant" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCommerceItemvariant" }, "put": { "summary": "Update an itemvariant", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "sku", "is_active", "is_visible", "is_featured", "media", "available_at", "tags", "width", "height", "length", "weight", "size_unit", "weight_unit", "total_stock", "prices", "options", "inventory_id", "requires_shipping", "metadata", "items", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Itemvariant", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceItemvariant" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "itemvariant" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceItemvariant" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCommerceItemvariant" }, "patch": { "summary": "Update an itemvariant", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "public_name", "description", "public_description", "sku", "is_active", "is_visible", "is_featured", "media", "available_at", "tags", "width", "height", "length", "weight", "size_unit", "weight_unit", "total_stock", "prices", "options", "inventory_id", "requires_shipping", "metadata", "items", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Itemvariant", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CommerceItemvariant" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "itemvariant" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CommerceItemvariant" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCommerceItemvariant" }, "delete": { "summary": "Remove an itemvariant", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Itemvariant", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "commerce", "itemvariant" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCommerceItemvariant" } }, "/payment/{connection_id}/payment": { "post": { "summary": "Create a payment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "contact_id", "payment_method", "type", "currency", "notes", "invoice_id", "bill_id", "link_id", "account_id", "reference", "organization_id", "allocations", "status", "salesorder_id", "tender_type", "tip_amount", "fee_amount", "location_id", "device_id", "card_brand", "card_last4", "paid_at", "exchange_rate", "category_ids", "net_amount", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentPayment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "payment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentPayment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createPaymentPayment" }, "get": { "summary": "List all payments", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "invoice_id", "in": "query", "required": false, "description": "The invoice ID to filter by (reference to AccountingInvoice)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "link_id", "in": "query", "required": false, "description": "The link ID to filter by" }, { "type": "string", "name": "bill_id", "in": "query", "required": false, "description": "The bill ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "The type to filter by" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AccountingOrganization)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "contact_id", "payment_method", "type", "currency", "notes", "invoice_id", "bill_id", "link_id", "account_id", "reference", "organization_id", "allocations", "status", "salesorder_id", "tender_type", "tip_amount", "fee_amount", "location_id", "device_id", "card_brand", "card_last4", "paid_at", "exchange_rate", "category_ids", "net_amount", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "payment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentPayment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPaymentPayments" } }, "/payment/{connection_id}/payment/{id}": { "get": { "summary": "Retrieve a payment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "contact_id", "payment_method", "type", "currency", "notes", "invoice_id", "bill_id", "link_id", "account_id", "reference", "organization_id", "allocations", "status", "salesorder_id", "tender_type", "tip_amount", "fee_amount", "location_id", "device_id", "card_brand", "card_last4", "paid_at", "exchange_rate", "category_ids", "net_amount", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Payment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "payment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentPayment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPaymentPayment" }, "put": { "summary": "Update a payment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "contact_id", "payment_method", "type", "currency", "notes", "invoice_id", "bill_id", "link_id", "account_id", "reference", "organization_id", "allocations", "status", "salesorder_id", "tender_type", "tip_amount", "fee_amount", "location_id", "device_id", "card_brand", "card_last4", "paid_at", "exchange_rate", "category_ids", "net_amount", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Payment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentPayment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "payment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentPayment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updatePaymentPayment" }, "patch": { "summary": "Update a payment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "contact_id", "payment_method", "type", "currency", "notes", "invoice_id", "bill_id", "link_id", "account_id", "reference", "organization_id", "allocations", "status", "salesorder_id", "tender_type", "tip_amount", "fee_amount", "location_id", "device_id", "card_brand", "card_last4", "paid_at", "exchange_rate", "category_ids", "net_amount", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Payment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentPayment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "payment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentPayment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathPaymentPayment" }, "delete": { "summary": "Remove a payment", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Payment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "payment" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removePaymentPayment" } }, "/payment/{connection_id}/link": { "post": { "summary": "Create a link", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "is_active", "lineitems", "currency", "amount", "payment_id", "contact_id", "url", "description", "is_chargeable_now", "success_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentLink" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "link" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentLink" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createPaymentLink" }, "get": { "summary": "List all links", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "payment_id", "in": "query", "required": false, "description": "The payment ID to filter by (reference to PaymentPayment)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "is_active", "lineitems", "currency", "amount", "payment_id", "contact_id", "url", "description", "is_chargeable_now", "success_url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "link" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentLink" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPaymentLinks" } }, "/payment/{connection_id}/link/{id}": { "get": { "summary": "Retrieve a link", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "is_active", "lineitems", "currency", "amount", "payment_id", "contact_id", "url", "description", "is_chargeable_now", "success_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Link", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "link" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentLink" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPaymentLink" }, "put": { "summary": "Update a link", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "is_active", "lineitems", "currency", "amount", "payment_id", "contact_id", "url", "description", "is_chargeable_now", "success_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Link", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentLink" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "link" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentLink" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updatePaymentLink" }, "patch": { "summary": "Update a link", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "is_active", "lineitems", "currency", "amount", "payment_id", "contact_id", "url", "description", "is_chargeable_now", "success_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Link", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentLink" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "link" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentLink" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathPaymentLink" }, "delete": { "summary": "Remove a link", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Link", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "link" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removePaymentLink" } }, "/payment/{connection_id}/refund/{id}": { "get": { "summary": "Retrieve a refund", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "payment_id", "currency", "notes", "status", "reference", "refunded_at", "reason", "tender_type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Refund", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "refund" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentRefund" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPaymentRefund" } }, "/payment/{connection_id}/refund": { "get": { "summary": "List all refunds", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "payment_id", "in": "query", "required": false, "description": "The payment ID to filter by (reference to PaymentPayment)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "payment_id", "currency", "notes", "status", "reference", "refunded_at", "reason", "tender_type", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "refund" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentRefund" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPaymentRefunds" } }, "/payment/{connection_id}/payout/{id}": { "get": { "summary": "Retrieve a payout", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "currency", "notes", "status", "arrival_at", "fee_amount", "net_amount", "account_id", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Payout", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "payout" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentPayout" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPaymentPayout" } }, "/payment/{connection_id}/payout": { "get": { "summary": "List all payouts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "total_amount", "currency", "notes", "status", "arrival_at", "fee_amount", "net_amount", "account_id", "lineitems", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "payout" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentPayout" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPaymentPayouts" } }, "/payment/{connection_id}/subscription": { "post": { "summary": "Create a subscription", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "description", "contact_id", "invoice_id", "current_period_end_at", "current_period_start_at", "canceled_at", "currency", "total_amount", "start_at", "end_at", "status", "month", "interval_unit", "day_of_month", "day_of_week", "interval", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentSubscription" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "subscription" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentSubscription" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createPaymentSubscription" }, "get": { "summary": "List all subscriptions", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by (reference to AccountingContact)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "description", "contact_id", "invoice_id", "current_period_end_at", "current_period_start_at", "canceled_at", "currency", "total_amount", "start_at", "end_at", "status", "month", "interval_unit", "day_of_month", "day_of_week", "interval", "lineitems", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "subscription" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentSubscription" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPaymentSubscriptions" } }, "/payment/{connection_id}/subscription/{id}": { "get": { "summary": "Retrieve a subscription", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "description", "contact_id", "invoice_id", "current_period_end_at", "current_period_start_at", "canceled_at", "currency", "total_amount", "start_at", "end_at", "status", "month", "interval_unit", "day_of_month", "day_of_week", "interval", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Subscription", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "subscription" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentSubscription" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPaymentSubscription" }, "put": { "summary": "Update a subscription", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "description", "contact_id", "invoice_id", "current_period_end_at", "current_period_start_at", "canceled_at", "currency", "total_amount", "start_at", "end_at", "status", "month", "interval_unit", "day_of_month", "day_of_week", "interval", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Subscription", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentSubscription" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "subscription" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentSubscription" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updatePaymentSubscription" }, "patch": { "summary": "Update a subscription", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "description", "contact_id", "invoice_id", "current_period_end_at", "current_period_start_at", "canceled_at", "currency", "total_amount", "start_at", "end_at", "status", "month", "interval_unit", "day_of_month", "day_of_week", "interval", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Subscription", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PaymentSubscription" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "subscription" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PaymentSubscription" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathPaymentSubscription" }, "delete": { "summary": "Remove a subscription", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Subscription", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "payment", "subscription" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removePaymentSubscription" } }, "/genai/{connection_id}/model/{id}": { "get": { "summary": "Retrieve a model", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "name", "description", "max_tokens", "web_url", "has_temperature", "has_questions", "has_vision", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Model", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "model" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiModel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getGenaiModel" } }, "/genai/{connection_id}/model": { "get": { "summary": "List all models", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "name", "description", "max_tokens", "web_url", "has_temperature", "has_questions", "has_vision", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "model" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/GenaiModel" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listGenaiModels" } }, "/genai/{connection_id}/prompt": { "post": { "summary": "Create a prompt", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "model_id", "messages", "temperature", "max_tokens", "responses", "tokens_used", "mcp_url", "mcp_deferred_tools", "mcp_authorization_token", "questions", "answers", "skill_ids", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiPrompt" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "prompt" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiPrompt" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createGenaiPrompt" } }, "/genai/{connection_id}/embedding": { "post": { "summary": "Create an embedding", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "model_id", "content", "enconding_format", "type", "dimension", "max_tokens", "embeddings", "tokens_used", "raw", "id" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiEmbedding" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "embedding" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiEmbedding" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createGenaiEmbedding" } }, "/genai/{connection_id}/task": { "post": { "summary": "Create a task", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "instructions", "status", "model_id", "user_id", "repo_url", "source_branch_identifier", "target_branch_identifier", "pullrequest_url", "web_url", "messages", "summary", "error", "files_changed", "lines_added", "lines_deleted", "tokens_used", "started_at", "completed_at", "agent_id", "organization_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiTask" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "task" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiTask" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createGenaiTask" }, "get": { "summary": "List all tasks", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "PENDING", "RUNNING", "BLOCKED", "COMPLETED", "FAILED", "CANCELLED", "EXPIRED", "OTHER" ] }, { "type": "string", "name": "agent_id", "in": "query", "required": false, "description": "The agent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "instructions", "status", "model_id", "user_id", "repo_url", "source_branch_identifier", "target_branch_identifier", "pullrequest_url", "web_url", "messages", "summary", "error", "files_changed", "lines_added", "lines_deleted", "tokens_used", "started_at", "completed_at", "agent_id", "organization_id", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "task" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/GenaiTask" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listGenaiTasks" } }, "/genai/{connection_id}/task/{id}": { "get": { "summary": "Retrieve a task", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "instructions", "status", "model_id", "user_id", "repo_url", "source_branch_identifier", "target_branch_identifier", "pullrequest_url", "web_url", "messages", "summary", "error", "files_changed", "lines_added", "lines_deleted", "tokens_used", "started_at", "completed_at", "agent_id", "organization_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Task", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "task" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiTask" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getGenaiTask" }, "put": { "summary": "Update a task", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "instructions", "status", "model_id", "user_id", "repo_url", "source_branch_identifier", "target_branch_identifier", "pullrequest_url", "web_url", "messages", "summary", "error", "files_changed", "lines_added", "lines_deleted", "tokens_used", "started_at", "completed_at", "agent_id", "organization_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Task", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiTask" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "task" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiTask" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateGenaiTask" }, "patch": { "summary": "Update a task", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "instructions", "status", "model_id", "user_id", "repo_url", "source_branch_identifier", "target_branch_identifier", "pullrequest_url", "web_url", "messages", "summary", "error", "files_changed", "lines_added", "lines_deleted", "tokens_used", "started_at", "completed_at", "agent_id", "organization_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Task", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiTask" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "task" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiTask" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathGenaiTask" }, "delete": { "summary": "Remove a task", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Task", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "task" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeGenaiTask" } }, "/genai/{connection_id}/agent": { "post": { "summary": "Create an agent", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "instructions", "model_id", "is_active", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiAgent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "agent" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiAgent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createGenaiAgent" }, "get": { "summary": "List all agents", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "instructions", "model_id", "is_active", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "agent" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/GenaiAgent" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listGenaiAgents" } }, "/genai/{connection_id}/agent/{id}": { "get": { "summary": "Retrieve an agent", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "instructions", "model_id", "is_active", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Agent", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "agent" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiAgent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getGenaiAgent" }, "put": { "summary": "Update an agent", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "instructions", "model_id", "is_active", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Agent", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiAgent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "agent" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiAgent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateGenaiAgent" }, "patch": { "summary": "Update an agent", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "instructions", "model_id", "is_active", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Agent", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiAgent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "agent" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiAgent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathGenaiAgent" }, "delete": { "summary": "Remove an agent", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Agent", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "agent" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeGenaiAgent" } }, "/genai/{connection_id}/organization": { "post": { "summary": "Create an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createGenaiOrganization" }, "get": { "summary": "List all organizations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "organization" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/GenaiOrganization" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listGenaiOrganizations" } }, "/genai/{connection_id}/organization/{id}": { "get": { "summary": "Retrieve an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getGenaiOrganization" }, "put": { "summary": "Update an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateGenaiOrganization" }, "patch": { "summary": "Update an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathGenaiOrganization" }, "delete": { "summary": "Remove an organization", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "organization" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeGenaiOrganization" } }, "/genai/{connection_id}/skill/{id}": { "get": { "summary": "Retrieve a skill", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "version", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Skill", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "skill" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiSkill" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getGenaiSkill" }, "delete": { "summary": "Remove a skill", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Skill", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "skill" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeGenaiSkill" } }, "/genai/{connection_id}/skill": { "get": { "summary": "List all skills", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "version", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "skill" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/GenaiSkill" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listGenaiSkills" } }, "/genai/{connection_id}/memory": { "post": { "summary": "Create a memory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "parent_id", "user_identifier", "name", "content", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiMemory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "memory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiMemory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createGenaiMemory" }, "get": { "summary": "List all memories", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "FOLDER", "MEMORY" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "parent_id", "user_identifier", "name", "content", "description", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "memory" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/GenaiMemory" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listGenaiMemories" } }, "/genai/{connection_id}/memory/{id}": { "get": { "summary": "Retrieve a memory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "parent_id", "user_identifier", "name", "content", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Memory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "memory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiMemory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getGenaiMemory" }, "put": { "summary": "Update a memory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "parent_id", "user_identifier", "name", "content", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Memory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiMemory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "memory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiMemory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateGenaiMemory" }, "patch": { "summary": "Update a memory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "parent_id", "user_identifier", "name", "content", "description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Memory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GenaiMemory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "memory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/GenaiMemory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathGenaiMemory" }, "delete": { "summary": "Remove a memory", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Memory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "genai", "memory" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeGenaiMemory" } }, "/kms/{connection_id}/space": { "post": { "summary": "Create a space", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "is_active", "user_id", "parent_page_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsSpace" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "space" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsSpace" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createKmsSpace" }, "get": { "summary": "List all spaces", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "is_active", "user_id", "parent_page_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "space" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/KmsSpace" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listKmsSpaces" } }, "/kms/{connection_id}/space/{id}": { "get": { "summary": "Retrieve a space", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "is_active", "user_id", "parent_page_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Space", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "space" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsSpace" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getKmsSpace" }, "put": { "summary": "Update a space", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "is_active", "user_id", "parent_page_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Space", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsSpace" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "space" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsSpace" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateKmsSpace" }, "patch": { "summary": "Update a space", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "is_active", "user_id", "parent_page_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Space", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsSpace" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "space" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsSpace" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathKmsSpace" }, "delete": { "summary": "Remove a space", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Space", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "space" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeKmsSpace" } }, "/kms/{connection_id}/page": { "post": { "summary": "Create a page", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "title", "type", "space_id", "parent_id", "is_active", "user_id", "download_url", "metadata", "has_children", "web_url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsPage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "page" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsPage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createKmsPage" }, "get": { "summary": "List all pages", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "space_id", "in": "query", "required": false, "description": "The space ID to filter by (reference to KmsSpace)" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "title", "type", "space_id", "parent_id", "is_active", "user_id", "download_url", "metadata", "has_children", "web_url", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "page" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/KmsPage" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listKmsPages" } }, "/kms/{connection_id}/page/{id}": { "get": { "summary": "Retrieve a page", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "title", "type", "space_id", "parent_id", "is_active", "user_id", "download_url", "metadata", "has_children", "web_url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Page", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "page" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsPage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getKmsPage" }, "put": { "summary": "Update a page", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "title", "type", "space_id", "parent_id", "is_active", "user_id", "download_url", "metadata", "has_children", "web_url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Page", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsPage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "page" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsPage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateKmsPage" }, "patch": { "summary": "Update a page", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "title", "type", "space_id", "parent_id", "is_active", "user_id", "download_url", "metadata", "has_children", "web_url", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Page", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsPage" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "page" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsPage" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathKmsPage" }, "delete": { "summary": "Remove a page", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Page", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "page" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeKmsPage" } }, "/kms/{connection_id}/comment": { "post": { "summary": "Create a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "content_type", "content", "user_id", "page_id", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createKmsComment" }, "get": { "summary": "List all comments", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "page_id", "in": "query", "required": false, "description": "The page ID to filter by (reference to KmsPage)" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "The type to filter by" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "content_type", "content", "user_id", "page_id", "parent_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "comment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/KmsComment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listKmsComments" } }, "/kms/{connection_id}/comment/{id}": { "get": { "summary": "Retrieve a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "content_type", "content", "user_id", "page_id", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getKmsComment" }, "put": { "summary": "Update a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "content_type", "content", "user_id", "page_id", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateKmsComment" }, "patch": { "summary": "Update a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "type", "content_type", "content", "user_id", "page_id", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/KmsComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/KmsComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathKmsComment" }, "delete": { "summary": "Remove a comment", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "kms", "comment" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeKmsComment" } }, "/task/{connection_id}/project": { "post": { "summary": "Create a project", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "user_ids", "group_ids", "description", "has_tasks", "has_children", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskProject" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "project" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskProject" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createTaskProject" }, "get": { "summary": "List all projects", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "user_ids", "group_ids", "description", "has_tasks", "has_children", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "project" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TaskProject" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listTaskProjects" } }, "/task/{connection_id}/project/{id}": { "get": { "summary": "Retrieve a project", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "user_ids", "group_ids", "description", "has_tasks", "has_children", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Project", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "project" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskProject" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getTaskProject" }, "put": { "summary": "Update a project", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "user_ids", "group_ids", "description", "has_tasks", "has_children", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Project", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskProject" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "project" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskProject" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateTaskProject" }, "patch": { "summary": "Update a project", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "user_ids", "group_ids", "description", "has_tasks", "has_children", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Project", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskProject" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "project" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskProject" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathTaskProject" }, "delete": { "summary": "Remove a project", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Project", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "project" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeTaskProject" } }, "/task/{connection_id}/task": { "post": { "summary": "Create a task", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "project_id", "parent_id", "completed_at", "status", "notes", "due_at", "start_at", "end_at", "priority", "assigned_user_ids", "creator_user_id", "follower_user_ids", "group_ids", "tags", "url", "attachment_ids", "metadata", "has_children", "type", "time_spent", "time_spent_unit", "progress", "story_points", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskTask" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "task" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskTask" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createTaskTask" }, "get": { "summary": "List all tasks", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "project_id", "in": "query", "required": false, "description": "The project ID to filter by (reference to TaskProject)" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "status", "in": "query", "required": false, "description": "The status to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "assigned_user_id", "in": "query", "required": false, "description": "The assigned user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "project_id", "parent_id", "completed_at", "status", "notes", "due_at", "start_at", "end_at", "priority", "assigned_user_ids", "creator_user_id", "follower_user_ids", "group_ids", "tags", "url", "attachment_ids", "metadata", "has_children", "type", "time_spent", "time_spent_unit", "progress", "story_points", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "task" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TaskTask" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listTaskTasks" } }, "/task/{connection_id}/task/{id}": { "get": { "summary": "Retrieve a task", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "project_id", "parent_id", "completed_at", "status", "notes", "due_at", "start_at", "end_at", "priority", "assigned_user_ids", "creator_user_id", "follower_user_ids", "group_ids", "tags", "url", "attachment_ids", "metadata", "has_children", "type", "time_spent", "time_spent_unit", "progress", "story_points", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Task", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "task" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskTask" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getTaskTask" }, "put": { "summary": "Update a task", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "project_id", "parent_id", "completed_at", "status", "notes", "due_at", "start_at", "end_at", "priority", "assigned_user_ids", "creator_user_id", "follower_user_ids", "group_ids", "tags", "url", "attachment_ids", "metadata", "has_children", "type", "time_spent", "time_spent_unit", "progress", "story_points", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Task", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskTask" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "task" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskTask" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateTaskTask" }, "patch": { "summary": "Update a task", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "project_id", "parent_id", "completed_at", "status", "notes", "due_at", "start_at", "end_at", "priority", "assigned_user_ids", "creator_user_id", "follower_user_ids", "group_ids", "tags", "url", "attachment_ids", "metadata", "has_children", "type", "time_spent", "time_spent_unit", "progress", "story_points", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Task", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskTask" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "task" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskTask" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathTaskTask" }, "delete": { "summary": "Remove a task", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Task", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "task" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeTaskTask" } }, "/task/{connection_id}/comment": { "post": { "summary": "Create a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "text", "user_id", "user_name", "task_id", "parent_id", "has_children", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createTaskComment" }, "get": { "summary": "List all comments", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "task_id", "in": "query", "required": false, "description": "The task ID to filter by (reference to TaskTask)" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "text", "user_id", "user_name", "task_id", "parent_id", "has_children", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "comment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TaskComment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listTaskComments" } }, "/task/{connection_id}/comment/{id}": { "get": { "summary": "Retrieve a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "text", "user_id", "user_name", "task_id", "parent_id", "has_children", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getTaskComment" }, "put": { "summary": "Update a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "text", "user_id", "user_name", "task_id", "parent_id", "has_children", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateTaskComment" }, "patch": { "summary": "Update a comment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "text", "user_id", "user_name", "task_id", "parent_id", "has_children", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TaskComment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "comment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskComment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathTaskComment" }, "delete": { "summary": "Remove a comment", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Comment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "comment" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeTaskComment" } }, "/task/{connection_id}/change/{id}": { "get": { "summary": "Retrieve a change", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "task_id", "user_id", "items", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Change", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "change" ], "responses": { "200": { "schema": { "$ref": "#/definitions/TaskChange" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getTaskChange" } }, "/task/{connection_id}/change": { "get": { "summary": "List all changes", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "task_id", "in": "query", "required": false, "description": "The task ID to filter by (reference to TaskTask)" }, { "type": "string", "name": "project_id", "in": "query", "required": false, "description": "The project ID to filter by (reference to TaskProject)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "task_id", "user_id", "items", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "task", "change" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/TaskChange" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listTaskChanges" } }, "/calendar/{connection_id}/calendar": { "post": { "summary": "Create a calendar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "timezone", "is_primary", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarCalendar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "calendar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarCalendar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCalendarCalendar" }, "get": { "summary": "List all calendars", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "timezone", "is_primary", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "calendar" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CalendarCalendar" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCalendarCalendars" } }, "/calendar/{connection_id}/calendar/{id}": { "get": { "summary": "Retrieve a calendar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "timezone", "is_primary", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Calendar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "calendar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarCalendar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCalendarCalendar" }, "put": { "summary": "Update a calendar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "timezone", "is_primary", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Calendar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarCalendar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "calendar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarCalendar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCalendarCalendar" }, "patch": { "summary": "Update a calendar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "timezone", "is_primary", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Calendar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarCalendar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "calendar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarCalendar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCalendarCalendar" }, "delete": { "summary": "Remove a calendar", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Calendar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "calendar" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCalendarCalendar" } }, "/calendar/{connection_id}/event": { "post": { "summary": "Create an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "is_all_day", "timezone", "notes", "location", "is_free", "is_private", "status", "organizer", "attendees", "recurring_event_id", "recurrence", "web_url", "has_conference", "conference", "attachments", "send_notifications", "matter_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCalendarEvent" }, "get": { "summary": "List all events", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "calendar_id", "in": "query", "required": false, "description": "The calendar ID to filter by (reference to CalendarCalendar)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "boolean", "name": "expand", "in": "query", "required": false, "description": "Whether to flatten grouped or recurring items into individual entries." }, { "type": "string", "name": "matter_id", "in": "query", "required": false, "description": "The matter ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "is_all_day", "timezone", "notes", "location", "is_free", "is_private", "status", "organizer", "attendees", "recurring_event_id", "recurrence", "web_url", "has_conference", "conference", "attachments", "send_notifications", "matter_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "event" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CalendarEvent" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCalendarEvents" } }, "/calendar/{connection_id}/event/{id}": { "get": { "summary": "Retrieve an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "is_all_day", "timezone", "notes", "location", "is_free", "is_private", "status", "organizer", "attendees", "recurring_event_id", "recurrence", "web_url", "has_conference", "conference", "attachments", "send_notifications", "matter_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCalendarEvent" }, "put": { "summary": "Update an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "is_all_day", "timezone", "notes", "location", "is_free", "is_private", "status", "organizer", "attendees", "recurring_event_id", "recurrence", "web_url", "has_conference", "conference", "attachments", "send_notifications", "matter_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCalendarEvent" }, "patch": { "summary": "Update an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "is_all_day", "timezone", "notes", "location", "is_free", "is_private", "status", "organizer", "attendees", "recurring_event_id", "recurrence", "web_url", "has_conference", "conference", "attachments", "send_notifications", "matter_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCalendarEvent" }, "delete": { "summary": "Remove an event", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "event" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCalendarEvent" } }, "/calendar/{connection_id}/busy": { "get": { "summary": "List all busies", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "calendar_id", "in": "query", "required": false, "description": "The calendar ID to get availability for. Typically user's email or user ID. (reference to CalendarCalendar)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "start_at", "end_at", "timezone", "description", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "busy" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CalendarBusy" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCalendarBusies" } }, "/calendar/{connection_id}/link": { "post": { "summary": "Create a link", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "url", "duration", "description", "is_active", "price_amount", "price_currency", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarLink" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "link" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarLink" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCalendarLink" }, "get": { "summary": "List all links", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "url", "duration", "description", "is_active", "price_amount", "price_currency", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "link" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CalendarLink" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCalendarLinks" } }, "/calendar/{connection_id}/link/{id}": { "get": { "summary": "Retrieve a link", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "url", "duration", "description", "is_active", "price_amount", "price_currency", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Link", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "link" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarLink" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCalendarLink" }, "put": { "summary": "Update a link", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "url", "duration", "description", "is_active", "price_amount", "price_currency", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Link", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarLink" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "link" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarLink" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCalendarLink" }, "patch": { "summary": "Update a link", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "url", "duration", "description", "is_active", "price_amount", "price_currency", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Link", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarLink" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "link" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarLink" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCalendarLink" }, "delete": { "summary": "Remove a link", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Link", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "link" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCalendarLink" } }, "/calendar/{connection_id}/recording/{id}": { "get": { "summary": "Retrieve a recording", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "expires_at", "event_id", "web_url", "media", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Recording", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "recording" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarRecording" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCalendarRecording" } }, "/calendar/{connection_id}/recording": { "get": { "summary": "List all recordings", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "event_id", "in": "query", "required": false, "description": "The event ID to filter by (reference to CalendarEvent)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "expires_at", "event_id", "web_url", "media", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "recording" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CalendarRecording" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCalendarRecordings" } }, "/calendar/{connection_id}/webinar": { "post": { "summary": "Create a webinar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "timezone", "notes", "status", "organizer", "join_url", "web_url", "panelists", "registrants", "panelist_password", "registrant_password", "conference", "recurrence", "capacity", "is_webcast", "is_enabled", "is_auto_approve", "require_first_name", "require_last_name", "require_email", "require_company", "require_job_title", "require_address", "require_phone", "has_qa", "has_polls", "has_recording", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarWebinar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "webinar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarWebinar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCalendarWebinar" }, "get": { "summary": "List all webinars", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "timezone", "notes", "status", "organizer", "join_url", "web_url", "panelists", "registrants", "panelist_password", "registrant_password", "conference", "recurrence", "capacity", "is_webcast", "is_enabled", "is_auto_approve", "require_first_name", "require_last_name", "require_email", "require_company", "require_job_title", "require_address", "require_phone", "has_qa", "has_polls", "has_recording", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "webinar" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CalendarWebinar" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCalendarWebinars" } }, "/calendar/{connection_id}/webinar/{id}": { "get": { "summary": "Retrieve a webinar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "timezone", "notes", "status", "organizer", "join_url", "web_url", "panelists", "registrants", "panelist_password", "registrant_password", "conference", "recurrence", "capacity", "is_webcast", "is_enabled", "is_auto_approve", "require_first_name", "require_last_name", "require_email", "require_company", "require_job_title", "require_address", "require_phone", "has_qa", "has_polls", "has_recording", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Webinar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "webinar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarWebinar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCalendarWebinar" }, "put": { "summary": "Update a webinar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "timezone", "notes", "status", "organizer", "join_url", "web_url", "panelists", "registrants", "panelist_password", "registrant_password", "conference", "recurrence", "capacity", "is_webcast", "is_enabled", "is_auto_approve", "require_first_name", "require_last_name", "require_email", "require_company", "require_job_title", "require_address", "require_phone", "has_qa", "has_polls", "has_recording", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Webinar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarWebinar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "webinar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarWebinar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCalendarWebinar" }, "patch": { "summary": "Update a webinar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "calendar_id", "subject", "start_at", "end_at", "timezone", "notes", "status", "organizer", "join_url", "web_url", "panelists", "registrants", "panelist_password", "registrant_password", "conference", "recurrence", "capacity", "is_webcast", "is_enabled", "is_auto_approve", "require_first_name", "require_last_name", "require_email", "require_company", "require_job_title", "require_address", "require_phone", "has_qa", "has_polls", "has_recording", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Webinar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CalendarWebinar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "webinar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CalendarWebinar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCalendarWebinar" }, "delete": { "summary": "Remove a webinar", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Webinar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "calendar", "webinar" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCalendarWebinar" } }, "/ads/{connection_id}/organization": { "post": { "summary": "Create an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "currency", "timezone", "parent_id", "status", "account_number", "managers", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAdsOrganization" }, "get": { "summary": "List all organizations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "currency", "timezone", "parent_id", "status", "account_number", "managers", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "organization" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsOrganization" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsOrganizations" } }, "/ads/{connection_id}/organization/{id}": { "get": { "summary": "Retrieve an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "currency", "timezone", "parent_id", "status", "account_number", "managers", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsOrganization" }, "put": { "summary": "Update an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "currency", "timezone", "parent_id", "status", "account_number", "managers", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAdsOrganization" }, "patch": { "summary": "Update an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "currency", "timezone", "parent_id", "status", "account_number", "managers", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAdsOrganization" }, "delete": { "summary": "Remove an organization", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "organization" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAdsOrganization" } }, "/ads/{connection_id}/campaign": { "post": { "summary": "Create a campaign", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "status", "effective_status", "start_at", "end_at", "budget_amount", "budget_period", "budget_unit", "total_spend_amount", "targeting", "goal", "planned_spend_amount", "frequency_cap", "advertising_channel_type", "campaign_budget_identifier", "currency", "category", "has_eu_political_ads", "labels", "kpi", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsCampaign" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "campaign" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsCampaign" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAdsCampaign" }, "get": { "summary": "List all campaigns", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "status", "in": "query", "required": false, "description": "The status to filter by" }, { "type": "string", "name": "goal", "in": "query", "required": false, "enum": [ "UNSPECIFIED", "BRAND_AWARENESS", "ENGAGEMENT", "REACH", "WEBSITE_TRAFFIC", "LEADS", "SALES", "APP_PROMOTION" ] }, { "type": "string", "name": "effective_status", "in": "query", "required": false, "enum": [ "UNSPECIFIED", "SERVING", "LIMITED", "LEARNING", "PAUSED", "PENDING", "ENDED", "MISCONFIGURED", "NOT_ELIGIBLE", "ARCHIVED", "REMOVED" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "status", "effective_status", "start_at", "end_at", "budget_amount", "budget_period", "budget_unit", "total_spend_amount", "targeting", "goal", "planned_spend_amount", "frequency_cap", "advertising_channel_type", "campaign_budget_identifier", "currency", "category", "has_eu_political_ads", "labels", "kpi", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "campaign" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsCampaign" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsCampaigns" } }, "/ads/{connection_id}/campaign/{id}": { "get": { "summary": "Retrieve a campaign", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "status", "effective_status", "start_at", "end_at", "budget_amount", "budget_period", "budget_unit", "total_spend_amount", "targeting", "goal", "planned_spend_amount", "frequency_cap", "advertising_channel_type", "campaign_budget_identifier", "currency", "category", "has_eu_political_ads", "labels", "kpi", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Campaign", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "campaign" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsCampaign" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsCampaign" }, "put": { "summary": "Update a campaign", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "status", "effective_status", "start_at", "end_at", "budget_amount", "budget_period", "budget_unit", "total_spend_amount", "targeting", "goal", "planned_spend_amount", "frequency_cap", "advertising_channel_type", "campaign_budget_identifier", "currency", "category", "has_eu_political_ads", "labels", "kpi", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Campaign", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsCampaign" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "campaign" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsCampaign" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAdsCampaign" }, "patch": { "summary": "Update a campaign", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "status", "effective_status", "start_at", "end_at", "budget_amount", "budget_period", "budget_unit", "total_spend_amount", "targeting", "goal", "planned_spend_amount", "frequency_cap", "advertising_channel_type", "campaign_budget_identifier", "currency", "category", "has_eu_political_ads", "labels", "kpi", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Campaign", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsCampaign" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "campaign" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsCampaign" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAdsCampaign" }, "delete": { "summary": "Remove a campaign", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Campaign", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "campaign" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAdsCampaign" } }, "/ads/{connection_id}/creative": { "post": { "summary": "Create a creative", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "item_id", "organization_id", "status", "creative_type", "hosting_source", "width", "height", "asset_urls", "link_url", "url_tags", "body", "title", "cta", "third_party_tag", "vast_tag_url", "external_creative_reference", "external_placement_reference", "external_ad_reference", "promoted", "path1", "path2", "data", "labels", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsCreative" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "creative" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsCreative" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAdsCreative" }, "get": { "summary": "List all creatives", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to AdsGroup)" }, { "type": "string", "name": "status", "in": "query", "required": false, "description": "The status to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "item_id", "organization_id", "status", "creative_type", "hosting_source", "width", "height", "asset_urls", "link_url", "url_tags", "body", "title", "cta", "third_party_tag", "vast_tag_url", "external_creative_reference", "external_placement_reference", "external_ad_reference", "promoted", "path1", "path2", "data", "labels", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "creative" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsCreative" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsCreatives" } }, "/ads/{connection_id}/creative/{id}": { "get": { "summary": "Retrieve a creative", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "item_id", "organization_id", "status", "creative_type", "hosting_source", "width", "height", "asset_urls", "link_url", "url_tags", "body", "title", "cta", "third_party_tag", "vast_tag_url", "external_creative_reference", "external_placement_reference", "external_ad_reference", "promoted", "path1", "path2", "data", "labels", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Creative", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "creative" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsCreative" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsCreative" }, "put": { "summary": "Update a creative", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "item_id", "organization_id", "status", "creative_type", "hosting_source", "width", "height", "asset_urls", "link_url", "url_tags", "body", "title", "cta", "third_party_tag", "vast_tag_url", "external_creative_reference", "external_placement_reference", "external_ad_reference", "promoted", "path1", "path2", "data", "labels", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Creative", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsCreative" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "creative" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsCreative" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAdsCreative" }, "patch": { "summary": "Update a creative", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "item_id", "organization_id", "status", "creative_type", "hosting_source", "width", "height", "asset_urls", "link_url", "url_tags", "body", "title", "cta", "third_party_tag", "vast_tag_url", "external_creative_reference", "external_placement_reference", "external_ad_reference", "promoted", "path1", "path2", "data", "labels", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Creative", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsCreative" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "creative" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsCreative" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAdsCreative" }, "delete": { "summary": "Remove a creative", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Creative", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "creative" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAdsCreative" } }, "/ads/{connection_id}/asset": { "post": { "summary": "Create an asset", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "name", "type", "url", "content", "mime_type", "width", "height", "file_size", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsAsset" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "asset" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsAsset" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAdsAsset" }, "get": { "summary": "List all assets", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "IMAGE", "VIDEO", "YOUTUBE_VIDEO", "MEDIA_BUNDLE", "TEXT" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "name", "type", "url", "content", "mime_type", "width", "height", "file_size", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "asset" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsAsset" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsAssets" } }, "/ads/{connection_id}/asset/{id}": { "get": { "summary": "Retrieve an asset", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "organization_id", "name", "type", "url", "content", "mime_type", "width", "height", "file_size", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Asset", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "asset" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsAsset" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsAsset" } }, "/ads/{connection_id}/insertionorder": { "post": { "summary": "Create an insertionorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "campaign_id", "status", "pacing", "frequency_cap", "kpi", "budget_unit", "budget_segments", "bid_strategy", "reference", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsInsertionorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "insertionorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsInsertionorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAdsInsertionorder" }, "get": { "summary": "List all insertionorders", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "campaign_id", "in": "query", "required": false, "description": "The campaign ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "campaign_id", "status", "pacing", "frequency_cap", "kpi", "budget_unit", "budget_segments", "bid_strategy", "reference", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "insertionorder" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsInsertionorder" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsInsertionorders" } }, "/ads/{connection_id}/insertionorder/{id}": { "get": { "summary": "Retrieve an insertionorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "campaign_id", "status", "pacing", "frequency_cap", "kpi", "budget_unit", "budget_segments", "bid_strategy", "reference", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Insertionorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "insertionorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsInsertionorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsInsertionorder" }, "put": { "summary": "Update an insertionorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "campaign_id", "status", "pacing", "frequency_cap", "kpi", "budget_unit", "budget_segments", "bid_strategy", "reference", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Insertionorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsInsertionorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "insertionorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsInsertionorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAdsInsertionorder" }, "patch": { "summary": "Update an insertionorder", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "organization_id", "campaign_id", "status", "pacing", "frequency_cap", "kpi", "budget_unit", "budget_segments", "bid_strategy", "reference", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Insertionorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsInsertionorder" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "insertionorder" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsInsertionorder" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAdsInsertionorder" }, "delete": { "summary": "Remove an insertionorder", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Insertionorder", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "insertionorder" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAdsInsertionorder" } }, "/ads/{connection_id}/group": { "post": { "summary": "Create a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "campaign_id", "organization_id", "insertionorder_id", "status", "effective_status", "targeting", "bid_amount", "bid_strategy", "budget_amount", "budget_period", "budget_allocation_type", "start_at", "end_at", "budget_unit", "budget_max_amount", "type", "has_eu_political_ads", "pacing", "frequency_cap", "creative_ids", "optimization_goal", "billing_event", "currency", "promoted", "language_locale", "creative_selection", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAdsGroup" }, "get": { "summary": "List all groups", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "campaign_id", "in": "query", "required": false, "description": "The campaign ID to filter by" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "io_id", "in": "query", "required": false, "description": "The IO ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "status", "in": "query", "required": false, "description": "The status to filter by" }, { "type": "string", "name": "effective_status", "in": "query", "required": false, "enum": [ "UNSPECIFIED", "SERVING", "LIMITED", "LEARNING", "PAUSED", "PENDING", "ENDED", "MISCONFIGURED", "NOT_ELIGIBLE", "ARCHIVED", "REMOVED" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "campaign_id", "organization_id", "insertionorder_id", "status", "effective_status", "targeting", "bid_amount", "bid_strategy", "budget_amount", "budget_period", "budget_allocation_type", "start_at", "end_at", "budget_unit", "budget_max_amount", "type", "has_eu_political_ads", "pacing", "frequency_cap", "creative_ids", "optimization_goal", "billing_event", "currency", "promoted", "language_locale", "creative_selection", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "group" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsGroup" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsGroups" } }, "/ads/{connection_id}/group/{id}": { "get": { "summary": "Retrieve a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "campaign_id", "organization_id", "insertionorder_id", "status", "effective_status", "targeting", "bid_amount", "bid_strategy", "budget_amount", "budget_period", "budget_allocation_type", "start_at", "end_at", "budget_unit", "budget_max_amount", "type", "has_eu_political_ads", "pacing", "frequency_cap", "creative_ids", "optimization_goal", "billing_event", "currency", "promoted", "language_locale", "creative_selection", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsGroup" }, "put": { "summary": "Update a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "campaign_id", "organization_id", "insertionorder_id", "status", "effective_status", "targeting", "bid_amount", "bid_strategy", "budget_amount", "budget_period", "budget_allocation_type", "start_at", "end_at", "budget_unit", "budget_max_amount", "type", "has_eu_political_ads", "pacing", "frequency_cap", "creative_ids", "optimization_goal", "billing_event", "currency", "promoted", "language_locale", "creative_selection", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAdsGroup" }, "patch": { "summary": "Update a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "parent_id", "campaign_id", "organization_id", "insertionorder_id", "status", "effective_status", "targeting", "bid_amount", "bid_strategy", "budget_amount", "budget_period", "budget_allocation_type", "start_at", "end_at", "budget_unit", "budget_max_amount", "type", "has_eu_political_ads", "pacing", "frequency_cap", "creative_ids", "optimization_goal", "billing_event", "currency", "promoted", "language_locale", "creative_selection", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAdsGroup" }, "delete": { "summary": "Remove a group", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "group" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAdsGroup" } }, "/ads/{connection_id}/ad": { "post": { "summary": "Create an ad", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "organization_id", "status", "ad_type", "advertiser_name", "creative_ids", "creative_asset_url", "ad_copy", "headline", "description", "cta", "final_url", "display_url", "path1", "path2", "promoted", "logo_creative_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsAd" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "ad" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsAd" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAdsAd" }, "get": { "summary": "List all ads", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "campaign_id", "in": "query", "required": false, "description": "The campaign ID to filter by" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to AdsGroup)" }, { "type": "string", "name": "status", "in": "query", "required": false, "description": "The status to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "organization_id", "status", "ad_type", "advertiser_name", "creative_ids", "creative_asset_url", "ad_copy", "headline", "description", "cta", "final_url", "display_url", "path1", "path2", "promoted", "logo_creative_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "ad" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsAd" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsAds" } }, "/ads/{connection_id}/ad/{id}": { "get": { "summary": "Retrieve an ad", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "organization_id", "status", "ad_type", "advertiser_name", "creative_ids", "creative_asset_url", "ad_copy", "headline", "description", "cta", "final_url", "display_url", "path1", "path2", "promoted", "logo_creative_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Ad", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "ad" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsAd" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsAd" }, "put": { "summary": "Update an ad", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "organization_id", "status", "ad_type", "advertiser_name", "creative_ids", "creative_asset_url", "ad_copy", "headline", "description", "cta", "final_url", "display_url", "path1", "path2", "promoted", "logo_creative_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Ad", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsAd" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "ad" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsAd" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAdsAd" }, "patch": { "summary": "Update an ad", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "campaign_id", "group_id", "organization_id", "status", "ad_type", "advertiser_name", "creative_ids", "creative_asset_url", "ad_copy", "headline", "description", "cta", "final_url", "display_url", "path1", "path2", "promoted", "logo_creative_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Ad", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AdsAd" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "ad" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsAd" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAdsAd" }, "delete": { "summary": "Remove an ad", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Ad", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "ad" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAdsAd" } }, "/ads/{connection_id}/report": { "get": { "summary": "List all reports", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "campaign_id", "in": "query", "required": false, "description": "The campaign ID to filter by" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to AdsGroup)" }, { "type": "string", "name": "ad_id", "in": "query", "required": false, "description": "The ad ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "One or more (comma-separated) of: CLICKS, IMPRESSIONS, CONVERSIONS, COST, CTR, CPC, CONVERSION_VALUE, CPA, ROAS, CPM, ECPM, ENGAGEMENT, VIDEO_COMPLETIONS, VIDEO_VIEWS, LEADS, ENGAGEMENTS, SAVES, LIKES, SHARES, COMMENTS, FOLLOWS, POST_CLICK_CONVERSIONS, VIEW_THROUGH_CONVERSIONS, ALL_CONVERSIONS, ALL_CONVERSION_VALUE, INTERACTIONS, REVENUE, MEDIA_COST, TOTAL_MEDIA_COST, VIDEO_PLAYS, VIDEO_QUARTILE_25, VIDEO_QUARTILE_50, VIDEO_QUARTILE_75, VIDEO_QUARTILE_100, VIDEO_AVG_TIME_WATCHED, VIDEO_THRUPLAY, VIEWABLE_IMPRESSIONS, MEASURABLE_IMPRESSIONS, VIEWABILITY_RATE, BILLABLE_IMPRESSIONS, DATA_FEES, PLATFORM_FEES, PROFIT, LANDING_PAGE_CLICKS, LEAD_FORM_OPENS, AD_UNIT_CLICKS, CARD_CLICKS, CARD_IMPRESSIONS, COMMENT_LIKES, COMPANY_PAGE_CLICKS, ACTION_CLICKS, TEXT_URL_CLICKS, OTHER_ENGAGEMENTS, OPENS, TOTAL_ENGAGEMENTS, UNIQUE_IMPRESSIONS, UNIQUE_CLICKS, VIRAL_IMPRESSIONS, VIRAL_CLICKS, VIRAL_LIKES, VIRAL_COMMENTS, VIRAL_SHARES, VIRAL_FOLLOWS, VIRAL_VIDEO_PLAYS, VIRAL_VIDEO_VIEWS, VIRAL_VIDEO_COMPLETIONS, VIRAL_VIDEO_QUARTILE_25, VIRAL_VIDEO_QUARTILE_50, VIRAL_VIDEO_QUARTILE_75, VIRAL_LEADS, VIRAL_LEAD_FORM_OPENS, VIRAL_LANDING_PAGE_CLICKS, VIRAL_CONVERSIONS, VIRAL_POST_CLICK_CONVERSIONS, VIRAL_VIEW_THROUGH_CONVERSIONS, VIRAL_ENGAGEMENTS, GMAIL_SECONDARY_CLICKS, AVERAGE_CPV, VIDEO_VIEWS_FROM_SEARCH, CROSS_DEVICE_CONVERSIONS, ABSOLUTE_TOP_IMPRESSION_SHARE, TOP_IMPRESSION_SHARE, ABSOLUTE_TOP_IMPRESSION_RATE_PERCENT, TOP_IMPRESSION_RATE_PERCENT, VIDEO_FULLSCREENS, VIDEO_PAUSES, VIDEO_MUTES, VIDEO_SKIPS, COMPANION_CLICKS, COMPANION_VIEWS, ACTIVE_VIEW_AVG_TIME, ELIGIBLE_IMPRESSIONS, EARNED_VIEWS, UNIQUE_VIEWERS, COST_USD, VIRAL_CARD_CLICKS, VIRAL_CARD_IMPRESSIONS, VIRAL_COMPANY_PAGE_CLICKS, VIRAL_VIDEO_FULLSCREENS, VIRAL_OTHER_ENGAGEMENTS, LEAD_GEN_CONTACT_SHARES, LEAD_GEN_INTERESTED_CLICKS, CM360_POST_CLICK_REVENUE, CM360_POST_VIEW_REVENUE, SCROLLS, MEDIA_FEE_1, MEDIA_FEE_2, MEDIA_FEE_3, MEDIA_FEE_4, MEDIA_FEE_5, ACTIVE_VIEW_DIST_UNMEASURABLE, ACTIVE_VIEW_DIST_UNVIEWABLE, ACTIVE_VIEW_DIST_VIEWABLE, ACTIVE_VIEW_AUDIBLE_VISIBLE_COMPLETE, ACTIVE_VIEW_VISIBLE_10S, NOT_MEASURABLE_IMPRESSIONS, NOT_VIEWABLE_IMPRESSIONS, 1D_VIEW, 1D_CLICK, 7D_VIEW, 7D_CLICK, 14D_CLICK, 28D_VIEW, 28D_CLICK, 30D_CLICK, VISITS, AUDIO_MUTES" }, { "type": "string", "name": "dimension", "in": "query", "required": false, "description": "One or more (comma-separated) of: DATE, PLATFORM, PLATFORM_POSITION, DEVICE" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "currency", "metrics", "start_at", "end_at", "organization_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "report" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsReport" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsReports" } }, "/ads/{connection_id}/target/{id}": { "get": { "summary": "Retrieve a target", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "name", "type", "is_active", "parent_id", "audience_count_min", "audience_count_max", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Target", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "target" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsTarget" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsTarget" } }, "/ads/{connection_id}/target": { "get": { "summary": "List all targets", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "INTEREST", "BEHAVIOR", "LOCALE", "COUNTRY", "REGION", "CITY", "ZIP", "US_DMA", "TOPIC", "USER_LIST", "CARRIER", "DEVICE_MODEL", "OS_VERSION" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "name", "type", "is_active", "parent_id", "audience_count_min", "audience_count_max", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "target" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsTarget" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsTargets" } }, "/ads/{connection_id}/promoted/{id}": { "get": { "summary": "Retrieve a promoted", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "name", "type", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Promoted", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "promoted" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AdsPromoted" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAdsPromoted" } }, "/ads/{connection_id}/promoted": { "get": { "summary": "List all promoteds", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to AdsOrganization)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "PAGE_ID", "APP_ID", "STORE_URL", "PIXEL_ID", "CUSTOM_CONVERSION_ID", "CATALOG_ID", "PRODUCT_SET_ID", "PRIORITIZED_SET_ID", "EVENT_ID", "OFFER_ID", "LEAD_FORM_ID", "MESSAGING_CHANNEL_ID", "PRODUCT_ID", "TWEET_ID", "AD_GROUP_TYPE" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "name", "type", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "ads", "promoted" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AdsPromoted" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAdsPromoteds" } }, "/lms/{connection_id}/course": { "post": { "summary": "Create a course", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_private", "is_active", "price_amount", "languages", "categories", "currency", "media", "instructors", "students", "content_ids", "skills", "duration_minutes", "provider_name", "published_at", "time_estimate_minutes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsCourse" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "course" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsCourse" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLmsCourse" }, "get": { "summary": "List all courses", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "class_id", "in": "query", "required": false, "description": "The class ID to filter by (reference to LmsClass)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_private", "is_active", "price_amount", "languages", "categories", "currency", "media", "instructors", "students", "content_ids", "skills", "duration_minutes", "provider_name", "published_at", "time_estimate_minutes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "course" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LmsCourse" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLmsCourses" } }, "/lms/{connection_id}/course/{id}": { "get": { "summary": "Retrieve a course", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_private", "is_active", "price_amount", "languages", "categories", "currency", "media", "instructors", "students", "content_ids", "skills", "duration_minutes", "provider_name", "published_at", "time_estimate_minutes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Course", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "course" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsCourse" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLmsCourse" }, "put": { "summary": "Update a course", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_private", "is_active", "price_amount", "languages", "categories", "currency", "media", "instructors", "students", "content_ids", "skills", "duration_minutes", "provider_name", "published_at", "time_estimate_minutes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Course", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsCourse" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "course" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsCourse" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLmsCourse" }, "patch": { "summary": "Update a course", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_private", "is_active", "price_amount", "languages", "categories", "currency", "media", "instructors", "students", "content_ids", "skills", "duration_minutes", "provider_name", "published_at", "time_estimate_minutes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Course", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsCourse" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "course" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsCourse" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLmsCourse" }, "delete": { "summary": "Remove a course", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Course", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "course" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLmsCourse" } }, "/lms/{connection_id}/class": { "post": { "summary": "Create a class", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "course_id", "languages", "instructors", "students", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsClass" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "class" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsClass" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLmsClass" }, "get": { "summary": "List all classes", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "course_id", "in": "query", "required": false, "description": "The course ID to filter by (reference to Course)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "course_id", "languages", "instructors", "students", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "class" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LmsClass" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLmsClasses" } }, "/lms/{connection_id}/class/{id}": { "get": { "summary": "Retrieve a class", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "course_id", "languages", "instructors", "students", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Class", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "class" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsClass" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLmsClass" }, "put": { "summary": "Update a class", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "course_id", "languages", "instructors", "students", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Class", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsClass" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "class" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsClass" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLmsClass" }, "patch": { "summary": "Update a class", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "course_id", "languages", "instructors", "students", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Class", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsClass" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "class" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsClass" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLmsClass" }, "delete": { "summary": "Remove a class", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Class", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "class" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLmsClass" } }, "/lms/{connection_id}/student": { "post": { "summary": "Create a student", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "address", "image_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsStudent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "student" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsStudent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLmsStudent" }, "get": { "summary": "List all students", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "class_id", "in": "query", "required": false, "description": "The class ID to filter by (reference to LmsClass)" }, { "type": "string", "name": "course_id", "in": "query", "required": false, "description": "The course ID to filter by (reference to Course)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "address", "image_url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "student" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LmsStudent" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLmsStudents" } }, "/lms/{connection_id}/student/{id}": { "get": { "summary": "Retrieve a student", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "address", "image_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Student", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "student" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsStudent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLmsStudent" }, "put": { "summary": "Update a student", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "address", "image_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Student", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsStudent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "student" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsStudent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLmsStudent" }, "patch": { "summary": "Update a student", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "telephones", "address", "image_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Student", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsStudent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "student" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsStudent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLmsStudent" }, "delete": { "summary": "Remove a student", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Student", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "student" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLmsStudent" } }, "/lms/{connection_id}/instructor": { "post": { "summary": "Create an instructor", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "image_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsInstructor" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "instructor" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsInstructor" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLmsInstructor" }, "get": { "summary": "List all instructors", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "class_id", "in": "query", "required": false, "description": "The class ID to filter by (reference to LmsClass)" }, { "type": "string", "name": "course_id", "in": "query", "required": false, "description": "The course ID to filter by (reference to Course)" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by (reference to HrisCompany)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "image_url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "instructor" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LmsInstructor" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLmsInstructors" } }, "/lms/{connection_id}/instructor/{id}": { "get": { "summary": "Retrieve an instructor", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "image_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Instructor", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "instructor" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsInstructor" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLmsInstructor" }, "put": { "summary": "Update an instructor", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "image_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Instructor", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsInstructor" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "instructor" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsInstructor" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLmsInstructor" }, "patch": { "summary": "Update an instructor", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "emails", "title", "telephones", "image_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Instructor", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsInstructor" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "instructor" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsInstructor" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLmsInstructor" }, "delete": { "summary": "Remove an instructor", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Instructor", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "instructor" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLmsInstructor" } }, "/lms/{connection_id}/content": { "post": { "summary": "Create a content", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "external_reference", "course_ids", "name", "description", "languages", "media", "is_active", "duration_minutes", "categories", "subjects", "skills", "tags", "difficulty", "sort_order", "provider_name", "short_description", "localizations", "collection_ids", "instructors", "published_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsContent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "content" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsContent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLmsContent" }, "get": { "summary": "List all contents", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "course_id", "in": "query", "required": false, "description": "The course ID to filter by (reference to Course)" }, { "type": "string", "name": "collection_id", "in": "query", "required": false, "description": "The collection ID to filter by (reference to CommerceCollection)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "external_reference", "course_ids", "name", "description", "languages", "media", "is_active", "duration_minutes", "categories", "subjects", "skills", "tags", "difficulty", "sort_order", "provider_name", "short_description", "localizations", "collection_ids", "instructors", "published_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "content" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LmsContent" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLmsContents" } }, "/lms/{connection_id}/content/{id}": { "get": { "summary": "Retrieve a content", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "external_reference", "course_ids", "name", "description", "languages", "media", "is_active", "duration_minutes", "categories", "subjects", "skills", "tags", "difficulty", "sort_order", "provider_name", "short_description", "localizations", "collection_ids", "instructors", "published_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Content", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "content" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsContent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLmsContent" }, "put": { "summary": "Update a content", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "external_reference", "course_ids", "name", "description", "languages", "media", "is_active", "duration_minutes", "categories", "subjects", "skills", "tags", "difficulty", "sort_order", "provider_name", "short_description", "localizations", "collection_ids", "instructors", "published_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Content", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsContent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "content" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsContent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLmsContent" }, "patch": { "summary": "Update a content", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "external_reference", "course_ids", "name", "description", "languages", "media", "is_active", "duration_minutes", "categories", "subjects", "skills", "tags", "difficulty", "sort_order", "provider_name", "short_description", "localizations", "collection_ids", "instructors", "published_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Content", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsContent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "content" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsContent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLmsContent" }, "delete": { "summary": "Remove a content", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Content", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "content" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLmsContent" } }, "/lms/{connection_id}/collection": { "post": { "summary": "Create a collection", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "is_active", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsCollection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "collection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsCollection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLmsCollection" }, "get": { "summary": "List all collections", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "course_id", "in": "query", "required": false, "description": "The course ID to filter by (reference to Course)" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "is_active", "parent_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "collection" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LmsCollection" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLmsCollections" } }, "/lms/{connection_id}/collection/{id}": { "get": { "summary": "Retrieve a collection", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "is_active", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Collection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "collection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsCollection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLmsCollection" }, "put": { "summary": "Update a collection", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "is_active", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Collection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsCollection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "collection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsCollection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLmsCollection" }, "patch": { "summary": "Update a collection", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "media", "is_active", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Collection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsCollection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "collection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsCollection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLmsCollection" }, "delete": { "summary": "Remove a collection", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Collection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "collection" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLmsCollection" } }, "/lms/{connection_id}/activity": { "post": { "summary": "Create an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content_id", "course_id", "student_id", "duration_minutes", "assigned_grade", "is_completed", "progress_percentage", "started_at", "completed_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsActivity" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLmsActivity" }, "get": { "summary": "List all activities", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "content_id", "in": "query", "required": false, "description": "The content ID to filter by" }, { "type": "string", "name": "student_id", "in": "query", "required": false, "description": "The student ID to filter by (reference to LmsStudent)" }, { "type": "string", "name": "course_id", "in": "query", "required": false, "description": "The course ID to filter by (reference to Course)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content_id", "course_id", "student_id", "duration_minutes", "assigned_grade", "is_completed", "progress_percentage", "started_at", "completed_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "activity" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LmsActivity" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLmsActivities" } }, "/lms/{connection_id}/activity/{id}": { "get": { "summary": "Retrieve an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content_id", "course_id", "student_id", "duration_minutes", "assigned_grade", "is_completed", "progress_percentage", "started_at", "completed_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLmsActivity" }, "put": { "summary": "Update an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content_id", "course_id", "student_id", "duration_minutes", "assigned_grade", "is_completed", "progress_percentage", "started_at", "completed_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsActivity" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLmsActivity" }, "patch": { "summary": "Update an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "content_id", "course_id", "student_id", "duration_minutes", "assigned_grade", "is_completed", "progress_percentage", "started_at", "completed_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LmsActivity" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LmsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLmsActivity" }, "delete": { "summary": "Remove an activity", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "lms", "activity" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLmsActivity" } }, "/repo/{connection_id}/organization": { "post": { "summary": "Create an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "avatar_url", "web_url", "user_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createRepoOrganization" }, "get": { "summary": "List all organizations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "avatar_url", "web_url", "user_ids", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "organization" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/RepoOrganization" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listRepoOrganizations" } }, "/repo/{connection_id}/organization/{id}": { "get": { "summary": "Retrieve an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "avatar_url", "web_url", "user_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getRepoOrganization" }, "put": { "summary": "Update an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "avatar_url", "web_url", "user_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateRepoOrganization" }, "patch": { "summary": "Update an organization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "avatar_url", "web_url", "user_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoOrganization" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "organization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoOrganization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathRepoOrganization" }, "delete": { "summary": "Remove an organization", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Organization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "organization" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeRepoOrganization" } }, "/repo/{connection_id}/repository": { "post": { "summary": "Create a repository", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "owner", "is_private", "web_url", "org_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoRepository" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "repository" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoRepository" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createRepoRepository" }, "get": { "summary": "List all repositories", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by (reference to RepoOrganization)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "owner", "is_private", "web_url", "org_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "repository" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/RepoRepository" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listRepoRepositories" } }, "/repo/{connection_id}/repository/{id}": { "get": { "summary": "Retrieve a repository", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "owner", "is_private", "web_url", "org_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Repository", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "repository" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoRepository" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getRepoRepository" }, "put": { "summary": "Update a repository", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "owner", "is_private", "web_url", "org_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Repository", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoRepository" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "repository" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoRepository" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateRepoRepository" }, "patch": { "summary": "Update a repository", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "owner", "is_private", "web_url", "org_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Repository", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoRepository" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "repository" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoRepository" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathRepoRepository" }, "delete": { "summary": "Remove a repository", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Repository", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "repository" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeRepoRepository" } }, "/repo/{connection_id}/branch": { "post": { "summary": "Create a branch", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "repo_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoBranch" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "branch" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoBranch" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createRepoBranch" }, "get": { "summary": "List all branches", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "repo_id", "in": "query", "required": false, "description": "The repo ID to filter by (reference to RepoRepository)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "repo_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "branch" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/RepoBranch" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listRepoBranches" } }, "/repo/{connection_id}/branch/{id}": { "get": { "summary": "Retrieve a branch", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "repo_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Branch", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "branch" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoBranch" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getRepoBranch" }, "put": { "summary": "Update a branch", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "repo_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Branch", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoBranch" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "branch" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoBranch" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateRepoBranch" }, "patch": { "summary": "Update a branch", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "repo_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Branch", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoBranch" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "branch" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoBranch" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathRepoBranch" }, "delete": { "summary": "Remove a branch", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Branch", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "branch" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeRepoBranch" } }, "/repo/{connection_id}/commit": { "post": { "summary": "Create a commit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "repo_id", "message", "branch_id", "pullrequest_ids", "lines_added", "lines_deleted", "lines_changed", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoCommit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "commit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoCommit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createRepoCommit" }, "get": { "summary": "List all commits", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "repo_id", "in": "query", "required": false, "description": "The repo ID to filter by (reference to RepoRepository)" }, { "type": "string", "name": "branch_id", "in": "query", "required": false, "description": "The repo branch ID to filter by (reference to RepoBranch)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "repo_id", "message", "branch_id", "pullrequest_ids", "lines_added", "lines_deleted", "lines_changed", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "commit" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/RepoCommit" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listRepoCommits" } }, "/repo/{connection_id}/commit/{id}": { "get": { "summary": "Retrieve a commit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "repo_id", "message", "branch_id", "pullrequest_ids", "lines_added", "lines_deleted", "lines_changed", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Commit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "commit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoCommit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getRepoCommit" }, "put": { "summary": "Update a commit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "repo_id", "message", "branch_id", "pullrequest_ids", "lines_added", "lines_deleted", "lines_changed", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Commit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoCommit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "commit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoCommit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateRepoCommit" }, "patch": { "summary": "Update a commit", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "repo_id", "message", "branch_id", "pullrequest_ids", "lines_added", "lines_deleted", "lines_changed", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Commit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoCommit" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "commit" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoCommit" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathRepoCommit" }, "delete": { "summary": "Remove a commit", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Commit", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "commit" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeRepoCommit" } }, "/repo/{connection_id}/pullrequest": { "post": { "summary": "Create a pullrequest", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_ids", "repo_id", "title", "notes", "target_branch_id", "source_branch_id", "status", "labels", "closed_at", "commit_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoPullrequest" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "pullrequest" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoPullrequest" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createRepoPullrequest" }, "get": { "summary": "List all pullrequests", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "repo_id", "in": "query", "required": false, "description": "The repo ID to filter by (reference to RepoRepository)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_ids", "repo_id", "title", "notes", "target_branch_id", "source_branch_id", "status", "labels", "closed_at", "commit_ids", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "pullrequest" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/RepoPullrequest" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listRepoPullrequests" } }, "/repo/{connection_id}/pullrequest/{id}": { "get": { "summary": "Retrieve a pullrequest", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_ids", "repo_id", "title", "notes", "target_branch_id", "source_branch_id", "status", "labels", "closed_at", "commit_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Pullrequest", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "pullrequest" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoPullrequest" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getRepoPullrequest" }, "put": { "summary": "Update a pullrequest", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_ids", "repo_id", "title", "notes", "target_branch_id", "source_branch_id", "status", "labels", "closed_at", "commit_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Pullrequest", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoPullrequest" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "pullrequest" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoPullrequest" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateRepoPullrequest" }, "patch": { "summary": "Update a pullrequest", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_ids", "repo_id", "title", "notes", "target_branch_id", "source_branch_id", "status", "labels", "closed_at", "commit_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Pullrequest", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RepoPullrequest" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "pullrequest" ], "responses": { "200": { "schema": { "$ref": "#/definitions/RepoPullrequest" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathRepoPullrequest" }, "delete": { "summary": "Remove a pullrequest", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Pullrequest", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "repo", "pullrequest" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeRepoPullrequest" } }, "/metadata/{connection_id}/metadata": { "post": { "summary": "Create a metadata", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "format", "original_format", "options", "object_type", "objects", "is_required", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MetadataMetadata" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "metadata", "metadata" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MetadataMetadata" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createMetadataMetadata" }, "get": { "summary": "List all metadatas", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "The type to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "format", "original_format", "options", "object_type", "objects", "is_required", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "metadata", "metadata" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/MetadataMetadata" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listMetadataMetadatas" } }, "/metadata/{connection_id}/metadata/{id}": { "get": { "summary": "Retrieve a metadata", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "format", "original_format", "options", "object_type", "objects", "is_required", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Metadata", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "metadata", "metadata" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MetadataMetadata" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getMetadataMetadata" }, "put": { "summary": "Update a metadata", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "format", "original_format", "options", "object_type", "objects", "is_required", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Metadata", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MetadataMetadata" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "metadata", "metadata" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MetadataMetadata" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateMetadataMetadata" }, "patch": { "summary": "Update a metadata", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "format", "original_format", "options", "object_type", "objects", "is_required", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Metadata", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/MetadataMetadata" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "metadata", "metadata" ], "responses": { "200": { "schema": { "$ref": "#/definitions/MetadataMetadata" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathMetadataMetadata" }, "delete": { "summary": "Remove a metadata", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Metadata", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "metadata", "metadata" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeMetadataMetadata" } }, "/forms/{connection_id}/form": { "post": { "summary": "Create a form", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "fields", "is_active", "published_url", "response_count", "has_multiple_submissions", "has_progress_bar", "has_shuffle_questions", "confirmation_message", "confirmation_redirect_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/FormsForm" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "forms", "form" ], "responses": { "200": { "schema": { "$ref": "#/definitions/FormsForm" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createFormsForm" }, "get": { "summary": "List all forms", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "fields", "is_active", "published_url", "response_count", "has_multiple_submissions", "has_progress_bar", "has_shuffle_questions", "confirmation_message", "confirmation_redirect_url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "forms", "form" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/FormsForm" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listFormsForms" } }, "/forms/{connection_id}/form/{id}": { "get": { "summary": "Retrieve a form", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "fields", "is_active", "published_url", "response_count", "has_multiple_submissions", "has_progress_bar", "has_shuffle_questions", "confirmation_message", "confirmation_redirect_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Form", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "forms", "form" ], "responses": { "200": { "schema": { "$ref": "#/definitions/FormsForm" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getFormsForm" }, "put": { "summary": "Update a form", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "fields", "is_active", "published_url", "response_count", "has_multiple_submissions", "has_progress_bar", "has_shuffle_questions", "confirmation_message", "confirmation_redirect_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Form", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/FormsForm" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "forms", "form" ], "responses": { "200": { "schema": { "$ref": "#/definitions/FormsForm" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateFormsForm" }, "patch": { "summary": "Update a form", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "fields", "is_active", "published_url", "response_count", "has_multiple_submissions", "has_progress_bar", "has_shuffle_questions", "confirmation_message", "confirmation_redirect_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Form", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/FormsForm" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "forms", "form" ], "responses": { "200": { "schema": { "$ref": "#/definitions/FormsForm" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathFormsForm" }, "delete": { "summary": "Remove a form", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Form", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "forms", "form" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeFormsForm" } }, "/forms/{connection_id}/submission/{id}": { "get": { "summary": "Retrieve a submission", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "form_id", "respondent_email", "respondent_name", "answers", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Submission", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "forms", "submission" ], "responses": { "200": { "schema": { "$ref": "#/definitions/FormsSubmission" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getFormsSubmission" } }, "/forms/{connection_id}/submission": { "get": { "summary": "List all submissions", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "form_id", "in": "query", "required": false, "description": "The form ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "form_id", "respondent_email", "respondent_name", "answers", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "forms", "submission" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/FormsSubmission" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listFormsSubmissions" } }, "/datastore/{connection_id}/database": { "post": { "summary": "Create a database", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "web_url", "is_active", "password", "region", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreDatabase" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "database" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreDatabase" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createDatastoreDatabase" }, "get": { "summary": "List all databases", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "web_url", "is_active", "password", "region", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "database" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/DatastoreDatabase" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listDatastoreDatabases" } }, "/datastore/{connection_id}/database/{id}": { "get": { "summary": "Retrieve a database", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "web_url", "is_active", "password", "region", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Database", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "database" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreDatabase" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getDatastoreDatabase" }, "put": { "summary": "Update a database", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "web_url", "is_active", "password", "region", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Database", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreDatabase" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "database" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreDatabase" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateDatastoreDatabase" }, "patch": { "summary": "Update a database", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "web_url", "is_active", "password", "region", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Database", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreDatabase" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "database" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreDatabase" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathDatastoreDatabase" }, "delete": { "summary": "Remove a database", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Database", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "database" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeDatastoreDatabase" } }, "/datastore/{connection_id}/table": { "post": { "summary": "Create a table", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "database_id", "fields", "relationships", "web_url", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreTable" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "table" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreTable" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createDatastoreTable" }, "get": { "summary": "List all tables", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "database_id", "in": "query", "required": false, "description": "The Database ID to filter by" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "database_id", "fields", "relationships", "web_url", "parent_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "table" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/DatastoreTable" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listDatastoreTables" } }, "/datastore/{connection_id}/table/{id}": { "get": { "summary": "Retrieve a table", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "database_id", "fields", "relationships", "web_url", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Table", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "table" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreTable" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getDatastoreTable" }, "put": { "summary": "Update a table", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "database_id", "fields", "relationships", "web_url", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Table", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreTable" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "table" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreTable" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateDatastoreTable" }, "patch": { "summary": "Update a table", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "database_id", "fields", "relationships", "web_url", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Table", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreTable" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "table" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreTable" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathDatastoreTable" }, "delete": { "summary": "Remove a table", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Table", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "table" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeDatastoreTable" } }, "/datastore/{connection_id}/record": { "post": { "summary": "Create a record", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "database_id", "table_id", "fields", "row_number", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreRecord" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "record" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreRecord" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createDatastoreRecord" }, "get": { "summary": "List all records", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "database_id", "in": "query", "required": false, "description": "The Database ID to filter by" }, { "type": "string", "name": "table_id", "in": "query", "required": false, "description": "The Database Table ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "database_id", "table_id", "fields", "row_number", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "record" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/DatastoreRecord" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listDatastoreRecords" } }, "/datastore/{connection_id}/record/{id}": { "get": { "summary": "Retrieve a record", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "database_id", "table_id", "fields", "row_number", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Record", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "record" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreRecord" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getDatastoreRecord" }, "put": { "summary": "Update a record", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "database_id", "table_id", "fields", "row_number", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Record", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreRecord" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "record" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreRecord" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateDatastoreRecord" }, "patch": { "summary": "Update a record", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "database_id", "table_id", "fields", "row_number", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Record", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreRecord" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "record" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreRecord" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathDatastoreRecord" }, "delete": { "summary": "Remove a record", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Record", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "record" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeDatastoreRecord" } }, "/datastore/{connection_id}/query": { "post": { "summary": "Create a query", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "table_id", "database_id", "query", "response", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DatastoreQuery" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "datastore", "query" ], "responses": { "200": { "schema": { "$ref": "#/definitions/DatastoreQuery" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createDatastoreQuery" } }, "/shipping/{connection_id}/shipment": { "post": { "summary": "Create a shipment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ShippingShipment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "shipment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingShipment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createShippingShipment" }, "get": { "summary": "List all shipments", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "order_id", "in": "query", "required": false, "description": "The AccountingOrder ID to filter by" }, { "type": "string", "name": "carrier_id", "in": "query", "required": false, "description": "The ShippingCarrier ID to filter by" }, { "type": "string", "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "shipment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ShippingShipment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listShippingShipments" } }, "/shipping/{connection_id}/shipment/{id}": { "get": { "summary": "Retrieve a shipment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Shipment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "shipment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingShipment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getShippingShipment" }, "put": { "summary": "Update a shipment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Shipment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ShippingShipment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "shipment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingShipment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateShippingShipment" }, "patch": { "summary": "Update a shipment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Shipment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ShippingShipment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "shipment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingShipment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathShippingShipment" }, "delete": { "summary": "Remove a shipment", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Shipment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "shipment" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeShippingShipment" } }, "/shipping/{connection_id}/label": { "post": { "summary": "Create a label", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ShippingLabel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "label" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingLabel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createShippingLabel" }, "get": { "summary": "List all labels", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "shipment_id", "in": "query", "required": false, "description": "The ShippingShipment ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "label" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ShippingLabel" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listShippingLabels" } }, "/shipping/{connection_id}/label/{id}": { "get": { "summary": "Retrieve a label", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Label", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "label" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingLabel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getShippingLabel" }, "put": { "summary": "Update a label", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Label", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ShippingLabel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "label" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingLabel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateShippingLabel" }, "patch": { "summary": "Update a label", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Label", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ShippingLabel" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "label" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingLabel" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathShippingLabel" }, "delete": { "summary": "Remove a label", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Label", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "label" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeShippingLabel" } }, "/shipping/{connection_id}/tracking/{id}": { "get": { "summary": "Retrieve a tracking", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "status", "events", "estimated_delivery", "actual_delivery_at", "status_description", "carrier_id", "carrier_status_code", "carrier_status_description", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Tracking", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "tracking" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingTracking" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getShippingTracking" } }, "/shipping/{connection_id}/tracking": { "get": { "summary": "List all trackings", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "order_id", "in": "query", "required": false, "description": "The AccountingOrder ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "status", "events", "estimated_delivery", "actual_delivery_at", "status_description", "carrier_id", "carrier_status_code", "carrier_status_description", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "tracking" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ShippingTracking" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listShippingTrackings" } }, "/shipping/{connection_id}/rate": { "post": { "summary": "Create a rate", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "shipment_id", "currency", "from_address", "to_address", "packages", "ship_by_at", "carrier_id", "id", "rates", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ShippingRate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "rate" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingRate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createShippingRate" } }, "/shipping/{connection_id}/carrier/{id}": { "get": { "summary": "Retrieve a carrier", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "is_active", "logo_url", "website_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Carrier", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "carrier" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ShippingCarrier" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getShippingCarrier" } }, "/shipping/{connection_id}/carrier": { "get": { "summary": "List all carriers", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "is_active", "logo_url", "website_url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipping", "carrier" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ShippingCarrier" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listShippingCarriers" } }, "/signing/{connection_id}/document": { "post": { "summary": "Create a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "status", "sent_at", "completed_at", "expires_at", "template_id", "download_url", "creator_id", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SigningDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createSigningDocument" }, "get": { "summary": "List all documents", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "status", "in": "query", "required": false, "description": "The status to filter by" }, { "type": "string", "name": "template_id", "in": "query", "required": false, "description": "The signing template ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "status", "sent_at", "completed_at", "expires_at", "template_id", "download_url", "creator_id", "raw", "metadata" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "document" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SigningDocument" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listSigningDocuments" } }, "/signing/{connection_id}/document/{id}": { "get": { "summary": "Retrieve a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "status", "sent_at", "completed_at", "expires_at", "template_id", "download_url", "creator_id", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getSigningDocument" }, "put": { "summary": "Update a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "status", "sent_at", "completed_at", "expires_at", "template_id", "download_url", "creator_id", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SigningDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateSigningDocument" }, "patch": { "summary": "Update a document", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "status", "sent_at", "completed_at", "expires_at", "template_id", "download_url", "creator_id", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SigningDocument" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "document" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningDocument" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathSigningDocument" }, "delete": { "summary": "Remove a document", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Document", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "document" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeSigningDocument" } }, "/signing/{connection_id}/signatory": { "post": { "summary": "Create a signatory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_id", "name", "email", "role", "status", "order", "signed_at", "decline_reason", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SigningSignatory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "signatory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningSignatory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createSigningSignatory" }, "get": { "summary": "List all signatories", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "document_id", "in": "query", "required": false, "description": "The document ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_id", "name", "email", "role", "status", "order", "signed_at", "decline_reason", "raw", "metadata" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "signatory" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SigningSignatory" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listSigningSignatories" } }, "/signing/{connection_id}/signatory/{id}": { "get": { "summary": "Retrieve a signatory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_id", "name", "email", "role", "status", "order", "signed_at", "decline_reason", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Signatory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "signatory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningSignatory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getSigningSignatory" }, "put": { "summary": "Update a signatory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_id", "name", "email", "role", "status", "order", "signed_at", "decline_reason", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Signatory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SigningSignatory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "signatory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningSignatory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateSigningSignatory" }, "patch": { "summary": "Update a signatory", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "document_id", "name", "email", "role", "status", "order", "signed_at", "decline_reason", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Signatory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SigningSignatory" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "signatory" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningSignatory" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathSigningSignatory" }, "delete": { "summary": "Remove a signatory", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Signatory", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "signatory" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeSigningSignatory" } }, "/signing/{connection_id}/template/{id}": { "get": { "summary": "Retrieve a template", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "creator_id", "raw", "metadata" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Template", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "template" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SigningTemplate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getSigningTemplate" } }, "/signing/{connection_id}/template": { "get": { "summary": "List all templates", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "is_active", "creator_id", "raw", "metadata" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "signing", "template" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SigningTemplate" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listSigningTemplates" } }, "/clubs/{connection_id}/group/{id}": { "get": { "summary": "Retrieve a group", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "sport_type", "group_type", "address", "member_count", "following_count", "post_count", "is_private", "is_verified", "is_featured", "is_admin", "is_owner", "membership_status", "url", "profile_image_url", "cover_image_url", "activity_types", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClubsGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getClubsGroup" } }, "/clubs/{connection_id}/group": { "get": { "summary": "List all groups", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "sport_type", "group_type", "address", "member_count", "following_count", "post_count", "is_private", "is_verified", "is_featured", "is_admin", "is_owner", "membership_status", "url", "profile_image_url", "cover_image_url", "activity_types", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "group" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ClubsGroup" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listClubsGroups" } }, "/clubs/{connection_id}/member/{id}": { "get": { "summary": "Retrieve a member", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "group_id", "is_admin", "is_owner", "membership_status", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Member", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "member" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClubsMember" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getClubsMember" } }, "/clubs/{connection_id}/member": { "get": { "summary": "List all members", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "group_id", "is_admin", "is_owner", "membership_status", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "member" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ClubsMember" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listClubsMembers" } }, "/clubs/{connection_id}/activity/{id}": { "get": { "summary": "Retrieve an activity", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "group_id", "name", "description", "type", "athlete_id", "athlete_name", "distance", "moving_time", "elapsed_time", "total_elevation_gain", "elevation_high", "elevation_low", "start_at", "timezone", "achievement_count", "kudos_count", "comment_count", "athlete_count", "photo_count", "average_speed", "max_speed", "average_cadence", "average_heartrate", "max_heartrate", "average_watts", "max_watts", "weighted_average_watts", "kilojoules", "calories", "has_heartrate", "is_trainer", "is_commute", "is_manual", "is_private", "map_polyline", "map_summary_polyline", "workout_type", "suffer_score", "pr_count", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activity", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "activity" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClubsActivity" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getClubsActivity" } }, "/clubs/{connection_id}/activity": { "get": { "summary": "List all activities", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "group_id", "name", "description", "type", "athlete_id", "athlete_name", "distance", "moving_time", "elapsed_time", "total_elevation_gain", "elevation_high", "elevation_low", "start_at", "timezone", "achievement_count", "kudos_count", "comment_count", "athlete_count", "photo_count", "average_speed", "max_speed", "average_cadence", "average_heartrate", "max_heartrate", "average_watts", "max_watts", "weighted_average_watts", "kilojoules", "calories", "has_heartrate", "is_trainer", "is_commute", "is_manual", "is_private", "map_polyline", "map_summary_polyline", "workout_type", "suffer_score", "pr_count", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "activity" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ClubsActivity" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listClubsActivities" } }, "/clubs/{connection_id}/event/{id}": { "get": { "summary": "Retrieve an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "group_id", "name", "description", "type", "status", "start_at", "end_at", "timezone", "duration_minutes", "location_id", "location_name", "opponent_id", "opponent_name", "home_team_name", "away_team_name", "home_score", "away_score", "score_for", "score_against", "is_home", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClubsEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getClubsEvent" } }, "/clubs/{connection_id}/event": { "get": { "summary": "List all events", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "group_id", "name", "description", "type", "status", "start_at", "end_at", "timezone", "duration_minutes", "location_id", "location_name", "opponent_id", "opponent_name", "home_team_name", "away_team_name", "home_score", "away_score", "score_for", "score_against", "is_home", "url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "event" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ClubsEvent" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listClubsEvents" } }, "/clubs/{connection_id}/location/{id}": { "get": { "summary": "Retrieve a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "group_id", "name", "address", "latitude", "longitude", "telephone", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ClubsLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getClubsLocation" } }, "/clubs/{connection_id}/location": { "get": { "summary": "List all locations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "group_id", "in": "query", "required": false, "description": "The group ID to filter by (reference to HrisGroup)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "group_id", "name", "address", "latitude", "longitude", "telephone", "url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "clubs", "location" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ClubsLocation" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listClubsLocations" } }, "/analytics/{connection_id}/property": { "post": { "summary": "Create a property", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "timezone", "currency", "industry", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AnalyticsProperty" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "property" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsProperty" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAnalyticsProperty" }, "get": { "summary": "List all properties", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "timezone", "currency", "industry", "parent_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "property" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsProperty" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAnalyticsProperties" } }, "/analytics/{connection_id}/property/{id}": { "get": { "summary": "Retrieve a property", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "timezone", "currency", "industry", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Property", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "property" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsProperty" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAnalyticsProperty" }, "put": { "summary": "Update a property", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "timezone", "currency", "industry", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Property", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AnalyticsProperty" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "property" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsProperty" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAnalyticsProperty" }, "patch": { "summary": "Update a property", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "timezone", "currency", "industry", "parent_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Property", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AnalyticsProperty" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "property" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsProperty" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAnalyticsProperty" }, "delete": { "summary": "Remove a property", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Property", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "property" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAnalyticsProperty" } }, "/analytics/{connection_id}/event": { "post": { "summary": "Create an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "event_type", "visitor_id", "property_id", "session_id", "page_url", "page_title", "page_referrer", "device", "browser", "os", "country", "country_code", "region", "city", "metadata", "value", "currency", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AnalyticsEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAnalyticsEvent" }, "get": { "summary": "List all events", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "property_id", "in": "query", "required": false, "description": "The analytics property ID to filter by" }, { "type": "string", "name": "session_id", "in": "query", "required": false, "description": "The analytics session ID to filter by" }, { "type": "string", "name": "visitor_id", "in": "query", "required": false, "description": "The analytics visitor ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "PAGE_VIEW", "SCREEN_VIEW", "CLICK", "FORM_SUBMIT", "PURCHASE", "SIGN_UP", "LOGIN", "LOGOUT", "SEARCH", "VIDEO_PLAY", "VIDEO_COMPLETE", "FILE_DOWNLOAD", "SCROLL", "SESSION_START", "FIRST_VISIT", "CUSTOM" ] }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "event_type", "visitor_id", "property_id", "session_id", "page_url", "page_title", "page_referrer", "device", "browser", "os", "country", "country_code", "region", "city", "metadata", "value", "currency", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "event" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsEvent" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAnalyticsEvents" } }, "/analytics/{connection_id}/event/{id}": { "get": { "summary": "Retrieve an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "event_type", "visitor_id", "property_id", "session_id", "page_url", "page_title", "page_referrer", "device", "browser", "os", "country", "country_code", "region", "city", "metadata", "value", "currency", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAnalyticsEvent" } }, "/analytics/{connection_id}/session/{id}": { "get": { "summary": "Retrieve a session", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "property_id", "visitor_id", "start_at", "end_at", "duration_seconds", "landing_page", "exit_page", "page_views", "events_count", "source", "medium", "campaign", "device", "browser", "os", "country", "city", "is_bounce", "is_conversion", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Session", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "session" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsSession" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAnalyticsSession" } }, "/analytics/{connection_id}/session": { "get": { "summary": "List all sessions", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "property_id", "in": "query", "required": false, "description": "The analytics property ID to filter by" }, { "type": "string", "name": "visitor_id", "in": "query", "required": false, "description": "The analytics visitor ID to filter by" }, { "type": "string", "name": "medium", "in": "query", "required": false, "description": "The analytics medium to filter by" }, { "type": "string", "name": "source", "in": "query", "required": false, "description": "The analytics source to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "property_id", "visitor_id", "start_at", "end_at", "duration_seconds", "landing_page", "exit_page", "page_views", "events_count", "source", "medium", "campaign", "device", "browser", "os", "country", "city", "is_bounce", "is_conversion", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "session" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsSession" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAnalyticsSessions" } }, "/analytics/{connection_id}/visitor": { "post": { "summary": "Create a visitor", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "property_id", "email", "name", "first_name", "last_name", "age", "gender", "country", "country_code", "city", "language", "timezone", "first_seen_at", "last_seen_at", "total_sessions", "total_page_views", "total_events", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AnalyticsVisitor" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "visitor" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsVisitor" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createAnalyticsVisitor" }, "get": { "summary": "List all visitors", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "property_id", "in": "query", "required": false, "description": "The analytics property ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "property_id", "email", "name", "first_name", "last_name", "age", "gender", "country", "country_code", "city", "language", "timezone", "first_seen_at", "last_seen_at", "total_sessions", "total_page_views", "total_events", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "visitor" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsVisitor" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAnalyticsVisitors" } }, "/analytics/{connection_id}/visitor/{id}": { "get": { "summary": "Retrieve a visitor", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "property_id", "email", "name", "first_name", "last_name", "age", "gender", "country", "country_code", "city", "language", "timezone", "first_seen_at", "last_seen_at", "total_sessions", "total_page_views", "total_events", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Visitor", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "visitor" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsVisitor" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getAnalyticsVisitor" }, "put": { "summary": "Update a visitor", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "property_id", "email", "name", "first_name", "last_name", "age", "gender", "country", "country_code", "city", "language", "timezone", "first_seen_at", "last_seen_at", "total_sessions", "total_page_views", "total_events", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Visitor", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AnalyticsVisitor" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "visitor" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsVisitor" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateAnalyticsVisitor" }, "patch": { "summary": "Update a visitor", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "property_id", "email", "name", "first_name", "last_name", "age", "gender", "country", "country_code", "city", "language", "timezone", "first_seen_at", "last_seen_at", "total_sessions", "total_page_views", "total_events", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Visitor", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AnalyticsVisitor" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "visitor" ], "responses": { "200": { "schema": { "$ref": "#/definitions/AnalyticsVisitor" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathAnalyticsVisitor" }, "delete": { "summary": "Remove a visitor", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Visitor", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "visitor" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeAnalyticsVisitor" } }, "/analytics/{connection_id}/report": { "get": { "summary": "List all reports", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "property_id", "in": "query", "required": false, "description": "The analytics property ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "USERS", "NEW_USERS", "SESSIONS", "PAGE_VIEWS", "UNIQUE_PAGE_VIEWS", "SCREENS", "EVENTS", "AVERAGE_SESSION_DURATION", "PAGES_PER_SESSION", "BOUNCE_RATE", "ENGAGEMENT_RATE", "EVENTS_PER_SESSION", "CONVERSIONS", "CONVERSION_RATE", "GOAL_COMPLETIONS", "GOAL_VALUE", "TRANSACTIONS", "REVENUE", "AVERAGE_ORDER_VALUE", "ECOMMERCE_CONVERSION_RATE", "SESSIONS_BY_SOURCE", "USERS_BY_SOURCE", "CONVERSIONS_BY_SOURCE", "VIDEO_VIEWS", "WATCH_TIME", "AVERAGE_VIEW_DURATION", "AVERAGE_VIEW_PERCENTAGE", "LIKES", "DISLIKES", "COMMENTS", "SHARES", "SUBSCRIBERS_GAINED", "SUBSCRIBERS_LOST" ] }, { "type": "string", "name": "dimension", "in": "query", "required": false, "enum": [ "DATE", "HOUR", "DAY_OF_WEEK", "WEEK", "MONTH", "YEAR", "PAGE", "PAGE_TITLE", "EVENT_NAME", "SOURCE", "MEDIUM", "CAMPAIGN", "COUNTRY", "CITY", "DEVICE_TYPE", "BROWSER", "OS", "USER_TYPE", "LANDING_PAGE", "VIDEO" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "property_id", "start_at", "end_at", "metrics", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "analytics", "report" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsReport" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listAnalyticsReports" } }, "/cdp/{connection_id}/profile": { "post": { "summary": "Create a profile", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "email", "telephone", "gender", "birthdate", "title", "company", "address", "identifiers", "metadata", "segments", "is_anonymous", "consent", "source_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpProfile" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "profile" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpProfile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCdpProfile" }, "get": { "summary": "List all profiles", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "email", "telephone", "gender", "birthdate", "title", "company", "address", "identifiers", "metadata", "segments", "is_anonymous", "consent", "source_id", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "profile" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CdpProfile" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCdpProfiles" } }, "/cdp/{connection_id}/profile/{id}": { "get": { "summary": "Retrieve a profile", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "email", "telephone", "gender", "birthdate", "title", "company", "address", "identifiers", "metadata", "segments", "is_anonymous", "consent", "source_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Profile", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "profile" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpProfile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCdpProfile" }, "put": { "summary": "Update a profile", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "email", "telephone", "gender", "birthdate", "title", "company", "address", "identifiers", "metadata", "segments", "is_anonymous", "consent", "source_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Profile", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpProfile" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "profile" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpProfile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCdpProfile" }, "patch": { "summary": "Update a profile", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "email", "telephone", "gender", "birthdate", "title", "company", "address", "identifiers", "metadata", "segments", "is_anonymous", "consent", "source_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Profile", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpProfile" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "profile" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpProfile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCdpProfile" }, "delete": { "summary": "Remove a profile", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Profile", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "profile" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCdpProfile" } }, "/cdp/{connection_id}/segment": { "post": { "summary": "Create a segment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "description", "definition", "type", "compute_mode", "size", "is_active", "source_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpSegment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "segment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpSegment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCdpSegment" }, "get": { "summary": "List all segments", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "description", "definition", "type", "compute_mode", "size", "is_active", "source_id", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "segment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CdpSegment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCdpSegments" } }, "/cdp/{connection_id}/segment/{id}": { "get": { "summary": "Retrieve a segment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "description", "definition", "type", "compute_mode", "size", "is_active", "source_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Segment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "segment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpSegment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCdpSegment" }, "put": { "summary": "Update a segment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "description", "definition", "type", "compute_mode", "size", "is_active", "source_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Segment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpSegment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "segment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpSegment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCdpSegment" }, "patch": { "summary": "Update a segment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "description", "definition", "type", "compute_mode", "size", "is_active", "source_id", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Segment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpSegment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "segment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpSegment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCdpSegment" }, "delete": { "summary": "Remove a segment", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Segment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "segment" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCdpSegment" } }, "/cdp/{connection_id}/event": { "post": { "summary": "Create an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "name", "type", "occurred_at", "profile_id", "identifiers", "metadata", "source", "source_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCdpEvent" }, "get": { "summary": "List all events", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "profile_id", "in": "query", "required": false, "description": "The profile ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "name", "type", "occurred_at", "profile_id", "identifiers", "metadata", "source", "source_id", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "event" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CdpEvent" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCdpEvents" } }, "/cdp/{connection_id}/event/{id}": { "get": { "summary": "Retrieve an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "name", "type", "occurred_at", "profile_id", "identifiers", "metadata", "source", "source_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCdpEvent" }, "put": { "summary": "Update an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "name", "type", "occurred_at", "profile_id", "identifiers", "metadata", "source", "source_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCdpEvent" }, "patch": { "summary": "Update an event", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "name", "type", "occurred_at", "profile_id", "identifiers", "metadata", "source", "source_id", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpEvent" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "event" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpEvent" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCdpEvent" }, "delete": { "summary": "Remove an event", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Event", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "event" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCdpEvent" } }, "/cdp/{connection_id}/source": { "post": { "summary": "Create a source", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpSource" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "source" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpSource" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCdpSource" }, "get": { "summary": "List all sources", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "source" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CdpSource" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCdpSources" } }, "/cdp/{connection_id}/source/{id}": { "get": { "summary": "Retrieve a source", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Source", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "source" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpSource" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCdpSource" }, "put": { "summary": "Update a source", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Source", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpSource" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "source" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpSource" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCdpSource" }, "patch": { "summary": "Update a source", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Source", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpSource" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "source" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpSource" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCdpSource" }, "delete": { "summary": "Remove a source", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Source", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "source" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCdpSource" } }, "/cdp/{connection_id}/destination": { "post": { "summary": "Create a destination", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpDestination" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "destination" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpDestination" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCdpDestination" }, "get": { "summary": "List all destinations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "destination" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CdpDestination" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCdpDestinations" } }, "/cdp/{connection_id}/destination/{id}": { "get": { "summary": "Retrieve a destination", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Destination", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "destination" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpDestination" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCdpDestination" }, "put": { "summary": "Update a destination", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Destination", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpDestination" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "destination" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpDestination" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCdpDestination" }, "patch": { "summary": "Update a destination", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "slug", "type", "direction", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Destination", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpDestination" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "destination" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpDestination" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCdpDestination" }, "delete": { "summary": "Remove a destination", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Destination", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "destination" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCdpDestination" } }, "/cdp/{connection_id}/activation": { "post": { "summary": "Create an activation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "segment_id", "destination_id", "source_id", "schedule", "status", "last_run_at", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpActivation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "activation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpActivation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createCdpActivation" }, "get": { "summary": "List all activations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "segment_id", "in": "query", "required": false, "description": "The segment ID to filter by" }, { "type": "string", "name": "destination_id", "in": "query", "required": false, "description": "The destination ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "segment_id", "destination_id", "source_id", "schedule", "status", "last_run_at", "is_enabled", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "activation" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/CdpActivation" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listCdpActivations" } }, "/cdp/{connection_id}/activation/{id}": { "get": { "summary": "Retrieve an activation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "segment_id", "destination_id", "source_id", "schedule", "status", "last_run_at", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "activation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpActivation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getCdpActivation" }, "put": { "summary": "Update an activation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "segment_id", "destination_id", "source_id", "schedule", "status", "last_run_at", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpActivation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "activation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpActivation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateCdpActivation" }, "patch": { "summary": "Update an activation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "segment_id", "destination_id", "source_id", "schedule", "status", "last_run_at", "is_enabled", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CdpActivation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "activation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/CdpActivation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathCdpActivation" }, "delete": { "summary": "Remove an activation", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Activation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "cdp", "activation" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeCdpActivation" } }, "/performance/{connection_id}/cycle/{id}": { "get": { "summary": "Retrieve a cycle", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "status", "start_at", "end_at", "due_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Cycle", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "cycle" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PerformanceCycle" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPerformanceCycle" } }, "/performance/{connection_id}/cycle": { "get": { "summary": "List all cycles", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "REVIEW", "GOAL", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "type", "status", "start_at", "end_at", "due_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "cycle" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PerformanceCycle" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPerformanceCycles" } }, "/performance/{connection_id}/review/{id}": { "get": { "summary": "Retrieve a review", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "reviewer_user_id", "cycle_id", "template_identifier", "type", "status", "rating", "rating_maximum", "rating_description", "comment", "questions", "is_acknowledged", "submitted_at", "completed_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Review", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "review" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PerformanceReview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPerformanceReview" } }, "/performance/{connection_id}/review": { "get": { "summary": "List all reviews", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "cycle_id", "in": "query", "required": false, "description": "The performance cycle ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "SELF", "MANAGER", "PEER", "UPWARD", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "reviewer_user_id", "cycle_id", "template_identifier", "type", "status", "rating", "rating_maximum", "rating_description", "comment", "questions", "is_acknowledged", "submitted_at", "completed_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "review" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PerformanceReview" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPerformanceReviews" } }, "/performance/{connection_id}/goal": { "post": { "summary": "Create a goal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "user_ids", "company_id", "parent_id", "cycle_id", "type", "status", "progress", "weight", "start_at", "due_at", "completed_at", "milestones", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PerformanceGoal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "goal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PerformanceGoal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createPerformanceGoal" }, "get": { "summary": "List all goals", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "cycle_id", "in": "query", "required": false, "description": "The performance cycle ID to filter by" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "INDIVIDUAL", "TEAM", "DEPARTMENT", "COMPANY", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "user_ids", "company_id", "parent_id", "cycle_id", "type", "status", "progress", "weight", "start_at", "due_at", "completed_at", "milestones", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "goal" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PerformanceGoal" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPerformanceGoals" } }, "/performance/{connection_id}/goal/{id}": { "get": { "summary": "Retrieve a goal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "user_ids", "company_id", "parent_id", "cycle_id", "type", "status", "progress", "weight", "start_at", "due_at", "completed_at", "milestones", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Goal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "goal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PerformanceGoal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPerformanceGoal" }, "put": { "summary": "Update a goal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "user_ids", "company_id", "parent_id", "cycle_id", "type", "status", "progress", "weight", "start_at", "due_at", "completed_at", "milestones", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Goal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PerformanceGoal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "goal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PerformanceGoal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updatePerformanceGoal" }, "patch": { "summary": "Update a goal", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "user_ids", "company_id", "parent_id", "cycle_id", "type", "status", "progress", "weight", "start_at", "due_at", "completed_at", "milestones", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Goal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PerformanceGoal" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "goal" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PerformanceGoal" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathPerformanceGoal" }, "delete": { "summary": "Remove a goal", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Goal", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "goal" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removePerformanceGoal" } }, "/performance/{connection_id}/feedback": { "post": { "summary": "Create a feedback", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "author_user_id", "type", "message", "tags", "is_visible", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PerformanceFeedback" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "feedback" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PerformanceFeedback" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createPerformanceFeedback" }, "get": { "summary": "List all feedbacks", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "PRAISE", "FEEDBACK", "REQUESTED", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "author_user_id", "type", "message", "tags", "is_visible", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "feedback" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/PerformanceFeedback" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listPerformanceFeedbacks" } }, "/performance/{connection_id}/feedback/{id}": { "get": { "summary": "Retrieve a feedback", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "user_id", "author_user_id", "type", "message", "tags", "is_visible", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Feedback", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "performance", "feedback" ], "responses": { "200": { "schema": { "$ref": "#/definitions/PerformanceFeedback" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getPerformanceFeedback" } }, "/social/{connection_id}/post": { "post": { "summary": "Create a post", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "parent_post_id", "title", "body", "status", "type", "media", "url", "language", "scheduled_at", "call_to_action", "metrics", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SocialPost" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "post" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialPost" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createSocialPost" }, "get": { "summary": "List all posts", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "profile_id", "in": "query", "required": false, "description": "The profile ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "parent_post_id", "title", "body", "status", "type", "media", "url", "language", "scheduled_at", "call_to_action", "metrics", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "post" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SocialPost" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listSocialPosts" } }, "/social/{connection_id}/post/{id}": { "get": { "summary": "Retrieve a post", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "parent_post_id", "title", "body", "status", "type", "media", "url", "language", "scheduled_at", "call_to_action", "metrics", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Post", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "post" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialPost" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getSocialPost" }, "put": { "summary": "Update a post", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "parent_post_id", "title", "body", "status", "type", "media", "url", "language", "scheduled_at", "call_to_action", "metrics", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Post", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SocialPost" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "post" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialPost" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateSocialPost" }, "patch": { "summary": "Update a post", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "parent_post_id", "title", "body", "status", "type", "media", "url", "language", "scheduled_at", "call_to_action", "metrics", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Post", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SocialPost" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "post" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialPost" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathSocialPost" }, "delete": { "summary": "Remove a post", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Post", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "post" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeSocialPost" } }, "/social/{connection_id}/profile/{id}": { "get": { "summary": "Retrieve a profile", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "username", "parent_id", "description", "url", "website_url", "avatar_url", "phone", "location", "address", "category", "is_verified", "is_private", "metrics", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Profile", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "profile" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialProfile" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getSocialProfile" } }, "/social/{connection_id}/profile": { "get": { "summary": "List all profiles", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "username", "parent_id", "description", "url", "website_url", "avatar_url", "phone", "location", "address", "category", "is_verified", "is_private", "metrics", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "profile" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SocialProfile" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listSocialProfiles" } }, "/social/{connection_id}/review/{id}": { "get": { "summary": "Retrieve a review", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "rating", "title", "content", "author_name", "author_avatar_url", "author_location", "reply", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Review", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "review" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialReview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getSocialReview" }, "put": { "summary": "Update a review", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "rating", "title", "content", "author_name", "author_avatar_url", "author_location", "reply", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Review", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SocialReview" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "review" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialReview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateSocialReview" }, "patch": { "summary": "Update a review", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "rating", "title", "content", "author_name", "author_avatar_url", "author_location", "reply", "url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Review", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SocialReview" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "review" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialReview" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathSocialReview" } }, "/social/{connection_id}/review": { "get": { "summary": "List all reviews", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "profile_id", "in": "query", "required": false, "description": "The profile ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "profile_id", "rating", "title", "content", "author_name", "author_avatar_url", "author_location", "reply", "url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "review" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SocialReview" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listSocialReviews" } }, "/social/{connection_id}/insight/{id}": { "get": { "summary": "Retrieve an insight", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "profile_id", "post_id", "date", "period", "metric", "value", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Insight", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "insight" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SocialInsight" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getSocialInsight" } }, "/social/{connection_id}/insight": { "get": { "summary": "List all insights", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "profile_id", "in": "query", "required": false, "description": "The profile ID to filter by" }, { "type": "string", "name": "post_id", "in": "query", "required": false, "description": "The post ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "profile_id", "post_id", "date", "period", "metric", "value", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "social", "insight" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SocialInsight" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listSocialInsights" } }, "/legal/{connection_id}/matter": { "post": { "summary": "Create a matter", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "number", "description", "status", "billing_method", "practicearea_id", "stage", "contact_ids", "company_ids", "parties", "user_id", "originating_user_id", "user_ids", "client_reference", "currency", "is_billable", "opened_at", "closed_at", "pending_at", "statute_of_limitations_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalMatter" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "matter" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalMatter" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLegalMatter" }, "get": { "summary": "List all matters", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "contact_id", "in": "query", "required": false, "description": "The contact ID to filter by" }, { "type": "string", "name": "company_id", "in": "query", "required": false, "description": "The company ID to filter by" }, { "type": "string", "name": "practicearea_id", "in": "query", "required": false, "description": "The practice area ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "number", "description", "status", "billing_method", "practicearea_id", "stage", "contact_ids", "company_ids", "parties", "user_id", "originating_user_id", "user_ids", "client_reference", "currency", "is_billable", "opened_at", "closed_at", "pending_at", "statute_of_limitations_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "matter" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LegalMatter" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLegalMatters" } }, "/legal/{connection_id}/matter/{id}": { "get": { "summary": "Retrieve a matter", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "number", "description", "status", "billing_method", "practicearea_id", "stage", "contact_ids", "company_ids", "parties", "user_id", "originating_user_id", "user_ids", "client_reference", "currency", "is_billable", "opened_at", "closed_at", "pending_at", "statute_of_limitations_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Matter", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "matter" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalMatter" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLegalMatter" }, "put": { "summary": "Update a matter", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "number", "description", "status", "billing_method", "practicearea_id", "stage", "contact_ids", "company_ids", "parties", "user_id", "originating_user_id", "user_ids", "client_reference", "currency", "is_billable", "opened_at", "closed_at", "pending_at", "statute_of_limitations_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Matter", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalMatter" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "matter" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalMatter" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLegalMatter" }, "patch": { "summary": "Update a matter", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "number", "description", "status", "billing_method", "practicearea_id", "stage", "contact_ids", "company_ids", "parties", "user_id", "originating_user_id", "user_ids", "client_reference", "currency", "is_billable", "opened_at", "closed_at", "pending_at", "statute_of_limitations_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Matter", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalMatter" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "matter" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalMatter" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLegalMatter" }, "delete": { "summary": "Remove a matter", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Matter", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "matter" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLegalMatter" } }, "/legal/{connection_id}/practicearea": { "post": { "summary": "Create a practicearea", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "code", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalPracticearea" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "practicearea" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalPracticearea" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLegalPracticearea" }, "get": { "summary": "List all practiceareas", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "code", "is_active", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "practicearea" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LegalPracticearea" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLegalPracticeareas" } }, "/legal/{connection_id}/practicearea/{id}": { "get": { "summary": "Retrieve a practicearea", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "code", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Practicearea", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "practicearea" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalPracticearea" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLegalPracticearea" }, "put": { "summary": "Update a practicearea", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "code", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Practicearea", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalPracticearea" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "practicearea" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalPracticearea" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLegalPracticearea" }, "patch": { "summary": "Update a practicearea", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "code", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Practicearea", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalPracticearea" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "practicearea" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalPracticearea" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLegalPracticearea" }, "delete": { "summary": "Remove a practicearea", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Practicearea", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "practicearea" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLegalPracticearea" } }, "/legal/{connection_id}/timeentry": { "post": { "summary": "Create a timeentry", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "worked_at", "minutes", "billable_minutes", "rate_amount", "total_amount", "currency", "is_billable", "is_billed", "invoice_id", "activity_code", "task_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalTimeentry" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "timeentry" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalTimeentry" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLegalTimeentry" }, "get": { "summary": "List all timeentries", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "matter_id", "in": "query", "required": false, "description": "The matter ID to filter by" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "worked_at", "minutes", "billable_minutes", "rate_amount", "total_amount", "currency", "is_billable", "is_billed", "invoice_id", "activity_code", "task_code", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "timeentry" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LegalTimeentry" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLegalTimeentries" } }, "/legal/{connection_id}/timeentry/{id}": { "get": { "summary": "Retrieve a timeentry", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "worked_at", "minutes", "billable_minutes", "rate_amount", "total_amount", "currency", "is_billable", "is_billed", "invoice_id", "activity_code", "task_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeentry", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "timeentry" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalTimeentry" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLegalTimeentry" }, "put": { "summary": "Update a timeentry", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "worked_at", "minutes", "billable_minutes", "rate_amount", "total_amount", "currency", "is_billable", "is_billed", "invoice_id", "activity_code", "task_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeentry", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalTimeentry" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "timeentry" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalTimeentry" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLegalTimeentry" }, "patch": { "summary": "Update a timeentry", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "worked_at", "minutes", "billable_minutes", "rate_amount", "total_amount", "currency", "is_billable", "is_billed", "invoice_id", "activity_code", "task_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeentry", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalTimeentry" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "timeentry" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalTimeentry" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLegalTimeentry" }, "delete": { "summary": "Remove a timeentry", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Timeentry", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "timeentry" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLegalTimeentry" } }, "/legal/{connection_id}/expense": { "post": { "summary": "Create an expense", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "incurred_at", "quantity", "price_amount", "total_amount", "currency", "type", "category", "is_billable", "is_billed", "invoice_id", "expense_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalExpense" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "expense" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalExpense" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createLegalExpense" }, "get": { "summary": "List all expenses", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "matter_id", "in": "query", "required": false, "description": "The matter ID to filter by" }, { "type": "string", "name": "user_id", "in": "query", "required": false, "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "HARD_COST", "SOFT_COST", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "incurred_at", "quantity", "price_amount", "total_amount", "currency", "type", "category", "is_billable", "is_billed", "invoice_id", "expense_code", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "expense" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/LegalExpense" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listLegalExpenses" } }, "/legal/{connection_id}/expense/{id}": { "get": { "summary": "Retrieve an expense", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "incurred_at", "quantity", "price_amount", "total_amount", "currency", "type", "category", "is_billable", "is_billed", "invoice_id", "expense_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expense", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "expense" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalExpense" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getLegalExpense" }, "put": { "summary": "Update an expense", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "incurred_at", "quantity", "price_amount", "total_amount", "currency", "type", "category", "is_billable", "is_billed", "invoice_id", "expense_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expense", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalExpense" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "expense" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalExpense" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateLegalExpense" }, "patch": { "summary": "Update an expense", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "matter_id", "user_id", "description", "incurred_at", "quantity", "price_amount", "total_amount", "currency", "type", "category", "is_billable", "is_billed", "invoice_id", "expense_code", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expense", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/LegalExpense" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "expense" ], "responses": { "200": { "schema": { "$ref": "#/definitions/LegalExpense" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathLegalExpense" }, "delete": { "summary": "Remove an expense", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Expense", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "legal", "expense" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeLegalExpense" } }, "/compute/{connection_id}/instance": { "post": { "summary": "Create an instance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "status_reason", "allowed_actions", "market", "region_id", "template_id", "image", "source_snapshot_id", "parent_instance_id", "gputype_id", "gpu_model", "gpu_count", "sku", "cpu_count", "memory_mb", "disk_mb", "architecture", "price_amount", "price_unit", "currency", "volume_ids", "endpoints", "ssh", "has_internet_access", "timeout_seconds", "expires_at", "on_expire", "idle_timeout_seconds", "on_idle", "project_identifier", "service_id", "env", "started_at", "terminated_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeInstance" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "instance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeInstance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeInstance" }, "get": { "summary": "List all instances", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "PROVISIONING", "STARTING", "RUNNING", "STOPPING", "STOPPED", "PAUSING", "PAUSED", "RESUMING", "RESTARTING", "TERMINATING", "TERMINATED", "PREEMPTED", "ERROR", "OTHER" ] }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "CONTAINER", "VM", "BAREMETAL", "SANDBOX", "OTHER" ] }, { "type": "string", "name": "region_id", "in": "query", "required": false, "description": "The ComputeRegion ID to filter by" }, { "type": "string", "name": "template_id", "in": "query", "required": false, "description": "The signing template ID to filter by" }, { "type": "string", "name": "service_id", "in": "query", "required": false, "description": "The ComputeService ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "status_reason", "allowed_actions", "market", "region_id", "template_id", "image", "source_snapshot_id", "parent_instance_id", "gputype_id", "gpu_model", "gpu_count", "sku", "cpu_count", "memory_mb", "disk_mb", "architecture", "price_amount", "price_unit", "currency", "volume_ids", "endpoints", "ssh", "has_internet_access", "timeout_seconds", "expires_at", "on_expire", "idle_timeout_seconds", "on_idle", "project_identifier", "service_id", "env", "started_at", "terminated_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "instance" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeInstance" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeInstances" } }, "/compute/{connection_id}/instance/{id}": { "get": { "summary": "Retrieve an instance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "status_reason", "allowed_actions", "market", "region_id", "template_id", "image", "source_snapshot_id", "parent_instance_id", "gputype_id", "gpu_model", "gpu_count", "sku", "cpu_count", "memory_mb", "disk_mb", "architecture", "price_amount", "price_unit", "currency", "volume_ids", "endpoints", "ssh", "has_internet_access", "timeout_seconds", "expires_at", "on_expire", "idle_timeout_seconds", "on_idle", "project_identifier", "service_id", "env", "started_at", "terminated_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Instance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "instance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeInstance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeInstance" }, "put": { "summary": "Update an instance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "status_reason", "allowed_actions", "market", "region_id", "template_id", "image", "source_snapshot_id", "parent_instance_id", "gputype_id", "gpu_model", "gpu_count", "sku", "cpu_count", "memory_mb", "disk_mb", "architecture", "price_amount", "price_unit", "currency", "volume_ids", "endpoints", "ssh", "has_internet_access", "timeout_seconds", "expires_at", "on_expire", "idle_timeout_seconds", "on_idle", "project_identifier", "service_id", "env", "started_at", "terminated_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Instance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeInstance" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "instance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeInstance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateComputeInstance" }, "patch": { "summary": "Update an instance", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "status_reason", "allowed_actions", "market", "region_id", "template_id", "image", "source_snapshot_id", "parent_instance_id", "gputype_id", "gpu_model", "gpu_count", "sku", "cpu_count", "memory_mb", "disk_mb", "architecture", "price_amount", "price_unit", "currency", "volume_ids", "endpoints", "ssh", "has_internet_access", "timeout_seconds", "expires_at", "on_expire", "idle_timeout_seconds", "on_idle", "project_identifier", "service_id", "env", "started_at", "terminated_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Instance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeInstance" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "instance" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeInstance" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathComputeInstance" }, "delete": { "summary": "Remove an instance", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Instance", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "instance" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeInstance" } }, "/compute/{connection_id}/template": { "post": { "summary": "Create a template", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "aliases", "image", "dockerfile", "start_command", "status", "gpu_model", "gpu_count", "cpu_count", "memory_mb", "disk_mb", "ports", "env", "is_public", "last_used_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeTemplate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "template" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeTemplate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeTemplate" }, "get": { "summary": "List all templates", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "aliases", "image", "dockerfile", "start_command", "status", "gpu_model", "gpu_count", "cpu_count", "memory_mb", "disk_mb", "ports", "env", "is_public", "last_used_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "template" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeTemplate" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeTemplates" } }, "/compute/{connection_id}/template/{id}": { "get": { "summary": "Retrieve a template", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "aliases", "image", "dockerfile", "start_command", "status", "gpu_model", "gpu_count", "cpu_count", "memory_mb", "disk_mb", "ports", "env", "is_public", "last_used_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Template", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "template" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeTemplate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeTemplate" }, "put": { "summary": "Update a template", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "aliases", "image", "dockerfile", "start_command", "status", "gpu_model", "gpu_count", "cpu_count", "memory_mb", "disk_mb", "ports", "env", "is_public", "last_used_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Template", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeTemplate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "template" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeTemplate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateComputeTemplate" }, "patch": { "summary": "Update a template", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "aliases", "image", "dockerfile", "start_command", "status", "gpu_model", "gpu_count", "cpu_count", "memory_mb", "disk_mb", "ports", "env", "is_public", "last_used_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Template", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeTemplate" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "template" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeTemplate" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathComputeTemplate" }, "delete": { "summary": "Remove a template", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Template", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "template" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeTemplate" } }, "/compute/{connection_id}/gputype/{id}": { "get": { "summary": "Retrieve a gputype", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "gpu_model", "gpu_manufacturer", "sku", "gpu_count", "gpu_memory_mb", "cpu_count", "memory_mb", "disk_mb", "architecture", "prices", "availability", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Gputype", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "gputype" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeGputype" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeGputype" } }, "/compute/{connection_id}/gputype": { "get": { "summary": "List all gputypes", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "region_id", "in": "query", "required": false, "description": "The ComputeRegion ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "gpu_model", "gpu_manufacturer", "sku", "gpu_count", "gpu_memory_mb", "cpu_count", "memory_mb", "disk_mb", "architecture", "prices", "availability", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "gputype" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeGputype" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeGputypes" } }, "/compute/{connection_id}/region/{id}": { "get": { "summary": "Retrieve a region", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "location", "country", "gpu_models", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Region", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "region" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeRegion" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeRegion" } }, "/compute/{connection_id}/region": { "get": { "summary": "List all regions", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "location", "country", "gpu_models", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "region" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeRegion" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeRegions" } }, "/compute/{connection_id}/volume": { "post": { "summary": "Create a volume", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "size_mb", "used_mb", "region_id", "availability_zone", "instance_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeVolume" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "volume" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeVolume" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeVolume" }, "get": { "summary": "List all volumes", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "region_id", "in": "query", "required": false, "description": "The ComputeRegion ID to filter by" }, { "type": "string", "name": "instance_id", "in": "query", "required": false, "description": "The ComputeInstance ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "size_mb", "used_mb", "region_id", "availability_zone", "instance_ids", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "volume" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeVolume" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeVolumes" } }, "/compute/{connection_id}/volume/{id}": { "get": { "summary": "Retrieve a volume", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "size_mb", "used_mb", "region_id", "availability_zone", "instance_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Volume", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "volume" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeVolume" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeVolume" }, "put": { "summary": "Update a volume", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "size_mb", "used_mb", "region_id", "availability_zone", "instance_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Volume", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeVolume" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "volume" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeVolume" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateComputeVolume" }, "patch": { "summary": "Update a volume", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "size_mb", "used_mb", "region_id", "availability_zone", "instance_ids", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Volume", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeVolume" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "volume" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeVolume" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathComputeVolume" }, "delete": { "summary": "Remove a volume", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Volume", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "volume" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeVolume" } }, "/compute/{connection_id}/snapshot": { "post": { "summary": "Create a snapshot", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "instance_id", "volume_id", "type", "status", "size_mb", "expires_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeSnapshot" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "snapshot" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeSnapshot" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeSnapshot" }, "get": { "summary": "List all snapshots", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "instance_id", "in": "query", "required": false, "description": "The ComputeInstance ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "instance_id", "volume_id", "type", "status", "size_mb", "expires_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "snapshot" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeSnapshot" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeSnapshots" } }, "/compute/{connection_id}/snapshot/{id}": { "get": { "summary": "Retrieve a snapshot", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "instance_id", "volume_id", "type", "status", "size_mb", "expires_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Snapshot", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "snapshot" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeSnapshot" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeSnapshot" }, "delete": { "summary": "Remove a snapshot", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Snapshot", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "snapshot" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeSnapshot" } }, "/compute/{connection_id}/usage": { "get": { "summary": "List all usages", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "instance_id", "in": "query", "required": false, "description": "The ComputeInstance ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "start_at", "end_at", "instance_id", "category", "quantity", "unit", "cost_amount", "currency", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "usage" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeUsage" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeUsages" } }, "/compute/{connection_id}/key": { "post": { "summary": "Create a key", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "public_key", "private_key", "fingerprint", "registry_url", "username", "secret", "instance_id", "expires_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeKey" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "key" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeKey" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeKey" }, "get": { "summary": "List all keys", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "instance_id", "in": "query", "required": false, "description": "The ComputeInstance ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "SSH", "REGISTRY", "SECRET", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "public_key", "private_key", "fingerprint", "registry_url", "username", "secret", "instance_id", "expires_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "key" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeKey" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeKeys" } }, "/compute/{connection_id}/key/{id}": { "get": { "summary": "Retrieve a key", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "public_key", "private_key", "fingerprint", "registry_url", "username", "secret", "instance_id", "expires_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Key", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "key" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeKey" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeKey" }, "put": { "summary": "Update a key", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "public_key", "private_key", "fingerprint", "registry_url", "username", "secret", "instance_id", "expires_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Key", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeKey" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "key" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeKey" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateComputeKey" }, "patch": { "summary": "Update a key", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "public_key", "private_key", "fingerprint", "registry_url", "username", "secret", "instance_id", "expires_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Key", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeKey" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "key" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeKey" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathComputeKey" }, "delete": { "summary": "Remove a key", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Key", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "key" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeKey" } }, "/compute/{connection_id}/service": { "post": { "summary": "Create a service", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "runtime", "region_id", "gputype_id", "sku", "instance_count", "min_instance_count", "max_instance_count", "repo_url", "branch", "image", "build_command", "start_command", "url", "project_identifier", "env", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeService" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "service" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeService" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeService" }, "get": { "summary": "List all services", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "CREATING", "DEPLOYING", "LIVE", "SUSPENDED", "FAILED", "OTHER" ] }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "WEB", "WORKER", "CRON", "STATIC", "PRIVATE", "OTHER" ] }, { "type": "string", "name": "region_id", "in": "query", "required": false, "description": "The ComputeRegion ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "runtime", "region_id", "gputype_id", "sku", "instance_count", "min_instance_count", "max_instance_count", "repo_url", "branch", "image", "build_command", "start_command", "url", "project_identifier", "env", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "service" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeService" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeServices" } }, "/compute/{connection_id}/service/{id}": { "get": { "summary": "Retrieve a service", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "runtime", "region_id", "gputype_id", "sku", "instance_count", "min_instance_count", "max_instance_count", "repo_url", "branch", "image", "build_command", "start_command", "url", "project_identifier", "env", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Service", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "service" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeService" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeService" }, "put": { "summary": "Update a service", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "runtime", "region_id", "gputype_id", "sku", "instance_count", "min_instance_count", "max_instance_count", "repo_url", "branch", "image", "build_command", "start_command", "url", "project_identifier", "env", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Service", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeService" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "service" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeService" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateComputeService" }, "patch": { "summary": "Update a service", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "type", "status", "runtime", "region_id", "gputype_id", "sku", "instance_count", "min_instance_count", "max_instance_count", "repo_url", "branch", "image", "build_command", "start_command", "url", "project_identifier", "env", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Service", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeService" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "service" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeService" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathComputeService" }, "delete": { "summary": "Remove a service", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Service", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "service" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeService" } }, "/compute/{connection_id}/deployment": { "post": { "summary": "Create a deployment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "status", "trigger", "environment", "commit_identifier", "commit_message", "branch", "image", "url", "started_at", "finished_at", "error", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeDeployment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "deployment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeDeployment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeDeployment" }, "get": { "summary": "List all deployments", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "service_id", "in": "query", "required": false, "description": "The ComputeService ID to filter by" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "QUEUED", "BUILDING", "DEPLOYING", "LIVE", "FAILED", "CANCELED", "SUPERSEDED", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "status", "trigger", "environment", "commit_identifier", "commit_message", "branch", "image", "url", "started_at", "finished_at", "error", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "deployment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeDeployment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeDeployments" } }, "/compute/{connection_id}/deployment/{id}": { "get": { "summary": "Retrieve a deployment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "status", "trigger", "environment", "commit_identifier", "commit_message", "branch", "image", "url", "started_at", "finished_at", "error", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deployment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "deployment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeDeployment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeDeployment" }, "put": { "summary": "Update a deployment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "status", "trigger", "environment", "commit_identifier", "commit_message", "branch", "image", "url", "started_at", "finished_at", "error", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deployment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeDeployment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "deployment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeDeployment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateComputeDeployment" }, "patch": { "summary": "Update a deployment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "status", "trigger", "environment", "commit_identifier", "commit_message", "branch", "image", "url", "started_at", "finished_at", "error", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deployment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeDeployment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "deployment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeDeployment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathComputeDeployment" }, "delete": { "summary": "Remove a deployment", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Deployment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "deployment" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeDeployment" } }, "/compute/{connection_id}/domain": { "post": { "summary": "Create a domain", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "status", "is_primary", "redirect_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeDomain" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "domain" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeDomain" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeDomain" }, "get": { "summary": "List all domains", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "service_id", "in": "query", "required": false, "description": "The ComputeService ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "status", "is_primary", "redirect_url", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "domain" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeDomain" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeDomains" } }, "/compute/{connection_id}/domain/{id}": { "get": { "summary": "Retrieve a domain", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "status", "is_primary", "redirect_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Domain", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "domain" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeDomain" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeDomain" }, "put": { "summary": "Update a domain", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "status", "is_primary", "redirect_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Domain", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeDomain" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "domain" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeDomain" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateComputeDomain" }, "patch": { "summary": "Update a domain", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "status", "is_primary", "redirect_url", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Domain", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeDomain" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "domain" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeDomain" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathComputeDomain" }, "delete": { "summary": "Remove a domain", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Domain", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "domain" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeDomain" } }, "/compute/{connection_id}/envvar": { "post": { "summary": "Create an envvar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "value", "environments", "is_secret", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeEnvvar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "envvar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeEnvvar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createComputeEnvvar" }, "get": { "summary": "List all envvars", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "service_id", "in": "query", "required": false, "description": "The ComputeService ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "value", "environments", "is_secret", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "envvar" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ComputeEnvvar" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listComputeEnvvars" } }, "/compute/{connection_id}/envvar/{id}": { "get": { "summary": "Retrieve an envvar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "value", "environments", "is_secret", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Envvar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "envvar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeEnvvar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getComputeEnvvar" }, "put": { "summary": "Update an envvar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "value", "environments", "is_secret", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Envvar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeEnvvar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "envvar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeEnvvar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateComputeEnvvar" }, "patch": { "summary": "Update an envvar", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "service_id", "name", "value", "environments", "is_secret", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Envvar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ComputeEnvvar" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "envvar" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ComputeEnvvar" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathComputeEnvvar" }, "delete": { "summary": "Remove an envvar", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Envvar", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "compute", "envvar" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeComputeEnvvar" } }, "/healthcare/{connection_id}/patient": { "post": { "summary": "Create a patient", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "gender", "birthdate", "is_deceased", "deceased_at", "emails", "telephones", "address", "language", "identifiers", "practitioner_ids", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HealthcarePatient" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "patient" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcarePatient" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHealthcarePatient" }, "get": { "summary": "List all patients", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "gender", "birthdate", "is_deceased", "deceased_at", "emails", "telephones", "address", "language", "identifiers", "practitioner_ids", "is_active", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "patient" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcarePatient" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcarePatients" } }, "/healthcare/{connection_id}/patient/{id}": { "get": { "summary": "Retrieve a patient", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "gender", "birthdate", "is_deceased", "deceased_at", "emails", "telephones", "address", "language", "identifiers", "practitioner_ids", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Patient", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "patient" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcarePatient" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcarePatient" }, "put": { "summary": "Update a patient", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "gender", "birthdate", "is_deceased", "deceased_at", "emails", "telephones", "address", "language", "identifiers", "practitioner_ids", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Patient", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HealthcarePatient" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "patient" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcarePatient" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHealthcarePatient" }, "patch": { "summary": "Update a patient", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "gender", "birthdate", "is_deceased", "deceased_at", "emails", "telephones", "address", "language", "identifiers", "practitioner_ids", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Patient", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HealthcarePatient" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "patient" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcarePatient" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHealthcarePatient" } }, "/healthcare/{connection_id}/practitioner/{id}": { "get": { "summary": "Retrieve a practitioner", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "gender", "emails", "telephones", "address", "image_url", "identifiers", "specialties", "qualifications", "languages", "location_ids", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Practitioner", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "practitioner" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcarePractitioner" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcarePractitioner" } }, "/healthcare/{connection_id}/practitioner": { "get": { "summary": "List all practitioners", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "first_name", "last_name", "title", "gender", "emails", "telephones", "address", "image_url", "identifiers", "specialties", "qualifications", "languages", "location_ids", "is_active", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "practitioner" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcarePractitioner" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcarePractitioners" } }, "/healthcare/{connection_id}/location/{id}": { "get": { "summary": "Retrieve a location", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "organization_name", "address", "telephones", "emails", "latitude", "longitude", "identifiers", "is_active", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Location", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "location" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareLocation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareLocation" } }, "/healthcare/{connection_id}/location": { "get": { "summary": "List all locations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "parent_id", "in": "query", "required": false, "description": "The parent ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "description", "parent_id", "organization_name", "address", "telephones", "emails", "latitude", "longitude", "identifiers", "is_active", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "location" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareLocation" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareLocations" } }, "/healthcare/{connection_id}/appointment": { "post": { "summary": "Create an appointment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "practitioner_ids", "location_id", "slot_ids", "status", "start_at", "end_at", "description", "service_types", "reasons", "cancellation_reason", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HealthcareAppointment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "appointment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareAppointment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHealthcareAppointment" }, "get": { "summary": "List all appointments", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "patient_id", "in": "query", "required": false, "description": "The patient ID to filter by" }, { "type": "string", "name": "practitioner_id", "in": "query", "required": false, "description": "The practitioner ID to filter by" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by" }, { "type": "string", "name": "status", "in": "query", "required": false, "enum": [ "PROPOSED", "PENDING", "BOOKED", "ARRIVED", "CHECKED_IN", "FULFILLED", "CANCELLED", "NOSHOW", "WAITLIST", "ENTERED_IN_ERROR", "OTHER" ] }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "practitioner_ids", "location_id", "slot_ids", "status", "start_at", "end_at", "description", "service_types", "reasons", "cancellation_reason", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "appointment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareAppointment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareAppointments" } }, "/healthcare/{connection_id}/appointment/{id}": { "get": { "summary": "Retrieve an appointment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "practitioner_ids", "location_id", "slot_ids", "status", "start_at", "end_at", "description", "service_types", "reasons", "cancellation_reason", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Appointment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "appointment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareAppointment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareAppointment" }, "put": { "summary": "Update an appointment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "practitioner_ids", "location_id", "slot_ids", "status", "start_at", "end_at", "description", "service_types", "reasons", "cancellation_reason", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Appointment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HealthcareAppointment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "appointment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareAppointment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateHealthcareAppointment" }, "patch": { "summary": "Update an appointment", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "practitioner_ids", "location_id", "slot_ids", "status", "start_at", "end_at", "description", "service_types", "reasons", "cancellation_reason", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Appointment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HealthcareAppointment" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "appointment" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareAppointment" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathHealthcareAppointment" }, "delete": { "summary": "Remove an appointment", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Appointment", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "appointment" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeHealthcareAppointment" } }, "/healthcare/{connection_id}/slot/{id}": { "get": { "summary": "Retrieve a slot", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "practitioner_id", "location_id", "status", "start_at", "end_at", "service_types", "is_overbooked", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Slot", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "slot" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareSlot" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareSlot" } }, "/healthcare/{connection_id}/slot": { "get": { "summary": "List all slots", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "practitioner_id", "in": "query", "required": false, "description": "The practitioner ID to filter by" }, { "type": "string", "name": "location_id", "in": "query", "required": false, "description": "The location ID to filter by" }, { "type": "string", "name": "start_gte", "in": "query", "required": false, "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "end_lt", "in": "query", "required": false, "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "practitioner_id", "location_id", "status", "start_at", "end_at", "service_types", "is_overbooked", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "slot" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareSlot" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareSlots" } }, "/healthcare/{connection_id}/encounter/{id}": { "get": { "summary": "Retrieve an encounter", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "practitioner_ids", "location_id", "appointment_id", "condition_ids", "status", "type", "reasons", "start_at", "end_at", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Encounter", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "encounter" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareEncounter" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareEncounter" } }, "/healthcare/{connection_id}/encounter": { "get": { "summary": "List all encounters", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "patient_id", "in": "query", "required": false, "description": "The patient ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "practitioner_ids", "location_id", "appointment_id", "condition_ids", "status", "type", "reasons", "start_at", "end_at", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "encounter" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareEncounter" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareEncounters" } }, "/healthcare/{connection_id}/condition/{id}": { "get": { "summary": "Retrieve a condition", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "type", "onset_at", "resolved_at", "recorded_at", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Condition", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "condition" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareCondition" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareCondition" } }, "/healthcare/{connection_id}/condition": { "get": { "summary": "List all conditions", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "patient_id", "in": "query", "required": false, "description": "The patient ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "type", "onset_at", "resolved_at", "recorded_at", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "condition" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCondition" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareConditions" } }, "/healthcare/{connection_id}/allergy/{id}": { "get": { "summary": "Retrieve an allergy", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "type", "criticality", "reactions", "onset_at", "recorded_at", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Allergy", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "allergy" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareAllergy" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareAllergy" } }, "/healthcare/{connection_id}/allergy": { "get": { "summary": "List all allergies", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "patient_id", "in": "query", "required": false, "description": "The patient ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "type", "criticality", "reactions", "onset_at", "recorded_at", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "allergy" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareAllergy" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareAllergies" } }, "/healthcare/{connection_id}/medication/{id}": { "get": { "summary": "Retrieve a medication", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "dosage", "refill_count", "authored_at", "start_at", "end_at", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Medication", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "medication" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareMedication" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareMedication" } }, "/healthcare/{connection_id}/medication": { "get": { "summary": "List all medications", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "patient_id", "in": "query", "required": false, "description": "The patient ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "dosage", "refill_count", "authored_at", "start_at", "end_at", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "medication" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMedication" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareMedications" } }, "/healthcare/{connection_id}/observation": { "post": { "summary": "Create an observation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "type", "value_number", "value_unit", "value_text", "interpretation", "reference_range", "components", "observed_at", "issued_at", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/HealthcareObservation" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "observation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareObservation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createHealthcareObservation" }, "get": { "summary": "List all observations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "patient_id", "in": "query", "required": false, "description": "The patient ID to filter by" }, { "type": "string", "name": "type", "in": "query", "required": false, "enum": [ "LABORATORY", "VITAL_SIGNS", "SOCIAL_HISTORY", "IMAGING", "SURVEY", "EXAM", "PROCEDURE", "THERAPY", "ACTIVITY", "OTHER" ] }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "type", "value_number", "value_unit", "value_text", "interpretation", "reference_range", "components", "observed_at", "issued_at", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "observation" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareObservation" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareObservations" } }, "/healthcare/{connection_id}/observation/{id}": { "get": { "summary": "Retrieve an observation", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "name", "codes", "status", "type", "value_number", "value_unit", "value_text", "interpretation", "reference_range", "components", "observed_at", "issued_at", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Observation", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "observation" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareObservation" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareObservation" } }, "/healthcare/{connection_id}/immunization/{id}": { "get": { "summary": "Retrieve an immunization", "parameters": [ { "type": "array", "name": "fields", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "location_id", "name", "codes", "status", "administered_at", "lot_number", "expires_at", "notes", "metadata", "raw" ] }, "description": "Fields to return" }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Immunization", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "immunization" ], "responses": { "200": { "schema": { "$ref": "#/definitions/HealthcareImmunization" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getHealthcareImmunization" } }, "/healthcare/{connection_id}/immunization": { "get": { "summary": "List all immunizations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "type": "string", "name": "patient_id", "in": "query", "required": false, "description": "The patient ID to filter by" }, { "type": "array", "name": "fields", "in": "query", "required": false, "description": "Fields to return", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "patient_id", "encounter_id", "practitioner_id", "location_id", "name", "codes", "status", "administered_at", "lot_number", "expires_at", "notes", "metadata", "raw" ] } }, { "type": "string", "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "healthcare", "immunization" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/HealthcareImmunization" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listHealthcareImmunizations" } }, "/unified/notification": { "get": { "summary": "List event notifications", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "notification" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Notification" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedNotifications" } }, "/unified/connection": { "post": { "summary": "Create connection", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Connection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "connection" ], "description": "Used only to import existing customer credentials. To connect a new account, use the \"Authorize or re-authorize a connection\" auth URL instead. To change credentials on an existing connection, use \"Update connection\".", "responses": { "200": { "schema": { "$ref": "#/definitions/Connection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createUnifiedConnection" }, "get": { "summary": "List all connections", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "external_xref", "in": "query", "required": false, "description": "Filter the results to only those integrations for your user referenced by this value" }, { "type": "array", "name": "categories", "in": "query", "required": false, "description": "Filter the results on these categories", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "passthrough", "hris", "ats", "auth", "saml", "crm", "enrich", "martech", "ticketing", "uc", "accounting", "storage", "commerce", "payment", "genai", "messaging", "kms", "task", "scim", "lms", "repo", "metadata", "calendar", "verification", "ads", "analytics", "forms", "shipping", "assessment", "signing", "clubs", "datastore", "cdp", "performance", "social", "legal", "compute", "healthcare" ] } }, { "type": "string", "name": "env", "in": "query", "required": false, "default": "Production" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "connection" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Connection" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedConnections" } }, "/unified/connection/{id}": { "get": { "summary": "Retrieve connection", "parameters": [ { "type": "string", "description": "ID of the Connection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "connection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/Connection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUnifiedConnection" }, "put": { "summary": "Update connection", "parameters": [ { "type": "string", "description": "ID of the Connection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Connection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "connection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/Connection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateUnifiedConnection" }, "patch": { "summary": "Update connection", "parameters": [ { "type": "string", "description": "ID of the Connection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Connection" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "connection" ], "responses": { "200": { "schema": { "$ref": "#/definitions/Connection" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathUnifiedConnection" }, "delete": { "summary": "Remove connection", "parameters": [ { "type": "string", "description": "ID of the Connection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "connection" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeUnifiedConnection" } }, "/unified/connection/{id}/reauth": { "post": { "summary": "Create a re-authorization token for a connection", "parameters": [ { "type": "string", "description": "ID of the Connection", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "connection" ], "description": "Returns a short-lived, single-use token that lets your end-user re-authorize this existing connection in place via the \"Authorize or re-authorize a connection\" URL with connection_id and reauth_token.", "responses": { "200": { "schema": { "$ref": "#/definitions/ConnectionReauth" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createUnifiedConnectionReauth" } }, "/unified/secretsmanager/instructions": { "get": { "summary": "List secrets manager setup instructions", "parameters": [], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "secretsmanager" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SecretsManagerInstructions" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedSecretsmanagerInstructions" } }, "/unified/secretsmanager/secrets": { "get": { "summary": "List secrets in a secrets manager", "parameters": [ { "type": "string", "name": "secretsmanager_id", "in": "query", "required": true, "description": "The secrets manager to list secrets from" }, { "type": "string", "name": "query", "in": "query", "required": false, "description": "Filter secrets by name" }, { "type": "number", "name": "limit", "in": "query", "required": false, "description": "Maximum number of secrets to return" }, { "type": "number", "name": "offset", "in": "query", "required": false, "description": "Number of secrets to skip" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "secretsmanager" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SecretsManagerSecret" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedSecretsmanagerSecrets" } }, "/unified/secretsmanager": { "post": { "summary": "Create secrets manager", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SecretsManager" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "secretsmanager" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SecretsManager" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createUnifiedSecretsmanager" }, "get": { "summary": "List secrets managers", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false }, { "type": "number", "name": "offset", "in": "query", "required": false }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "secretsmanager" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/SecretsManager" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedSecretsmanagers" } }, "/unified/secretsmanager/{id}": { "get": { "summary": "Retrieve secrets manager", "parameters": [ { "type": "string", "description": "ID of the Secretsmanager", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "secretsmanager" ], "responses": { "200": { "schema": { "$ref": "#/definitions/SecretsManager" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUnifiedSecretsmanager" }, "delete": { "summary": "Remove secrets manager", "parameters": [ { "type": "string", "description": "ID of the Secretsmanager", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "secretsmanager" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeUnifiedSecretsmanager" } }, "/unified/issue/{id}": { "get": { "summary": "Retrieve support issue", "parameters": [ { "type": "string", "description": "ID of the Issue", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "issue" ], "responses": { "200": { "schema": { "$ref": "#/definitions/Issue" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUnifiedIssue" } }, "/unified/issue": { "get": { "summary": "List support issues", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "issue" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Issue" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedIssues" } }, "/unified/integration": { "get": { "summary": "Returns all integrations", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false }, { "type": "number", "name": "offset", "in": "query", "required": false }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "categories", "in": "query", "required": false, "description": "Filter the results on these categories", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "passthrough", "hris", "ats", "auth", "saml", "crm", "enrich", "martech", "ticketing", "uc", "accounting", "storage", "commerce", "payment", "genai", "messaging", "kms", "task", "scim", "lms", "repo", "metadata", "calendar", "verification", "ads", "analytics", "forms", "shipping", "assessment", "signing", "clubs", "datastore", "cdp", "performance", "social", "legal", "compute", "healthcare" ] } }, { "type": "boolean", "name": "summary", "in": "query", "required": false }, { "type": "boolean", "name": "active", "in": "query", "required": false, "description": "Filter the results for only the workspace's active integrations" }, { "type": "string", "name": "env", "in": "query", "required": false, "default": "Production" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "Filter the results for only this integration type" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "integration" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Integration" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedIntegrations" } }, "/unified/integration/workspace/{workspace_id}": { "get": { "summary": "Returns all activated integrations in a workspace", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 2000 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "type": "array", "name": "categories", "in": "query", "required": false, "description": "Filter the results on these categories", "collectionFormat": "multi", "items": { "type": "string", "enum": [ "passthrough", "hris", "ats", "auth", "saml", "crm", "enrich", "martech", "ticketing", "uc", "accounting", "storage", "commerce", "payment", "genai", "messaging", "kms", "task", "scim", "lms", "repo", "metadata", "calendar", "verification", "ads", "analytics", "forms", "shipping", "assessment", "signing", "clubs", "datastore", "cdp", "performance", "social", "legal", "compute", "healthcare" ] } }, { "type": "boolean", "name": "summary", "in": "query", "required": false }, { "type": "boolean", "name": "active", "in": "query", "required": false, "description": "Filter the results for only the workspace's active integrations" }, { "type": "string", "name": "env", "in": "query", "required": false, "default": "Production" }, { "type": "string", "description": "The ID of the workspace", "name": "workspace_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "integration" ], "description": "No authentication required as this is to be used by front-end interface", "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Integration" } }, "description": "Successful" } }, "operationId": "listUnifiedIntegrationWorkspaces" } }, "/unified/webhook/{id}": { "get": { "summary": "Retrieve webhook by its ID", "parameters": [ { "type": "string", "description": "ID of the Webhook", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "webhook" ], "responses": { "200": { "schema": { "$ref": "#/definitions/Webhook" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUnifiedWebhook" }, "put": { "summary": "Update webhook subscription", "parameters": [ { "type": "string", "description": "ID of the Webhook", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Webhook" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "webhook" ], "responses": { "200": { "schema": { "$ref": "#/definitions/Webhook" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateUnifiedWebhook" }, "patch": { "summary": "Update webhook subscription", "parameters": [ { "type": "string", "description": "ID of the Webhook", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Webhook" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "webhook" ], "responses": { "200": { "schema": { "$ref": "#/definitions/Webhook" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathUnifiedWebhook" }, "delete": { "summary": "Remove webhook subscription", "parameters": [ { "type": "string", "description": "ID of the Webhook", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "webhook" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeUnifiedWebhook" } }, "/unified/webhook": { "get": { "summary": "Returns all registered webhooks", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "object", "in": "query", "required": false, "description": "Filter the results for webhooks for only this object", "enum": [ "accounting_account", "accounting_transaction", "accounting_journal", "accounting_contact", "accounting_invoice", "accounting_bill", "accounting_vendorcredit", "accounting_creditmemo", "accounting_taxrate", "accounting_paymentterm", "accounting_organization", "accounting_order", "accounting_salesorder", "accounting_salesreceipt", "accounting_purchaseorder", "accounting_balancesheet", "accounting_profitloss", "accounting_trialbalance", "accounting_category", "accounting_expense", "accounting_expensereport", "accounting_purchasereceipt", "accounting_cashflow", "accounting_quote", "accounting_agedreceivable", "accounting_agedpayable", "accounting_project", "accounting_bankfeedaccount", "accounting_bankfeedtransaction", "payment_payment", "payment_link", "payment_payout", "payment_refund", "payment_subscription", "commerce_item", "commerce_collection", "commerce_inventory", "commerce_location", "commerce_review", "commerce_saleschannel", "commerce_itemvariant", "commerce_reservation", "commerce_availability", "verification_package", "verification_request", "assessment_package", "assessment_order", "ats_activity", "ats_application", "ats_applicationstatus", "ats_candidate", "ats_document", "ats_interview", "ats_job", "ats_scorecard", "ats_company", "crm_company", "crm_contact", "crm_deal", "crm_event", "crm_lead", "crm_pipeline", "crm_taxonomy", "hris_employee", "hris_group", "hris_payslip", "hris_timeoff", "hris_company", "hris_location", "hris_device", "hris_timeshift", "hris_attendance", "hris_deduction", "hris_benefit", "hris_bankaccount", "hris_document", "hris_taxonomy", "hris_job", "hris_payroll", "hris_paycode", "hris_earning", "martech_list", "martech_member", "martech_campaign", "martech_report", "passthrough", "ticketing_note", "ticketing_ticket", "ticketing_customer", "ticketing_category", "uc_contact", "uc_call", "uc_comment", "uc_recording", "uc_scorecard", "uc_scorecardtemplate", "enrich_person", "enrich_company", "storage_file", "genai_model", "genai_prompt", "genai_embedding", "genai_task", "genai_agent", "genai_organization", "genai_skill", "genai_memory", "messaging_message", "messaging_channel", "messaging_event", "kms_space", "kms_page", "kms_comment", "task_project", "task_task", "task_comment", "task_change", "scim_users", "scim_groups", "lms_course", "lms_class", "lms_student", "lms_instructor", "lms_content", "lms_collection", "lms_activity", "repo_organization", "repo_repository", "repo_branch", "repo_commit", "repo_pullrequest", "metadata_metadata", "calendar_calendar", "calendar_event", "calendar_busy", "calendar_link", "calendar_recording", "calendar_webinar", "ads_organization", "ads_ad", "ads_campaign", "ads_report", "ads_group", "ads_creative", "ads_asset", "ads_insertionorder", "ads_target", "ads_promoted", "analytics_property", "analytics_event", "analytics_session", "analytics_visitor", "analytics_report", "forms_form", "forms_submission", "shipping_carrier", "shipping_rate", "shipping_shipment", "shipping_label", "shipping_tracking", "signing_document", "signing_signatory", "signing_template", "clubs_group", "clubs_member", "clubs_activity", "clubs_location", "clubs_event", "datastore_database", "datastore_table", "datastore_record", "datastore_query", "cdp_profile", "cdp_segment", "cdp_event", "cdp_source", "cdp_destination", "cdp_activation", "performance_cycle", "performance_review", "performance_goal", "performance_feedback", "social_post", "social_profile", "social_review", "social_insight", "legal_matter", "legal_practicearea", "legal_timeentry", "legal_expense", "compute_instance", "compute_template", "compute_gputype", "compute_region", "compute_volume", "compute_snapshot", "compute_usage", "compute_key", "compute_service", "compute_deployment", "compute_domain", "compute_envvar", "healthcare_patient", "healthcare_practitioner", "healthcare_location", "healthcare_appointment", "healthcare_slot", "healthcare_encounter", "healthcare_condition", "healthcare_allergy", "healthcare_medication", "healthcare_observation", "healthcare_immunization" ] }, { "type": "string", "name": "integration_type", "in": "query", "required": false, "description": "Filter the results to just this integration" }, { "type": "string", "name": "connection_id", "in": "query", "required": false, "description": "Filter the results to just this integration" }, { "type": "string", "name": "created_lte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose created date is equal or less to this value", "default": "" }, { "type": "string", "name": "env", "in": "query", "required": false, "default": "Production" }, { "type": "boolean", "name": "is_healthy", "in": "query", "required": false, "description": "Filter by health. Omit to return all." } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "webhook" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedWebhooks" }, "post": { "summary": "Create webhook subscription", "parameters": [ { "type": "boolean", "name": "include_all", "in": "query", "required": false, "description": "When true, send existing/historic data. When false, no historic data is sent." }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Webhook" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "webhook" ], "description": "The data payload received by your server is described at https://docs.unified.to/unified/overview. The `interval` field can be set as low as 1 minute for paid accounts, and 60 minutes for free accounts.", "responses": { "200": { "schema": { "$ref": "#/definitions/Webhook" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createUnifiedWebhook" } }, "/unified/webhook/{id}/trigger": { "put": { "summary": "Trigger webhook", "parameters": [ { "type": "string", "description": "ID of the Webhook", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "webhook" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateUnifiedWebhookTrigger" }, "patch": { "summary": "Trigger webhook", "parameters": [ { "type": "string", "description": "ID of the Webhook", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "webhook" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathUnifiedWebhookTrigger" } }, "/unified/apicall/{id}": { "get": { "summary": "Retrieve specific API Call by its ID", "parameters": [ { "type": "string", "description": "ID of the Apicall", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "apicall" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ApiCall" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getUnifiedApicall" } }, "/unified/apicall": { "get": { "summary": "Returns API Calls", "parameters": [ { "type": "number", "name": "limit", "in": "query", "required": false, "default": 100 }, { "type": "number", "name": "offset", "in": "query", "required": false, "default": 0 }, { "type": "string", "name": "updated_gte", "in": "query", "required": false, "format": "date-time", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "default": "" }, { "type": "string", "name": "sort", "in": "query", "required": false, "enum": [ "name", "updated_at", "created_at" ] }, { "type": "string", "name": "order", "in": "query", "required": false, "enum": [ "asc", "desc" ] }, { "type": "string", "name": "external_xref", "in": "query", "required": false, "description": "Filter the results to only those integrations for your user referenced by this value" }, { "type": "string", "name": "integration_type", "in": "query", "required": false, "description": "Filter the results to just this integration" }, { "type": "boolean", "name": "error", "in": "query", "required": false, "description": "Filter the results for API Calls with errors" }, { "type": "string", "name": "connection_id", "in": "query", "required": false, "description": "Filter the results to just this integration" }, { "type": "string", "name": "env", "in": "query", "required": false, "default": "Production" }, { "type": "string", "name": "webhook_id", "in": "query", "required": false, "description": "Filter the results to just this webhook" }, { "type": "string", "name": "type", "in": "query", "required": false, "description": "Filter the results to just this type", "enum": [ "login", "webhook", "inbound", "mcp" ] }, { "type": "boolean", "name": "is_billable", "in": "query", "required": false, "description": "Filter the results for only billable API Calls" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "apicall" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ApiCall" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedApicalls" } }, "/unified/environment": { "get": { "summary": "Returns all environments", "parameters": [], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "environment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Environment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listUnifiedEnvironments" }, "post": { "summary": "Create new environments", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Environments_List" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "environment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Environment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createUnifiedEnvironment" } }, "/unified/environment/{env}": { "delete": { "summary": "Remove an environment", "parameters": [ { "type": "string", "name": "env", "in": "path", "required": true } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "environment" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/Environment" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeUnifiedEnvironment" } }, "/unified/integration/auth/{workspace_id}/{integration_type}": { "get": { "summary": "Authorize or re-authorize a connection", "parameters": [ { "type": "string", "name": "success_redirect", "in": "query", "required": false, "description": "The URL where you want the user to be redirect to after a successful authorization. The connection ID will be appended with (id=) to this URL, as will the state that was provided." }, { "type": "string", "name": "failure_redirect", "in": "query", "required": false, "description": "The URL where you want the user to be redirect to after an unsuccessful authentication. An \"error\" variable will be appended." }, { "type": "string", "name": "state", "in": "query", "required": false, "description": "Extra state to send back to your success URL" }, { "type": "string", "name": "external_xref", "in": "query", "required": false, "description": "Your user identifier to associate with the new Integration" }, { "type": "array", "name": "scopes", "in": "query", "required": false, "collectionFormat": "multi", "items": { "type": "string" } }, { "type": "boolean", "name": "redirect", "in": "query", "required": false }, { "type": "string", "name": "env", "in": "query", "required": false, "default": "Production" }, { "type": "string", "name": "lang", "in": "query", "required": false, "description": "Language: en, fr, es, it, pt, zh, hi" }, { "type": "string", "name": "subdomain", "in": "query", "required": false, "description": "Optional tenant domain or subdomain for integrations that require it to build the authorize, token, or API URL. Depending on the integration, this may be a bare subdomain or a full domain/URL." }, { "type": "string", "name": "region", "in": "query", "required": false, "description": "Optional region index (into the integration api.urls array) selected by the end-user. Set automatically by the auth widget when the workspace integration has prompt_region=true." }, { "type": "string", "name": "connection_id", "in": "query", "required": false, "description": "Existing connection ID to re-authorize in place instead of creating a duplicate. Requires reauth_token." }, { "type": "string", "name": "reauth_token", "in": "query", "required": false, "description": "Single-use token from \"Create a re-authorization token for a connection\" (POST /unified/connection/{id}/reauth); required with connection_id." }, { "type": "string", "description": "The ID of the workspace", "name": "workspace_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "Type of the supported integration", "name": "integration_type", "in": "path", "required": true } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "unified", "integration", "auth" ], "description": "Returns an authorization URL for the specified integration. After successful authorization, a new connection is created unless connection_id and reauth_token are provided, in which case the existing connection is updated in place.", "responses": { "200": { "schema": { "type": "string" }, "description": "Successful" } }, "operationId": "getUnifiedIntegrationAuth" } }, "/unified/integration/login/{workspace_id}/{integration_type}": { "get": { "summary": "Sign in a user", "parameters": [ { "type": "string", "name": "success_redirect", "in": "query", "required": false, "description": "The URL where you want the user to be redirect to after a successful authentication/sign-in. A \"jwt\" parameter will be appended to the URL which will contain a name and email of the user who just signed-in." }, { "type": "string", "name": "failure_redirect", "in": "query", "required": false, "description": "The URL where you want the user to be redirect to after an unsuccessful authentication. An \"error\" variable will be appended." }, { "type": "string", "name": "state", "in": "query", "required": false, "description": "Extra state to send back to your success URL" }, { "type": "boolean", "name": "redirect", "in": "query", "required": false }, { "type": "string", "name": "env", "in": "query", "required": false, "default": "Production" }, { "type": "string", "description": "The ID of the workspace", "name": "workspace_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "Type of the supported integration", "name": "integration_type", "in": "path", "required": true } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "auth", "login" ], "description": "Returns an authentication URL for the specified integration. Once a successful OAuth2 code-flow authentication occurs, the name and email are returned inside a jwt parameter, which is a JSON web token that is base-64 encoded.", "responses": { "200": { "schema": { "type": "string" }, "description": "Successful" } }, "operationId": "getUnifiedIntegrationLogin" } }, "/unified/integration/saml/{workspace_id}/{integration_type}": { "get": { "summary": "Sign in a user via SAML", "parameters": [ { "type": "string", "name": "success_redirect", "in": "query", "required": false, "description": "The URL where you want the user to be redirect to after a successful authentication/sign-in. A \"jwt\" parameter will be appended to the URL which will contain a name and email of the user who just signed-in." }, { "type": "string", "name": "failure_redirect", "in": "query", "required": false, "description": "The URL where you want the user to be redirect to after an unsuccessful authentication. An \"error\" variable will be appended." }, { "type": "string", "name": "state", "in": "query", "required": false, "description": "Extra state to send back to your success URL" }, { "type": "boolean", "name": "redirect", "in": "query", "required": false }, { "type": "string", "name": "env", "in": "query", "required": false, "default": "Production" }, { "type": "string", "description": "The ID of the workspace", "name": "workspace_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "Type of the supported integration", "name": "integration_type", "in": "path", "required": true } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "auth", "saml" ], "description": "Returns a SAML authentication URL for the specified integration. Once a successful authentication occurs, the name and email are returned inside a jwt parameter, which is a JSON web token that is base-64 encoded.", "responses": { "200": { "schema": { "type": "string" }, "description": "Successful" } }, "operationId": "getUnifiedIntegrationSaml" } }, "/scim/{connection_id}/users": { "post": { "summary": "Create user", "parameters": [ { "type": "string", "name": "filter", "in": "query", "required": false }, { "type": "string", "name": "sortBy", "in": "query", "required": false }, { "type": "string", "name": "sortOrder", "in": "query", "required": false }, { "type": "number", "name": "startIndex", "in": "query", "required": false }, { "type": "number", "name": "count", "in": "query", "required": false }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ScimUser" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "user" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ScimUser" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createScimUsers" }, "get": { "summary": "List users", "parameters": [ { "type": "string", "name": "filter", "in": "query", "required": false }, { "type": "string", "name": "sortBy", "in": "query", "required": false }, { "type": "string", "name": "sortOrder", "in": "query", "required": false }, { "type": "number", "name": "startIndex", "in": "query", "required": false }, { "type": "number", "name": "count", "in": "query", "required": false }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "user" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ScimUser" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listScimUsers" } }, "/scim/{connection_id}/users/{id}": { "get": { "summary": "Get user", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the User", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "user" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ScimUser" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getScimUsers" }, "put": { "summary": "Update user", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the User", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ScimUser" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "user" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ScimUser" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateScimUsers" }, "patch": { "summary": "Update user", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the User", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ScimUser" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "user" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ScimUser" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathScimUsers" }, "delete": { "summary": "Delete user", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the User", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "user" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeScimUsers" } }, "/scim/{connection_id}/groups": { "post": { "summary": "Create group", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ScimGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ScimGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createScimGroups" }, "get": { "summary": "List groups", "parameters": [ { "type": "string", "name": "filter", "in": "query", "required": false }, { "type": "string", "name": "sortBy", "in": "query", "required": false }, { "type": "string", "name": "sortOrder", "in": "query", "required": false }, { "type": "number", "name": "startIndex", "in": "query", "required": false }, { "type": "number", "name": "count", "in": "query", "required": false }, { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "group" ], "responses": { "200": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ScimGroup" } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listScimGroups" } }, "/scim/{connection_id}/groups/{id}": { "get": { "summary": "Get group", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ScimGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getScimGroups" }, "put": { "summary": "Update group", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ScimGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ScimGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateScimGroups" }, "patch": { "summary": "Update group", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ScimGroup" } } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "group" ], "responses": { "200": { "schema": { "$ref": "#/definitions/ScimGroup" }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "pathScimGroups" }, "delete": { "summary": "Delete group", "parameters": [ { "type": "string", "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" }, { "type": "string", "description": "ID of the Group", "name": "id", "in": "path", "required": true, "pattern": "^[0-9a-fA-F]{24}$" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scim", "group" ], "responses": { "204": { "description": "Successful" }, "default": { "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeScimGroups" } } }, "definitions": { "AssessmentPackage_integration_types": { "type": "array", "items": { "type": "string" }, "description": "Integration types that support this package" }, "AssessmentPackage_aliases": { "type": "array", "items": { "type": "string" }, "description": "Alternative namesidentifiers for this package" }, "AssessmentPackage_tags": { "type": "array", "items": { "type": "string" }, "description": "Category tags (e.g., \"Assessment\", \"Background Check\")" }, "AssessmentParameter_options": { "type": "array", "items": { "type": "string" }, "description": "Options for MULTIPLE_CHOICE and MULTIPLE_SELECT" }, "AssessmentParameter_file_types": { "type": "array", "items": { "type": "string" }, "description": "Valid file MIME types for FILE type" }, "AssessmentParameter_valid_regions": { "type": "array", "items": { "type": "string" }, "description": "Regions where this parameter is valid ({country}-{state} or {country})" }, "AssessmentParameter": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "public_question": { "type": "string", "description": "Question to ask the candidateuser" }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "MULTIPLE_CHOICE", "MULTIPLE_SELECT", "DATE", "FILE" ] }, "options": { "$ref": "#/definitions/AssessmentParameter_options", "description": "Options for MULTIPLE_CHOICE and MULTIPLE_SELECT" }, "file_types": { "$ref": "#/definitions/AssessmentParameter_file_types", "description": "Valid file MIME types for FILE type" }, "valid_regions": { "$ref": "#/definitions/AssessmentParameter_valid_regions", "description": "Regions where this parameter is valid ({country}-{state} or {country})" }, "is_required": { "type": "boolean" } } }, "AssessmentParameters": { "type": "array", "items": { "$ref": "#/definitions/AssessmentParameter" }, "description": "Questionsinputs needed for this assessment (aligned with verification)" }, "AssessmentPackageRegion_regions": { "type": "array", "items": { "type": "string" }, "description": "Countryregion codes where this package is available ({country}-{state} or {country})" }, "AssessmentPackageRegion": { "type": "object", "properties": { "regions": { "$ref": "#/definitions/AssessmentPackageRegion_regions", "description": "Countryregion codes where this package is available ({country}-{state} or {country})" }, "cost_amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217 format" }, "processing_time": { "type": "number", "description": "Processing time in milliseconds" } } }, "AssessmentPackageRegions": { "type": "array", "items": { "$ref": "#/definitions/AssessmentPackageRegion" } }, "AssessmentMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "AssessmentMetadatas": { "type": "array", "items": { "$ref": "#/definitions/AssessmentMetadata" } }, "AssessmentPackage": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the assessment package" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "workspace_id": { "type": "string", "description": "Workspace ID that this package belongs to (reference to KmsSpace)", "readOnly": true }, "connection_id": { "type": "string", "description": "Connection ID that this package belongs to", "readOnly": true }, "integration_types": { "$ref": "#/definitions/AssessmentPackage_integration_types", "description": "Integration types that support this package" }, "name": { "type": "string", "description": "Name of the assessment package" }, "type": { "type": "string", "enum": [ "SKILLS_TEST", "BEHAVIORAL_ASSESSMENT", "VIDEO_INTERVIEW", "BACKGROUND_CHECK", "REFERENCE_CHECK", "OTHER" ] }, "aliases": { "$ref": "#/definitions/AssessmentPackage_aliases", "description": "Alternative namesidentifiers for this package" }, "tags": { "$ref": "#/definitions/AssessmentPackage_tags", "description": "Category tags (e.g., \"Assessment\", \"Background Check\")" }, "description": { "type": "string", "description": "Detailed description" }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/AssessmentParameter" }, "description": "Questionsinputs needed for this assessment (aligned with verification)" }, "has_redirect_url": { "type": "boolean", "description": "Whether provider redirects user to complete assessment" }, "has_target_url": { "type": "boolean", "description": "Where provider redirects user after completion" }, "needs_ip_address": { "type": "boolean", "description": "Whether IP address is required" }, "max_score": { "type": "number", "description": "Maximum possible score if this assessment returns a score" }, "info_url": { "type": "string", "description": "URL to find additional information about this package" }, "regions": { "type": "array", "items": { "$ref": "#/definitions/AssessmentPackageRegion" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AssessmentMetadata" } }, "raw": {} }, "required": [ "type" ], "description": "Used by assessment providers to SUBMIT packages to ATS systems" }, "AssessmentParameterInput_inputs": { "type": "array", "items": { "type": "string" } }, "AssessmentParameterInput": { "type": "object", "properties": { "parameter_id": { "type": "string" }, "name": { "type": "string", "description": "Name of parameter" }, "inputs": { "$ref": "#/definitions/AssessmentParameterInput_inputs" } } }, "AssessmentParameterInputs": { "type": "array", "items": { "$ref": "#/definitions/AssessmentParameterInput" }, "description": "Filled-in answers to the package's parameter questions" }, "AssessmentAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area (e.g., state in the U.S., province in Canada)" }, "region_code": { "type": "string", "description": "Short form for regional area (e.g., two-letter stateprovince abbreviation)" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code in ISO 3166 A-2 format" } } }, "AssessmentAddresses": { "type": "array", "items": { "$ref": "#/definitions/AssessmentAddress" } }, "AssessmentOrder_profile_emails": { "type": "array", "items": { "type": "string" } }, "AssessmentOrder_profile_telephones": { "type": "array", "items": { "type": "string" } }, "AssessmentOrder_profile_social_media_urls": { "type": "array", "items": { "type": "string" } }, "AssessmentOrder_response_download_urls": { "type": "array", "items": { "type": "string" }, "description": "Report download URLs" }, "AssessmentResponseDetail": { "type": "object", "properties": { "title": { "type": "string" }, "text": { "type": "string" }, "is_private": { "type": "boolean" }, "is_failed_reason": { "type": "boolean" }, "parameter_id": { "type": "string", "description": "In reference to the parameter input" }, "download_url": { "type": "string" } } }, "AssessmentResponseDetails": { "type": "array", "items": { "$ref": "#/definitions/AssessmentResponseDetail" } }, "AssessmentAttribute": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "SUB_RESULT" ] }, "label": { "type": "string" }, "value": { "type": "string", "description": "For TEXT and NUMBER types" }, "reference": { "type": "string", "description": "For SUB_RESULT type" }, "score_value": { "type": "number" }, "score_max": { "type": "number" }, "status": { "type": "string", "description": "For SUB_RESULT type", "enum": [ "OPEN", "IN_PROGRESS", "COMPLETED", "FAILED", "REJECTED" ] } }, "required": [ "type", "label" ] }, "AssessmentAttributes": { "type": "array", "items": { "$ref": "#/definitions/AssessmentAttribute" }, "description": "Additional result attributes" }, "AssessmentOrder": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "workspace_id": { "type": "string", "description": "Workspace ID that this order belongs to (reference to KmsSpace)" }, "connection_id": { "type": "string", "description": "Connection ID that this order belongs to" }, "webhook_id": { "type": "string", "description": "Webhook ID that this order belongs to" }, "package_id": { "type": "string", "description": "Assessment package ID" }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/AssessmentParameterInput" }, "description": "Filled-in answers to the package's parameter questions" }, "target_url": { "type": "string", "description": "URL to redirect user to after assessment" }, "status": { "type": "string", "enum": [ "OPEN", "IN_PROGRESS", "COMPLETED", "FAILED", "REJECTED" ] }, "reference": { "type": "string", "description": "ATS-specific reference ID" }, "application_id": { "type": "string", "description": "ATS application ID" }, "job_id": { "type": "string", "description": "ATS job ID" }, "company_id": { "type": "string", "description": "ATS company ID (reference to AtsCompany)" }, "candidate_id": { "type": "string", "description": "ATS candidate ID" }, "employee_id": { "type": "string", "description": "ATS employee ID" }, "profile_name": { "type": "string" }, "profile_first_name": { "type": "string" }, "profile_last_name": { "type": "string" }, "profile_resume_url": { "type": "string" }, "profile_ip_address": { "type": "string", "description": "XXX.XXX.XXX.XXX" }, "profile_date_of_birth": { "type": "string", "description": "YYYY-MM-DD" }, "profile_addresses": { "type": "array", "items": { "$ref": "#/definitions/AssessmentAddress" } }, "profile_gender": { "type": "string", "enum": [ "MALE", "FEMALE", "INTERSEX", "TRANS", "NON_BINARY" ] }, "profile_emails": { "$ref": "#/definitions/AssessmentOrder_profile_emails" }, "profile_telephones": { "$ref": "#/definitions/AssessmentOrder_profile_telephones" }, "profile_national_identifier": { "type": "string" }, "profile_social_media_urls": { "$ref": "#/definitions/AssessmentOrder_profile_social_media_urls" }, "response_completed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "response_expires_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "response_issued_at": { "type": "string", "format": "date-time", "description": "Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "response_status": { "type": "string", "enum": [ "OPEN", "IN_PROGRESS", "COMPLETED", "FAILED", "REJECTED" ] }, "response_score": { "type": "number", "description": "Assessment score (e.g., 0-100)" }, "response_max_score": { "type": "number", "description": "Maximum possible score" }, "response_url": { "type": "string", "description": "URL to view detailed results" }, "response_redirect_url": { "type": "string", "description": "URL to redirect the user to complete assessment" }, "response_download_urls": { "$ref": "#/definitions/AssessmentOrder_response_download_urls", "description": "Report download URLs" }, "response_details": { "type": "array", "items": { "$ref": "#/definitions/AssessmentResponseDetail" } }, "response_source": { "type": "string" }, "response_attributes": { "type": "array", "items": { "$ref": "#/definitions/AssessmentAttribute" }, "description": "Additional result attributes" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AssessmentMetadata" } }, "raw": {} }, "required": [ "workspace_id", "connection_id" ] }, "MessagingMember": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": "string" } } }, "MessagingMembers": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" }, "description": "for email systems, this field represents the CC value" }, "MessagingMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "MessagingMetadatas": { "type": "array", "items": { "$ref": "#/definitions/MessagingMetadata" } }, "MessagingChannel": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "parent_id": { "type": "string" }, "has_subchannels": { "type": "boolean" }, "members": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" } }, "is_active": { "type": "boolean" }, "is_private": { "type": "boolean" }, "web_url": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MessagingMetadata" } }, "raw": {} } }, "MessagingReference": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "MessagingReferences": { "type": "array", "items": { "$ref": "#/definitions/MessagingReference" }, "description": "Represents all channels to which the message is sent. Identifies the channels where the message is posted. To send to the \"Draft\" channel/folder, use a channel ID \"DRAFT\"." }, "MessagingMessage_author_member": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": "string" } }, "description": "for email systems, this field represents the From value" }, "MessagingReaction_member": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": "string" } } }, "MessagingReaction": { "type": "object", "properties": { "reaction": { "type": "string" }, "member": { "$ref": "#/definitions/MessagingReaction_member" } }, "required": [ "reaction", "member" ] }, "MessagingReactions": { "type": "array", "items": { "$ref": "#/definitions/MessagingReaction" } }, "MessagingAttachment": { "type": "object", "properties": { "filename": { "type": "string" }, "size": { "type": "number" }, "content_identifier": { "type": "string", "description": "the inline attachment's content_id" }, "content_type": { "type": "string" }, "download_url": { "type": "string" }, "message_id": { "type": "string" } } }, "MessagingAttachments": { "type": "array", "items": { "$ref": "#/definitions/MessagingAttachment" } }, "MessagingButton": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "icon": { "type": "string" } }, "required": [ "id" ] }, "MessagingButtons": { "type": "array", "items": { "$ref": "#/definitions/MessagingButton" } }, "MessagingMessage": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "channels": { "type": "array", "items": { "$ref": "#/definitions/MessagingReference" }, "description": "Represents all channels to which the message is sent. Identifies the channels where the message is posted. To send to the \"Draft\" channel/folder, use a channel ID \"DRAFT\"." }, "parent_id": { "type": "string", "description": "Represents the ID of the immediate predecessor message in the thread. Identifies a specific message to which the current message directly replies." }, "message_thread_identifier": { "type": "string", "description": "the opaque identifier for the first message in a thread " }, "author_member": { "$ref": "#/definitions/MessagingMessage_author_member", "description": "for email systems, this field represents the From value" }, "destination_members": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" }, "description": "for email systems, this field represents the To value" }, "hidden_members": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" }, "description": "for email systems, this field represents the BCC value" }, "mentioned_members": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" }, "description": "for email systems, this field represents the CC value" }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/MessagingReaction" } }, "subject": { "type": "string" }, "message": { "type": "string" }, "message_html": { "type": "string" }, "message_markdown": { "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/MessagingAttachment" } }, "web_url": { "type": "string" }, "reference": { "type": "string", "description": "eg. RFC822 MessageID" }, "has_children": { "type": "boolean" }, "is_unread": { "type": "boolean" }, "buttons": { "type": "array", "items": { "$ref": "#/definitions/MessagingButton" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MessagingMetadata" } }, "raw": {} } }, "MessagingEvent_channel": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "parent_id": { "type": "string" }, "has_subchannels": { "type": "boolean" }, "members": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" } }, "is_active": { "type": "boolean" }, "is_private": { "type": "boolean" }, "web_url": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MessagingMetadata" } }, "raw": {} } }, "MessagingEvent_message_author_member": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "email": { "type": "string" }, "name": { "type": "string" }, "image_url": { "type": "string" } }, "description": "for email systems, this field represents the From value" }, "MessagingEvent_message": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "channels": { "type": "array", "items": { "$ref": "#/definitions/MessagingReference" }, "description": "Represents all channels to which the message is sent. Identifies the channels where the message is posted. To send to the \"Draft\" channel/folder, use a channel ID \"DRAFT\"." }, "parent_id": { "type": "string", "description": "Represents the ID of the immediate predecessor message in the thread. Identifies a specific message to which the current message directly replies." }, "message_thread_identifier": { "type": "string", "description": "the opaque identifier for the first message in a thread " }, "author_member": { "$ref": "#/definitions/MessagingEvent_message_author_member", "description": "for email systems, this field represents the From value" }, "destination_members": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" }, "description": "for email systems, this field represents the To value" }, "hidden_members": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" }, "description": "for email systems, this field represents the BCC value" }, "mentioned_members": { "type": "array", "items": { "$ref": "#/definitions/MessagingMember" }, "description": "for email systems, this field represents the CC value" }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/MessagingReaction" } }, "subject": { "type": "string" }, "message": { "type": "string" }, "message_html": { "type": "string" }, "message_markdown": { "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/MessagingAttachment" } }, "web_url": { "type": "string" }, "reference": { "type": "string", "description": "eg. RFC822 MessageID" }, "has_children": { "type": "boolean" }, "is_unread": { "type": "boolean" }, "buttons": { "type": "array", "items": { "$ref": "#/definitions/MessagingButton" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MessagingMetadata" } }, "raw": {} } }, "MessagingEvent_button": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "icon": { "type": "string" } }, "required": [ "id" ] }, "MessagingEvent_user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "MessagingEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "not used" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "type": { "type": "string", "enum": [ "MESSAGE_RECEIVED", "REACTION_ADDED", "REACTION_REMOVED", "BUTTON_CLICK", "APP_MENTION", "CHANNEL_JOINED", "CHANNEL_LEFT", "CHANNEL_CREATED", "CHANNEL_DELETED", "CHANNEL_RENAMED", "USER_CREATED", "USER_DELETED", "USER_UPDATED" ] }, "channel": { "$ref": "#/definitions/MessagingEvent_channel" }, "message": { "$ref": "#/definitions/MessagingEvent_message" }, "button": { "$ref": "#/definitions/MessagingEvent_button" }, "user": { "$ref": "#/definitions/MessagingEvent_user" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MessagingMetadata" } }, "raw": {}, "is_replacing_original": { "type": "boolean" } } }, "CrmReference": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "CrmReferences": { "type": "array", "items": { "$ref": "#/definitions/CrmReference" } }, "CrmDeal_tags": { "type": "array", "items": { "type": "string" } }, "CrmDeal_contact_ids": { "type": "array", "items": { "type": "string" } }, "CrmDeal_company_ids": { "type": "array", "items": { "type": "string" } }, "CrmMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "CrmMetadatas": { "type": "array", "items": { "$ref": "#/definitions/CrmMetadata" } }, "CrmDeal": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this deal object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this deal object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this deal object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of this deal" }, "amount": { "type": "number", "description": "The potential amount that deal could be worth" }, "currency": { "type": "string", "description": "The currency for the deal amount (3 letter ISO code; eg. USD)" }, "closed_at": { "type": "string", "format": "date-time", "description": "The date that this deal closed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "closing_at": { "type": "string", "format": "date-time", "description": "expected closing date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "stages": { "type": "array", "items": { "$ref": "#/definitions/CrmReference" } }, "pipelines": { "type": "array", "items": { "$ref": "#/definitions/CrmReference" } }, "source": { "type": "string", "description": "The source for this deal" }, "probability": { "type": "number" }, "tags": { "$ref": "#/definitions/CrmDeal_tags" }, "lost_reason": { "type": "string" }, "won_reason": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "contact_ids": { "$ref": "#/definitions/CrmDeal_contact_ids", "description": "(reference to CrmContact)" }, "company_ids": { "$ref": "#/definitions/CrmDeal_company_ids", "description": "(reference to CrmCompany)" }, "description": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CrmMetadata" } }, "raw": { "description": "The raw data returned by the integration for this deal" } }, "description": "A deal represents an opportunity with companies and/or contacts" }, "CrmEmail": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] } } }, "CrmEmails": { "type": "array", "items": { "$ref": "#/definitions/CrmEmail" } }, "CrmTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } }, "required": [ "telephone" ] }, "CrmTelephones": { "type": "array", "items": { "$ref": "#/definitions/CrmTelephone" } }, "CrmContact_deal_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of deal IDs associated with this contact" }, "CrmContact_company_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of company IDs associated with this contact" }, "CrmContact_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "CrmContact_link_urls": { "type": "array", "items": { "type": "string" }, "description": "Additional URLs associated with the contact e.g., LinkedIn, website, etc" }, "CrmContact": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this contact object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the contact" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string", "description": "The job title of the contact" }, "company": { "type": "string", "description": "The companyorganization name of the contact" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/CrmEmail" }, "description": "An array of email addresses for this contact" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/CrmTelephone" }, "description": "An array of telephones for this contact" }, "deal_ids": { "$ref": "#/definitions/CrmContact_deal_ids", "description": "An array of deal IDs associated with this contact (reference to CrmDeal)" }, "company_ids": { "$ref": "#/definitions/CrmContact_company_ids", "description": "An array of company IDs associated with this contact (reference to CrmCompany)" }, "address": { "$ref": "#/definitions/CrmContact_address" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "link_urls": { "$ref": "#/definitions/CrmContact_link_urls", "description": "Additional URLs associated with the contact e.g., LinkedIn, website, etc" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CrmMetadata" } }, "department": { "type": "string" }, "image_url": { "type": "string" }, "raw": { "description": "The raw data returned by the integration for this contact" } }, "description": "A contact represents a person that optionally is associated with a deal and/or a company" }, "CrmCompany_deal_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of deal IDs associated with this contact" }, "CrmCompany_contact_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of contact IDs associated with this company" }, "CrmCompany_websites": { "type": "array", "items": { "type": "string" } }, "CrmCompany_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "CrmCompany_tags": { "type": "array", "items": { "type": "string" } }, "CrmCompany_link_urls": { "type": "array", "items": { "type": "string" }, "description": "Additional URLs associated with the contact e.g., LinkedIn, website, etc" }, "CrmCompany_domains": { "type": "array", "items": { "type": "string" } }, "CrmCompany": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this company object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the company" }, "deal_ids": { "$ref": "#/definitions/CrmCompany_deal_ids", "description": "An array of deal IDs associated with this contact (reference to CrmDeal)" }, "contact_ids": { "$ref": "#/definitions/CrmCompany_contact_ids", "description": "An array of contact IDs associated with this company (reference to CrmContact)" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/CrmEmail" } }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/CrmTelephone" } }, "websites": { "$ref": "#/definitions/CrmCompany_websites" }, "address": { "$ref": "#/definitions/CrmCompany_address" }, "is_active": { "type": "boolean" }, "tags": { "$ref": "#/definitions/CrmCompany_tags" }, "description": { "type": "string" }, "industry": { "type": "string" }, "link_urls": { "$ref": "#/definitions/CrmCompany_link_urls", "description": "Additional URLs associated with the contact e.g., LinkedIn, website, etc" }, "employees": { "type": "number" }, "timezone": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CrmMetadata" } }, "domains": { "$ref": "#/definitions/CrmCompany_domains" }, "raw": { "description": "The raw data returned by the integration for this company" } }, "description": "A company represents an organization that optionally is associated with a deal and/or contacts" }, "CrmEvent_note": { "type": "object", "properties": { "description": { "type": "string", "description": "The event note's description" }, "title": { "type": "string" } }, "description": "The note object, when type = note" }, "CrmEvent_meeting": { "type": "object", "properties": { "start_at": { "type": "string", "format": "date-time", "description": "The event meeting's start datetime (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "The event meeting's end datetime (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "title": { "type": "string", "description": "The event meeting's topicsubject" }, "description": { "type": "string", "description": "The event meeting's agendadescription" } }, "description": "The meeting object, when type = meeting" }, "CrmEvent_email_to": { "type": "array", "items": { "type": "string" }, "description": "The event email's \"to\" name & email (name )" }, "CrmEvent_email_cc": { "type": "array", "items": { "type": "string" }, "description": "The event email's cc name & email (name )" }, "CrmEvent_email_attachment_file_ids": { "type": "array", "items": { "type": "string" } }, "CrmEvent_email": { "type": "object", "properties": { "from": { "type": "string", "description": "The event email's from name & email address (name )" }, "to": { "$ref": "#/definitions/CrmEvent_email_to", "description": "The event email's \"to\" name & email (name )" }, "cc": { "$ref": "#/definitions/CrmEvent_email_cc", "description": "The event email's cc name & email (name )" }, "subject": { "type": "string", "description": "The event email's subject" }, "body": { "type": "string", "description": "The event email's body" }, "attachment_file_ids": { "$ref": "#/definitions/CrmEvent_email_attachment_file_ids" } }, "description": "The email object, when type = email" }, "CrmEvent_call": { "type": "object", "properties": { "duration": { "type": "number", "description": "The event call's duration in minutes" }, "description": { "type": "string", "description": "The event call's descriptionnotes" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } }, "description": "The call object, when type = call" }, "CrmEvent_task": { "type": "object", "properties": { "name": { "type": "string", "description": "The event task's nametitle/subject" }, "status": { "type": "string", "description": "The event task's status", "enum": [ "COMPLETED", "NOT_STARTED", "WORK_IN_PROGRESS", "DEFERRED" ] }, "description": { "type": "string", "description": "The event task's descriptionnote" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "priority": { "type": "string", "enum": [ "HIGH", "MEDIUM", "LOW" ] } }, "description": "The task object, when type = task" }, "CrmEvent_marketing_email_to": { "type": "array", "items": { "type": "string" }, "description": "The event email's \"to\" name & email (name )" }, "CrmEvent_marketing_email_cc": { "type": "array", "items": { "type": "string" }, "description": "The event email's cc name & email (name )" }, "CrmEvent_marketing_email_attachment_file_ids": { "type": "array", "items": { "type": "string" } }, "CrmEvent_marketing_email": { "type": "object", "properties": { "name": { "type": "string" }, "from": { "type": "string", "description": "The event email's from name & email address (name )" }, "to": { "$ref": "#/definitions/CrmEvent_marketing_email_to", "description": "The event email's \"to\" name & email (name )" }, "cc": { "$ref": "#/definitions/CrmEvent_marketing_email_cc", "description": "The event email's cc name & email (name )" }, "subject": { "type": "string", "description": "The event email's subject" }, "body": { "type": "string", "description": "The event email's body" }, "attachment_file_ids": { "$ref": "#/definitions/CrmEvent_marketing_email_attachment_file_ids" } } }, "CrmEventFormOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } }, "CrmEventFormOptions": { "type": "array", "items": { "$ref": "#/definitions/CrmEventFormOption" } }, "CrmEventFormField": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "MULTIPLE_CHOICE", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "EMAIL", "PHONE", "YES_NO", "CURRENCY", "URL" ] }, "options": { "type": "array", "items": { "$ref": "#/definitions/CrmEventFormOption" } }, "required": { "type": "boolean" } } }, "CrmEventFormFields": { "type": "array", "items": { "$ref": "#/definitions/CrmEventFormField" } }, "CrmEvent_form": { "type": "object", "properties": { "name": { "type": "string" }, "archived_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/CrmEventFormField" } }, "redirect_url": { "type": "string" } } }, "CrmEvent_page_view": { "type": "object", "properties": { "count": { "type": "number" }, "average": { "type": "number" }, "url": { "type": "string" } } }, "CrmEvent_deal_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of deal IDs associated with this event" }, "CrmEvent_company_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of company IDs associated with this event" }, "CrmEvent_contact_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of contact IDs associated with this event" }, "CrmEvent_lead_ids": { "type": "array", "items": { "type": "string" } }, "CrmEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this event object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this event object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this event object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "type": { "type": "string", "description": "The type of event", "enum": [ "NOTE", "EMAIL", "TASK", "MEETING", "CALL", "MARKETING_EMAIL", "FORM", "PAGE_VIEW" ] }, "note": { "$ref": "#/definitions/CrmEvent_note", "description": "The note object, when type = note" }, "meeting": { "$ref": "#/definitions/CrmEvent_meeting", "description": "The meeting object, when type = meeting" }, "email": { "$ref": "#/definitions/CrmEvent_email", "description": "The email object, when type = email" }, "call": { "$ref": "#/definitions/CrmEvent_call", "description": "The call object, when type = call" }, "task": { "$ref": "#/definitions/CrmEvent_task", "description": "The task object, when type = task" }, "marketing_email": { "$ref": "#/definitions/CrmEvent_marketing_email" }, "form": { "$ref": "#/definitions/CrmEvent_form" }, "page_view": { "$ref": "#/definitions/CrmEvent_page_view" }, "deal_ids": { "$ref": "#/definitions/CrmEvent_deal_ids", "description": "An array of deal IDs associated with this event (reference to CrmDeal)" }, "company_ids": { "$ref": "#/definitions/CrmEvent_company_ids", "description": "An array of company IDs associated with this event (reference to CrmCompany)" }, "contact_ids": { "$ref": "#/definitions/CrmEvent_contact_ids", "description": "An array of contact IDs associated with this event (reference to CrmContact)" }, "lead_ids": { "$ref": "#/definitions/CrmEvent_lead_ids", "description": "(reference to CrmLead)" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CrmMetadata" } }, "raw": { "description": "The raw data returned by the integration for this event." } }, "description": "An event represents an event, activity, or engagement and is always associated with a deal, contact, or company" }, "CrmLead_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "CrmLead_link_urls": { "type": "array", "items": { "type": "string" } }, "CrmLead": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "creator_user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "contact_id": { "type": "string", "description": "(reference to CrmContact)" }, "company_id": { "type": "string", "description": "(reference to CrmCompany)" }, "company_name": { "type": "string" }, "is_active": { "type": "boolean" }, "address": { "$ref": "#/definitions/CrmLead_address" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/CrmEmail" } }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/CrmTelephone" } }, "source": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string", "description": "The job title of the lead" }, "link_urls": { "$ref": "#/definitions/CrmLead_link_urls" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CrmMetadata" } }, "raw": {} } }, "CrmTaxonomy": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "INDUSTRY" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CrmMetadata" } }, "raw": {} }, "required": [ "id" ] }, "CrmStage": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "deal_probability": { "type": "number" }, "is_closed": { "type": "boolean" }, "display_order": { "type": "number" } } }, "CrmStages": { "type": "array", "items": { "$ref": "#/definitions/CrmStage" } }, "CrmPipeline": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "is_active": { "type": "boolean" }, "deal_probability": { "type": "number" }, "display_order": { "type": "number" }, "stages": { "type": "array", "items": { "$ref": "#/definitions/CrmStage" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CrmMetadata" } }, "raw": {} } }, "MarketingList_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" } } }, "MarketingMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "MarketingMetadatas": { "type": "array", "items": { "$ref": "#/definitions/MarketingMetadata" } }, "MarketingList": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this list" }, "created_at": { "type": "string", "format": "date-time", "description": "Date that this list was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The list's name" }, "description": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "The user who created this list (reference to HrisEmployee)" }, "is_active": { "type": "boolean" }, "address": { "$ref": "#/definitions/MarketingList_address" }, "subject": { "type": "string" }, "sender_name": { "type": "string" }, "sender_email": { "type": "string" }, "language": { "type": "string" }, "sender_company": { "type": "string" }, "sender_phone": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MarketingMetadata" } }, "raw": { "description": "The raw data returned by the integration for this list" } }, "description": "Mailing List" }, "MarketingEmail": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] } }, "required": [ "email" ] }, "MarketingEmails": { "type": "array", "items": { "$ref": "#/definitions/MarketingEmail" }, "description": "An array of email addresses for this member" }, "MarketingMember_list_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of list IDs associated with this member" }, "MarketingMember_tags": { "type": "array", "items": { "type": "string" }, "description": "An array of tags associated with this member" }, "MarketingMember": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this member object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this member object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this member object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the member" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": "string", "description": "The name of the company/organization the member belongs to" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/MarketingEmail" }, "description": "An array of email addresses for this member" }, "list_ids": { "$ref": "#/definitions/MarketingMember_list_ids", "description": "An array of list IDs associated with this member" }, "tags": { "$ref": "#/definitions/MarketingMember_tags", "description": "An array of tags associated with this member" }, "status": { "type": "string", "enum": [ "SUBSCRIBED", "UNSUBSCRIBED", "CLEANED", "PENDING", "TRANSACTIONAL" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MarketingMetadata" } }, "raw": { "description": "The raw data returned by the integration for this member" } }, "description": "A member represents a person" }, "MarketingCampaign_list_ids": { "type": "array", "items": { "type": "string" }, "description": "Associated listaudience IDs" }, "MarketingCampaign": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the campaign" }, "created_at": { "type": "string", "format": "date-time", "description": "When the campaign was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the campaign was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Campaign nametitle" }, "type": { "type": "string", "description": "Campaign type (e.g., regular, automation, ab_test)" }, "status": { "type": "string", "description": "Campaign status", "enum": [ "DRAFT", "SCHEDULED", "SENDING", "SENT", "CANCELLED", "PAUSED", "ARCHIVED", "OTHER" ] }, "list_ids": { "$ref": "#/definitions/MarketingCampaign_list_ids", "description": "Associated listaudience IDs" }, "subject_line": { "type": "string", "description": "Email subject line" }, "preview_text": { "type": "string", "description": "Email preview text" }, "from_name": { "type": "string", "description": "Sender name" }, "from_email": { "type": "string", "description": "Sender email address" }, "reply_to_email": { "type": "string", "description": "Reply-to email address" }, "send_at": { "type": "string", "format": "date-time", "description": "Scheduled send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MarketingMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "MarketingReportLink": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL" }, "total_clicks": { "type": "number", "description": "Total clicks on this link" }, "click_percentage": { "type": "number", "description": "Percentage of total clicks" }, "unique_clicks": { "type": "number", "description": "Unique clicks on this link" }, "unique_click_percentage": { "type": "number", "description": "Percentage of unique clicks" }, "last_click_at": { "type": "string", "format": "date-time", "description": "Last click timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "MarketingReportLinks": { "type": "array", "items": { "$ref": "#/definitions/MarketingReportLink" }, "description": "URL-specific click data" }, "MarketingReport": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the campaign report" }, "start_at": { "type": "string", "format": "date-time", "description": "Start time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "End time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "campaign_id": { "type": "string", "description": "Associated campaign ID" }, "list_id": { "type": "string", "description": "Associated list ID" }, "emails_sent": { "type": "number", "description": "Total emails sent" }, "abuse_reports": { "type": "number", "description": "Number of abuse reports" }, "unsubscribed": { "type": "number", "description": "Number of unsubscribes" }, "sent_at": { "type": "string", "format": "date-time", "description": "Send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "hard_bounces": { "type": "number", "description": "Hard bounce count" }, "soft_bounces": { "type": "number", "description": "Soft bounce count" }, "syntax_errors": { "type": "number", "description": "Syntax error count" }, "forwards_count": { "type": "number", "description": "Forward count" }, "forwards_opens": { "type": "number", "description": "Forwards opened" }, "opens_total": { "type": "number", "description": "Total opens" }, "unique_opens": { "type": "number", "description": "Unique opens" }, "open_rate": { "type": "number", "description": "Open rate (decimal)" }, "last_open_at": { "type": "string", "format": "date-time", "description": "Last open timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "clicks_total": { "type": "number", "description": "Total clicks" }, "unique_clicks": { "type": "number", "description": "Unique clicks" }, "unique_subscriber_clicks": { "type": "number", "description": "Unique subscriber clicks" }, "click_rate": { "type": "number", "description": "Click rate (decimal)" }, "last_click_at": { "type": "string", "format": "date-time", "description": "Last click timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "links": { "type": "array", "items": { "$ref": "#/definitions/MarketingReportLink" }, "description": "URL-specific click data" }, "human_opens_total": { "type": "number", "description": "Total opens excluding automated/bot/proxy (e.g. Apple Mail Privacy Protection) opens" }, "human_unique_opens": { "type": "number", "description": "Unique opens excluding automated/bot/proxy opens" }, "human_open_rate": { "type": "number", "description": "Open rate (decimal) excluding automated/bot/proxy opens" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/MarketingMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "TicketingTicket_tags": { "type": "array", "items": { "type": "string" } }, "TicketingTicket_attachment_ids": { "type": "array", "items": { "type": "string" }, "description": "Array of attachment IDs retrieved from StorageFile.Get endpoint" }, "TicketingMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "TicketingMetadatas": { "type": "array", "items": { "$ref": "#/definitions/TicketingMetadata" } }, "TicketingTicket": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "customer_id": { "type": "string" }, "subject": { "type": "string", "description": "short description of the ticket" }, "description": { "type": "string", "description": "Full description of ticket issue" }, "status": { "type": "string", "enum": [ "ACTIVE", "CLOSED" ] }, "closed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "priority": { "type": "string" }, "category_id": { "type": "string", "description": "(reference to AccountingCategory)" }, "source": { "type": "string", "description": "Channel where ticket was originally submitted" }, "source_ref": { "type": "string", "description": "Reference to source-specific object" }, "tags": { "$ref": "#/definitions/TicketingTicket_tags" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "url": { "type": "string" }, "attachment_ids": { "$ref": "#/definitions/TicketingTicket_attachment_ids", "description": "Array of attachment IDs retrieved from StorageFile.Get endpoint (reference to StorageFile)" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/TicketingMetadata" } }, "raw": {} } }, "TicketingEmail": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] } }, "required": [ "email" ] }, "TicketingEmails": { "type": "array", "items": { "$ref": "#/definitions/TicketingEmail" } }, "TicketingTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } }, "required": [ "telephone" ] }, "TicketingTelephones": { "type": "array", "items": { "$ref": "#/definitions/TicketingTelephone" } }, "TicketingCustomer_tags": { "type": "array", "items": { "type": "string" } }, "TicketingCustomer": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/TicketingEmail" } }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/TicketingTelephone" } }, "tags": { "$ref": "#/definitions/TicketingCustomer_tags" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/TicketingMetadata" } }, "raw": {} } }, "TicketingNote": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "customer_id": { "type": "string" }, "description": { "type": "string" }, "ticket_id": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/TicketingMetadata" } }, "raw": {} } }, "TicketingCategory": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_active": { "type": "boolean" }, "parent_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/TicketingMetadata" } }, "raw": {} } }, "EnrichEmail": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] }, "is_verified": { "type": "boolean" } }, "required": [ "email" ] }, "EnrichEmails": { "type": "array", "items": { "$ref": "#/definitions/EnrichEmail" }, "description": "An array of email addresses for this person" }, "EnrichTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } }, "required": [ "telephone" ] }, "EnrichTelephones": { "type": "array", "items": { "$ref": "#/definitions/EnrichTelephone" }, "description": "An array of telephones for this company" }, "EnrichPerson_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" } }, "description": "The address of the person" }, "EnrichPersonWorkHistory": { "type": "object", "properties": { "company_id": { "type": "string", "description": "(reference to EnrichCompany)" }, "company_name": { "type": "string" }, "title": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "location": { "type": "string" }, "company_domain": { "type": "string" } }, "required": [ "title" ] }, "EnrichPersonWorkHistories": { "type": "array", "items": { "$ref": "#/definitions/EnrichPersonWorkHistory" } }, "EnrichPerson": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this person object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this person object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this person object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the person" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string", "description": "The job title of the person" }, "birthdate": { "type": "string", "description": "The birth date of the person" }, "image_url": { "type": "string", "description": "The image URL of the person" }, "bio": { "type": "string", "description": "The biography description of the person" }, "company": { "type": "string", "description": "The companyorganization name of the person" }, "company_domain": { "type": "string", "description": "The company's domain" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/EnrichEmail" }, "description": "An array of email addresses for this person" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/EnrichTelephone" }, "description": "An array of telephones for this person" }, "twitter_handle": { "type": "string", "description": "The twitter handle of the person" }, "linkedin_url": { "type": "string", "description": "The LinkedIn URL of the person" }, "github_url": { "type": "string", "description": "The GitHub URL of the person" }, "github_username": { "type": "string", "description": "The GitHub username of the person" }, "twitter_url": { "type": "string", "description": "The twitter URL of the person" }, "facebook_url": { "type": "string", "description": "The Facebook URL of the person" }, "gender": { "type": "string", "description": "The gender of the person", "enum": [ "MALE", "FEMALE" ] }, "address": { "$ref": "#/definitions/EnrichPerson_address", "description": "The address of the person" }, "timezone": { "type": "string", "description": "The timezone code of the person" }, "utc_offset": { "type": "number", "description": "The timezone's hourly offset from UTC of the person" }, "work_histories": { "type": "array", "items": { "$ref": "#/definitions/EnrichPersonWorkHistory" } }, "raw": { "description": "The raw data returned by the integration for this person" } }, "description": "A person object from an enrichment integration" }, "EnrichCompany_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" } }, "description": "The address of the company" }, "EnrichCompany": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this company object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the company" }, "description": { "type": "string", "description": "The description of the company" }, "domain": { "type": "string", "description": "The webmail domain of the company" }, "twitter_handle": { "type": "string", "description": "The twitter handle of the company" }, "twitter_url": { "type": "string", "description": "The twitter URL of the company" }, "address": { "$ref": "#/definitions/EnrichCompany_address", "description": "The address of the company" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/EnrichTelephone" }, "description": "An array of telephones for this company" }, "linkedin_url": { "type": "string", "description": "The LinkedIn URL of the company" }, "crunchbase_url": { "type": "string", "description": "The Crunchbase URL of the company" }, "facebook_url": { "type": "string", "description": "The Facebook URL of the company" }, "youtube_url": { "type": "string", "description": "The Youtube URL of the company" }, "instagram_url": { "type": "string", "description": "The Crunchbase URL of the company" }, "yelp_url": { "type": "string", "description": "The Yelp URL of the company" }, "logo_url": { "type": "string", "description": "The URL of the logo of the company" }, "exchange": { "type": "string", "description": "The public exchange of the company (eg. NASDAQ)" }, "stock": { "type": "string", "description": "The stock ticker of the company (eg. AMZN)" }, "year_founded": { "type": "number", "description": "The year that the company was founded" }, "alexa_rank": { "type": "number", "description": "The Alexa rank of the company" }, "naics_code": { "type": "number", "description": "The NAICS code of the company" }, "sic_code": { "type": "number", "description": "The SIC code of the company" }, "employees": { "type": "string", "description": "The number of employees at the company" }, "revenue": { "type": "string", "description": "The approximate revenue of the company" }, "industry": { "type": "string", "description": "The industry of the company" }, "raw": { "description": "The raw data returned by the integration for this company" } }, "description": "A company object from an enrichment integration" }, "UcCall_telephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } }, "required": [ "telephone" ], "description": "The telephone number called" }, "UcEmail": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] } }, "required": [ "email" ] }, "UcEmails": { "type": "array", "items": { "$ref": "#/definitions/UcEmail" }, "description": "An array of email addresses for this contact" }, "UcTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } }, "required": [ "telephone" ] }, "UcTelephones": { "type": "array", "items": { "$ref": "#/definitions/UcTelephone" }, "description": "An array of telephones for this contact" }, "UcMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "UcMetadatas": { "type": "array", "items": { "$ref": "#/definitions/UcMetadata" } }, "UcContact": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this contact object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the contact" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string", "description": "The job title of the contact" }, "company": { "type": "string", "description": "The company/organization name of the contact" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/UcEmail" }, "description": "An array of email addresses for this contact" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/UcTelephone" }, "description": "An array of telephones for this contact" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/UcMetadata" } }, "raw": { "description": "The raw data returned by the integration for this contact" } }, "description": "A contact represents a person that optionally is associated with a call" }, "UcContacts": { "type": "array", "items": { "$ref": "#/definitions/UcContact" } }, "UcCall": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this call object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "contact_id": { "type": "string", "description": "The contact ID for call (reference to UcContact)" }, "telephone": { "$ref": "#/definitions/UcCall_telephone", "description": "The telephone number called" }, "start_at": { "type": "string", "format": "date-time", "description": "The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "contacts": { "type": "array", "items": { "$ref": "#/definitions/UcContact" } }, "is_private": { "type": "boolean" }, "user_name": { "type": "string" }, "user_phone": { "type": "string" }, "type": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/UcMetadata" } }, "raw": { "description": "The raw data returned by the integration for this call" }, "conversation_identifier": { "type": "string", "description": "opaque identifier shared across legs of one interaction" } } }, "UcComment": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "content": { "type": "string" }, "user_id": { "type": "string", "description": "reference to HrisEmployee (reference to HrisEmployee)" }, "call_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/UcMetadata" } }, "raw": {} } }, "UcRecordingTranscript": { "type": "object", "properties": { "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "text": { "type": "string" }, "contact_id": { "type": "string", "description": "(reference to UcContact)" }, "user_id": { "type": "string", "description": "reference to HrisEmployee (reference to HrisEmployee)" } }, "required": [ "text" ] }, "UcRecordingTranscripts": { "type": "array", "items": { "$ref": "#/definitions/UcRecordingTranscript" } }, "UcRecordingMedia": { "type": "object", "properties": { "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "language": { "type": "string", "description": "two digit ISO code" }, "transcripts": { "type": "array", "items": { "$ref": "#/definitions/UcRecordingTranscript" } }, "transcript_download_url": { "type": "string" }, "recording_download_url": { "type": "string" } } }, "UcRecordingMedias": { "type": "array", "items": { "$ref": "#/definitions/UcRecordingMedia" } }, "UcRecording": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "expires_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "call_id": { "type": "string" }, "web_url": { "type": "string" }, "contacts": { "type": "array", "items": { "$ref": "#/definitions/UcContact" } }, "user_id": { "type": "string", "description": "reference to HrisEmployee (reference to HrisEmployee)" }, "media": { "type": "array", "items": { "$ref": "#/definitions/UcRecordingMedia" } }, "user_name": { "type": "string" }, "user_phone": { "type": "string" }, "type": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "conversation_identifier": { "type": "string", "description": "opaque identifier shared across legs of one interaction" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/UcMetadata" } }, "raw": {} } }, "UcScorecardQuestion": { "type": "object", "properties": { "question_identifier": { "type": "string" }, "text": { "type": "string" }, "answer": { "type": "string" }, "score": { "type": "number" }, "is_not_applicable": { "type": "boolean" } } }, "UcScorecardQuestions": { "type": "array", "items": { "$ref": "#/definitions/UcScorecardQuestion" } }, "UcScorecard": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "call_id": { "type": "string" }, "scorecardtemplate_id": { "type": "string" }, "name": { "type": "string", "description": "name of the scorecard template that was filled in" }, "user_id": { "type": "string", "description": "the user being reviewed; reference to HrisEmployee (reference to HrisEmployee)" }, "reviewer_user_id": { "type": "string", "description": "the user who filled in the scorecard; reference to HrisEmployee (reference to HrisEmployee)" }, "reviewed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "score": { "type": "number", "description": "overall score" }, "questions": { "type": "array", "items": { "$ref": "#/definitions/UcScorecardQuestion" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/UcMetadata" } }, "raw": {} } }, "UcScorecardtemplateQuestion_options": { "type": "array", "items": { "type": "string" } }, "UcScorecardtemplateQuestion": { "type": "object", "properties": { "question_identifier": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string", "enum": [ "RATING", "YES_NO", "TEXT", "OTHER" ] }, "options": { "$ref": "#/definitions/UcScorecardtemplateQuestion_options" } } }, "UcScorecardtemplateQuestions": { "type": "array", "items": { "$ref": "#/definitions/UcScorecardtemplateQuestion" } }, "UcScorecardtemplate": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_active": { "type": "boolean" }, "questions": { "type": "array", "items": { "$ref": "#/definitions/UcScorecardtemplateQuestion" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/UcMetadata" } }, "raw": {} } }, "AtsActivity_document_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs for AtsDocument.get" }, "AtsActivity_user_ids": { "type": "array", "items": { "type": "string" }, "description": "id values of the recruiters associated with the activity." }, "AtsActivity_from": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] } }, "required": [ "email" ] }, "AtsEmail": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] } }, "required": [ "email" ] }, "AtsEmails": { "type": "array", "items": { "$ref": "#/definitions/AtsEmail" } }, "AtsMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string", "description": "Actual textual value of the slug" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "AtsMetadatas": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "AtsActivity": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "candidate_id": { "type": "string" }, "application_id": { "type": "string" }, "job_id": { "type": "string" }, "interview_id": { "type": "string" }, "document_ids": { "$ref": "#/definitions/AtsActivity_document_ids", "description": "IDs for AtsDocument.get" }, "title": { "type": "string" }, "description": { "type": "string" }, "is_private": { "type": "boolean" }, "user_ids": { "$ref": "#/definitions/AtsActivity_user_ids", "description": "id values of the recruiters associated with the activity. (reference to HrisEmployee)" }, "type": { "type": "string", "enum": [ "NOTE", "TASK", "EMAIL" ] }, "from": { "$ref": "#/definitions/AtsActivity_from" }, "to": { "type": "array", "items": { "$ref": "#/definitions/AtsEmail" } }, "cc": { "type": "array", "items": { "$ref": "#/definitions/AtsEmail" } }, "bcc": { "type": "array", "items": { "$ref": "#/definitions/AtsEmail" } }, "sub_type": { "type": "string" }, "company_id": { "type": "string", "description": "(reference to AtsCompany)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "raw": {} } }, "AtsTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } }, "required": [ "telephone" ] }, "AtsTelephones": { "type": "array", "items": { "$ref": "#/definitions/AtsTelephone" } }, "AtsCandidate_tags": { "type": "array", "items": { "type": "string" } }, "AtsCandidate_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AtsCandidate_link_urls": { "type": "array", "items": { "type": "string" }, "description": "URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)" }, "AtsCandidate_sources": { "type": "array", "items": { "type": "string" } }, "AtsCandidate_user_ids": { "type": "array", "items": { "type": "string" }, "description": "references hris employees" }, "AtsCandidateExperience": { "type": "object", "properties": { "company_name": { "type": "string" }, "title": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "AtsCandidateExperiences": { "type": "array", "items": { "$ref": "#/definitions/AtsCandidateExperience" } }, "AtsCandidateEducation": { "type": "object", "properties": { "institution": { "type": "string" }, "level": { "type": "string" }, "degree": { "type": "string" }, "field_of_study": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "AtsCandidateEducations": { "type": "array", "items": { "$ref": "#/definitions/AtsCandidateEducation" } }, "AtsCandidate_skills": { "type": "array", "items": { "type": "string" } }, "AtsCandidate_job_ids": { "type": "array", "items": { "type": "string" } }, "AtsCandidate": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/AtsEmail" } }, "title": { "type": "string", "description": "Candidate’s current job title" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/AtsTelephone" } }, "company_name": { "type": "string", "description": "Name of company where candidate currently works" }, "image_url": { "type": "string" }, "tags": { "$ref": "#/definitions/AtsCandidate_tags" }, "address": { "$ref": "#/definitions/AtsCandidate_address" }, "external_identifier": { "type": "string" }, "link_urls": { "$ref": "#/definitions/AtsCandidate_link_urls", "description": "URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)" }, "origin": { "type": "string", "enum": [ "AGENCY", "APPLIED", "INTERNAL", "REFERRED", "SOURCED", "UNIVERSITY" ] }, "company_id": { "type": "string", "description": "(reference to AtsCompany)" }, "sources": { "$ref": "#/definitions/AtsCandidate_sources" }, "date_of_birth": { "type": "string", "format": "date-time" }, "user_id": { "type": "string", "description": "Employee ID that owns the relationship for this candidate (reference to HrisEmployee)" }, "user_ids": { "$ref": "#/definitions/AtsCandidate_user_ids", "description": "references hris employees (reference to HrisEmployee)" }, "web_url": { "type": "string" }, "experiences": { "type": "array", "items": { "$ref": "#/definitions/AtsCandidateExperience" } }, "education": { "type": "array", "items": { "$ref": "#/definitions/AtsCandidateEducation" } }, "skills": { "$ref": "#/definitions/AtsCandidate_skills" }, "job_ids": { "$ref": "#/definitions/AtsCandidate_job_ids" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "summary": { "type": "string", "description": "Personal / professional bio" }, "raw": {} } }, "AtsJob_recruiter_ids": { "type": "array", "items": { "type": "string" } }, "AtsJob_hiring_manager_ids": { "type": "array", "items": { "type": "string" } }, "AtsReference": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AtsReferences": { "type": "array", "items": { "$ref": "#/definitions/AtsReference" } }, "AtsAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AtsAddresses": { "type": "array", "items": { "$ref": "#/definitions/AtsAddress" } }, "AtsCompensation": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SALARY", "BONUS", "STOCK_OPTIONS", "EQUITY", "OTHER" ] }, "min": { "type": "number" }, "max": { "type": "number" }, "currency": { "type": "string" }, "frequency": { "type": "string", "enum": [ "ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK" ] } } }, "AtsCompensations": { "type": "array", "items": { "$ref": "#/definitions/AtsCompensation" }, "description": "compensation details for the offer" }, "AtsJob_public_job_urls": { "type": "array", "items": { "type": "string" }, "description": "URLs for pages containing public listings for the job" }, "AtsJobQuestion_options": { "type": "array", "items": { "type": "string" } }, "AtsJobQuestion_parent_answer_values": { "type": "array", "items": { "type": "string" }, "description": "only ask this question when the parent question's answer is one of these" }, "AtsJobQuestion": { "type": "object", "properties": { "id": { "type": "string" }, "question": { "type": "string" }, "required": { "type": "boolean" }, "description": { "type": "string" }, "prompt": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "MULTIPLE_CHOICE", "FILE", "TEXTAREA", "MULTIPLE_SELECT", "UNIVERSITY", "YES_NO", "CURRENCY", "URL" ] }, "options": { "$ref": "#/definitions/AtsJobQuestion_options" }, "min_length": { "type": "number", "description": "minimum answer length (TEXT)" }, "max_length": { "type": "number", "description": "maximum answer length (TEXT)" }, "min_value": { "type": "number", "description": "minimum answer value (NUMBER)" }, "max_value": { "type": "number", "description": "maximum answer value (NUMBER)" }, "min_at": { "type": "string", "format": "date-time", "description": "earliest allowed answer (DATE) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "max_at": { "type": "string", "format": "date-time", "description": "latest allowed answer (DATE) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "parent_id": { "type": "string", "description": "id of the question in this job's questions list that this question depends on" }, "parent_answer_values": { "$ref": "#/definitions/AtsJobQuestion_parent_answer_values", "description": "only ask this question when the parent question's answer is one of these" } }, "required": [ "question", "type" ] }, "AtsJobQuestions": { "type": "array", "items": { "$ref": "#/definitions/AtsJobQuestion" } }, "AtsJobPosting_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } }, "description": "job-post-specific address" }, "AtsJobPosting": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posting_url": { "type": "string" }, "name": { "type": "string", "description": "job-post-specific name" }, "description": { "type": "string", "description": "job-post-specific description" }, "address": { "$ref": "#/definitions/AtsJobPosting_address", "description": "job-post-specific address" }, "location": { "type": "string", "description": "job-post-specific location" }, "is_active": { "type": "boolean" } } }, "AtsJobPostings": { "type": "array", "items": { "$ref": "#/definitions/AtsJobPosting" }, "description": "Public job postings" }, "AtsGroup": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TEAM", "GROUP", "DEPARTMENT", "DIVISION", "BUSINESS_UNIT", "BRANCH", "SUB_DEPARTMENT" ] } } }, "AtsGroups": { "type": "array", "items": { "$ref": "#/definitions/AtsGroup" }, "description": "The departments/divisions/teams that this job belongs to" }, "AtsJobOpening": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "OPEN", "CLOSED" ] }, "opened_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "closed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "application_id": { "type": "string", "description": "points to an application" }, "close_reason": { "type": "string" } } }, "AtsJobOpenings": { "type": "array", "items": { "$ref": "#/definitions/AtsJobOpening" } }, "AtsJob_skills": { "type": "array", "items": { "type": "string" } }, "AtsJob": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "recruiter_ids": { "$ref": "#/definitions/AtsJob_recruiter_ids" }, "hiring_manager_ids": { "$ref": "#/definitions/AtsJob_hiring_manager_ids" }, "hiring_managers": { "type": "array", "items": { "$ref": "#/definitions/AtsReference" } }, "status": { "type": "string", "enum": [ "ARCHIVED", "PENDING", "DRAFT", "OPEN", "CLOSED" ] }, "closed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "addresses": { "type": "array", "items": { "$ref": "#/definitions/AtsAddress" } }, "compensation": { "type": "array", "items": { "$ref": "#/definitions/AtsCompensation" } }, "employment_type": { "type": "string", "enum": [ "FULL_TIME", "PART_TIME", "CONTRACTOR", "INTERN", "CONSULTANT", "VOLUNTEER", "CASUAL", "SEASONAL", "FREELANCE", "OTHER" ] }, "remote": { "type": "boolean" }, "language_locale": { "type": "string", "description": "Preferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us)" }, "public_job_urls": { "$ref": "#/definitions/AtsJob_public_job_urls", "description": "URLs for pages containing public listings for the job" }, "number_of_openings": { "type": "number", "description": "Number of openings for the job" }, "company_id": { "type": "string", "description": "id value of the company associated with the job in the ATS (reference to AtsCompany)" }, "questions": { "type": "array", "items": { "$ref": "#/definitions/AtsJobQuestion" } }, "postings": { "type": "array", "items": { "$ref": "#/definitions/AtsJobPosting" }, "description": "Public job postings" }, "groups": { "type": "array", "items": { "$ref": "#/definitions/AtsGroup" }, "description": "The departments/divisions/teams that this job belongs to" }, "openings": { "type": "array", "items": { "$ref": "#/definitions/AtsJobOpening" } }, "minimum_experience_years": { "type": "number" }, "minimum_degree": { "type": "string" }, "skills": { "$ref": "#/definitions/AtsJob_skills" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "user_id": { "type": "string", "description": "User id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee)" }, "industry": { "type": "string" }, "summary": { "type": "string", "description": "Short job blurb (distinct from full description when both exist)" }, "raw": {} } }, "AtsInterview_user_ids": { "type": "array", "items": { "type": "string" } }, "AtsInterview": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "candidate_id": { "type": "string" }, "job_id": { "type": "string" }, "application_id": { "type": "string" }, "user_ids": { "$ref": "#/definitions/AtsInterview_user_ids", "description": "(reference to HrisEmployee)" }, "status": { "type": "string", "enum": [ "SCHEDULED", "AWAITING_FEEDBACK", "COMPLETE", "CANCELED", "NEEDS_SCHEDULING" ] }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "location": { "type": "string" }, "meeting_url": { "type": "string", "description": "the URL of the virtual/video meeting (eg. Zoom, Google Meet, Microsoft Teams)" }, "external_event_xref": { "type": "string", "description": "the ID of the event in a calendar" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "raw": {} } }, "AtsDocument": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "document_url": { "type": "string", "description": "This link expires after 1 hour. " }, "document_data": { "type": "string", "description": "base64 encoded file contents used for create/update actions. Use this field to send an attachment e.g. a resume, a profile, or other text content" }, "filename": { "type": "string" }, "type": { "type": "string", "enum": [ "RESUME", "COVER_LETTER", "OFFER_PACKET", "OFFER_LETTER", "TAKE_HOME_TEST", "OTHER" ] }, "candidate_id": { "type": "string" }, "application_id": { "type": "string" }, "job_id": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "raw": {} } }, "AtsStatus": { "type": "object", "properties": { "id": { "type": "string" }, "job_id": { "type": "string", "description": "The ID of the job this status/stage belongs to, when the provider scopes statuses per job." }, "status": { "type": "string", "enum": [ "NEW", "REVIEWING", "SCREENING", "SUBMITTED", "FIRST_INTERVIEW", "SECOND_INTERVIEW", "THIRD_INTERVIEW", "BACKGROUND_CHECK", "OFFERED", "ACCEPTED", "HIRED", "REJECTED", "DECLINED", "WITHDRAWN" ] }, "original_status": { "type": "string" }, "description": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "raw": {} } }, "AtsApplicationAnswer_answers": { "type": "array", "items": { "type": "string" } }, "AtsApplicationAnswer": { "type": "object", "properties": { "question_id": { "type": "string" }, "question": { "type": "string" }, "answers": { "$ref": "#/definitions/AtsApplicationAnswer_answers" } }, "required": [ "question_id", "answers" ] }, "AtsApplicationAnswers": { "type": "array", "items": { "$ref": "#/definitions/AtsApplicationAnswer" } }, "AtsOffer": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "creator_user_id": { "type": "string", "description": "user id of the recruiter who created the offer (reference to HrisEmployee)" }, "employee_user_id": { "type": "string", "description": "newly hired employee id (reference to HrisEmployee)" }, "sent_at": { "type": "string", "format": "date-time", "description": "date the offer was sent (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "accepted_at": { "type": "string", "format": "date-time", "description": "date the offer was accepted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "rejected_at": { "type": "string", "format": "date-time", "description": "date the offer was rejected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "date the employee starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "compensation": { "type": "array", "items": { "$ref": "#/definitions/AtsCompensation" }, "description": "compensation details for the offer" }, "status": { "type": "string", "enum": [ "CREATED", "SENT", "ACCEPTED", "REJECTED" ] } } }, "AtsOffers": { "type": "array", "items": { "$ref": "#/definitions/AtsOffer" } }, "AtsApplication": { "type": "object", "properties": { "id": { "type": "string" }, "candidate_id": { "type": "string" }, "job_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "applied_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "hired_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "rejected_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "rejected_reason": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "NEW", "REVIEWING", "SCREENING", "SUBMITTED", "FIRST_INTERVIEW", "SECOND_INTERVIEW", "THIRD_INTERVIEW", "BACKGROUND_CHECK", "OFFERED", "ACCEPTED", "HIRED", "REJECTED", "DECLINED", "WITHDRAWN" ] }, "original_status": { "type": "string", "description": "The integration's original status. Mostly used to have your customers chose the application status/stage so that your software can trigger an event." }, "answers": { "type": "array", "items": { "$ref": "#/definitions/AtsApplicationAnswer" } }, "offers": { "type": "array", "items": { "$ref": "#/definitions/AtsOffer" } }, "user_id": { "type": "string", "description": "HR user/employee ID (reference to HrisEmployee)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "original_substatus": { "type": "string", "description": "The provider's secondary/sub status, when distinct from original_status (e.g. UKG Ready hiring_stage)" }, "summary": { "type": "string", "description": "Application personal summary (e.g. Pinpoint Personal Summary)" }, "raw": {} } }, "AtsScorecardQuestion": { "type": "object", "properties": { "text": { "type": "string", "description": "The question to ask the interviewer" }, "description": { "type": "string" }, "answer": { "type": "string", "description": "Candidate’s answer to the question" } }, "required": [ "text" ] }, "AtsScorecardQuestions": { "type": "array", "items": { "$ref": "#/definitions/AtsScorecardQuestion" } }, "AtsScorecard": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "application_id": { "type": "string" }, "interviewer_id": { "type": "string" }, "interview_id": { "type": "string" }, "candidate_id": { "type": "string" }, "job_id": { "type": "string" }, "recommendation": { "type": "string", "enum": [ "DEFINITELY_NO", "NO", "YES", "STRONG_YES" ] }, "comment": { "type": "string" }, "questions": { "type": "array", "items": { "$ref": "#/definitions/AtsScorecardQuestion" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "raw": {} } }, "AtsCompany_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AtsCompany_recruiter_ids": { "type": "array", "items": { "type": "string" } }, "AtsCompany": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "address": { "$ref": "#/definitions/AtsCompany_address" }, "website_url": { "type": "string" }, "phone": { "type": "string" }, "parent_id": { "type": "string" }, "recruiter_ids": { "$ref": "#/definitions/AtsCompany_recruiter_ids" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AtsMetadata" } }, "raw": {} } }, "HrisEmail": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] } }, "required": [ "email" ] }, "HrisEmails": { "type": "array", "items": { "$ref": "#/definitions/HrisEmail" } }, "HrisTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } }, "required": [ "telephone" ] }, "HrisTelephones": { "type": "array", "items": { "$ref": "#/definitions/HrisTelephone" } }, "HrisEmployee_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "HrisEmployee_employee_roles": { "type": "array", "items": { "type": "string", "enum": [ "ADMIN", "MANAGER", "RECRUITER", "SALESREP", "INTERVIEWER", "USER", "EMPLOYEE" ] } }, "HrisCompensation": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SALARY", "BONUS", "STOCK_OPTIONS", "EQUITY", "OTHER", "HOURLY", "COMMISSION" ] }, "amount": { "type": "number" }, "currency": { "type": "string" }, "frequency": { "type": "string", "enum": [ "ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK", "BIWEEKLY", "SEMIMONTHLY" ] }, "group_id": { "type": "string", "description": "(reference to HrisGroup)" }, "notes": { "type": "string" } } }, "HrisCompensations": { "type": "array", "items": { "$ref": "#/definitions/HrisCompensation" } }, "HrisGroup_user_ids": { "type": "array", "items": { "type": "string" } }, "HrisGroup_manager_ids": { "type": "array", "items": { "type": "string" } }, "HrisMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {}, "slug": { "type": "string" } } }, "HrisMetadatas": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "HrisGroup": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "parent_id": { "type": "string" }, "type": { "type": "string", "enum": [ "TEAM", "GROUP", "DEPARTMENT", "DIVISION", "BUSINESS_UNIT", "BRANCH", "SUB_DEPARTMENT", "PAY_GROUP" ] }, "user_ids": { "$ref": "#/definitions/HrisGroup_user_ids", "description": "(reference to HrisEmployee)" }, "manager_ids": { "$ref": "#/definitions/HrisGroup_manager_ids" }, "is_active": { "type": "boolean" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "pay_frequency": { "type": "string", "description": "pay cycle when type is PAY_GROUP", "enum": [ "ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK", "BIWEEKLY", "SEMIMONTHLY" ] }, "next_paid_at": { "type": "string", "format": "date-time", "description": "next pay date when type is PAY_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisGroups": { "type": "array", "items": { "$ref": "#/definitions/HrisGroup" }, "description": "Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email." }, "HrisLocation_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "HrisLocation": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "address": { "$ref": "#/definitions/HrisLocation_address" }, "parent_id": { "type": "string" }, "external_identifier": { "type": "string" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/HrisTelephone" } }, "timezone": { "type": "string" }, "currency": { "type": "string" }, "language_locale": { "type": "string" }, "is_active": { "type": "boolean" }, "is_hq": { "type": "boolean", "description": "if this location is the headquarters of the company" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisLocations": { "type": "array", "items": { "$ref": "#/definitions/HrisLocation" } }, "HrisEmployeerelationship_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "HrisEmployeerelationship": { "type": "object", "properties": { "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/HrisEmail" } }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/HrisTelephone" } }, "address": { "$ref": "#/definitions/HrisEmployeerelationship_address" }, "type": { "type": "string", "enum": [ "EMERGENCY", "SPOUSE", "CHILD", "PARENT", "SIBLING", "FRIEND", "OTHER" ] }, "is_dependent": { "type": "boolean" }, "is_beneficiary": { "type": "boolean" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "HrisEmployeerelationships": { "type": "array", "items": { "$ref": "#/definitions/HrisEmployeerelationship" }, "description": "the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...)" }, "HrisEmployee": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/HrisEmail" } }, "title": { "type": "string" }, "job_id": { "type": "string", "description": "the hris_job (position) this employee holds; their primary job when they hold more than one" }, "manager_id": { "type": "string" }, "employment_status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "gender": { "type": "string", "enum": [ "MALE", "FEMALE", "INTERSEX", "TRANS", "NON_BINARY" ] }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/HrisTelephone" } }, "date_of_birth": { "type": "string", "format": "date-time", "description": "YYYYMM/DD" }, "employee_number": { "type": "string", "description": "the company's ID for this employee" }, "hired_at": { "type": "string", "format": "date-time", "description": "The employee's start date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "terminated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "termination_reason": { "type": "string" }, "marital_status": { "type": "string", "enum": [ "MARRIED", "SINGLE" ] }, "employment_type": { "type": "string", "enum": [ "FULL_TIME", "PART_TIME", "CONTRACTOR", "INTERN", "CONSULTANT", "VOLUNTEER", "CASUAL", "SEASONAL", "FREELANCE", "OTHER" ] }, "address": { "$ref": "#/definitions/HrisEmployee_address" }, "language_locale": { "type": "string" }, "currency": { "type": "string" }, "timezone": { "type": "string" }, "image_url": { "type": "string", "description": "This link expires after 1 hour. " }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "pronouns": { "type": "string" }, "employee_roles": { "$ref": "#/definitions/HrisEmployee_employee_roles" }, "compensation": { "type": "array", "items": { "$ref": "#/definitions/HrisCompensation" } }, "salutation": { "type": "string", "description": "Mr. Mrs. Ms." }, "bio": { "type": "string" }, "ssn_sin": { "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/definitions/HrisGroup" }, "description": "Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email." }, "locations": { "type": "array", "items": { "$ref": "#/definitions/HrisLocation" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "storage_quota_allocated": { "type": "number" }, "storage_quota_used": { "type": "number" }, "storage_quota_available": { "type": "number" }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/HrisEmployeerelationship" }, "description": "the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...)" }, "has_mfa": { "type": "boolean", "description": "does the user/employee have multi-factor authentication enabled" }, "timeoff_days_total": { "type": "number", "description": "Total time off allowance for the current leave period, in days (when reported by the provider)" }, "timeoff_days_used": { "type": "number", "description": "Time off days used or booked in the current leave period (when reported by the provider)" }, "flsa_status": { "type": "string", "description": "US Fair Labor Standards Act classification", "enum": [ "EXEMPT", "NON_EXEMPT", "SALARIED_NONEXEMPT", "OWNER" ] }, "pay_frequency": { "type": "string", "description": "how often the employee is paid (eg. BIWEEKLY)", "enum": [ "ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK", "BIWEEKLY", "SEMIMONTHLY" ] }, "raw": {} } }, "HrisCompany_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "HrisCompany": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "legal_name": { "type": "string" }, "address": { "$ref": "#/definitions/HrisCompany_address" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisEmployees": { "type": "array", "items": { "$ref": "#/definitions/HrisEmployee" }, "description": "the employees currently holding this job. May not have all of the Employee fields present, but should have id and name" }, "HrisJob": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "the job or position title" }, "description": { "type": "string" }, "code": { "type": "string", "description": "the integration's job code or position number, when it differs from id" }, "is_active": { "type": "boolean" }, "employment_type": { "type": "string", "enum": [ "FULL_TIME", "PART_TIME", "CONTRACTOR", "INTERN", "CONSULTANT", "VOLUNTEER", "CASUAL", "SEASONAL", "FREELANCE", "OTHER" ] }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "groups": { "type": "array", "items": { "$ref": "#/definitions/HrisGroup" }, "description": "the groups (departments, teams, organizations) this job belongs to. May not have all of the Group fields present, but should have id and name" }, "locations": { "type": "array", "items": { "$ref": "#/definitions/HrisLocation" }, "description": "where this job is worked. May not have all of the Location fields present, but should have id and name" }, "parent_id": { "type": "string", "description": "the hris_job this job reports to (position hierarchy)" }, "users": { "type": "array", "items": { "$ref": "#/definitions/HrisEmployee" }, "description": "the employees currently holding this job. May not have all of the Employee fields present, but should have id and name" }, "compensation": { "type": "array", "items": { "$ref": "#/definitions/HrisCompensation" }, "description": "pay attached to the job itself (eg. an hourly rate)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisTimeoff": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "employee ID (reference to HrisEmployee)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "is_paid": { "type": "boolean" }, "status": { "type": "string", "enum": [ "APPROVED", "PENDING", "DENIED", "CANCELLED" ] }, "approver_user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "approved_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "comments": { "type": "string" }, "reason": { "type": "string" }, "original_type": { "type": "string", "description": "integration leave-type label before normalization" }, "type": { "type": "string", "enum": [ "VACATION", "SICK", "HOLIDAY", "BEREAVEMENT", "PARENTAL", "UNPAID", "IN_LIEU", "OTHER" ] }, "duration": { "type": "number" }, "duration_type": { "type": "string", "enum": [ "HOUR", "DAY" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} }, "required": [ "user_id" ] }, "HrisPayslipDetail": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EARNING_SALARY", "EARNING_OVERTIME", "EARNING_TIP", "EARNING_BONUS", "EARNING_COMMISSION", "EARNING_ADJUSTMENT", "EARNING", "PRETAX_DEDUCTION", "PRETAX_DEDUCTION_HEALTH_INSURANCE", "PRETAX_DEDUCTION_RETIREMENT", "PRETAX_DEDUCTION_HRA", "TAX_FEDERAL", "TAX_REGION", "TAX_LOCAL", "POSTTAX_BENEFIT", "POSTTAX_GARNISHMENT", "REIMBURSEMENT", "EARNING_REGULAR", "EARNING_DOUBLE_OVERTIME", "EARNING_PTO", "EARNING_SICK", "EARNING_HOLIDAY", "EARNING_SEVERANCE", "EARNING_REIMBURSEMENT", "TAX_SOCIAL_SECURITY", "TAX_MEDICARE", "TAX_UNEMPLOYMENT", "TAX_EMPLOYER", "PRETAX_DEDUCTION_HSA", "PRETAX_DEDUCTION_FSA", "PRETAX_DEDUCTION_DEPENDENT_CARE", "PRETAX_DEDUCTION_COMMUTER", "PRETAX_DEDUCTION_DENTAL", "PRETAX_DEDUCTION_VISION", "POSTTAX_DEDUCTION", "POSTTAX_RETIREMENT_ROTH", "POSTTAX_LOAN_REPAYMENT", "EMPLOYER_CONTRIBUTION", "PENSION", "EARNING_CASH_IN_LIEU" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "amount": { "type": "number" }, "employee_amount": { "type": "number" }, "company_amount": { "type": "number" }, "hours": { "type": "number" }, "rate_amount": { "type": "number", "description": "pay rate for hourly/unit-based lines" }, "ytd_amount": { "type": "number", "description": "year-to-date amount for this line" }, "is_pre_tax": { "type": "boolean" }, "is_employer": { "type": "boolean", "description": "true when this line is paid by the employer (employer tax or contribution)" }, "paycode_id": { "type": "string", "description": "the hris_paycode for this line" }, "benefit_id": { "type": "string" }, "deduction_id": { "type": "string" }, "original_type": { "type": "string", "description": "integration pay-code label before normalization" } }, "required": [ "amount" ] }, "HrisPayslipDetails": { "type": "array", "items": { "$ref": "#/definitions/HrisPayslipDetail" } }, "HrisPayslip_deduction": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "employee ID (reference to HrisEmployee)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "benefit_id": { "type": "string" }, "amount": { "type": "number", "description": "percentage or absolute amount (employee's portion)" }, "type": { "type": "string", "enum": [ "FIXED", "PERCENTAGE" ] }, "coverage_level": { "type": "string", "description": "Level selected by employee (e.g. \"FAMILY\", \"EMPLOYEE_ONLY\", or other)", "enum": [ "EMPLOYEE_ONLY", "EMPLOYEE_SPOUSE", "EMPLOYEE_CHILD", "EMPLOYEE_CHILDREN", "EMPLOYEE_FAMILY", "FAMILY", "OTHER" ] }, "frequency": { "type": "string", "description": "Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)", "enum": [ "ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK", "BIWEEKLY", "SEMIMONTHLY" ] }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "is_active": { "type": "boolean" }, "notes": { "type": "string" }, "employer_amount": { "type": "number", "description": "percentage or absolute amount (employer's portion/match)" }, "employer_type": { "type": "string", "enum": [ "PERCENTAGE", "FIXED" ] }, "max_amount": { "type": "number", "description": "annual maximum employee amount (always money)" }, "paycode_id": { "type": "string", "description": "the hris_paycode (deduction code) this deduction uses" }, "garnishment_type": { "type": "string", "description": "set when this deduction is a court-ordered garnishment", "enum": [ "CHILD_SUPPORT", "TAX_LEVY", "STUDENT_LOAN", "CREDITOR", "BANKRUPTCY", "OTHER" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} }, "description": "The ID (and optionally name) of the employee deduction (if this detail represents a deduction)" }, "HrisPayslip": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "the employee (reference to HrisEmployee)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "payment_reference": { "type": "string" }, "payment_type": { "type": "string", "enum": [ "DIRECT", "CHEQUE", "CASH" ] }, "paid_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "currency": { "type": "string" }, "gross_amount": { "type": "number" }, "net_amount": { "type": "number" }, "details": { "type": "array", "items": { "$ref": "#/definitions/HrisPayslipDetail" } }, "deduction": { "$ref": "#/definitions/HrisPayslip_deduction", "description": "The ID (and optionally name) of the employee deduction (if this detail represents a deduction)" }, "payroll_id": { "type": "string", "description": "the hris_payroll (pay run) this payslip belongs to" }, "group_id": { "type": "string", "description": "the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)" }, "type": { "type": "string", "enum": [ "REGULAR", "OFF_CYCLE", "BONUS", "CORRECTION", "TERMINATION", "CONTRACTOR" ] }, "hours": { "type": "number", "description": "total hours paid on this payslip" }, "employee_tax_amount": { "type": "number", "description": "total taxes withheld from the employee" }, "employer_tax_amount": { "type": "number", "description": "total employer-paid taxes" }, "deduction_amount": { "type": "number", "description": "total employee deductions (pre and post-tax)" }, "employer_contribution_amount": { "type": "number", "description": "total employer benefit contributions" }, "gross_ytd_amount": { "type": "number", "description": "year-to-date gross pay as of this payslip" }, "net_ytd_amount": { "type": "number", "description": "year-to-date net pay as of this payslip" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisPayroll_user_ids": { "type": "array", "items": { "type": "string" }, "description": "employees paid in this payroll" }, "HrisPayroll_payslip_ids": { "type": "array", "items": { "type": "string" } }, "HrisPayroll": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "group_id": { "type": "string", "description": "the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "APPROVED", "PROCESSING", "PAID", "FAILED", "CANCELLED" ] }, "type": { "type": "string", "enum": [ "REGULAR", "OFF_CYCLE", "BONUS", "CORRECTION", "TERMINATION", "CONTRACTOR" ] }, "start_at": { "type": "string", "format": "date-time", "description": "pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "paid_at": { "type": "string", "format": "date-time", "description": "pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "approved_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "currency": { "type": "string" }, "gross_amount": { "type": "number" }, "net_amount": { "type": "number" }, "employee_tax_amount": { "type": "number" }, "employer_tax_amount": { "type": "number" }, "deduction_amount": { "type": "number", "description": "total employee deductions" }, "employer_contribution_amount": { "type": "number", "description": "total employer benefit contributions" }, "total_cost_amount": { "type": "number", "description": "total company cost/debit for this payroll" }, "user_ids": { "$ref": "#/definitions/HrisPayroll_user_ids", "description": "employees paid in this payroll (reference to HrisEmployee)" }, "payslip_ids": { "$ref": "#/definitions/HrisPayroll_payslip_ids" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisPaycode": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "name": { "type": "string" }, "code": { "type": "string", "description": "the payroll system's code for this item" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "EARNING", "DEDUCTION", "TAX", "CONTRIBUTION", "REIMBURSEMENT" ] }, "detail_type": { "type": "string", "description": "the normalized payslip-line type this code produces", "enum": [ "EARNING_SALARY", "EARNING_OVERTIME", "EARNING_TIP", "EARNING_BONUS", "EARNING_COMMISSION", "EARNING_ADJUSTMENT", "EARNING", "PRETAX_DEDUCTION", "PRETAX_DEDUCTION_HEALTH_INSURANCE", "PRETAX_DEDUCTION_RETIREMENT", "PRETAX_DEDUCTION_HRA", "TAX_FEDERAL", "TAX_REGION", "TAX_LOCAL", "POSTTAX_BENEFIT", "POSTTAX_GARNISHMENT", "REIMBURSEMENT", "EARNING_REGULAR", "EARNING_DOUBLE_OVERTIME", "EARNING_PTO", "EARNING_SICK", "EARNING_HOLIDAY", "EARNING_SEVERANCE", "EARNING_REIMBURSEMENT", "TAX_SOCIAL_SECURITY", "TAX_MEDICARE", "TAX_UNEMPLOYMENT", "TAX_EMPLOYER", "PRETAX_DEDUCTION_HSA", "PRETAX_DEDUCTION_FSA", "PRETAX_DEDUCTION_DEPENDENT_CARE", "PRETAX_DEDUCTION_COMMUTER", "PRETAX_DEDUCTION_DENTAL", "PRETAX_DEDUCTION_VISION", "POSTTAX_DEDUCTION", "POSTTAX_RETIREMENT_ROTH", "POSTTAX_LOAN_REPAYMENT", "EMPLOYER_CONTRIBUTION", "PENSION", "EARNING_CASH_IN_LIEU" ] }, "is_pre_tax": { "type": "boolean" }, "is_employer": { "type": "boolean" }, "is_active": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisEarning": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "employee ID (reference to HrisEmployee)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "paycode_id": { "type": "string", "description": "the hris_paycode (earning code) this earning is paid under" }, "amount": { "type": "number", "description": "money amount added to each pay run it applies to" }, "currency": { "type": "string" }, "hours": { "type": "number" }, "rate_amount": { "type": "number", "description": "rate per hour/unit" }, "frequency": { "type": "string", "description": "ONE_TIME for a single addition to the next unprocessed pay run, otherwise recurring", "enum": [ "ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK", "BIWEEKLY", "SEMIMONTHLY" ] }, "start_at": { "type": "string", "format": "date-time", "description": "recurring: first effective date; ONE_TIME: requested pay date (empty = next unprocessed pay run) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "recurring: last effective date (empty = until stopped) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "status": { "type": "string", "enum": [ "PENDING", "ACTIVE", "PROCESSED", "ENDED", "CANCELLED", "FAILED" ] }, "payroll_id": { "type": "string", "description": "the hris_payroll (pay run) a ONE_TIME earning targets or was paid in" }, "payslip_id": { "type": "string", "description": "the hris_payslip a ONE_TIME earning was paid on" }, "notes": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisDevice_user_ids": { "type": "array", "items": { "type": "string" }, "description": "users who have this device" }, "HrisDevice_admin_user_ids": { "type": "array", "items": { "type": "string" } }, "HrisDevice": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "asset_tag": { "type": "string" }, "version": { "type": "string", "description": "device version" }, "manufacturer": { "type": "string", "description": "device manufacturer" }, "model": { "type": "string", "description": "device model" }, "os": { "type": "string", "description": "operating system name" }, "os_version": { "type": "string" }, "user_ids": { "$ref": "#/definitions/HrisDevice_user_ids", "description": "users who have this device (reference to HrisEmployee)" }, "admin_user_ids": { "$ref": "#/definitions/HrisDevice_admin_user_ids", "description": "(reference to HrisEmployee)" }, "location_id": { "type": "string", "description": "pointer to HR Location object (reference to HrisLocation)" }, "has_antivirus": { "type": "boolean" }, "has_password_manager": { "type": "boolean" }, "has_firewall": { "type": "boolean" }, "has_hd_encrypted": { "type": "boolean" }, "has_screenlock": { "type": "boolean" }, "is_missing": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisTimeshift": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "employee_user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "location_id": { "type": "string", "description": "(reference to HrisLocation)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "group_id": { "type": "string", "description": "department, team, etc. (reference to HrisGroup)" }, "compensation": { "type": "array", "items": { "$ref": "#/definitions/HrisCompensation" } }, "approver_user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "approved_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "hours": { "type": "number" }, "is_approved": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} }, "required": [ "employee_user_id" ] }, "HrisAttendance_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "HrisAttendanceBreak": { "type": "object", "properties": { "id": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "is_paid": { "type": "boolean" }, "duration_minutes": { "type": "number" }, "name": { "type": "string", "description": "break type label, e.g. \"Lunch\"" } } }, "HrisAttendanceBreaks": { "type": "array", "items": { "$ref": "#/definitions/HrisAttendanceBreak" } }, "HrisAttendance": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "employee_user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "start_at": { "type": "string", "format": "date-time", "description": "clock-in (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "clock-out (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "timeshift_id": { "type": "string", "description": "the scheduled hris_timeshift this attendance record fulfils" }, "location_id": { "type": "string", "description": "(reference to HrisLocation)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "group_id": { "type": "string", "description": "department, team, etc. (reference to HrisGroup)" }, "timezone": { "type": "string" }, "address": { "$ref": "#/definitions/HrisAttendance_address" }, "hours": { "type": "number", "description": "worked hours" }, "currency": { "type": "string", "description": "pairs with hourly_rate and tip amounts" }, "status": { "type": "string", "enum": [ "OPEN", "CLOSED", "APPROVED" ] }, "breaks": { "type": "array", "items": { "$ref": "#/definitions/HrisAttendanceBreak" } }, "declared_tips_amount": { "type": "number", "description": "cash tips declared by the employee for this attendance record" }, "non_cash_tips_amount": { "type": "number", "description": "card/non-cash tips attributed to this attendance record" }, "job_name": { "type": "string" }, "hourly_rate": { "type": "number" }, "approver_user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "approved_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} }, "required": [ "employee_user_id", "start_at", "end_at" ], "description": "Also called timesheets" }, "HrisBenefit": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "e.g. \"401(k) Plan\"" }, "description": { "type": "string", "description": "e.g. \"Company 401(k) retirement plan\"" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "type": { "type": "string", "enum": [ "RETIREMENT", "HEALTH", "DENTAL", "VISION", "LIFE", "HSA", "FSA", "SHORT_TERM_DISABILITY", "LONG_TERM_DISABILITY", "WORKERS_COMP", "HOUSING_STIPEND", "EMPLOYER_TAX_CONTRIBUTION", "GARNISHMENT", "LOAN_REPAYMENT", "CHARITABLE_CONTRIBUTION", "OTHER", "RETIREMENT_ROTH", "COMMUTER", "DEPENDENT_CARE", "PENSION" ] }, "tax": { "type": "string", "description": "Tax describes the tax treatment of the benefit", "enum": [ "PRE_TAX", "POST_TAX", "TAXABLE", "NON_TAXABLE", "TAX" ] }, "frequency": { "type": "string", "description": "Frequency that costs accrue for this benefit. For insurance/benefits, usually \"MONTHLY\". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).", "enum": [ "ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK", "BIWEEKLY", "SEMIMONTHLY" ] }, "is_active": { "type": "boolean" }, "employer_contribution_type": { "type": "string", "enum": [ "PERCENTAGE", "FIXED" ] }, "employer_contribution_amount": { "type": "number", "description": "percentage or money" }, "employer_contribution_max_amount": { "type": "number", "description": "always money" }, "coverage_level": { "type": "string", "enum": [ "EMPLOYEE_ONLY", "EMPLOYEE_SPOUSE", "EMPLOYEE_CHILD", "EMPLOYEE_CHILDREN", "EMPLOYEE_FAMILY", "FAMILY", "OTHER" ] }, "currency": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} }, "description": "Company-wide benefit plans available to employees." }, "HrisDeduction": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "employee ID (reference to HrisEmployee)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "benefit_id": { "type": "string" }, "amount": { "type": "number", "description": "percentage or absolute amount (employee's portion)" }, "type": { "type": "string", "enum": [ "FIXED", "PERCENTAGE" ] }, "coverage_level": { "type": "string", "description": "Level selected by employee (e.g. \"FAMILY\", \"EMPLOYEE_ONLY\", or other)", "enum": [ "EMPLOYEE_ONLY", "EMPLOYEE_SPOUSE", "EMPLOYEE_CHILD", "EMPLOYEE_CHILDREN", "EMPLOYEE_FAMILY", "FAMILY", "OTHER" ] }, "frequency": { "type": "string", "description": "Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)", "enum": [ "ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK", "BIWEEKLY", "SEMIMONTHLY" ] }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "is_active": { "type": "boolean" }, "notes": { "type": "string" }, "employer_amount": { "type": "number", "description": "percentage or absolute amount (employer's portion/match)" }, "employer_type": { "type": "string", "enum": [ "PERCENTAGE", "FIXED" ] }, "max_amount": { "type": "number", "description": "annual maximum employee amount (always money)" }, "paycode_id": { "type": "string", "description": "the hris_paycode (deduction code) this deduction uses" }, "garnishment_type": { "type": "string", "description": "set when this deduction is a court-ordered garnishment", "enum": [ "CHILD_SUPPORT", "TAX_LEVY", "STUDENT_LOAN", "CREDITOR", "BANKRUPTCY", "OTHER" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} }, "description": "Employee-specific deduction/benefit enrolment." }, "HrisBankaccount": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "employee ID (required for listcreate) (reference to HrisEmployee)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "account_type": { "type": "string", "enum": [ "CHECKING", "SAVINGS" ] }, "bank_name": { "type": "string" }, "routing_number": { "type": "string", "description": "9-digit US routing number" }, "account_number": { "type": "string" }, "account_number_last4": { "type": "string", "description": "when full number not returned" }, "name": { "type": "string", "description": "account nickname (e.g. \"BoA Checking\")" }, "is_primary": { "type": "boolean", "description": "primary for direct deposit" }, "iban": { "type": "string", "description": "International Bank Account Number (non-US accounts)" }, "bic": { "type": "string", "description": "BIC / SWIFT code" }, "country_code": { "type": "string", "description": "ISO 2-digit country code of the bank account" }, "currency": { "type": "string" }, "split_type": { "type": "string", "description": "how net pay is split into this account when an employee has several accounts", "enum": [ "PERCENTAGE", "FIXED", "REMAINDER" ] }, "split_amount": { "type": "number", "description": "percentage (when split_type is PERCENTAGE) or money (when FIXED)" }, "priority": { "type": "number", "description": "order in which split accounts are funded (1 = first)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisTaxonomy_alternative_names": { "type": "array", "items": { "type": "string" }, "description": "synonyms / alternative labels" }, "HrisTaxonomy_role_ids": { "type": "array", "items": { "type": "string" }, "description": "ids of hris_taxonomy items of type ROLE that this skill relates to" }, "HrisTaxonomy": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "type": { "type": "string", "description": "the kind of taxonomy item: skill, knowledge, competence, ability, certification or role/occupation", "enum": [ "SKILL", "KNOWLEDGE", "COMPETENCE", "ABILITY", "CERTIFICATION", "ROLE", "HOLIDAY", "LEAVE" ] }, "name": { "type": "string", "description": "the preferred label of the skill/role" }, "description": { "type": "string" }, "domain": { "type": "string", "description": "1st-level grouping (broadest)" }, "category": { "type": "string", "description": "2nd-level grouping" }, "subcategory": { "type": "string", "description": "3rd-level grouping" }, "parent_id": { "type": "string", "description": "id of the parent taxonomy item, for providers exposing arbitrary-depth trees" }, "alternative_names": { "$ref": "#/definitions/HrisTaxonomy_alternative_names", "description": "synonyms / alternative labels" }, "url": { "type": "string", "description": "external reference URL for this item" }, "role_ids": { "$ref": "#/definitions/HrisTaxonomy_role_ids", "description": "ids of hris_taxonomy items of type ROLE that this skill relates to" }, "is_active": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "HrisDocument": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "document_url": { "type": "string", "description": "download link, expires after 1 hour" }, "document_data": { "type": "string", "description": "base64 encoded file contents for create/update" }, "filename": { "type": "string" }, "type": { "type": "string", "description": "unified, normalized document type (OTHER when unmappable)", "enum": [ "CONTRACT", "OFFER_LETTER", "POLICY", "TAX", "ID", "VISA", "PAYSLIP", "BENEFITS", "CERTIFICATION", "PERFORMANCE_REVIEW", "ONBOARDING", "TERMINATION", "MEDICAL", "OTHER" ] }, "user_id": { "type": "string", "description": "pointer to the HR Employee object that owns this document (reference to HrisEmployee)" }, "company_id": { "type": "string", "description": "(reference to HrisCompany)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HrisMetadata" } }, "raw": {} } }, "VerificationPackage_aliases": { "type": "array", "items": { "type": "string" } }, "VerificationPackage_tags": { "type": "array", "items": { "type": "string" }, "description": "Category (Verification, Validation, Background Check)" }, "VerificationParameter_options": { "type": "array", "items": { "type": "string" }, "description": "options for MULTIPLE_CHOICE and MULTIPLE_SELECT" }, "VerificationParameter_file_types": { "type": "array", "items": { "type": "string" }, "description": "valid file mime types" }, "VerificationParameter_valid_regions": { "type": "array", "items": { "type": "string" }, "description": "{country}-{stateprovince/territory} or just {country} 2-digit ISO codes" }, "VerificationParameter": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "public_question": { "type": "string", "description": "question to ask the human" }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "MULTIPLE_CHOICE", "MULTIPLE_SELECT", "DATE", "FILE" ] }, "options": { "$ref": "#/definitions/VerificationParameter_options", "description": "options for MULTIPLE_CHOICE and MULTIPLE_SELECT" }, "file_types": { "$ref": "#/definitions/VerificationParameter_file_types", "description": "valid file mime types" }, "valid_regions": { "$ref": "#/definitions/VerificationParameter_valid_regions", "description": "{country}-{stateprovince/territory} or just {country} 2-digit ISO codes" }, "is_required": { "type": "boolean" } }, "required": [ "name" ] }, "VerificationParameters": { "type": "array", "items": { "$ref": "#/definitions/VerificationParameter" }, "description": "Questions that need to be answered for this verification" }, "VerificationTime_valid_regions": { "type": "array", "items": { "type": "string" }, "description": "{country}-{stateprovince/territory} or just {country} 2-digit ISO codes" }, "VerificationTime": { "type": "object", "properties": { "milliseconds": { "type": "number" }, "valid_regions": { "$ref": "#/definitions/VerificationTime_valid_regions", "description": "{country}-{stateprovince/territory} or just {country} 2-digit ISO codes" } } }, "VerificationTimes": { "type": "array", "items": { "$ref": "#/definitions/VerificationTime" }, "description": "average processing time in minutes" }, "VerificationPackage_valid_regions": { "type": "array", "items": { "type": "string" }, "description": "{country}-{state/province/territory} or just {country} 2-digit ISO codes" }, "VerificationMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "VerificationMetadatas": { "type": "array", "items": { "$ref": "#/definitions/VerificationMetadata" } }, "VerificationPackage": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the verification type" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Name of the verification type" }, "type": { "type": "string", "enum": [ "IDENTITY_VERIFICATION", "SCREENING", "BACKGROUND_CHECK", "EMPLOYMENT_VERIFICATION", "EDUCATION_VERIFICATION", "CREDIT_CHECK", "FRAUD_PREVENTION", "OTHER" ] }, "aliases": { "$ref": "#/definitions/VerificationPackage_aliases" }, "tags": { "$ref": "#/definitions/VerificationPackage_tags", "description": "Category (Verification, Validation, Background Check)" }, "description": { "type": "string", "description": "Detailed description" }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/VerificationParameter" }, "description": "Questions that need to be answered for this verification" }, "average_processing_times": { "type": "array", "items": { "$ref": "#/definitions/VerificationTime" }, "description": "average processing time in minutes" }, "has_redirect_url": { "type": "boolean" }, "has_target_url": { "type": "boolean", "description": "where the provider will redirect the user to after the verification" }, "needs_ip_address": { "type": "boolean" }, "cost_amount": { "type": "number", "description": "Cost-related information" }, "currency": { "type": "string" }, "max_score": { "type": "number", "description": "if this verification returns a score, what is the maximum?" }, "info_url": { "type": "string", "description": "where to find additional information" }, "valid_regions": { "$ref": "#/definitions/VerificationPackage_valid_regions", "description": "{country}-{state/province/territory} or just {country} 2-digit ISO codes" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/VerificationMetadata" } }, "raw": {} }, "required": [ "name", "type" ] }, "VerificationParameterInput_inputs": { "type": "array", "items": { "type": "string" } }, "VerificationParameterInput": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "name of parameter" }, "inputs": { "$ref": "#/definitions/VerificationParameterInput_inputs" } } }, "VerificationParameterInputs": { "type": "array", "items": { "$ref": "#/definitions/VerificationParameterInput" } }, "VerificationAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "VerificationAddresses": { "type": "array", "items": { "$ref": "#/definitions/VerificationAddress" } }, "VerificationRequest_profile_emails": { "type": "array", "items": { "type": "string" } }, "VerificationRequest_profile_telephones": { "type": "array", "items": { "type": "string" } }, "VerificationRequest_response_download_urls": { "type": "array", "items": { "type": "string" }, "description": "report download" }, "VerificationResponseDetail": { "type": "object", "properties": { "title": { "type": "string" }, "text": { "type": "string" }, "is_private": { "type": "boolean" }, "is_failed_reason": { "type": "boolean" }, "parameter_id": { "type": "string", "description": "in reference to the parameter input" }, "download_url": { "type": "string" } } }, "VerificationResponseDetails": { "type": "array", "items": { "$ref": "#/definitions/VerificationResponseDetail" } }, "VerificationRequest": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "package_id": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/VerificationParameterInput" } }, "target_url": { "type": "string" }, "candidate_id": { "type": "string", "description": "points to ATS Candidate" }, "profile_ip_address": { "type": "string", "description": "XXX.XXX.XXX.XXX" }, "profile_name": { "type": "string" }, "profile_date_of_birth": { "type": "string", "description": "YYYY-MM-DD" }, "profile_addresses": { "type": "array", "items": { "$ref": "#/definitions/VerificationAddress" } }, "profile_gender": { "type": "string", "enum": [ "MALE", "FEMALE", "INTERSEX", "TRANS", "NON_BINARY" ] }, "profile_emails": { "$ref": "#/definitions/VerificationRequest_profile_emails" }, "profile_telephones": { "$ref": "#/definitions/VerificationRequest_profile_telephones" }, "profile_national_identifier": { "type": "string" }, "response_completed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "response_expires_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "response_issued_at": { "type": "string", "format": "date-time", "description": "datetime that identify was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "response_status": { "type": "string", "description": "Background checks and compliance checks return CLEARFLAGGED or PASS/FAIL or YES/NO", "enum": [ "COMPLETED", "FAILED", "PASSED", "PENDING" ] }, "response_score": { "type": "number", "description": "Identity verification services provide confidence scores (e.g., 0-100), Credit checks return specific numeric scores (e.g., FICO score 300-850), Fraud prevention tools use risk scores (e.g., 1-999)" }, "response_redirect_url": { "type": "string", "description": "Most modern IDV providers (like Onfido, Veriff, Jumio, ID.me). Background Check Providers, such as Checkr, GoodHire, Sterling, and HireRight. Credit bureaus and services often require direct user consent and information. This allows them to properly handle disclosures required by regulations like FCRA. Employment and Education Verification need users to confirm previous employers and schools." }, "response_download_urls": { "$ref": "#/definitions/VerificationRequest_response_download_urls", "description": "report download" }, "response_details": { "type": "array", "items": { "$ref": "#/definitions/VerificationResponseDetail" } }, "response_source": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/VerificationMetadata" } }, "raw": {} } }, "Payload": { "type": "object", "description": "integration-specific payload" }, "AccountingAccountTaxonomy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CLASSIFICATION", "GROUP", "SUBGROUP", "SYSTEM_ROLE", "OTHER" ] }, "original_type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type", "value" ] }, "AccountingAccountTaxonomies": { "type": "array", "items": { "$ref": "#/definitions/AccountingAccountTaxonomy" } }, "AccountingMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "AccountingMetadatas": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "AccountingAccount": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier used by the SaaS application to uniquely identify the Account" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the Account was created, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the Account was last updated, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Account name" }, "description": { "type": "string", "description": "Account description" }, "type": { "type": "string", "description": "Account type, such as BANK. EQUITY, ASSET, ...", "enum": [ "ACCOUNTS_PAYABLE", "ACCOUNTS_RECEIVABLE", "BANK", "CREDIT_CARD", "FIXED_ASSET", "LIABILITY", "EQUITY", "EXPENSE", "REVENUE", "OTHER" ] }, "status": { "type": "string", "description": "Account status, such as ACTIVE or ARCHIVED", "enum": [ "ACTIVE", "ARCHIVED" ] }, "balance": { "type": "number", "description": "Balance of the account." }, "currency": { "type": "string", "description": "Account’s currency, in ISO 4217 format (e.g. U.S. dollars is USD)" }, "customer_defined_code": { "type": "string", "description": "Identifier for tracking and categorizing accounts for reporting or analysis purposes that is defined by the end-customer" }, "is_payable": { "type": "boolean", "description": "True if the account is an “accounts payable” account" }, "parent_id": { "type": "string", "description": "The parent account ID for this account" }, "taxonomy": { "type": "array", "items": { "$ref": "#/definitions/AccountingAccountTaxonomy" } }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": { "description": "The original data from the integration's API" } }, "description": "Chart of accounts" }, "AccountingJournalLineitem_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingJournalLineitem": { "type": "object", "properties": { "id": { "type": "string" }, "tax_amount": { "type": "number" }, "total_amount": { "type": "number", "description": "will be a positive value for a debit and negative for a credit" }, "debit_amount": { "type": "number", "description": "will replace total_amount (absolute value)" }, "credit_amount": { "type": "number" }, "description": { "type": "string" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "payment_id": { "type": "string", "description": "link to PaymentPayment (reference to PaymentPayment)" }, "invoice_id": { "type": "string", "description": "(reference to AccountingInvoice)" }, "category_ids": { "$ref": "#/definitions/AccountingJournalLineitem_category_ids", "description": "(reference to AccountingCategory)" }, "group_id": { "type": "string", "description": "points to a HRIS Group (reference to HrisGroup)" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "organization_id": { "type": "string", "description": "points to a AccountingOrganization" }, "taxrate_id": { "type": "string", "description": "ref -> AccountingTaxrate applied to the line" } } }, "AccountingJournalLineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingJournalLineitem" }, "description": "new field name" }, "AccountingJournal_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingAttachment": { "type": "object", "properties": { "id": { "type": "string" }, "download_url": { "type": "string" }, "name": { "type": "string" }, "mime_type": { "type": "string" } } }, "AccountingAttachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "AccountingJournal": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "reference": { "type": "string" }, "tax_amount": { "type": "number" }, "currency": { "type": "string" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingJournalLineitem" }, "description": "new field name" }, "taxrate_id": { "type": "string" }, "description": { "type": "string" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "source": { "type": "string" }, "organization_id": { "type": "string" }, "category_ids": { "$ref": "#/definitions/AccountingJournal_category_ids", "description": "(reference to AccountingCategory)" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "total_amount": { "type": "number", "description": "Total of the debit lines; equals the total of the credit lines" }, "exchange_rate": { "type": "number", "description": "Exchange rate to the base/home currency at the posting date" }, "status": { "type": "string", "description": "Posting state of the journal entry", "enum": [ "DRAFT", "POSTED", "VOID", "OTHER" ] }, "is_inclusive_of_tax": { "type": "boolean", "description": "True when the line amounts already include tax" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingTransactionLineItem_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingTransactionLineItem": { "type": "object", "properties": { "id": { "type": "string" }, "unit_quantity": { "type": "number" }, "unit_amount": { "type": "number" }, "total_amount": { "type": "number", "description": "will be a positive value for a debit and negative for a credit" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "object_type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "category_ids": { "$ref": "#/definitions/AccountingTransactionLineItem_category_ids", "description": "(reference to AccountingCategory)" }, "taxrate_id": { "type": "string", "description": "ref -> AccountingTaxrate applied to the line" } } }, "AccountingTransactionLineItems": { "type": "array", "items": { "$ref": "#/definitions/AccountingTransactionLineItem" } }, "AccountingTransactionContact": { "type": "object", "properties": { "id": { "type": "string" }, "is_customer": { "type": "boolean" }, "is_supplier": { "type": "boolean" } }, "required": [ "id" ] }, "AccountingTransactionContacts": { "type": "array", "items": { "$ref": "#/definitions/AccountingTransactionContact" }, "description": "denormalized parties, reusing the transaction contact shape" }, "AccountingTransaction_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingTransaction": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "memo": { "type": "string" }, "total_amount": { "type": "number", "description": "negative for CREDIT, positive for DEBIT" }, "tax_amount": { "type": "number", "description": "negative for CREDIT, positive for DEBIT" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "reference": { "type": "string" }, "sub_total_amount": { "type": "number" }, "split_account_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_terms": { "type": "string" }, "customer_message": { "type": "string" }, "type": { "type": "string", "description": "eg. CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, BANK_DEPOSIT, BANK_TRANSFER, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingTransactionLineItem" } }, "currency": { "type": "string" }, "contacts": { "type": "array", "items": { "$ref": "#/definitions/AccountingTransactionContact" } }, "organization_id": { "type": "string" }, "category_ids": { "$ref": "#/definitions/AccountingTransaction_category_ids", "description": "(reference to AccountingCategory)" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "transaction_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "exchange_rate": { "type": "number", "description": "Exchange rate to the base/home currency at the transaction date" }, "status": { "type": "string", "description": "Posting state of the transaction", "enum": [ "PENDING", "POSTED", "VOID", "OTHER" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingEmail": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER" ] } } }, "AccountingEmails": { "type": "array", "items": { "$ref": "#/definitions/AccountingEmail" } }, "AccountingTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } } }, "AccountingTelephones": { "type": "array", "items": { "$ref": "#/definitions/AccountingTelephone" } }, "AccountingContact_billing_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingContact_shipping_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingContactPaymentMethod": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "ACH", "ALIPAY", "CARD", "GIROPAY", "IDEAL", "OTHER", "PAYPAL", "WIRE", "CHECK" ] }, "name": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "type" ] }, "AccountingContactPaymentMethods": { "type": "array", "items": { "$ref": "#/definitions/AccountingContactPaymentMethod" } }, "AccountingAssociatedContact": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/AccountingEmail" } } } }, "AccountingAssociatedContacts": { "type": "array", "items": { "$ref": "#/definitions/AccountingAssociatedContact" } }, "AccountingContact": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/AccountingEmail" } }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/AccountingTelephone" } }, "currency": { "type": "string" }, "billing_address": { "$ref": "#/definitions/AccountingContact_billing_address" }, "shipping_address": { "$ref": "#/definitions/AccountingContact_shipping_address" }, "is_active": { "type": "boolean" }, "tax_exemption": { "type": "string", "enum": [ "FEDERAL_GOV", "REGION_GOV", "LOCAL_GOV", "TRIBAL_GOV", "CHARITABLE_ORG", "RELIGIOUS_ORG", "EDUCATIONAL_ORG", "MEDICAL_ORG", "RESALE", "FOREIGN", "OTHER" ] }, "tax_number": { "type": "string", "description": "The ID/number of the customer's tax number. This is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global)." }, "is_customer": { "type": "boolean" }, "is_supplier": { "type": "boolean" }, "portal_url": { "type": "string", "description": "URL for the contact’s portal" }, "payment_methods": { "type": "array", "items": { "$ref": "#/definitions/AccountingContactPaymentMethod" } }, "company_name": { "type": "string" }, "identification": { "type": "string", "description": "contact account numbers such as registration, A membership or identification reference to help to identify and search customers" }, "associated_contacts": { "type": "array", "items": { "$ref": "#/definitions/AccountingAssociatedContact" } }, "organization_id": { "type": "string" }, "payment_terms": { "type": "string", "enum": [ "ON_RECEIPT", "NET_7", "NET_10", "NET_15", "NET_20", "NET_25", "NET_30", "NET_45", "NET_60", "NET_90", "OTHER" ] }, "paymentterm_id": { "type": "string" }, "balance_amount": { "type": "number", "description": "Outstanding AR/AP balance for this contact" }, "website": { "type": "string" }, "notes": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingExtendedNote_user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AccountingExtendedNote": { "type": "object", "properties": { "note": { "type": "string" }, "user": { "$ref": "#/definitions/AccountingExtendedNote_user" }, "date": { "type": "string", "format": "date-time" }, "visibility": { "type": "string", "enum": [ "PUBLIC", "PRIVATE" ] } } }, "AccountingExtendedNotes": { "type": "array", "items": { "$ref": "#/definitions/AccountingExtendedNote" } }, "AccountingLineitem_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingReference": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AccountingReferences": { "type": "array", "items": { "$ref": "#/definitions/AccountingReference" } }, "AccountingFee": { "type": "object", "properties": { "type": { "type": "string", "description": "Unified fee category", "enum": [ "TAX", "DISCOUNT", "PROMOTION", "SHIPPING", "GIFT_WRAP", "COD", "SURCHARGE", "TIP", "SERVICE_CHARGE", "OTHER" ] }, "original_type": { "type": "string", "description": "The provider's original fee label, e.g. \"VAT\" or a shipping carrier name" }, "amount": { "type": "number" }, "currency": { "type": "string", "description": "ISO 4217 currency code, e.g. USD" } }, "required": [ "type", "amount" ] }, "AccountingFees": { "type": "array", "items": { "$ref": "#/definitions/AccountingFee" } }, "AccountingLineitem": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "refunded_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number", "description": "unit_quantity * unit_amount + tax_amount" }, "refund_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "tax_amount": { "type": "number" }, "item_id": { "type": "string", "description": "(reference to CommerceItem)" }, "unit_amount": { "type": "number" }, "unit_quantity": { "type": "number" }, "item_sku": { "type": "string" }, "item_name": { "type": "string" }, "item_description": { "type": "string" }, "notes": { "type": "string" }, "taxrate_id": { "type": "string" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "category_ids": { "$ref": "#/definitions/AccountingLineitem_category_ids", "description": "(reference to AccountingCategory)" }, "locations": { "type": "array", "items": { "$ref": "#/definitions/AccountingReference" } }, "item_variants": { "type": "array", "items": { "$ref": "#/definitions/AccountingReference" } }, "fees": { "type": "array", "items": { "$ref": "#/definitions/AccountingFee" } }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "project_id": { "type": "string", "description": "ref -> AccountingProject; the project this line is coded to (reference to TaskProject)" }, "exchange_rate": { "type": "number", "description": "The exchange rate applied to this line, for multi-currency documents" }, "is_billable": { "type": "boolean", "description": "True when the line is rebillable to a customer" } } }, "AccountingLineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "AccountingPaymentReference": { "type": "object", "properties": { "payment_id": { "type": "string", "description": "references a PaymentPayment that was applied to this object (reference to PaymentPayment)" }, "amount": { "type": "number", "description": "amount of the payment applied to this object" }, "allocated_at": { "type": "string", "format": "date-time", "description": "Date and time when the payment was applied, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "AccountingPaymentReferences": { "type": "array", "items": { "$ref": "#/definitions/AccountingPaymentReference" }, "description": "read-only reciprocal of PaymentPayment.allocations; payments applied to this sales order" }, "AccountingInvoice_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingInvoice_salesorder_ids": { "type": "array", "items": { "type": "string" }, "description": "refs -> AccountingSalesorder; the sales orders this invoice was raised from" }, "AccountingInvoice": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "paid_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "refunded_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "cancelled_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "paid_amount": { "type": "number" }, "refund_amount": { "type": "number" }, "tax_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "balance_amount": { "type": "number" }, "invoice_number": { "type": "string", "description": "External identifier (ie. reference) for this invoice" }, "reference": { "type": "string" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "currency": { "type": "string" }, "notes": { "type": "string" }, "extended_notes": { "type": "array", "items": { "$ref": "#/definitions/AccountingExtendedNote" } }, "refund_reason": { "type": "string" }, "term": { "type": "string", "description": "@deprecated use payment_terms instead", "enum": [ "ON_RECEIPT", "NET_7", "NET_10", "NET_15", "NET_20", "NET_25", "NET_30", "NET_45", "NET_60", "NET_90", "OTHER" ] }, "payment_terms": { "type": "string", "enum": [ "ON_RECEIPT", "NET_7", "NET_10", "NET_15", "NET_20", "NET_25", "NET_30", "NET_45", "NET_60", "NET_90", "OTHER" ] }, "paymentterm_id": { "type": "string" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "status": { "type": "string", "enum": [ "DRAFT", "VOIDED", "AUTHORIZED", "PAID", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "REFUNDED", "SUBMITTED", "DELETED", "OVERDUE" ] }, "url": { "type": "string", "description": "The public URL for the invoice to send to a customer to view or pay." }, "payment_collection_method": { "type": "string", "description": "When set to charging_automatically, an automated attempt will occur to pay this invoice using the default payment source attached to the contactcustomer. When set to send_invoice, an will email will be sent with this invoice to the contact/customer with payment instructions.", "enum": [ "send_invoice", "charge_automatically" ] }, "type": { "type": "string", "description": "BILL removed (use AccountingBill); remaining values: INVOICE, CREDITMEMO", "enum": [ "INVOICE", "CREDITMEMO" ] }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "send": { "type": "boolean" }, "organization_id": { "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/AccountingPaymentReference" }, "description": "ead-only reciprocal of PaymentPayment.allocations; payments applied to this invoice" }, "category_ids": { "$ref": "#/definitions/AccountingInvoice_category_ids", "description": "(reference to AccountingCategory)" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "sub_total_amount": { "type": "number", "description": "Total before tax" }, "exchange_rate": { "type": "number", "description": "Exchange rate to the base/home currency at the document date" }, "is_inclusive_of_tax": { "type": "boolean", "description": "True when the document amounts already include tax" }, "salesorder_ids": { "$ref": "#/definitions/AccountingInvoice_salesorder_ids", "description": "refs -> AccountingSalesorder; the sales orders this invoice was raised from" }, "raw": {} } }, "AccountingBill_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingBill_purchaseorder_ids": { "type": "array", "items": { "type": "string" }, "description": "refs -> AccountingPurchaseorder; the purchase orders this bill was raised from" }, "AccountingBill": { "type": "object", "properties": { "id": { "type": "string" }, "bill_number": { "type": "string", "description": "External identifier for this invoice" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "paid_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "refunded_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "cancelled_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "paid_amount": { "type": "number" }, "refund_amount": { "type": "number" }, "tax_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "balance_amount": { "type": "number" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "currency": { "type": "string" }, "notes": { "type": "string" }, "extended_notes": { "type": "array", "items": { "$ref": "#/definitions/AccountingExtendedNote" } }, "refund_reason": { "type": "string" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "status": { "type": "string", "enum": [ "DRAFT", "VOIDED", "AUTHORIZED", "PAID", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "REFUNDED", "SUBMITTED", "DELETED", "OVERDUE" ] }, "url": { "type": "string", "description": "The public URL for the invoice to send to a customer to view or pay." }, "payment_collection_method": { "type": "string", "description": "When set to charging_automatically, an automated attempt will occur to pay this invoice using the default payment source attached to the contactcustomer. When set to send_invoice, an will email will be sent with this invoice to the contact/customer with payment instructions.", "enum": [ "send_invoice", "charge_automatically" ] }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "send": { "type": "boolean" }, "organization_id": { "type": "string" }, "term": { "type": "string", "description": "@deprecated use payment_terms instead", "enum": [ "ON_RECEIPT", "NET_7", "NET_10", "NET_15", "NET_20", "NET_25", "NET_30", "NET_45", "NET_60", "NET_90", "OTHER" ] }, "payment_terms": { "type": "string", "enum": [ "ON_RECEIPT", "NET_7", "NET_10", "NET_15", "NET_20", "NET_25", "NET_30", "NET_45", "NET_60", "NET_90", "OTHER" ] }, "paymentterm_id": { "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/AccountingPaymentReference" }, "description": "read-only reciprocal of PaymentPayment.allocations; payments applied to this invoice" }, "category_ids": { "$ref": "#/definitions/AccountingBill_category_ids", "description": "(reference to AccountingCategory)" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "sub_total_amount": { "type": "number", "description": "Total before tax" }, "exchange_rate": { "type": "number", "description": "Exchange rate to the base/home currency at the document date" }, "purchaseorder_ids": { "$ref": "#/definitions/AccountingBill_purchaseorder_ids", "description": "refs -> AccountingPurchaseorder; the purchase orders this bill was raised from" }, "raw": {} } }, "AccountingCreditApplication": { "type": "object", "properties": { "object_type": { "type": "string", "description": "The type of object this credit was applied to", "enum": [ "INVOICE", "BILL" ] }, "object_id": { "type": "string", "description": "The id of the object this credit was applied to" }, "amount": { "type": "number", "description": "The amount of credit applied to this object" }, "applied_at": { "type": "string", "format": "date-time", "description": "Date and time when the credit was applied, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "AccountingCreditApplications": { "type": "array", "items": { "$ref": "#/definitions/AccountingCreditApplication" }, "description": "What this vendor credit was applied to (invoices/bills). Writable inline on create/update." }, "AccountingCreditmemo": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "paid_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "refunded_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "cancelled_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "paid_amount": { "type": "number" }, "refund_amount": { "type": "number" }, "tax_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "balance_amount": { "type": "number" }, "creditmemo_number": { "type": "string", "description": "External identifier for this invoice" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "invoice_id": { "type": "string", "description": "(reference to AccountingInvoice)" }, "currency": { "type": "string" }, "notes": { "type": "string" }, "refund_reason": { "type": "string" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "status": { "type": "string", "enum": [ "DRAFT", "VOIDED", "AUTHORIZED", "PAID", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "REFUNDED", "SUBMITTED", "DELETED", "OVERDUE" ] }, "url": { "type": "string", "description": "The public URL for the invoice to send to a customer to view or pay." }, "payment_collection_method": { "type": "string", "description": "When set to charging_automatically, an automated attempt will occur to pay this invoice using the default payment source attached to the contactcustomer. When set to send_invoice, an will email will be sent with this invoice to the contact/customer with payment instructions.", "enum": [ "send_invoice", "charge_automatically" ] }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "send": { "type": "boolean" }, "organization_id": { "type": "string" }, "apply_amount": { "type": "number" }, "applications": { "type": "array", "items": { "$ref": "#/definitions/AccountingCreditApplication" }, "description": "What this credit memo was applied to (invoices/bills). Writable inline on create/update." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingVendorcredit": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "balance_amount": { "type": "number" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "currency": { "type": "string" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "bill_id": { "type": "string" }, "notes": { "type": "string" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "status": { "type": "string", "enum": [ "DRAFT", "VOIDED", "AUTHORIZED", "PAID", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "REFUNDED", "SUBMITTED", "DELETED", "OVERDUE" ] }, "organization_id": { "type": "string" }, "apply_amount": { "type": "number" }, "applications": { "type": "array", "items": { "$ref": "#/definitions/AccountingCreditApplication" }, "description": "What this vendor credit was applied to (invoices/bills). Writable inline on create/update." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingTaxrateComponent": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the tax component, e.g. GST or PST" }, "rate": { "type": "number", "description": "Rate of this component, in %" }, "is_compound": { "type": "boolean", "description": "True when this component is charged on top of the other components" } } }, "AccountingTaxrateComponents": { "type": "array", "items": { "$ref": "#/definitions/AccountingTaxrateComponent" }, "description": "Component parts of a compound or multi-component tax" }, "AccountingTaxrate": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "rate": { "type": "number", "description": "%" }, "is_active": { "type": "boolean" }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "effective_rate": { "type": "number", "description": "Net effective rate in %, where it differs from the nominal rate" }, "total_rate": { "type": "number", "description": "Sum of all components, in %" }, "components": { "type": "array", "items": { "$ref": "#/definitions/AccountingTaxrateComponent" }, "description": "Component parts of a compound or multi-component tax" }, "type": { "type": "string", "description": "Whether the rate applies to sales, purchases, or both", "enum": [ "SALES", "PURCHASE", "BOTH", "OTHER" ] }, "is_compound": { "type": "boolean", "description": "True when the rate stacks on top of other taxes" }, "country": { "type": "string", "description": "Jurisdiction country" }, "region": { "type": "string", "description": "Jurisdiction state / province" }, "raw": {} } }, "AccountingPaymentterm": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "term label, e.g. \"Net 30\"" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "ON_RECEIPT", "NET_7", "NET_10", "NET_15", "NET_20", "NET_25", "NET_30", "NET_45", "NET_60", "NET_90", "OTHER" ] }, "category": { "type": "string", "description": "STANDARD (days-based) or DATE_DRIVEN (month-based)", "enum": [ "STANDARD", "DATE_DRIVEN", "OTHER" ] }, "is_active": { "type": "boolean" }, "due_days": { "type": "number", "description": "(standard) days until payment is due" }, "discount_days": { "type": "number", "description": "(standard) days within which an early-pay discount applies" }, "discount_percent": { "type": "number", "description": "(standard) early-pay discount rate" }, "day_of_month_due": { "type": "number", "description": "(date-driven) day of month payment is due (1–31)" }, "discount_day_of_month": { "type": "number", "description": "(date-driven) pay before this day of month for the discount" }, "due_next_month_days": { "type": "number", "description": "(date-driven) if invoiced within N days of month-end, due next month" }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingOrganization_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingOrganization": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "legal_name": { "type": "string" }, "currency": { "type": "string", "description": "Currency primarily used by the organization, in ISO 4217 format (e.g. U.S. dollars is USD)." }, "address": { "$ref": "#/definitions/AccountingOrganization_address" }, "tax_number": { "type": "string", "description": "Organization's tax number. For example, in the U.S., this is an Employer Identification Number (EIN)." }, "timezone": { "type": "string" }, "website": { "type": "string" }, "parent_id": { "type": "string" }, "fiscal_year_end_month": { "type": "number", "description": "Month of the year when the organization’s fiscal year ends (1 - 12, where January is 1)" }, "organization_code": { "type": "string", "description": "Identifier for tracking and categorizing organizations for reporting or analysis purposes that is defined by the end-customer" }, "type": { "type": "string", "description": "Entity type within a consolidation hierarchy", "enum": [ "COMPANY", "SUBSIDIARY", "DIVISION", "LOCATION" ] }, "is_elimination": { "type": "boolean", "description": "True for consolidation/elimination entities" }, "books_close_at": { "type": "string", "format": "date-time", "description": "Company-wide books close / lock date; transactions on or before this date fall in a closed accounting period (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingOrder_shipping_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingOrder_billing_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingOrder": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "contact_id": { "type": "string", "description": "Customer, Supplier (reference to AccountingContact)" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "type": { "type": "string", "enum": [ "SALES", "PURCHASE" ] }, "currency": { "type": "string" }, "total_amount": { "type": "number" }, "shipping_address": { "$ref": "#/definitions/AccountingOrder_shipping_address" }, "billing_address": { "$ref": "#/definitions/AccountingOrder_billing_address" }, "status": { "type": "string", "enum": [ "DRAFT", "VOIDED", "AUTHORIZED", "PAID", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "REFUNDED", "SUBMITTED", "DELETED", "OPEN", "COMPLETED", "CANCELED" ] }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} }, "description": "@deprecated; use AccountingSalesorder or AccountingPurchaseorder" }, "AccountingPurchaseorder_shipping_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingPurchaseorder_billing_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingPurchaseorder_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingPurchaseorder": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "contact_id": { "type": "string", "description": "Customer, Supplier (reference to AccountingContact)" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "currency": { "type": "string" }, "total_amount": { "type": "number" }, "shipping_address": { "$ref": "#/definitions/AccountingPurchaseorder_shipping_address" }, "billing_address": { "$ref": "#/definitions/AccountingPurchaseorder_billing_address" }, "status": { "type": "string", "enum": [ "DRAFT", "VOIDED", "AUTHORIZED", "PAID", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "REFUNDED", "SUBMITTED", "DELETED", "OPEN", "COMPLETED", "CANCELED" ] }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "organization_id": { "type": "string" }, "category_ids": { "$ref": "#/definitions/AccountingPurchaseorder_category_ids", "description": "(reference to AccountingCategory)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "raw": {} } }, "AccountingSalesorder_shipping_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingSalesorder_billing_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingSalesorder_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingSalesorder": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "contact_id": { "type": "string", "description": "Customer, Supplier (reference to AccountingContact)" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "currency": { "type": "string" }, "total_amount": { "type": "number" }, "shipping_address": { "$ref": "#/definitions/AccountingSalesorder_shipping_address" }, "billing_address": { "$ref": "#/definitions/AccountingSalesorder_billing_address" }, "status": { "type": "string", "enum": [ "DRAFT", "VOIDED", "AUTHORIZED", "PAID", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "REFUNDED", "SUBMITTED", "DELETED", "OPEN", "COMPLETED", "CANCELED" ] }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "sales_channel": { "type": "string" }, "organization_id": { "type": "string" }, "fees": { "type": "array", "items": { "$ref": "#/definitions/AccountingFee" } }, "category_ids": { "$ref": "#/definitions/AccountingSalesorder_category_ids", "description": "(reference to AccountingCategory)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "order_number": { "type": "string", "description": "human-facing receipt/ticket/check number, distinct from id" }, "location_id": { "type": "string", "description": "store/site; reference to a commerce_location or hris_location" }, "employee_user_id": { "type": "string", "description": "selling/serving HR employee (server, cashier) (reference to HrisEmployee)" }, "device_id": { "type": "string", "description": "POS register/terminal/device (HRIS Device)" }, "fulfillment_type": { "type": "string", "enum": [ "DINE_IN", "TAKEOUT", "DELIVERY", "PICKUP", "CURBSIDE", "SHIPPING", "DIGITAL", "OTHER" ] }, "guest_count": { "type": "number" }, "subtotal_amount": { "type": "number", "description": "pre-tax, pre-tip amount" }, "tax_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "tip_amount": { "type": "number" }, "service_charge_amount": { "type": "number" }, "refunded_amount": { "type": "number" }, "closed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "subscription_id": { "type": "string", "description": "payment_subscription that generated this order, if recurring" }, "payments": { "type": "array", "items": { "$ref": "#/definitions/AccountingPaymentReference" }, "description": "read-only reciprocal of PaymentPayment.allocations; payments applied to this sales order" }, "raw": {} } }, "AccountingSalesreceipt_billing_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingSalesreceipt_shipping_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string", "description": "Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province." }, "region_code": { "type": "string", "description": "Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province." }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "Country code for the country, in ISO 3166 A-2 format" } } }, "AccountingSalesreceipt_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingSalesreceipt": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {}, "receipt_number": { "type": "string" }, "reference": { "type": "string" }, "contact_id": { "type": "string", "description": "customer (reference to AccountingContact)" }, "account_id": { "type": "string", "description": "deposit-to GL account (reference to AccountingAccount)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "currency": { "type": "string" }, "exchange_rate": { "type": "number" }, "sub_total_amount": { "type": "number" }, "tax_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "total_amount": { "type": "number" }, "is_inclusive_of_tax": { "type": "boolean" }, "payment_method": { "type": "string" }, "notes": { "type": "string" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "billing_address": { "$ref": "#/definitions/AccountingSalesreceipt_billing_address" }, "shipping_address": { "$ref": "#/definitions/AccountingSalesreceipt_shipping_address" }, "category_ids": { "$ref": "#/definitions/AccountingSalesreceipt_category_ids", "description": "(reference to AccountingCategory)" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "status": { "type": "string", "enum": [ "DRAFT", "POSTED", "VOID", "OTHER" ] } } }, "AccountingBalancesheetItem_sub_items_List": { "type": "array", "items": {} }, "AccountingBalancesheetItem": { "type": "object", "properties": { "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "name": { "type": "string" }, "amount": { "type": "number" }, "sub_items": { "$ref": "#/definitions/AccountingBalancesheetItem_sub_items" } } }, "AccountingBalancesheetItems": { "type": "array", "items": { "$ref": "#/definitions/AccountingBalancesheetItem" } }, "AccountingBalancesheet": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "currency": { "type": "string" }, "net_assets_amount": { "type": "number" }, "assets": { "type": "array", "items": { "$ref": "#/definitions/AccountingBalancesheetItem" } }, "liabilities": { "type": "array", "items": { "$ref": "#/definitions/AccountingBalancesheetItem" } }, "equity": { "type": "array", "items": { "$ref": "#/definitions/AccountingBalancesheetItem" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingTrialbalanceSubItem": { "type": "object", "properties": { "amount": { "type": "number" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "account_name": { "type": "string" } } }, "AccountingTrialbalanceSubItems": { "type": "array", "items": { "$ref": "#/definitions/AccountingTrialbalanceSubItem" } }, "AccountingTrialbalance": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "currency": { "type": "string" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_debit_amount": { "type": "number" }, "total_credit_amount": { "type": "number" }, "sub_items": { "type": "array", "items": { "$ref": "#/definitions/AccountingTrialbalanceSubItem" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingProfitloss_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingProfitlossAccount_transaction_ids": { "type": "array", "items": { "type": "string" } }, "AccountingProfitlossAccount": { "type": "object", "properties": { "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "account_name": { "type": "string" }, "total_amount": { "type": "number" }, "transaction_ids": { "$ref": "#/definitions/AccountingProfitlossAccount_transaction_ids" } } }, "AccountingProfitlossAccounts": { "type": "array", "items": { "$ref": "#/definitions/AccountingProfitlossAccount" } }, "AccountingProfitlossSection": { "type": "object", "properties": { "section_type": { "type": "string" }, "section_name": { "type": "string" }, "total_amount": { "type": "number" }, "accounts": { "type": "array", "items": { "$ref": "#/definitions/AccountingProfitlossAccount" } } } }, "AccountingProfitlossSections": { "type": "array", "items": { "$ref": "#/definitions/AccountingProfitlossSection" } }, "AccountingProfitloss": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "category_ids": { "$ref": "#/definitions/AccountingProfitloss_category_ids", "description": "(reference to AccountingCategory)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "currency": { "type": "string" }, "income_total_amount": { "type": "number" }, "net_income_amount": { "type": "number" }, "expenses_total_amount": { "type": "number" }, "cost_of_goods_sold_total_amount": { "type": "number" }, "income_sections": { "type": "array", "items": { "$ref": "#/definitions/AccountingProfitlossSection" } }, "expenses_sections": { "type": "array", "items": { "$ref": "#/definitions/AccountingProfitlossSection" } }, "cost_of_goods_sold_sections": { "type": "array", "items": { "$ref": "#/definitions/AccountingProfitlossSection" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingCashflow_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingCashflowItem_transaction_ids": { "type": "array", "items": { "type": "string" }, "description": "Optional linkage to transactions" }, "AccountingCashflowItem_sub_items_List": { "type": "array", "items": {} }, "AccountingCashflowItem": { "type": "object", "properties": { "account_id": { "type": "string", "description": "If attributable to a specific GL account (reference to AccountingAccount)" }, "name": { "type": "string", "description": "e.g. \"Net Income\", \"Depreciation\", \"Equipment\"" }, "amount": { "type": "number", "description": "Positive = inflow, Negative = outflow" }, "transaction_ids": { "$ref": "#/definitions/AccountingCashflowItem_transaction_ids", "description": "Optional linkage to transactions" }, "sub_items": { "$ref": "#/definitions/AccountingCashflowItem_sub_items" } } }, "AccountingCashflowItems": { "type": "array", "items": { "$ref": "#/definitions/AccountingCashflowItem" } }, "AccountingCashflowSection": { "type": "object", "properties": { "section_name": { "type": "string", "description": "e.g. \"Operating Activities\"" }, "total_amount": { "type": "number", "description": "Net cash providedused by this section" }, "items": { "type": "array", "items": { "$ref": "#/definitions/AccountingCashflowItem" } } } }, "AccountingCashflowSections": { "type": "array", "items": { "$ref": "#/definitions/AccountingCashflowSection" } }, "AccountingCashflow": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "category_ids": { "$ref": "#/definitions/AccountingCashflow_category_ids", "description": "(reference to AccountingCategory)" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "name": { "type": "string", "description": "e.g. \"Cash Flow Statement Q1 2020\"" }, "currency": { "type": "string", "description": "ISO 4217, e.g. \"USD\"" }, "cash_beginning_amount": { "type": "number", "description": "Cash at beginning of period" }, "cash_ending_amount": { "type": "number", "description": "Cash at end of period" }, "net_change_in_cash_amount": { "type": "number", "description": "Usually ending - beginning" }, "operating_sections": { "type": "array", "items": { "$ref": "#/definitions/AccountingCashflowSection" } }, "investing_sections": { "type": "array", "items": { "$ref": "#/definitions/AccountingCashflowSection" } }, "financing_sections": { "type": "array", "items": { "$ref": "#/definitions/AccountingCashflowSection" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": { "description": "Original data from the integration" } }, "description": "Sections" }, "AccountingCategory": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_active": { "type": "boolean" }, "parent_id": { "type": "string" }, "type": { "type": "string", "description": "The kind of dimension", "enum": [ "CLASS", "DEPARTMENT", "LOCATION", "PROJECT", "TASK", "CUSTOM", "EXPENSE", "INCOME" ] }, "code": { "type": "string", "description": "platform-side tracking code" }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingExpense_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingExpense": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "references a HR employee/user (reference to HrisEmployee)" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "name": { "type": "string" }, "payment_method": { "type": "string" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "currency": { "type": "string" }, "tax_amount": { "type": "number" }, "reimbursed_amount": { "type": "number" }, "reimbursed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "approved_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "approver_user_id": { "type": "string", "description": "references HR employee/user (reference to HrisEmployee)" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "organization_id": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/definitions/AccountingReference" } }, "approver_users": { "type": "array", "items": { "$ref": "#/definitions/AccountingReference" }, "description": "expense approver(s); id is HR employee/user when resolved" }, "status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "PENDING", "APPROVED", "REJECTED", "PAID" ] }, "external_number": { "type": "string" }, "category_ids": { "$ref": "#/definitions/AccountingExpense_category_ids", "description": "(reference to AccountingCategory)" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "taxrate_id": { "type": "string", "description": "ref -> AccountingTaxrate applied to the expense" }, "exchange_rate": { "type": "number", "description": "Exchange rate to the base/home currency at the expense date" }, "type": { "type": "string", "description": "USER = employee spend; COMPANY = books/purchase expense", "enum": [ "USER", "COMPANY" ] }, "raw": {} } }, "AccountingExpensereport_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingExpensereport": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "user_id": { "type": "string", "description": "references a HR employee/user (reference to HrisEmployee)" }, "approver_user_id": { "type": "string", "description": "references HR employee/user (reference to HrisEmployee)" }, "approver_users": { "type": "array", "items": { "$ref": "#/definitions/AccountingReference" }, "description": "expense approver(s); id is HR employee/user when resolved" }, "status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "PENDING", "APPROVED", "REJECTED", "PAID" ] }, "total_amount": { "type": "number" }, "currency": { "type": "string" }, "tax_amount": { "type": "number" }, "reimbursed_amount": { "type": "number" }, "reimbursed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "approved_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "external_number": { "type": "string" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } }, "category_ids": { "$ref": "#/definitions/AccountingExpensereport_category_ids", "description": "(reference to AccountingCategory)" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "users": { "type": "array", "items": { "$ref": "#/definitions/AccountingReference" } }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingPurchasereceiptLineitem": { "type": "object", "properties": { "id": { "type": "string" }, "item_id": { "type": "string", "description": "(reference to CommerceItem)" }, "item_sku": { "type": "string" }, "item_name": { "type": "string" }, "item_description": { "type": "string" }, "unit_quantity_received": { "type": "number" }, "unit_quantity_ordered": { "type": "number" }, "unit_amount": { "type": "number" }, "total_amount": { "type": "number" }, "purchaseorder_id": { "type": "string" }, "purchaseorder_line_identifier": { "type": "string", "description": "vendor PO line number for three-way match" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "locations": { "type": "array", "items": { "$ref": "#/definitions/AccountingReference" }, "description": "plant/warehouse/bin — same shape as IAccountingLineitem.locations" } } }, "AccountingPurchasereceiptLineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingPurchasereceiptLineitem" } }, "AccountingPurchasereceipt": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {}, "receipt_number": { "type": "string" }, "contact_id": { "type": "string", "description": "supplier (reference to AccountingContact)" }, "purchaseorder_id": { "type": "string", "description": "header when single-PO" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "status": { "type": "string", "enum": [ "POSTED", "CANCELLED", "OTHER" ] }, "currency": { "type": "string" }, "total_amount": { "type": "number" }, "notes": { "type": "string", "description": "supplier delivery note / packing slip / memo — NOT a separate reference field" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingPurchasereceiptLineitem" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/AccountingAttachment" } } } }, "AccountingQuote_category_ids": { "type": "array", "items": { "type": "string" }, "description": "tracking categories / classes (AccountingCategory dimensions)" }, "AccountingQuote": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "quote_number": { "type": "string", "description": "External identifier for this quote (Xero QuoteNumber, QBO DocNumber, NetSuite tranId)" }, "reference": { "type": "string", "description": "customer-side reference / PO number" }, "title": { "type": "string", "description": "short title (Xero Title, max 100)" }, "summary": { "type": "string", "description": "longer summary (Xero Summary, max 3000)" }, "payment_terms": { "type": "string", "description": "unified payment terms enum, as on accounting_invoice / accounting_bill", "enum": [ "ON_RECEIPT", "NET_7", "NET_10", "NET_15", "NET_20", "NET_25", "NET_30", "NET_45", "NET_60", "NET_90", "OTHER" ] }, "customer_message": { "type": "string", "description": "customer-visible message" }, "memo": { "type": "string", "description": "internal note, not customer-visible" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "contacts": { "type": "array", "items": { "$ref": "#/definitions/AccountingTransactionContact" }, "description": "denormalized parties, reusing the transaction contact shape" }, "issued_at": { "type": "string", "format": "date-time", "description": "Xero Date, QBO TxnDate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "expires_at": { "type": "string", "format": "date-time", "description": "Xero ExpiryDate, QBO ExpirationDate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "sent_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "accepted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "declined_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "status": { "type": "string", "description": "where EXPIRED is derived (expires_at < now), the source status is preserved in raw", "enum": [ "DRAFT", "SENT", "ACCEPTED", "DECLINED", "INVOICED", "EXPIRED", "VOIDED", "DELETED" ] }, "currency": { "type": "string" }, "currency_rate": { "type": "number", "description": "exchange rate to the organization's base currency" }, "sub_total_amount": { "type": "number" }, "tax_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "total_amount": { "type": "number" }, "tax_mode": { "type": "string", "description": "INCLUSIVE / EXCLUSIVE / NONE; maps Xero LineAmountTypes (a boolean cannot represent NoTax)", "enum": [ "INCLUSIVE", "EXCLUSIVE", "NONE" ] }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/AccountingLineitem" } }, "invoice_id": { "type": "string", "description": "populated once the quote is converted to an invoice; left null when the source cannot supply it (reference to AccountingInvoice)" }, "project_id": { "type": "string", "description": "points to an AccountingProject (accounting costing project) (reference to TaskProject)" }, "group_id": { "type": "string", "description": "points to a HRIS Group (reference to HrisGroup)" }, "category_ids": { "$ref": "#/definitions/AccountingQuote_category_ids", "description": "tracking categories / classes (AccountingCategory dimensions) (reference to AccountingCategory)" }, "url": { "type": "string", "description": "public online-quote link where exposed" }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingAgedRow_contact": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AccountingAgedRow_transaction": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AccountingAgedRow": { "type": "object", "properties": { "contact": { "$ref": "#/definitions/AccountingAgedRow_contact" }, "transaction": { "$ref": "#/definitions/AccountingAgedRow_transaction" }, "posted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "balance_amount": { "type": "number" } } }, "AccountingAgedRows": { "type": "array", "items": { "$ref": "#/definitions/AccountingAgedRow" } }, "AccountingAgedPeriod": { "type": "object", "properties": { "name": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "sub_items": { "type": "array", "items": { "$ref": "#/definitions/AccountingAgedRow" } } } }, "AccountingAgedPeriods": { "type": "array", "items": { "$ref": "#/definitions/AccountingAgedPeriod" } }, "AccountingAgedreceivable": { "type": "object", "properties": { "id": { "type": "string", "description": "synthetic, one row per currency / date window" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "currency": { "type": "string", "description": "ISO 4217" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_current_amount": { "type": "number", "description": "open balances not yet past due; distinct from the first past-due period" }, "total_overdue_amount": { "type": "number", "description": "sum of open balances across all past-due periods" }, "total_amount": { "type": "number" }, "periods": { "type": "array", "items": { "$ref": "#/definitions/AccountingAgedPeriod" } }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingAgedpayable": { "type": "object", "properties": { "id": { "type": "string", "description": "synthetic, one row per currency / date window" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "currency": { "type": "string", "description": "ISO 4217" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_current_amount": { "type": "number", "description": "open balances not yet past due; distinct from the first past-due period" }, "total_overdue_amount": { "type": "number", "description": "sum of open balances across all past-due periods" }, "total_amount": { "type": "number" }, "periods": { "type": "array", "items": { "$ref": "#/definitions/AccountingAgedPeriod" } }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingProject_category_ids": { "type": "array", "items": { "type": "string" } }, "AccountingProject": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "code": { "type": "string", "description": "provider-side project code/number (e.g. NetSuite entityId, Intacct PROJECTID, BC jobNumber)" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "ON_HOLD", "COMPLETED", "CANCELLED", "CLOSED" ] }, "is_active": { "type": "boolean" }, "is_billable": { "type": "boolean" }, "contact_id": { "type": "string", "description": "the customer the project is for (reference to AccountingContact)" }, "parent_id": { "type": "string", "description": "parent project / sub-project hierarchy" }, "manager_user_id": { "type": "string", "description": "references a HRIS employee/user (reference to HrisEmployee)" }, "started_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "due_at": { "type": "string", "format": "date-time", "description": "planned/target end date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "ended_at": { "type": "string", "format": "date-time", "description": "actual completion (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "currency": { "type": "string" }, "estimate_amount": { "type": "number" }, "estimated_cost_amount": { "type": "number" }, "actual_cost_amount": { "type": "number" }, "invoiced_amount": { "type": "number" }, "to_be_invoiced_amount": { "type": "number" }, "expense_amount": { "type": "number" }, "deposit_amount": { "type": "number" }, "deposit_applied_amount": { "type": "number" }, "credit_note_amount": { "type": "number" }, "minutes_logged": { "type": "number", "description": "integer minutes, not hours" }, "minutes_to_be_invoiced": { "type": "number", "description": "integer minutes, not hours" }, "percent_complete": { "type": "number", "description": "0-100" }, "billing_type": { "type": "string", "enum": [ "FIXED_PRICE", "TIME_AND_MATERIALS", "MILESTONE", "NON_BILLABLE" ] }, "category_ids": { "$ref": "#/definitions/AccountingProject_category_ids", "description": "(reference to AccountingCategory)" }, "location_id": { "type": "string" }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": {} } }, "AccountingBankfeedaccount": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "creation timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "last-update timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "organization_id": { "type": "string", "description": "ref -> accounting Organization this record belongs to" }, "name": { "type": "string", "description": "account nickname / source name" }, "bank_name": { "type": "string", "description": "bank / institution name" }, "account_number": { "type": "string", "description": "full account number where available" }, "account_number_last4": { "type": "string", "description": "last-4 when the full number isn't returned" }, "routing_number": { "type": "string", "description": "bank routing number" }, "account_type": { "type": "string", "description": "CHECKING, SAVINGS, CREDIT_CARD, LOAN, OTHER", "enum": [ "CHECKING", "SAVINGS", "CREDIT_CARD", "LOAN", "OTHER" ] }, "account_id": { "type": "string", "description": "ref -> AccountingAccount: the target GL account the feed posts into (reference to AccountingAccount)" }, "currency": { "type": "string", "description": "ISO 4217 currency of the account" }, "balance": { "type": "number", "description": "current balance of the source account" }, "feed_start_at": { "type": "string", "format": "date-time", "description": "date the feed begins delivering transactions (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "status": { "type": "string", "description": "feed state: ACTIVE, INACTIVE", "enum": [ "ACTIVE", "INACTIVE" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": { "description": "The original data from the integration's API" } } }, "AccountingBankfeedtransaction_category_ids": { "type": "array", "items": { "type": "string" }, "description": "dimension refs -> AccountingCategory (class/department/location)" }, "AccountingBankfeedtransaction": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "creation timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "last-update timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "organization_id": { "type": "string", "description": "ref -> accounting Organization this record belongs to" }, "bankfeedaccount_id": { "type": "string", "description": "ref -> BankfeedAccount this transaction belongs to" }, "transaction_at": { "type": "string", "format": "date-time", "description": "when the transaction occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "posted_at": { "type": "string", "format": "date-time", "description": "when it posted / cleared (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "amount": { "type": "number", "description": "transaction amount (positive; direction from type)" }, "type": { "type": "string", "description": "direction: DEBIT, CREDIT", "enum": [ "DEBIT", "CREDIT" ] }, "bank_category": { "type": "string", "description": "the bank's own category label" }, "description": { "type": "string", "description": "bank memo / statement text" }, "merchant_name": { "type": "string", "description": "counterparty as reported by the bank" }, "is_pending": { "type": "boolean", "description": "true if not yet cleared" }, "reference": { "type": "string", "description": "bank reference or check number" }, "currency": { "type": "string", "description": "ISO 4217" }, "contact_id": { "type": "string", "description": "matched vendor/customer once reconciled (reference to AccountingContact)" }, "account_id": { "type": "string", "description": "GL account once categorized (reference to AccountingAccount)" }, "category_ids": { "$ref": "#/definitions/AccountingBankfeedtransaction_category_ids", "description": "dimension refs -> AccountingCategory (class/department/location) (reference to AccountingCategory)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AccountingMetadata" } }, "raw": { "description": "The original data from the integration's API" } } }, "StoragePermission_roles": { "type": "array", "items": { "type": "string", "enum": [ "OWNER", "READ", "WRITE" ] } }, "StoragePermission": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "group_id": { "type": "string", "description": "(reference to HrisGroup)" }, "roles": { "$ref": "#/definitions/StoragePermission_roles" }, "is_hidden": { "type": "boolean" }, "is_public": { "type": "boolean" } }, "required": [ "roles" ] }, "StoragePermissions": { "type": "array", "items": { "$ref": "#/definitions/StoragePermission" } }, "StorageReference": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" } } }, "StorageReferences": { "type": "array", "items": { "$ref": "#/definitions/StorageReference" } }, "StorageFile_tags": { "type": "array", "items": { "type": "string" }, "description": "labels" }, "StorageMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "StorageMetadatas": { "type": "array", "items": { "$ref": "#/definitions/StorageMetadata" } }, "StorageFile": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "parent_id": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "size": { "type": "number" }, "type": { "type": "string", "enum": [ "FILE", "FOLDER" ] }, "mime_type": { "type": "string" }, "permissions": { "type": "array", "items": { "$ref": "#/definitions/StoragePermission" } }, "download_url": { "type": "string", "description": "This link expires after 1 hour. When you need to retrieve the contents of a file, call the \"Retrieve a file\" endpoint again to get a new download_url." }, "hash": { "type": "string" }, "data": { "type": "string", "description": "base64 encoded file contents used to create/update only" }, "version": { "type": "string" }, "web_url": { "type": "string" }, "references": { "type": "array", "items": { "$ref": "#/definitions/StorageReference" } }, "tags": { "$ref": "#/definitions/StorageFile_tags", "description": "labels" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/StorageMetadata" } }, "raw": {} } }, "CommerceItemPrice": { "type": "object", "properties": { "price": { "type": "number" }, "compare_at_price": { "type": "number", "description": "The original price of the item before an adjustment or a sale." }, "currency": { "type": "string" } }, "required": [ "price" ] }, "CommerceItemPrices": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemPrice" } }, "CommerceItem_tags": { "type": "array", "items": { "type": "string" } }, "CommerceMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {}, "slug": { "type": "string" }, "description": { "type": "string" }, "is_required": { "type": "boolean" } } }, "CommerceMetadatas": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "CommerceItemMedia": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "alt": { "type": "string" }, "type": { "type": "string", "enum": [ "image", "video" ] }, "height": { "type": "number" }, "width": { "type": "number" }, "position": { "type": "number", "description": "1 is the first" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } } }, "required": [ "url" ] }, "CommerceItemMedias": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemMedia" } }, "CommerceReference": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "CommerceReferences": { "type": "array", "items": { "$ref": "#/definitions/CommerceReference" }, "description": "references CommerceItem" }, "CommerceItem": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "public_name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "global_code": { "type": "string" }, "public_description": { "type": "string" }, "is_active": { "type": "boolean" }, "is_taxable": { "type": "boolean" }, "vendor_name": { "type": "string" }, "type": { "type": "string", "description": "product, service, digital-download, ..." }, "is_visible": { "type": "boolean" }, "is_featured": { "type": "boolean" }, "weight": { "type": "number" }, "weight_unit": { "type": "string", "enum": [ "g", "kg", "oz", "lb" ] }, "requires_shipping": { "type": "boolean" }, "prices": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemPrice" } }, "inventory_id": { "type": "string" }, "total_stock": { "type": "number" }, "tags": { "$ref": "#/definitions/CommerceItem_tags" }, "media": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemMedia" } }, "account_id": { "type": "string", "description": "Reference to Accounting Account (reference to AccountingAccount)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "collections": { "type": "array", "items": { "$ref": "#/definitions/CommerceReference" }, "description": "points to Collection with id, name, and type fields" }, "taxrate_id": { "type": "string", "description": "references AccountingTaxrate" }, "location_id": { "type": "string", "description": "(reference to CommerceLocation)" }, "duration": { "type": "number", "description": "minutes" }, "raw": {} } }, "CommerceCollection_tags": { "type": "array", "items": { "type": "string" } }, "CommerceCollection": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "public_name": { "type": "string" }, "description": { "type": "string" }, "public_description": { "type": "string" }, "media": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemMedia" } }, "is_visible": { "type": "boolean" }, "is_active": { "type": "boolean" }, "is_featured": { "type": "boolean" }, "tags": { "$ref": "#/definitions/CommerceCollection_tags" }, "type": { "type": "string", "enum": [ "COLLECTION", "SAVED_SEARCH", "CATEGORY" ] }, "parent_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "item_metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "raw": {} }, "required": [ "name" ], "description": "A collection of items/products/services" }, "CommerceInventory": { "type": "object", "properties": { "id": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "item_id": { "type": "string", "description": "(reference to CommerceItem)" }, "item_variant_id": { "type": "string", "description": "(reference to CommerceCommerceItemvariant)" }, "item_option_id": { "type": "string" }, "location_id": { "type": "string", "description": "(reference to CommerceLocation)" }, "available": { "type": "number" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "raw": {} } }, "CommerceLocation_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "CommerceTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "FAX", "MOBILE", "OTHER" ] } }, "required": [ "telephone" ] }, "CommerceTelephones": { "type": "array", "items": { "$ref": "#/definitions/CommerceTelephone" } }, "CommerceLocation_categories": { "type": "array", "items": { "type": "string" } }, "CommerceLocation": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "address": { "$ref": "#/definitions/CommerceLocation_address" }, "description": { "type": "string" }, "is_active": { "type": "boolean" }, "language_locale": { "type": "string" }, "parent_id": { "type": "string" }, "currency": { "type": "string" }, "location_type": { "type": "string", "enum": [ "RESTAURANT", "SALON", "WAREHOUSE", "STORE", "OTHER" ] }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/CommerceTelephone" } }, "rating": { "type": "number" }, "review_count": { "type": "number" }, "price_level": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "image_url": { "type": "string" }, "web_url": { "type": "string" }, "media": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemMedia" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "raw": {}, "categories": { "$ref": "#/definitions/CommerceLocation_categories" } } }, "CommerceReviewComment": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "content": { "type": "string" }, "author_name": { "type": "string" }, "author_email": { "type": "string" }, "author_avatar_url": { "type": "string" }, "author_location": { "type": "string" }, "helpful_votes": { "type": "number" }, "unhelpful_votes": { "type": "number" }, "status": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED", "SPAM" ] }, "is_verified": { "type": "boolean" }, "is_public": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "raw": { "description": "Original review data from source platform" } } }, "CommerceReviewComments": { "type": "array", "items": { "$ref": "#/definitions/CommerceReviewComment" } }, "CommerceReview": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "item_id": { "type": "string", "description": "Reference to the product being reviewed (reference to CommerceItem)" }, "item_variant_id": { "type": "string", "description": "Optional reference to specific variant if applicable (reference to CommerceCommerceItemvariant)" }, "location_id": { "type": "string", "description": "(reference to CommerceLocation)" }, "rating": { "type": "number", "description": "1-5 rating" }, "title": { "type": "string" }, "content": { "type": "string" }, "author_name": { "type": "string" }, "author_email": { "type": "string" }, "author_avatar_url": { "type": "string" }, "author_location": { "type": "string" }, "verified_purchase": { "type": "boolean" }, "helpful_votes": { "type": "number" }, "unhelpful_votes": { "type": "number" }, "media": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemMedia" }, "description": "Photosvideos attached to the review" }, "status": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED", "SPAM" ] }, "is_verified": { "type": "boolean" }, "is_featured": { "type": "boolean" }, "is_public": { "type": "boolean" }, "comments": { "type": "array", "items": { "$ref": "#/definitions/CommerceReviewComment" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "url": { "type": "string" }, "raw": { "description": "Original review data from source platform" } } }, "CommerceReservation": { "type": "object", "properties": { "id": { "type": "string" }, "location_id": { "type": "string", "description": "(reference to CommerceLocation)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "size": { "type": "number" }, "status": { "type": "string", "enum": [ "PENDING", "CONFIRMED", "CANCELLED", "NO_SHOW", "COMPLETED" ] }, "guest_name": { "type": "string" }, "guest_phone": { "type": "string" }, "guest_email": { "type": "string" }, "notes": { "type": "string" }, "item_id": { "type": "string", "description": "(reference to CommerceItem)" }, "item_name": { "type": "string" }, "staff_user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "staff_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "url": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "raw": {} } }, "CommerceAvailability": { "type": "object", "properties": { "location_id": { "type": "string", "description": "(reference to CommerceLocation)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "size": { "type": "number" }, "item_id": { "type": "string", "description": "(reference to CommerceItem)" }, "staff_user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "raw": {} } }, "CommerceSaleschannel": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "slug": { "type": "string", "description": "maps to code (name) a stable identifier per channel" }, "description": { "type": "string" }, "is_active": { "type": "boolean" }, "collections": { "type": "array", "items": { "$ref": "#/definitions/CommerceReference" }, "description": "points to a CommerceCollection" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "raw": {} } }, "CommerceItemvariant_tags": { "type": "array", "items": { "type": "string" } }, "CommerceItemOption_values": { "type": "array", "items": { "type": "string" } }, "CommerceItemOption": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "number" }, "values": { "$ref": "#/definitions/CommerceItemOption_values" } }, "required": [ "name", "values" ] }, "CommerceItemOptions": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemOption" } }, "CommerceItemvariant": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "public_name": { "type": "string" }, "description": { "type": "string" }, "public_description": { "type": "string" }, "sku": { "type": "string", "description": "barcode, UPC, isbn, etc" }, "is_active": { "type": "boolean" }, "is_visible": { "type": "boolean" }, "is_featured": { "type": "boolean" }, "media": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemMedia" } }, "available_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "tags": { "$ref": "#/definitions/CommerceItemvariant_tags" }, "width": { "type": "number" }, "height": { "type": "number" }, "length": { "type": "number" }, "weight": { "type": "number" }, "size_unit": { "type": "string", "enum": [ "cm", "inch" ] }, "weight_unit": { "type": "string", "enum": [ "g", "kg", "oz", "lb" ] }, "total_stock": { "type": "number" }, "prices": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemPrice" } }, "options": { "type": "array", "items": { "$ref": "#/definitions/CommerceItemOption" } }, "inventory_id": { "type": "string" }, "requires_shipping": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CommerceMetadata" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/CommerceReference" }, "description": "references CommerceItem" }, "raw": {} } }, "PaymentAllocation": { "type": "object", "properties": { "object_type": { "type": "string", "description": "The type of object this payment was applied to", "enum": [ "INVOICE", "BILL", "CREDITMEMO", "VENDORCREDIT", "SALESORDER", "PURCHASEORDER" ] }, "object_id": { "type": "string", "description": "The id of the object this payment was applied to" }, "amount": { "type": "number", "description": "The amount of the payment applied to this object" }, "currency": { "type": "string", "description": "ISO 4217 currency code of the applied amount" }, "exchange_rate": { "type": "number", "description": "The exchange rate at the time the payment was applied, for multi-currency" }, "allocated_at": { "type": "string", "format": "date-time", "description": "Date and time when the payment was applied, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "PaymentAllocations": { "type": "array", "items": { "$ref": "#/definitions/PaymentAllocation" }, "description": "What this payment was applied to (invoices, bills, credit memos, etc.). Replaces separate invoice/bill payment endpoints." }, "PaymentPayment_category_ids": { "type": "array", "items": { "type": "string" }, "description": "dimension refs -> AccountingCategory" }, "PaymentMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "PaymentMetadatas": { "type": "array", "items": { "$ref": "#/definitions/PaymentMetadata" } }, "PaymentPayment": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "contact_id": { "type": "string", "description": "(reference to AccountingContact)" }, "payment_method": { "type": "string" }, "type": { "type": "string", "enum": [ "INVOICE", "BILL" ] }, "currency": { "type": "string" }, "notes": { "type": "string" }, "invoice_id": { "type": "string", "description": "(reference to AccountingInvoice)" }, "bill_id": { "type": "string", "description": "references AccountingBill" }, "link_id": { "type": "string" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" }, "reference": { "type": "string" }, "organization_id": { "type": "string", "description": "reference to an AccountingOrganization" }, "allocations": { "type": "array", "items": { "$ref": "#/definitions/PaymentAllocation" }, "description": "What this payment was applied to (invoices, bills, credit memos, etc.). Replaces separate invoice/bill payment endpoints." }, "status": { "type": "string", "enum": [ "SUCCEEDED", "PENDING", "AUTHORIZED", "FAILED", "CANCELED" ] }, "salesorder_id": { "type": "string", "description": "reference to an AccountingSalesorder, e.g. the POS order this payment settled" }, "tender_type": { "type": "string", "description": "normalized tender category; the provider's original label stays in payment_method", "enum": [ "CARD", "CASH", "GIFT_CARD", "BANK_TRANSFER", "WALLET", "CHECK", "STORE_CREDIT", "BUY_NOW_PAY_LATER", "EXTERNAL", "OTHER" ] }, "tip_amount": { "type": "number" }, "fee_amount": { "type": "number", "description": "processing/processor fee" }, "location_id": { "type": "string", "description": "store/site where the payment was taken (commerce_location)" }, "device_id": { "type": "string", "description": "POS terminal/register/device (hr device)" }, "card_brand": { "type": "string" }, "card_last4": { "type": "string" }, "paid_at": { "type": "string", "format": "date-time", "description": "Date and time the payment was made (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "exchange_rate": { "type": "number", "description": "Exchange rate to the base/home currency at the payment date" }, "category_ids": { "$ref": "#/definitions/PaymentPayment_category_ids", "description": "dimension refs -> AccountingCategory (reference to AccountingCategory)" }, "net_amount": { "type": "number", "description": "total_amount minus fee_amount" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PaymentMetadata" } }, "raw": {} } }, "PaymentLineitem": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "refunded_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "refund_amount": { "type": "number", "description": "new field" }, "discount_amount": { "type": "number" }, "tax_amount": { "type": "number" }, "item_id": { "type": "string", "description": "(reference to CommerceItem)" }, "unit_amount": { "type": "number" }, "unit_quantity": { "type": "number" }, "item_sku": { "type": "string" }, "item_name": { "type": "string" }, "item_description": { "type": "string" }, "notes": { "type": "string" }, "taxrate_id": { "type": "string" }, "account_id": { "type": "string", "description": "(reference to AccountingAccount)" } } }, "PaymentLineitems": { "type": "array", "items": { "$ref": "#/definitions/PaymentLineitem" } }, "PaymentLink": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "is_active": { "type": "boolean" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/PaymentLineitem" } }, "currency": { "type": "string" }, "amount": { "type": "number" }, "payment_id": { "type": "string", "description": "(reference to PaymentPayment)" }, "contact_id": { "type": "string", "description": "ID of the AccountingContact (reference to AccountingContact)" }, "url": { "type": "string", "description": "the payment link" }, "description": { "type": "string" }, "is_chargeable_now": { "type": "boolean" }, "success_url": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PaymentMetadata" } }, "raw": {} } }, "PaymentRefund": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "payment_id": { "type": "string", "description": "(reference to PaymentPayment)" }, "currency": { "type": "string" }, "notes": { "type": "string" }, "status": { "type": "string", "enum": [ "SUCCEEDED", "PENDING", "FAILED", "CANCELED" ] }, "reference": { "type": "string" }, "refunded_at": { "type": "string", "format": "date-time", "description": "Date and time the refund occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "reason": { "type": "string", "description": "Why the refund was issued", "enum": [ "DUPLICATE", "FRAUDULENT", "REQUESTED_BY_CUSTOMER", "OTHER" ] }, "tender_type": { "type": "string", "description": "Normalized tender category the refund was returned to; mirrors PaymentPayment.tender_type", "enum": [ "CARD", "CASH", "GIFT_CARD", "BANK_TRANSFER", "WALLET", "CHECK", "STORE_CREDIT", "BUY_NOW_PAY_LATER", "EXTERNAL", "OTHER" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PaymentMetadata" } }, "raw": {} } }, "PaymentPayoutLineitem": { "type": "object", "properties": { "object_type": { "type": "string", "description": "What this payout line settles", "enum": [ "PAYMENT", "REFUND", "FEE", "ADJUSTMENT", "TRANSFER", "OTHER" ] }, "object_id": { "type": "string", "description": "id of the settled object -- a PaymentPayment or PaymentRefund for PAYMENT / REFUND lines" }, "amount": { "type": "number", "description": "Gross amount of this line" }, "currency": { "type": "string", "description": "ISO 4217 currency code of the line amount" }, "fee_amount": { "type": "number", "description": "Processor fee attributed to this line" }, "net_amount": { "type": "number", "description": "amount minus fee_amount" } } }, "PaymentPayoutLineitems": { "type": "array", "items": { "$ref": "#/definitions/PaymentPayoutLineitem" }, "description": "The transactions included in this payout" }, "PaymentPayout": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_amount": { "type": "number" }, "currency": { "type": "string" }, "notes": { "type": "string" }, "status": { "type": "string", "enum": [ "SUCCEEDED", "PENDING", "FAILED", "CANCELED" ] }, "arrival_at": { "type": "string", "format": "date-time", "description": "Date the funds land in the destination account (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "fee_amount": { "type": "number", "description": "Processor fee deducted from the payout" }, "net_amount": { "type": "number", "description": "total_amount minus fee_amount" }, "account_id": { "type": "string", "description": "ref -> AccountingAccount; the destination account (reference to AccountingAccount)" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/PaymentPayoutLineitem" }, "description": "The transactions included in this payout" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PaymentMetadata" } }, "raw": {} } }, "PaymentSubscription": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "description": { "type": "string" }, "contact_id": { "type": "string", "description": "a reference to an Accounting Contact (reference to AccountingContact)" }, "invoice_id": { "type": "string", "description": "a reference to an Accounting Invoice (reference to AccountingInvoice)" }, "current_period_end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "current_period_start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "canceled_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "currency": { "type": "string" }, "total_amount": { "type": "number" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "CANCELED", "PAUSED" ] }, "month": { "type": "number", "description": "the month on which to charge a customer (1-12). Only applies when the interval_unit is YEAR." }, "interval_unit": { "type": "string", "enum": [ "YEAR", "MONTH", "WEEK", "DAY" ] }, "day_of_month": { "type": "number", "description": "The day of the month to charge customers on. 1-28 or -1 to indicate the last day of the month. Only applies when the interval_unit is MONTH." }, "day_of_week": { "type": "number", "description": "The day of the week to charge customers on. 1-7 or -1 to indicate the last day of the week. Only applies when the interval_unit is WEEK." }, "interval": { "type": "number", "description": "The number of intervals between charges within the interval_unit. Defaults to 1." }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/PaymentLineitem" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PaymentMetadata" } }, "raw": {} } }, "GenaiModel": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "max_tokens": { "type": "number", "description": "The maximum number of tokens that the model can process in a single response. This limits ensures computational efficiency and resource management." }, "web_url": { "type": "string" }, "has_temperature": { "type": "boolean", "description": "Controls randomness of responses. A lower temperature leads to more predictable outputs while a higher temperature results in more varies and sometimes more creative outputs. 0-1" }, "has_questions": { "type": "boolean", "description": "Whether the model is a decision model (such as TypeSafe Jev or Cloudflare Clef) that answers the typed questions of a prompt with answers instead of generating text responses." }, "has_vision": { "type": "boolean", "description": "Whether the model accepts images as input (see the images on each prompt message)." }, "raw": {} } }, "GenaiContent_images": { "type": "array", "items": { "type": "string" }, "description": "Images for the model to evaluate with this message, as base64 data URLs (data:image/png;base64,...). Only for models with has_vision." }, "GenaiContent": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "SYSTEM", "USER", "ASSISTANT" ] }, "content": { "type": "string" }, "images": { "$ref": "#/definitions/GenaiContent_images", "description": "Images for the model to evaluate with this message, as base64 data URLs (data:image/png;base64,...). Only for models with has_vision." } }, "required": [ "content" ] }, "GenaiContents": { "type": "array", "items": { "$ref": "#/definitions/GenaiContent" }, "description": "The conversation between the user and the coding agent." }, "GenaiPrompt_responses": { "type": "array", "items": { "type": "string" } }, "GenaiPrompt_mcp_deferred_tools": { "type": "array", "items": { "type": "string" } }, "GenaiQuestion_options": { "type": "array", "items": { "type": "string" }, "description": "CHOICE: the options to select from; SCORE: the ordered levels (lowest first)." }, "GenaiQuestion": { "type": "object", "properties": { "id": { "type": "string", "description": "A caller-chosen key; the matching answer is returned with the same id." }, "type": { "type": "string", "enum": [ "BOOLEAN", "CHOICE", "SCORE" ] }, "instructions": { "type": "string", "description": "The question to evaluate." }, "options": { "$ref": "#/definitions/GenaiQuestion_options", "description": "CHOICE: the options to select from; SCORE: the ordered levels (lowest first)." } }, "required": [ "id", "type", "instructions" ] }, "GenaiQuestions": { "type": "array", "items": { "$ref": "#/definitions/GenaiQuestion" }, "description": "Typed questions to evaluate against the messages (for decision models such as TypeSafe Jev)." }, "GenaiAnswerProbability": { "type": "object", "properties": { "option": { "type": "string", "description": "CHOICE: the option; SCORE: the level description." }, "probability": { "type": "number", "description": "0-1" } }, "required": [ "option", "probability" ] }, "GenaiAnswerProbabilities": { "type": "array", "items": { "$ref": "#/definitions/GenaiAnswerProbability" }, "description": "CHOICE/SCORE: the probability of every option or level." }, "GenaiAnswer": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the genai_prompt question that this answers." }, "type": { "type": "string", "enum": [ "BOOLEAN", "CHOICE", "SCORE" ] }, "value": { "type": "string", "description": "CHOICE: the selected option." }, "score": { "type": "number", "description": "SCORE: the probability-weighted level index; BOOLEAN: the probability (0-1) that the answer is yes." }, "probabilities": { "type": "array", "items": { "$ref": "#/definitions/GenaiAnswerProbability" }, "description": "CHOICE/SCORE: the probability of every option or level." }, "confidence": { "type": "number", "description": "0-1: how certain the model is of the answer." } }, "required": [ "id", "type" ] }, "GenaiAnswers": { "type": "array", "items": { "$ref": "#/definitions/GenaiAnswer" }, "description": "One answer per question, matched by id." }, "GenaiPrompt_skill_ids": { "type": "array", "items": { "type": "string" }, "description": "ids of the genai_skill objects (Agent Skills) to make available to the LLM while it answers." }, "GenaiPrompt": { "type": "object", "properties": { "model_id": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/GenaiContent" } }, "temperature": { "type": "number", "description": "0-1" }, "max_tokens": { "type": "number", "description": "a float between 0-1" }, "responses": { "$ref": "#/definitions/GenaiPrompt_responses" }, "tokens_used": { "type": "number" }, "mcp_url": { "type": "string", "description": "Supply a remote MCP URL to send to the LLM API for it to call its tools. Note: Some LLM APIs do not yet support remote MCP URLs. " }, "mcp_deferred_tools": { "$ref": "#/definitions/GenaiPrompt_mcp_deferred_tools" }, "mcp_authorization_token": { "type": "string", "description": "OAuth Bearer token for MCP servers that require authentication." }, "questions": { "type": "array", "items": { "$ref": "#/definitions/GenaiQuestion" }, "description": "Typed questions to evaluate against the messages (for decision models such as TypeSafe Jev)." }, "answers": { "type": "array", "items": { "$ref": "#/definitions/GenaiAnswer" }, "description": "One answer per question, matched by id." }, "skill_ids": { "$ref": "#/definitions/GenaiPrompt_skill_ids", "description": "ids of the genai_skill objects (Agent Skills) to make available to the LLM while it answers." }, "raw": {} } }, "GenaiEmbeddingContent": { "type": "object", "properties": { "text": { "type": "string" } }, "required": [ "text" ] }, "GenaiEmbeddingContents": { "type": "array", "items": { "$ref": "#/definitions/GenaiEmbeddingContent" } }, "GenaiEmbedding": { "type": "object", "properties": { "model_id": { "type": "string" }, "content": { "type": "array", "items": { "$ref": "#/definitions/GenaiEmbeddingContent" } }, "enconding_format": { "type": "string", "enum": [ "FLOAT", "UINT8", "INT8", "BINARY", "UBINARY", "BASE64" ] }, "type": { "type": "string", "description": "'SEARCH_DOC' | 'SEARCH_QUERY' | 'CLUSTERING' | 'CLASSIFICATION';" }, "dimension": { "type": "number", "description": "256, 512, 1024, and 1536" }, "max_tokens": { "type": "number" }, "embeddings": { "type": "string", "description": "JSON string based off of the format", "readOnly": true }, "tokens_used": { "type": "number", "readOnly": true }, "raw": {}, "id": { "type": "string" } } }, "GenaiTask": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "A short human-readable title for the coding agent task." }, "instructions": { "type": "string", "description": "The natural-language instructions given to the coding agent." }, "status": { "type": "string", "enum": [ "PENDING", "RUNNING", "BLOCKED", "COMPLETED", "FAILED", "CANCELLED", "EXPIRED", "OTHER" ] }, "model_id": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "repo_url": { "type": "string", "description": "The git repository that the coding agent works in." }, "source_branch_identifier": { "type": "string", "description": "The name of the branch that the coding agent starts its work from." }, "target_branch_identifier": { "type": "string", "description": "The name of the branch that the coding agent pushed its work to." }, "pullrequest_url": { "type": "string", "description": "The pull/merge request that the coding agent opened for its work." }, "web_url": { "type": "string", "description": "The provider's own web page for this task." }, "messages": { "type": "array", "items": { "$ref": "#/definitions/GenaiContent" }, "description": "The conversation between the user and the coding agent." }, "summary": { "type": "string", "description": "The coding agent's summary of the work that it performed." }, "error": { "type": "string", "description": "The failure description (when the status is FAILED)." }, "files_changed": { "type": "number" }, "lines_added": { "type": "number" }, "lines_deleted": { "type": "number" }, "tokens_used": { "type": "number" }, "started_at": { "type": "string", "format": "date-time", "description": "When the coding agent started working on the task. (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "completed_at": { "type": "string", "format": "date-time", "description": "When the coding agent stopped working on the task. (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "agent_id": { "type": "string", "description": "id of the genai_agent (the reusable agent/preset configuration) that runs this task." }, "organization_id": { "type": "string", "description": "id of the genai_organization (the organization or execution environment) that this task runs under." }, "raw": {} } }, "GenaiAgent": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "instructions": { "type": "string", "description": "The system prompt or stored procedure that the agent follows." }, "model_id": { "type": "string", "description": "The model that the agent runs on." }, "is_active": { "type": "boolean" }, "raw": {} } }, "GenaiOrganization": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_active": { "type": "boolean" }, "raw": {} } }, "GenaiSkill": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string", "description": "What the skill does and when to use it." }, "version": { "type": "string", "description": "The version that is used when a prompt does not pin one." }, "raw": {} } }, "GenaiMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "GenaiMetadatas": { "type": "array", "items": { "$ref": "#/definitions/GenaiMetadata" } }, "GenaiMemory": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "type": { "type": "string", "description": "FOLDER for a memory store or a sub-folder in one, MEMORY for a memory.", "enum": [ "FOLDER", "MEMORY" ] }, "parent_id": { "type": "string", "description": "id of the parent genai_memory folder. Empty on root-level nodes." }, "user_identifier": { "type": "string", "description": "The customer's own identifier for the end user that the memory belongs to." }, "name": { "type": "string", "description": "The folder name, or the memory's file name where the integration organizes memories by path." }, "content": { "type": "string", "description": "The memory text. MEMORY nodes only." }, "description": { "type": "string", "description": "The memory store's description. Store-level folders only." }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/GenaiMetadata" } }, "raw": {} } }, "KmsPageMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL", "PERCENT", "EMAIL", "PHONE", "REFERENCE", "TIME" ] }, "extra_data": {}, "slug": { "type": "string" } } }, "KmsPageMetadatas": { "type": "array", "items": { "$ref": "#/definitions/KmsPageMetadata" } }, "KmsSpace": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "parent_id": { "type": "string" }, "is_active": { "type": "boolean" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "parent_page_id": { "type": "string", "description": "(reference to KmsPage)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/KmsPageMetadata" } }, "raw": {} } }, "KmsPage": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "HTML", "MARKDOWN", "TEXT", "OTHER" ] }, "space_id": { "type": "string", "description": "(reference to KmsSpace)" }, "parent_id": { "type": "string" }, "is_active": { "type": "boolean" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "download_url": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/KmsPageMetadata" } }, "has_children": { "type": "boolean" }, "web_url": { "type": "string" }, "raw": {} }, "required": [ "type" ] }, "KmsComment": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "type": { "type": "string", "enum": [ "PAGE_INLINE", "PAGE" ] }, "content_type": { "type": "string", "enum": [ "HTML", "MARKDOWN", "TEXT", "OTHER" ] }, "content": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "page_id": { "type": "string", "description": "(reference to KmsPage)" }, "parent_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/KmsPageMetadata" } }, "raw": {} } }, "TaskProject_user_ids": { "type": "array", "items": { "type": "string" } }, "TaskProject_group_ids": { "type": "array", "items": { "type": "string" } }, "TaskMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {}, "slug": { "type": "string" } } }, "TaskMetadatas": { "type": "array", "items": { "$ref": "#/definitions/TaskMetadata" } }, "TaskProject": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "parent_id": { "type": "string" }, "user_ids": { "$ref": "#/definitions/TaskProject_user_ids", "description": "(reference to HrisEmployee)" }, "group_ids": { "$ref": "#/definitions/TaskProject_group_ids", "description": "(reference to HrisGroup)" }, "description": { "type": "string" }, "has_tasks": { "type": "boolean", "description": "If you can use this project ID to list tasks. Default is true." }, "has_children": { "type": "boolean", "description": "If this project has children folders / lists" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/TaskMetadata" } }, "raw": {} } }, "TaskTask_assigned_user_ids": { "type": "array", "items": { "type": "string" } }, "TaskTask_follower_user_ids": { "type": "array", "items": { "type": "string" } }, "TaskTask_group_ids": { "type": "array", "items": { "type": "string" } }, "TaskTask_tags": { "type": "array", "items": { "type": "string" } }, "TaskTask_attachment_ids": { "type": "array", "items": { "type": "string" }, "description": "Array of attachment IDs retrieved from StorageFile.Get endpoint" }, "TaskTask": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "project_id": { "type": "string", "description": "(reference to TaskProject)" }, "parent_id": { "type": "string" }, "completed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "status": { "type": "string", "enum": [ "OPENED", "IN_PROGRESS", "COMPLETED" ] }, "notes": { "type": "string" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "Scheduled/planned start of the task (distinct from created_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "Scheduled/planned end of the task (distinct from due_at and completed_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "priority": { "type": "string" }, "assigned_user_ids": { "$ref": "#/definitions/TaskTask_assigned_user_ids", "description": "(reference to HrisEmployee)" }, "creator_user_id": { "type": "string", "description": "The user who created this task (reference to HrisEmployee)" }, "follower_user_ids": { "$ref": "#/definitions/TaskTask_follower_user_ids", "description": "(reference to HrisEmployee)" }, "group_ids": { "$ref": "#/definitions/TaskTask_group_ids", "description": "(reference to HrisGroup)" }, "tags": { "$ref": "#/definitions/TaskTask_tags" }, "url": { "type": "string" }, "attachment_ids": { "$ref": "#/definitions/TaskTask_attachment_ids", "description": "Array of attachment IDs retrieved from StorageFile.Get endpoint (reference to StorageFile)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/TaskMetadata" } }, "has_children": { "type": "boolean" }, "type": { "type": "string", "description": "The task/issue type name (e.g. Jira issue type)." }, "time_spent": { "type": "number" }, "time_spent_unit": { "type": "string" }, "progress": { "type": "number", "description": "0-100" }, "story_points": { "type": "number" }, "raw": {} } }, "TaskComment": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "text": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "user_name": { "type": "string" }, "task_id": { "type": "string", "description": "(reference to TaskTask)" }, "parent_id": { "type": "string" }, "has_children": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/TaskMetadata" } }, "raw": {} } }, "TaskChangeItem": { "type": "object", "properties": { "field": { "type": "string", "description": "unified field in ITaskTask" }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "field" ] }, "TaskChangeItems": { "type": "array", "items": { "$ref": "#/definitions/TaskChangeItem" } }, "TaskChange": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "task_id": { "type": "string", "description": "(reference to TaskTask)" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "items": { "type": "array", "items": { "$ref": "#/definitions/TaskChangeItem" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/TaskMetadata" } }, "raw": {} } }, "CalendarMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "CalendarMetadatas": { "type": "array", "items": { "$ref": "#/definitions/CalendarMetadata" } }, "CalendarCalendar": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "timezone": { "type": "string" }, "is_primary": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CalendarMetadata" } }, "raw": {} } }, "CalendarEvent_organizer": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "ACCEPTED", "REJECTED", "TENTATIVE" ] }, "required": { "type": "boolean" }, "is_cohost": { "type": "boolean" } } }, "CalendarAttendee": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "ACCEPTED", "REJECTED", "TENTATIVE" ] }, "required": { "type": "boolean" }, "is_cohost": { "type": "boolean" } } }, "CalendarAttendees": { "type": "array", "items": { "$ref": "#/definitions/CalendarAttendee" } }, "CalendarEventRecurrence_on_days": { "type": "array", "items": { "type": "string", "enum": [ "SU", "MO", "TU", "WE", "TH", "FR", "SA" ] }, "description": "days of the week to repeat on, defaults to undefined (every day), only used if frequency is WEEKLY" }, "CalendarEventRecurrence_on_months_List": { "type": "array", "items": { "type": "number" }, "description": "months of the year to repeat on, defaults to undefined (every month), only used if frequency is YEARLY, January is 1" }, "CalendarEventRecurrence_on_month_days_List": { "type": "array", "items": { "type": "number" }, "description": "days of the month to repeat on, defaults to undefined (every day), only used if frequency is MONTHLY" }, "CalendarEventRecurrence_on_weeks_List": { "type": "array", "items": { "type": "number" }, "description": "week ordinals for BYDAY (e.g., -1 for last, -2 for second-to-last, 1 for first, 2 for second), only used with on_days. 0 is used for days without week ordinals." }, "CalendarEventRecurrence_on_year_days_List": { "type": "array", "items": { "type": "number" }, "description": "days of the year to repeat on, defaults to undefined (every day), only used if frequency is YEARLY" }, "CalendarEventRecurrence_excluded_dates_List": { "type": "array", "items": { "type": "string" }, "description": "dates to exclude from the recurrence, defaults to undefined (no exclusions)" }, "CalendarEventRecurrence_included_dates_List": { "type": "array", "items": { "type": "string" }, "description": "dates to include in the recurrence, defaults to undefined (no inclusions)" }, "CalendarEventRecurrence": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "DAILY", "WEEKLY", "MONTHLY", "YEARLY" ] }, "interval": { "type": "number", "description": "how many \"units\" between occurrences, defaults to 1" }, "count": { "type": "number", "description": "how many occurrences, defaults to undefined (no limit)" }, "end_at": { "type": "string", "format": "date-time", "description": "until date, defaults to undefined (no end date) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "on_days": { "$ref": "#/definitions/CalendarEventRecurrence_on_days", "description": "days of the week to repeat on, defaults to undefined (every day), only used if frequency is WEEKLY" }, "on_months": { "$ref": "#/definitions/CalendarEventRecurrence_on_months", "description": "months of the year to repeat on, defaults to undefined (every month), only used if frequency is YEARLY, January is 1" }, "on_month_days": { "$ref": "#/definitions/CalendarEventRecurrence_on_month_days", "description": "days of the month to repeat on, defaults to undefined (every day), only used if frequency is MONTHLY" }, "on_weeks": { "$ref": "#/definitions/CalendarEventRecurrence_on_weeks", "description": "week ordinals for BYDAY (e.g., -1 for last, -2 for second-to-last, 1 for first, 2 for second), only used with on_days. 0 is used for days without week ordinals." }, "on_year_days": { "$ref": "#/definitions/CalendarEventRecurrence_on_year_days", "description": "days of the year to repeat on, defaults to undefined (every day), only used if frequency is YEARLY" }, "week_start": { "type": "string", "description": "week start day, defaults to undefined (no week start day)", "enum": [ "SU", "MO", "TU", "WE", "TH", "FR", "SA" ] }, "excluded_dates": { "$ref": "#/definitions/CalendarEventRecurrence_excluded_dates", "description": "dates to exclude from the recurrence, defaults to undefined (no exclusions)" }, "included_dates": { "$ref": "#/definitions/CalendarEventRecurrence_included_dates", "description": "dates to include in the recurrence, defaults to undefined (no inclusions)" }, "timezone": { "type": "string", "description": "timezone, defaults to undefined (no timezone)" } } }, "CalendarEventRecurrences": { "type": "array", "items": { "$ref": "#/definitions/CalendarEventRecurrence" } }, "CalendarConference": { "type": "object", "properties": { "conference_identifier": { "type": "string" }, "url": { "type": "string" }, "label": { "type": "string" }, "telephone": { "type": "string" }, "participant_access_code": { "type": "string" }, "host_access_code": { "type": "string" }, "notes": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" }, "region_code": { "type": "string", "description": "ISO 2-digit region code" } } }, "CalendarConferences": { "type": "array", "items": { "$ref": "#/definitions/CalendarConference" } }, "CalendarAttachment": { "type": "object", "properties": { "id": { "type": "string", "description": "ID for the storage_fileget endpoint" }, "name": { "type": "string" }, "mime_type": { "type": "string" }, "download_url": { "type": "string" } } }, "CalendarAttachments": { "type": "array", "items": { "$ref": "#/definitions/CalendarAttachment" } }, "CalendarEvent": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "calendar_id": { "type": "string", "description": "(reference to CalendarCalendar)" }, "subject": { "type": "string" }, "start_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "is_all_day": { "type": "boolean" }, "timezone": { "type": "string" }, "notes": { "type": "string" }, "location": { "type": "string" }, "is_free": { "type": "boolean" }, "is_private": { "type": "boolean" }, "status": { "type": "string", "enum": [ "CANCELED", "CONFIRMED", "TENTATIVE" ] }, "organizer": { "$ref": "#/definitions/CalendarEvent_organizer" }, "attendees": { "type": "array", "items": { "$ref": "#/definitions/CalendarAttendee" } }, "recurring_event_id": { "type": "string", "description": "(reference to CalendarEvent)" }, "recurrence": { "type": "array", "items": { "$ref": "#/definitions/CalendarEventRecurrence" } }, "web_url": { "type": "string" }, "has_conference": { "type": "boolean" }, "conference": { "type": "array", "items": { "$ref": "#/definitions/CalendarConference" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/CalendarAttachment" } }, "send_notifications": { "type": "boolean" }, "matter_id": { "type": "string", "description": "pointer to Legal Matter" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CalendarMetadata" } }, "raw": {} } }, "CalendarBusy": { "type": "object", "properties": { "id": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "timezone": { "type": "string" }, "description": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CalendarMetadata" } }, "raw": {} }, "required": [ "start_at", "end_at" ] }, "CalendarLink": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "url": { "type": "string" }, "duration": { "type": "number", "description": "minutes" }, "description": { "type": "string" }, "is_active": { "type": "boolean" }, "price_amount": { "type": "number" }, "price_currency": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CalendarMetadata" } }, "raw": {} }, "required": [ "url" ] }, "CalendarRecordingTranscript_attendee": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "ACCEPTED", "REJECTED", "TENTATIVE" ] }, "required": { "type": "boolean" }, "is_cohost": { "type": "boolean" } } }, "CalendarRecordingTranscript": { "type": "object", "properties": { "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "text": { "type": "string" }, "attendee": { "$ref": "#/definitions/CalendarRecordingTranscript_attendee" }, "language": { "type": "string", "description": "two digit ISO code" } }, "required": [ "text" ] }, "CalendarRecordingTranscripts": { "type": "array", "items": { "$ref": "#/definitions/CalendarRecordingTranscript" } }, "CalendarRecordingMedia": { "type": "object", "properties": { "attendees": { "type": "array", "items": { "$ref": "#/definitions/CalendarAttendee" } }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "language": { "type": "string", "description": "two digit ISO code" }, "transcripts": { "type": "array", "items": { "$ref": "#/definitions/CalendarRecordingTranscript" } }, "summary": { "type": "string", "description": "provider AI-generated meeting summary" }, "transcript_download_url": { "type": "string" }, "summary_download_url": { "type": "string", "description": "download/export link for a provider AI summary document (e.g. Google Meet smart notes)" }, "recording_download_url": { "type": "string" } } }, "CalendarRecordingMedias": { "type": "array", "items": { "$ref": "#/definitions/CalendarRecordingMedia" } }, "CalendarRecording": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "expires_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "event_id": { "type": "string", "description": "(reference to CalendarEvent)" }, "web_url": { "type": "string" }, "media": { "type": "array", "items": { "$ref": "#/definitions/CalendarRecordingMedia" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CalendarMetadata" } }, "raw": {} } }, "CalendarWebinar_organizer": { "type": "object", "properties": { "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "ACCEPTED", "REJECTED", "TENTATIVE" ] }, "required": { "type": "boolean" }, "is_cohost": { "type": "boolean" } } }, "CalendarWebinarPanelist": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "is_required": { "type": "boolean" }, "join_url": { "type": "string" }, "join_password": { "type": "string" }, "status": { "type": "string", "enum": [ "ACCEPTED", "REJECTED", "TENTATIVE" ] } } }, "CalendarWebinarPanelists": { "type": "array", "items": { "$ref": "#/definitions/CalendarWebinarPanelist" } }, "CalendarWebinarRegistrant": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "registration_reference": { "type": "string" }, "registration_status": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED", "CANCELLED" ] }, "registered_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "CalendarWebinarRegistrants": { "type": "array", "items": { "$ref": "#/definitions/CalendarWebinarRegistrant" } }, "CalendarWebinar": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "calendar_id": { "type": "string", "description": "(reference to CalendarCalendar)" }, "subject": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "timezone": { "type": "string" }, "notes": { "type": "string" }, "status": { "type": "string", "enum": [ "CANCELED", "CONFIRMED", "TENTATIVE" ] }, "organizer": { "$ref": "#/definitions/CalendarWebinar_organizer" }, "join_url": { "type": "string" }, "web_url": { "type": "string", "description": "information" }, "panelists": { "type": "array", "items": { "$ref": "#/definitions/CalendarWebinarPanelist" } }, "registrants": { "type": "array", "items": { "$ref": "#/definitions/CalendarWebinarRegistrant" } }, "panelist_password": { "type": "string" }, "registrant_password": { "type": "string" }, "conference": { "type": "array", "items": { "$ref": "#/definitions/CalendarConference" } }, "recurrence": { "type": "array", "items": { "$ref": "#/definitions/CalendarEventRecurrence" } }, "capacity": { "type": "number" }, "is_webcast": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "is_auto_approve": { "type": "boolean" }, "require_first_name": { "type": "boolean" }, "require_last_name": { "type": "boolean" }, "require_email": { "type": "boolean" }, "require_company": { "type": "boolean" }, "require_job_title": { "type": "boolean" }, "require_address": { "type": "boolean" }, "require_phone": { "type": "boolean" }, "has_qa": { "type": "boolean" }, "has_polls": { "type": "boolean" }, "has_recording": { "type": "boolean" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CalendarMetadata" } }, "raw": {} } }, "AdsManager": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AdsManagers": { "type": "array", "items": { "$ref": "#/definitions/AdsManager" }, "description": "Manager/agency chain, top-most manager first, closest manager last (SA360 manager/sub_manager)" }, "AdsMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "AdsMetadatas": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "AdsOrganization": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "currency": { "type": "string" }, "timezone": { "type": "string" }, "parent_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "account_number": { "type": "string", "description": "Integration-specific account number distinct from id (Microsoft AccountNumber)" }, "managers": { "type": "array", "items": { "$ref": "#/definitions/AdsManager" }, "description": "Manager/agency chain, top-most manager first, closest manager last (SA360 manager/sub_manager)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "TargetRef": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "TargetReves": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "CityTarget": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "radius": { "type": "number" }, "radius_unit": { "type": "string", "enum": [ "MILES", "KILOMETERS" ] } }, "required": [ "id" ] }, "CityTargets": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "AdsCampaign_targeting_geographic_location_types": { "type": "array", "items": { "type": "string", "enum": [ "HOME", "RECENT", "TRAVEL" ] } }, "AdsCampaign_targeting_geographic": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "regions": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "cities": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "postal_codes": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "us_dmas": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_countries": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_regions": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_cities": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "excluded_postal_codes": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_us_dmas": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "location_types": { "$ref": "#/definitions/AdsCampaign_targeting_geographic_location_types" }, "presence_type": { "type": "string", "enum": [ "PRESENCE", "PRESENCE_OR_INTEREST" ] } } }, "AdsCampaign_targeting_demographic": { "type": "object", "properties": { "age_min": { "type": "number" }, "age_max": { "type": "number" }, "male": { "type": "boolean" }, "female": { "type": "boolean" } }, "description": "Demographic targeting (Meta: age_min, age_max, genders)" }, "LookalikeAudience": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "similarity": { "type": "number" }, "source_audience_id": { "type": "string" } }, "required": [ "id" ] }, "LookalikeAudiences": { "type": "array", "items": { "$ref": "#/definitions/LookalikeAudience" } }, "AudienceCombination": { "type": "object", "properties": { "interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "references": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "life_events": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } } } }, "AudienceCombinations": { "type": "array", "items": { "$ref": "#/definitions/AudienceCombination" } }, "AdsCampaign_targeting_audience": { "type": "object", "properties": { "custom_audiences": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_custom_audiences": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "lookalike_audiences": { "type": "array", "items": { "$ref": "#/definitions/LookalikeAudience" } }, "interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "combination_spec": { "type": "array", "items": { "$ref": "#/definitions/AudienceCombination" } } } }, "AdsCampaign_targeting_placement_platforms": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_placement_facebook_positions": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_placement_instagram_positions": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_placement_messenger_positions": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_placement_audience_network_positions": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_placement": { "type": "object", "properties": { "platforms": { "$ref": "#/definitions/AdsCampaign_targeting_placement_platforms" }, "facebook_positions": { "$ref": "#/definitions/AdsCampaign_targeting_placement_facebook_positions" }, "instagram_positions": { "$ref": "#/definitions/AdsCampaign_targeting_placement_instagram_positions" }, "messenger_positions": { "$ref": "#/definitions/AdsCampaign_targeting_placement_messenger_positions" }, "audience_network_positions": { "$ref": "#/definitions/AdsCampaign_targeting_placement_audience_network_positions" } } }, "AdsCampaign_targeting_device": { "type": "object", "properties": { "types": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "user_device": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "user_os": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "carriers": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } } } }, "AdsKeyword": { "type": "object", "properties": { "text": { "type": "string" }, "match_type": { "type": "string", "enum": [ "BROAD", "PHRASE", "EXACT" ] } }, "required": [ "text" ], "description": "Content targeting (keywords, topics, placements, video)" }, "AdsKeywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "AdsCampaign_targeting_content_urls": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_content_excluded_urls": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_content_video_youtube_videos": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_content_video_excluded_youtube_videos": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_content_video_youtube_channels": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_content_video_excluded_youtube_channels": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_content_video_positions": { "type": "array", "items": { "type": "string", "enum": [ "PREROLL", "MIDROLL", "POSTROLL", "INSTREAM", "OUTSTREAM" ] } }, "AdsCampaign_targeting_content_video_player_sizes": { "type": "array", "items": { "type": "string", "enum": [ "SMALL", "LARGE", "HD" ] } }, "AdsCampaign_targeting_content_video_durations": { "type": "array", "items": { "type": "string", "enum": [ "SHORT", "MEDIUM", "LONG" ] } }, "AdsCampaign_targeting_content_video": { "type": "object", "properties": { "youtube_videos": { "$ref": "#/definitions/AdsCampaign_targeting_content_video_youtube_videos" }, "excluded_youtube_videos": { "$ref": "#/definitions/AdsCampaign_targeting_content_video_excluded_youtube_videos" }, "youtube_channels": { "$ref": "#/definitions/AdsCampaign_targeting_content_video_youtube_channels" }, "excluded_youtube_channels": { "$ref": "#/definitions/AdsCampaign_targeting_content_video_excluded_youtube_channels" }, "positions": { "$ref": "#/definitions/AdsCampaign_targeting_content_video_positions" }, "player_sizes": { "$ref": "#/definitions/AdsCampaign_targeting_content_video_player_sizes" }, "durations": { "$ref": "#/definitions/AdsCampaign_targeting_content_video_durations" } } }, "AdsCampaign_targeting_content": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "excluded_keywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "topics": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_topics": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "urls": { "$ref": "#/definitions/AdsCampaign_targeting_content_urls" }, "excluded_urls": { "$ref": "#/definitions/AdsCampaign_targeting_content_excluded_urls" }, "video": { "$ref": "#/definitions/AdsCampaign_targeting_content_video" } } }, "AdsCampaign_targeting_brand_safety_excluded_publisher_categories": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_brand_safety_excluded_content_labels": { "type": "array", "items": { "type": "string" }, "description": "Google Ads ContentLabelType" }, "AdsCampaign_targeting_brand_safety_brand_safety_content_filter_levels": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_brand_safety_publisher_visibility_categories": { "type": "array", "items": { "type": "string", "enum": [ "limited", "standard", "expanded" ] } }, "AdsCampaign_targeting_brand_safety_block_list_ids": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_targeting_brand_safety": { "type": "object", "properties": { "excluded_publisher_categories": { "$ref": "#/definitions/AdsCampaign_targeting_brand_safety_excluded_publisher_categories" }, "excluded_content_labels": { "$ref": "#/definitions/AdsCampaign_targeting_brand_safety_excluded_content_labels", "description": "Google Ads ContentLabelType" }, "brand_safety_content_filter_levels": { "$ref": "#/definitions/AdsCampaign_targeting_brand_safety_brand_safety_content_filter_levels" }, "publisher_visibility_categories": { "$ref": "#/definitions/AdsCampaign_targeting_brand_safety_publisher_visibility_categories" }, "block_list_ids": { "$ref": "#/definitions/AdsCampaign_targeting_brand_safety_block_list_ids" } }, "description": "Brand safety (Meta: excluded_publisher_categories, etc.; Google" }, "AdSchedule": { "type": "object", "properties": { "day_of_week": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "start_hour": { "type": "number", "description": "0-23" }, "start_minute": { "type": "number", "description": "0, 15, 30, 45" }, "end_hour": { "type": "number", "description": "0-24 (24 = end of day)" }, "end_minute": { "type": "number", "description": "0, 15, 30, 45" }, "bid_modifier": { "type": "number", "description": "0.1-10.0" } }, "required": [ "day_of_week", "start_hour", "end_hour" ] }, "AdSchedules": { "type": "array", "items": { "$ref": "#/definitions/AdSchedule" } }, "AdsCampaign_targeting_optimization": { "type": "object", "properties": { "mode": { "type": "string", "description": "Google: bid_only falsetrue", "enum": [ "TARGETING", "OBSERVATION" ] }, "advantage_audience": { "type": "boolean" }, "advantage_placements": { "type": "boolean" }, "targeting_optimization_expansion_all": { "type": "boolean" } }, "description": "Optimization (Meta: targeting_automation; Google: observation vs targeting mode)" }, "AdsCampaign_targeting": { "type": "object", "properties": { "geographic": { "$ref": "#/definitions/AdsCampaign_targeting_geographic" }, "demographic": { "$ref": "#/definitions/AdsCampaign_targeting_demographic", "description": "Demographic targeting (Meta: age_min, age_max, genders)" }, "audience": { "$ref": "#/definitions/AdsCampaign_targeting_audience" }, "placement": { "$ref": "#/definitions/AdsCampaign_targeting_placement" }, "device": { "$ref": "#/definitions/AdsCampaign_targeting_device" }, "language": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "content": { "$ref": "#/definitions/AdsCampaign_targeting_content" }, "brand_safety": { "$ref": "#/definitions/AdsCampaign_targeting_brand_safety", "description": "Brand safety (Meta: excluded_publisher_categories, etc.; Google" }, "schedule": { "type": "array", "items": { "$ref": "#/definitions/AdSchedule" } }, "optimization": { "$ref": "#/definitions/AdsCampaign_targeting_optimization", "description": "Optimization (Meta: targeting_automation; Google: observation vs targeting mode)" } } }, "AdsCampaign_frequency_cap": { "type": "object", "properties": { "is_unlimited": { "type": "boolean" }, "time_unit": { "type": "string", "enum": [ "UNSPECIFIED", "LIFETIME", "MONTHS", "WEEKS", "DAYS", "HOURS", "MINUTES" ] }, "time_unit_count": { "type": "number" }, "max_impressions": { "type": "number" }, "max_views": { "type": "number" } } }, "AdsCampaign_labels": { "type": "array", "items": { "type": "string" } }, "AdsCampaign_kpi": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "UNSPECIFIED", "CPM", "CPC", "CPA", "CTR", "VIEWABILITY", "CPIAVC", "CPE", "CPV", "CLICK_CVR", "IMPRESSION_CVR", "VCPM", "VTR", "AUDIO_COMPLETION_RATE", "VIDEO_COMPLETION_RATE", "CPCL", "CPCV", "TOS10", "MAXIMIZE_PACING", "CUSTOM_IMPRESSION_VALUE_OVER_COST", "OTHER" ] }, "amount": { "type": "number" }, "percentage": { "type": "number" }, "string_value": { "type": "string" }, "algorithm_id": { "type": "string" } } }, "AdsCampaign": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "effective_status": { "type": "string", "description": "read-only; controlled by the provider (whether/why the campaign can serve), unlike the user-managed status", "enum": [ "UNSPECIFIED", "SERVING", "LIMITED", "LEARNING", "PAUSED", "PENDING", "ENDED", "MISCONFIGURED", "NOT_ELIGIBLE", "ARCHIVED", "REMOVED" ] }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "budget_amount": { "type": "number" }, "budget_period": { "type": "string", "enum": [ "DAILY", "MONTHLY", "TOTAL", "LIFETIME" ] }, "budget_unit": { "type": "string", "enum": [ "UNSPECIFIED", "CURRENCY", "IMPRESSIONS" ] }, "total_spend_amount": { "type": "number" }, "targeting": { "$ref": "#/definitions/AdsCampaign_targeting" }, "goal": { "type": "string", "enum": [ "UNSPECIFIED", "BRAND_AWARENESS", "ENGAGEMENT", "REACH", "WEBSITE_TRAFFIC", "LEADS", "SALES", "APP_PROMOTION" ] }, "planned_spend_amount": { "type": "number" }, "frequency_cap": { "$ref": "#/definitions/AdsCampaign_frequency_cap" }, "advertising_channel_type": { "type": "string", "enum": [ "TEXT", "IMAGE", "VIDEO", "RESPONSIVE", "SHOPPING", "APP", "CALL", "CAROUSEL", "SOCIAL", "DISPLAY", "SEARCH", "AUDIO", "YOUTUBE", "NATIVE", "CTV", "DOOH", "PERFORMANCE_MAX" ] }, "campaign_budget_identifier": { "type": "string", "description": "Resource name for existing/shared budget (Google)" }, "currency": { "type": "string" }, "category": { "type": "string", "description": "Housing, employment, credit, NONE (Meta)" }, "has_eu_political_ads": { "type": "boolean" }, "labels": { "$ref": "#/definitions/AdsCampaign_labels" }, "kpi": { "$ref": "#/definitions/AdsCampaign_kpi" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsCreative_asset_urls": { "type": "array", "items": { "type": "string" }, "description": "Hosted asset mode (best-effort, provider-specific" }, "AdsPromoted": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "description": "Promoted entity types for ads_promoted list endpoint", "enum": [ "PAGE_ID", "APP_ID", "STORE_URL", "PIXEL_ID", "CUSTOM_CONVERSION_ID", "CATALOG_ID", "PRODUCT_SET_ID", "PRIORITIZED_SET_ID", "EVENT_ID", "OFFER_ID", "LEAD_FORM_ID", "MESSAGING_CHANNEL_ID", "PRODUCT_ID", "TWEET_ID", "AD_GROUP_TYPE" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} }, "required": [ "id", "type" ], "description": "Promoted entity (e.g. page, app, product, tweet) for ads create" }, "AdsPromoteds": { "type": "array", "items": { "$ref": "#/definitions/AdsPromoted" } }, "AdsCreative_labels": { "type": "array", "items": { "type": "string" } }, "AdsCreative": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "campaign_id": { "type": "string" }, "group_id": { "type": "string", "description": "(reference to AdsGroup)" }, "item_id": { "type": "string", "description": "references Commerce Item ID (reference to CommerceItem)" }, "organization_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "creative_type": { "type": "string", "enum": [ "UNSPECIFIED", "STANDARD", "EXPANDABLE", "VIDEO", "NATIVE", "AUDIO", "PUBLISHER_HOSTED", "ASSET_BASED", "IMAGE", "DOCUMENT", "SHARE" ] }, "hosting_source": { "type": "string", "enum": [ "UNSPECIFIED", "CM", "THIRD_PARTY", "HOSTED", "RICH_MEDIA", "PUBLISHER_HOSTED" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "asset_urls": { "$ref": "#/definitions/AdsCreative_asset_urls", "description": "Hosted asset mode (best-effort, provider-specific" }, "link_url": { "type": "string", "description": "Destination URL for creatives with links" }, "url_tags": { "type": "string", "description": "Appended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template" }, "body": { "type": "string" }, "title": { "type": "string" }, "cta": { "type": "string" }, "third_party_tag": { "type": "string" }, "vast_tag_url": { "type": "string" }, "external_creative_reference": { "type": "string" }, "external_placement_reference": { "type": "string" }, "external_ad_reference": { "type": "string" }, "promoted": { "type": "array", "items": { "$ref": "#/definitions/AdsPromoted" } }, "path1": { "type": "string", "description": "Display URL path 1 (Microsoft RSA Path1)" }, "path2": { "type": "string", "description": "Display URL path 2 (Microsoft RSA Path2)" }, "data": { "type": "string" }, "labels": { "$ref": "#/definitions/AdsCreative_labels" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsAsset": { "type": "object", "properties": { "id": { "type": "string", "description": "provider asset resource name/id (e.g. Google Ads customers/{cid}/assets/{id}, TikTok image/video id, DV360 mediaId)" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "organization_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "IMAGE", "VIDEO", "YOUTUBE_VIDEO", "MEDIA_BUNDLE", "TEXT" ] }, "url": { "type": "string", "description": "outbound: public asset URL; inbound (create): source URL to fetch bytes from when content is not supplied" }, "content": { "type": "string", "description": "inbound create-only: base64-encoded image/media bytes to upload" }, "mime_type": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "file_size": { "type": "number" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsInsertionorder_pacing": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "UNSPECIFIED", "DAILY", "FLIGHT" ] }, "type": { "type": "string" }, "daily_max_amount": { "type": "number" }, "daily_max_impressions": { "type": "number" } } }, "AdsInsertionorder_frequency_cap": { "type": "object", "properties": { "is_unlimited": { "type": "boolean" }, "time_unit": { "type": "string", "enum": [ "UNSPECIFIED", "LIFETIME", "MONTHS", "WEEKS", "DAYS", "HOURS", "MINUTES" ] }, "time_unit_count": { "type": "number" }, "max_impressions": { "type": "number" }, "max_views": { "type": "number" } } }, "AdsInsertionorder_kpi": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "UNSPECIFIED", "CPM", "CPC", "CPA", "CTR", "VIEWABILITY", "CPIAVC", "CPE", "CPV", "CLICK_CVR", "IMPRESSION_CVR", "VCPM", "VTR", "AUDIO_COMPLETION_RATE", "VIDEO_COMPLETION_RATE", "CPCL", "CPCV", "TOS10", "MAXIMIZE_PACING", "CUSTOM_IMPRESSION_VALUE_OVER_COST", "OTHER" ] }, "amount": { "type": "number" }, "percentage": { "type": "number" }, "string_value": { "type": "string" }, "algorithm_id": { "type": "string" } } }, "AdsInsertionorderBudgetSegment": { "type": "object", "properties": { "budget_amount": { "type": "number" }, "description": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "AdsInsertionorderBudgetSegments": { "type": "array", "items": { "$ref": "#/definitions/AdsInsertionorderBudgetSegment" } }, "AdsInsertionorder_bid_strategy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIXED_BID", "MAXIMIZE_SPEND", "PERFORMANCE_GOAL", "YOUTUBE_AND_PARTNERS" ] }, "fixed_bid_amount": { "type": "number" }, "performance_goal_type": { "type": "string", "enum": [ "UNSPECIFIED", "CPA", "CPC", "VIEWABLE_CPM", "CUSTOM_ALGO", "CIVA", "IVO_TEN", "AV_VIEWED", "REACH" ] }, "performance_goal_amount": { "type": "number" }, "max_average_cpm_bid_amount": { "type": "number" }, "custom_bidding_algorithm_id": { "type": "string" }, "raise_bid_for_deals": { "type": "boolean" }, "youtube_and_partners_type": { "type": "string", "enum": [ "UNSPECIFIED", "MANUAL_CPV", "MANUAL_CPM", "TARGET_CPA", "TARGET_CPM", "RESERVE_CPM", "MAXIMIZE_LIFT", "MAXIMIZE_CONVERSIONS", "TARGET_CPV", "TARGET_ROAS", "MAXIMIZE_CONVERSION_VALUE" ] }, "youtube_and_partners_value": { "type": "string" }, "target_roas": { "type": "number", "description": "Target ROAS e.g. 2.5 = 250% (Google)" } }, "required": [ "type" ], "description": "YOUTUBE_AND_PARTNERS" }, "AdsInsertionorder": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "campaign_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "pacing": { "$ref": "#/definitions/AdsInsertionorder_pacing" }, "frequency_cap": { "$ref": "#/definitions/AdsInsertionorder_frequency_cap" }, "kpi": { "$ref": "#/definitions/AdsInsertionorder_kpi" }, "budget_unit": { "type": "string", "enum": [ "UNSPECIFIED", "CURRENCY", "IMPRESSIONS" ] }, "budget_segments": { "type": "array", "items": { "$ref": "#/definitions/AdsInsertionorderBudgetSegment" } }, "bid_strategy": { "$ref": "#/definitions/AdsInsertionorder_bid_strategy", "description": "YOUTUBE_AND_PARTNERS" }, "reference": { "type": "string", "description": "client's reference ID for the insertion order" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsGroup_targeting_geographic_location_types": { "type": "array", "items": { "type": "string", "enum": [ "HOME", "RECENT", "TRAVEL" ] } }, "AdsGroup_targeting_geographic": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "regions": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "cities": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "postal_codes": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "us_dmas": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_countries": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_regions": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_cities": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "excluded_postal_codes": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_us_dmas": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "location_types": { "$ref": "#/definitions/AdsGroup_targeting_geographic_location_types" }, "presence_type": { "type": "string", "enum": [ "PRESENCE", "PRESENCE_OR_INTEREST" ] } } }, "AdsGroup_targeting_demographic": { "type": "object", "properties": { "age_min": { "type": "number" }, "age_max": { "type": "number" }, "male": { "type": "boolean" }, "female": { "type": "boolean" } }, "description": "Demographic targeting (Meta: age_min, age_max, genders)" }, "AdsGroup_targeting_audience": { "type": "object", "properties": { "custom_audiences": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_custom_audiences": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "lookalike_audiences": { "type": "array", "items": { "$ref": "#/definitions/LookalikeAudience" } }, "interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "combination_spec": { "type": "array", "items": { "$ref": "#/definitions/AudienceCombination" } } } }, "AdsGroup_targeting_placement_platforms": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_placement_facebook_positions": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_placement_instagram_positions": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_placement_messenger_positions": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_placement_audience_network_positions": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_placement": { "type": "object", "properties": { "platforms": { "$ref": "#/definitions/AdsGroup_targeting_placement_platforms" }, "facebook_positions": { "$ref": "#/definitions/AdsGroup_targeting_placement_facebook_positions" }, "instagram_positions": { "$ref": "#/definitions/AdsGroup_targeting_placement_instagram_positions" }, "messenger_positions": { "$ref": "#/definitions/AdsGroup_targeting_placement_messenger_positions" }, "audience_network_positions": { "$ref": "#/definitions/AdsGroup_targeting_placement_audience_network_positions" } } }, "AdsGroup_targeting_device": { "type": "object", "properties": { "types": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "user_device": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "user_os": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "carriers": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } } } }, "AdsGroup_targeting_content_urls": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_content_excluded_urls": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_content_video_youtube_videos": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_content_video_excluded_youtube_videos": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_content_video_youtube_channels": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_content_video_excluded_youtube_channels": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_content_video_positions": { "type": "array", "items": { "type": "string", "enum": [ "PREROLL", "MIDROLL", "POSTROLL", "INSTREAM", "OUTSTREAM" ] } }, "AdsGroup_targeting_content_video_player_sizes": { "type": "array", "items": { "type": "string", "enum": [ "SMALL", "LARGE", "HD" ] } }, "AdsGroup_targeting_content_video_durations": { "type": "array", "items": { "type": "string", "enum": [ "SHORT", "MEDIUM", "LONG" ] } }, "AdsGroup_targeting_content_video": { "type": "object", "properties": { "youtube_videos": { "$ref": "#/definitions/AdsGroup_targeting_content_video_youtube_videos" }, "excluded_youtube_videos": { "$ref": "#/definitions/AdsGroup_targeting_content_video_excluded_youtube_videos" }, "youtube_channels": { "$ref": "#/definitions/AdsGroup_targeting_content_video_youtube_channels" }, "excluded_youtube_channels": { "$ref": "#/definitions/AdsGroup_targeting_content_video_excluded_youtube_channels" }, "positions": { "$ref": "#/definitions/AdsGroup_targeting_content_video_positions" }, "player_sizes": { "$ref": "#/definitions/AdsGroup_targeting_content_video_player_sizes" }, "durations": { "$ref": "#/definitions/AdsGroup_targeting_content_video_durations" } } }, "AdsGroup_targeting_content": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "excluded_keywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "topics": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_topics": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "urls": { "$ref": "#/definitions/AdsGroup_targeting_content_urls" }, "excluded_urls": { "$ref": "#/definitions/AdsGroup_targeting_content_excluded_urls" }, "video": { "$ref": "#/definitions/AdsGroup_targeting_content_video" } } }, "AdsGroup_targeting_brand_safety_excluded_publisher_categories": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_brand_safety_excluded_content_labels": { "type": "array", "items": { "type": "string" }, "description": "Google Ads ContentLabelType" }, "AdsGroup_targeting_brand_safety_brand_safety_content_filter_levels": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_brand_safety_publisher_visibility_categories": { "type": "array", "items": { "type": "string", "enum": [ "limited", "standard", "expanded" ] } }, "AdsGroup_targeting_brand_safety_block_list_ids": { "type": "array", "items": { "type": "string" } }, "AdsGroup_targeting_brand_safety": { "type": "object", "properties": { "excluded_publisher_categories": { "$ref": "#/definitions/AdsGroup_targeting_brand_safety_excluded_publisher_categories" }, "excluded_content_labels": { "$ref": "#/definitions/AdsGroup_targeting_brand_safety_excluded_content_labels", "description": "Google Ads ContentLabelType" }, "brand_safety_content_filter_levels": { "$ref": "#/definitions/AdsGroup_targeting_brand_safety_brand_safety_content_filter_levels" }, "publisher_visibility_categories": { "$ref": "#/definitions/AdsGroup_targeting_brand_safety_publisher_visibility_categories" }, "block_list_ids": { "$ref": "#/definitions/AdsGroup_targeting_brand_safety_block_list_ids" } }, "description": "Brand safety (Meta: excluded_publisher_categories, etc.; Google" }, "AdsGroup_targeting_optimization": { "type": "object", "properties": { "mode": { "type": "string", "description": "Google: bid_only falsetrue", "enum": [ "TARGETING", "OBSERVATION" ] }, "advantage_audience": { "type": "boolean" }, "advantage_placements": { "type": "boolean" }, "targeting_optimization_expansion_all": { "type": "boolean" } }, "description": "Optimization (Meta: targeting_automation; Google: observation vs targeting mode)" }, "AdsGroup_targeting": { "type": "object", "properties": { "geographic": { "$ref": "#/definitions/AdsGroup_targeting_geographic" }, "demographic": { "$ref": "#/definitions/AdsGroup_targeting_demographic", "description": "Demographic targeting (Meta: age_min, age_max, genders)" }, "audience": { "$ref": "#/definitions/AdsGroup_targeting_audience" }, "placement": { "$ref": "#/definitions/AdsGroup_targeting_placement" }, "device": { "$ref": "#/definitions/AdsGroup_targeting_device" }, "language": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "content": { "$ref": "#/definitions/AdsGroup_targeting_content" }, "brand_safety": { "$ref": "#/definitions/AdsGroup_targeting_brand_safety", "description": "Brand safety (Meta: excluded_publisher_categories, etc.; Google" }, "schedule": { "type": "array", "items": { "$ref": "#/definitions/AdSchedule" } }, "optimization": { "$ref": "#/definitions/AdsGroup_targeting_optimization", "description": "Optimization (Meta: targeting_automation; Google: observation vs targeting mode)" } } }, "AdsGroup_bid_strategy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIXED_BID", "MAXIMIZE_SPEND", "PERFORMANCE_GOAL", "YOUTUBE_AND_PARTNERS" ] }, "fixed_bid_amount": { "type": "number" }, "performance_goal_type": { "type": "string", "enum": [ "UNSPECIFIED", "CPA", "CPC", "VIEWABLE_CPM", "CUSTOM_ALGO", "CIVA", "IVO_TEN", "AV_VIEWED", "REACH" ] }, "performance_goal_amount": { "type": "number" }, "max_average_cpm_bid_amount": { "type": "number" }, "custom_bidding_algorithm_id": { "type": "string" }, "raise_bid_for_deals": { "type": "boolean" }, "youtube_and_partners_type": { "type": "string", "enum": [ "UNSPECIFIED", "MANUAL_CPV", "MANUAL_CPM", "TARGET_CPA", "TARGET_CPM", "RESERVE_CPM", "MAXIMIZE_LIFT", "MAXIMIZE_CONVERSIONS", "TARGET_CPV", "TARGET_ROAS", "MAXIMIZE_CONVERSION_VALUE" ] }, "youtube_and_partners_value": { "type": "string" }, "target_roas": { "type": "number", "description": "Target ROAS e.g. 2.5 = 250% (Google)" } }, "required": [ "type" ], "description": "YOUTUBE_AND_PARTNERS" }, "AdsGroup_pacing": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "UNSPECIFIED", "DAILY", "FLIGHT" ] }, "type": { "type": "string" }, "daily_max_amount": { "type": "number" }, "daily_max_impressions": { "type": "number" } } }, "AdsGroup_frequency_cap": { "type": "object", "properties": { "is_unlimited": { "type": "boolean" }, "time_unit": { "type": "string", "enum": [ "UNSPECIFIED", "LIFETIME", "MONTHS", "WEEKS", "DAYS", "HOURS", "MINUTES" ] }, "time_unit_count": { "type": "number" }, "max_impressions": { "type": "number" }, "max_views": { "type": "number" } } }, "AdsGroup_creative_ids": { "type": "array", "items": { "type": "string" } }, "AdsGroup": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "parent_id": { "type": "string" }, "campaign_id": { "type": "string" }, "organization_id": { "type": "string" }, "insertionorder_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "effective_status": { "type": "string", "enum": [ "UNSPECIFIED", "SERVING", "LIMITED", "LEARNING", "PAUSED", "PENDING", "ENDED", "MISCONFIGURED", "NOT_ELIGIBLE", "ARCHIVED", "REMOVED" ] }, "targeting": { "$ref": "#/definitions/AdsGroup_targeting" }, "bid_amount": { "type": "number" }, "bid_strategy": { "$ref": "#/definitions/AdsGroup_bid_strategy", "description": "YOUTUBE_AND_PARTNERS" }, "budget_amount": { "type": "number" }, "budget_period": { "type": "string", "enum": [ "DAILY", "MONTHLY", "TOTAL", "LIFETIME" ] }, "budget_allocation_type": { "type": "string", "enum": [ "UNSPECIFIED", "AUTOMATIC", "FIXED", "UNLIMITED" ] }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "budget_unit": { "type": "string", "enum": [ "UNSPECIFIED", "CURRENCY", "IMPRESSIONS" ] }, "budget_max_amount": { "type": "number" }, "type": { "type": "string", "enum": [ "TEXT", "IMAGE", "VIDEO", "RESPONSIVE", "SHOPPING", "APP", "CALL", "CAROUSEL", "SOCIAL", "DISPLAY", "SEARCH", "AUDIO", "YOUTUBE", "NATIVE", "CTV", "DOOH", "PERFORMANCE_MAX" ] }, "has_eu_political_ads": { "type": "boolean" }, "pacing": { "$ref": "#/definitions/AdsGroup_pacing" }, "frequency_cap": { "$ref": "#/definitions/AdsGroup_frequency_cap" }, "creative_ids": { "$ref": "#/definitions/AdsGroup_creative_ids" }, "optimization_goal": { "type": "string", "description": "Optimization goals for ads_group (cross-platform; platform-specific values allowed as pass-through)", "enum": [ "REACH", "IMPRESSIONS", "LINK_CLICKS", "LANDING_PAGE_VIEWS", "CONVERSIONS", "LEAD_GENERATION", "APP_INSTALLS", "APP_ENGAGEMENT", "VIDEO_VIEWS", "ENGAGEMENT", "PAGE_LIKES", "MESSAGES" ] }, "billing_event": { "type": "string", "description": "Billing events for ads_group (what you pay for; cross-platform; platform-specific values allowed as pass-through)", "enum": [ "IMPRESSIONS", "LINK_CLICKS", "VIDEO_VIEWS", "APP_INSTALLS", "ENGAGEMENT", "PAGE_LIKES", "MESSAGES", "POST_ENGAGEMENT", "PURCHASE", "NONE" ] }, "currency": { "type": "string" }, "promoted": { "type": "array", "items": { "$ref": "#/definitions/AdsPromoted" } }, "language_locale": { "type": "string", "description": "Language + region, ISO 639-1 with region (e.g. en-US); LinkedIn locale" }, "creative_selection": { "type": "string", "description": "Creative rotation strategy (LinkedIn creativeSelection)", "enum": [ "OPTIMIZED", "ROUND_ROBIN" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsAd_creative_ids": { "type": "array", "items": { "type": "string" } }, "AdsAd": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "campaign_id": { "type": "string" }, "group_id": { "type": "string", "description": "(reference to AdsGroup)" }, "organization_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "ad_type": { "type": "string", "enum": [ "TEXT", "IMAGE", "VIDEO", "RESPONSIVE", "SHOPPING", "APP", "CALL", "CAROUSEL", "SOCIAL", "DISPLAY", "SEARCH", "AUDIO", "YOUTUBE", "NATIVE", "CTV", "DOOH", "PERFORMANCE_MAX" ] }, "advertiser_name": { "type": "string" }, "creative_ids": { "$ref": "#/definitions/AdsAd_creative_ids" }, "creative_asset_url": { "type": "string" }, "ad_copy": { "type": "string" }, "headline": { "type": "string" }, "description": { "type": "string" }, "cta": { "type": "string" }, "final_url": { "type": "string" }, "display_url": { "type": "string" }, "path1": { "type": "string" }, "path2": { "type": "string" }, "promoted": { "type": "array", "items": { "$ref": "#/definitions/AdsPromoted" } }, "logo_creative_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsReportMetrics_campaign_targeting_geographic_location_types": { "type": "array", "items": { "type": "string", "enum": [ "HOME", "RECENT", "TRAVEL" ] } }, "AdsReportMetrics_campaign_targeting_geographic": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "regions": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "cities": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "postal_codes": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "us_dmas": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_countries": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_regions": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_cities": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "excluded_postal_codes": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_us_dmas": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "location_types": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_geographic_location_types" }, "presence_type": { "type": "string", "enum": [ "PRESENCE", "PRESENCE_OR_INTEREST" ] } } }, "AdsReportMetrics_campaign_targeting_demographic": { "type": "object", "properties": { "age_min": { "type": "number" }, "age_max": { "type": "number" }, "male": { "type": "boolean" }, "female": { "type": "boolean" } }, "description": "Demographic targeting (Meta: age_min, age_max, genders)" }, "AdsReportMetrics_campaign_targeting_audience": { "type": "object", "properties": { "custom_audiences": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_custom_audiences": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "lookalike_audiences": { "type": "array", "items": { "$ref": "#/definitions/LookalikeAudience" } }, "interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "combination_spec": { "type": "array", "items": { "$ref": "#/definitions/AudienceCombination" } } } }, "AdsReportMetrics_campaign_targeting_placement_platforms": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_placement_facebook_positions": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_placement_instagram_positions": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_placement_messenger_positions": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_placement_audience_network_positions": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_placement": { "type": "object", "properties": { "platforms": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_placement_platforms" }, "facebook_positions": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_placement_facebook_positions" }, "instagram_positions": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_placement_instagram_positions" }, "messenger_positions": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_placement_messenger_positions" }, "audience_network_positions": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_placement_audience_network_positions" } } }, "AdsReportMetrics_campaign_targeting_device": { "type": "object", "properties": { "types": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "user_device": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "user_os": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "carriers": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } } } }, "AdsReportMetrics_campaign_targeting_content_urls": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_content_excluded_urls": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_content_video_youtube_videos": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_content_video_excluded_youtube_videos": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_content_video_youtube_channels": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_content_video_excluded_youtube_channels": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_content_video_positions": { "type": "array", "items": { "type": "string", "enum": [ "PREROLL", "MIDROLL", "POSTROLL", "INSTREAM", "OUTSTREAM" ] } }, "AdsReportMetrics_campaign_targeting_content_video_player_sizes": { "type": "array", "items": { "type": "string", "enum": [ "SMALL", "LARGE", "HD" ] } }, "AdsReportMetrics_campaign_targeting_content_video_durations": { "type": "array", "items": { "type": "string", "enum": [ "SHORT", "MEDIUM", "LONG" ] } }, "AdsReportMetrics_campaign_targeting_content_video": { "type": "object", "properties": { "youtube_videos": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_video_youtube_videos" }, "excluded_youtube_videos": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_video_excluded_youtube_videos" }, "youtube_channels": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_video_youtube_channels" }, "excluded_youtube_channels": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_video_excluded_youtube_channels" }, "positions": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_video_positions" }, "player_sizes": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_video_player_sizes" }, "durations": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_video_durations" } } }, "AdsReportMetrics_campaign_targeting_content": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "excluded_keywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "topics": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_topics": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "urls": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_urls" }, "excluded_urls": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_excluded_urls" }, "video": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content_video" } } }, "AdsReportMetrics_campaign_targeting_brand_safety_excluded_publisher_categories": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_brand_safety_excluded_content_labels": { "type": "array", "items": { "type": "string" }, "description": "Google Ads ContentLabelType" }, "AdsReportMetrics_campaign_targeting_brand_safety_brand_safety_content_filter_levels": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_brand_safety_publisher_visibility_categories": { "type": "array", "items": { "type": "string", "enum": [ "limited", "standard", "expanded" ] } }, "AdsReportMetrics_campaign_targeting_brand_safety_block_list_ids": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_targeting_brand_safety": { "type": "object", "properties": { "excluded_publisher_categories": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_brand_safety_excluded_publisher_categories" }, "excluded_content_labels": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_brand_safety_excluded_content_labels", "description": "Google Ads ContentLabelType" }, "brand_safety_content_filter_levels": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_brand_safety_brand_safety_content_filter_levels" }, "publisher_visibility_categories": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_brand_safety_publisher_visibility_categories" }, "block_list_ids": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_brand_safety_block_list_ids" } }, "description": "Brand safety (Meta: excluded_publisher_categories, etc.; Google" }, "AdsReportMetrics_campaign_targeting_optimization": { "type": "object", "properties": { "mode": { "type": "string", "description": "Google: bid_only falsetrue", "enum": [ "TARGETING", "OBSERVATION" ] }, "advantage_audience": { "type": "boolean" }, "advantage_placements": { "type": "boolean" }, "targeting_optimization_expansion_all": { "type": "boolean" } }, "description": "Optimization (Meta: targeting_automation; Google: observation vs targeting mode)" }, "AdsReportMetrics_campaign_targeting": { "type": "object", "properties": { "geographic": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_geographic" }, "demographic": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_demographic", "description": "Demographic targeting (Meta: age_min, age_max, genders)" }, "audience": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_audience" }, "placement": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_placement" }, "device": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_device" }, "language": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "content": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_content" }, "brand_safety": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_brand_safety", "description": "Brand safety (Meta: excluded_publisher_categories, etc.; Google" }, "schedule": { "type": "array", "items": { "$ref": "#/definitions/AdSchedule" } }, "optimization": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting_optimization", "description": "Optimization (Meta: targeting_automation; Google: observation vs targeting mode)" } } }, "AdsReportMetrics_campaign_frequency_cap": { "type": "object", "properties": { "is_unlimited": { "type": "boolean" }, "time_unit": { "type": "string", "enum": [ "UNSPECIFIED", "LIFETIME", "MONTHS", "WEEKS", "DAYS", "HOURS", "MINUTES" ] }, "time_unit_count": { "type": "number" }, "max_impressions": { "type": "number" }, "max_views": { "type": "number" } } }, "AdsReportMetrics_campaign_labels": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_campaign_kpi": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "UNSPECIFIED", "CPM", "CPC", "CPA", "CTR", "VIEWABILITY", "CPIAVC", "CPE", "CPV", "CLICK_CVR", "IMPRESSION_CVR", "VCPM", "VTR", "AUDIO_COMPLETION_RATE", "VIDEO_COMPLETION_RATE", "CPCL", "CPCV", "TOS10", "MAXIMIZE_PACING", "CUSTOM_IMPRESSION_VALUE_OVER_COST", "OTHER" ] }, "amount": { "type": "number" }, "percentage": { "type": "number" }, "string_value": { "type": "string" }, "algorithm_id": { "type": "string" } } }, "AdsReportMetrics_campaign": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "effective_status": { "type": "string", "description": "read-only; controlled by the provider (whether/why the campaign can serve), unlike the user-managed status", "enum": [ "UNSPECIFIED", "SERVING", "LIMITED", "LEARNING", "PAUSED", "PENDING", "ENDED", "MISCONFIGURED", "NOT_ELIGIBLE", "ARCHIVED", "REMOVED" ] }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "budget_amount": { "type": "number" }, "budget_period": { "type": "string", "enum": [ "DAILY", "MONTHLY", "TOTAL", "LIFETIME" ] }, "budget_unit": { "type": "string", "enum": [ "UNSPECIFIED", "CURRENCY", "IMPRESSIONS" ] }, "total_spend_amount": { "type": "number" }, "targeting": { "$ref": "#/definitions/AdsReportMetrics_campaign_targeting" }, "goal": { "type": "string", "enum": [ "UNSPECIFIED", "BRAND_AWARENESS", "ENGAGEMENT", "REACH", "WEBSITE_TRAFFIC", "LEADS", "SALES", "APP_PROMOTION" ] }, "planned_spend_amount": { "type": "number" }, "frequency_cap": { "$ref": "#/definitions/AdsReportMetrics_campaign_frequency_cap" }, "advertising_channel_type": { "type": "string", "enum": [ "TEXT", "IMAGE", "VIDEO", "RESPONSIVE", "SHOPPING", "APP", "CALL", "CAROUSEL", "SOCIAL", "DISPLAY", "SEARCH", "AUDIO", "YOUTUBE", "NATIVE", "CTV", "DOOH", "PERFORMANCE_MAX" ] }, "campaign_budget_identifier": { "type": "string", "description": "Resource name for existing/shared budget (Google)" }, "currency": { "type": "string" }, "category": { "type": "string", "description": "Housing, employment, credit, NONE (Meta)" }, "has_eu_political_ads": { "type": "boolean" }, "labels": { "$ref": "#/definitions/AdsReportMetrics_campaign_labels" }, "kpi": { "$ref": "#/definitions/AdsReportMetrics_campaign_kpi" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsReportMetrics_group_targeting_geographic_location_types": { "type": "array", "items": { "type": "string", "enum": [ "HOME", "RECENT", "TRAVEL" ] } }, "AdsReportMetrics_group_targeting_geographic": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "regions": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "cities": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "postal_codes": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "us_dmas": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_countries": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_regions": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_cities": { "type": "array", "items": { "$ref": "#/definitions/CityTarget" } }, "excluded_postal_codes": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_us_dmas": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "location_types": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_geographic_location_types" }, "presence_type": { "type": "string", "enum": [ "PRESENCE", "PRESENCE_OR_INTEREST" ] } } }, "AdsReportMetrics_group_targeting_demographic": { "type": "object", "properties": { "age_min": { "type": "number" }, "age_max": { "type": "number" }, "male": { "type": "boolean" }, "female": { "type": "boolean" } }, "description": "Demographic targeting (Meta: age_min, age_max, genders)" }, "AdsReportMetrics_group_targeting_audience": { "type": "object", "properties": { "custom_audiences": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_custom_audiences": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "lookalike_audiences": { "type": "array", "items": { "$ref": "#/definitions/LookalikeAudience" } }, "interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_interests": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_behaviors": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "combination_spec": { "type": "array", "items": { "$ref": "#/definitions/AudienceCombination" } } } }, "AdsReportMetrics_group_targeting_placement_platforms": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_placement_facebook_positions": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_placement_instagram_positions": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_placement_messenger_positions": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_placement_audience_network_positions": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_placement": { "type": "object", "properties": { "platforms": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_placement_platforms" }, "facebook_positions": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_placement_facebook_positions" }, "instagram_positions": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_placement_instagram_positions" }, "messenger_positions": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_placement_messenger_positions" }, "audience_network_positions": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_placement_audience_network_positions" } } }, "AdsReportMetrics_group_targeting_device": { "type": "object", "properties": { "types": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "user_device": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "user_os": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "carriers": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } } } }, "AdsReportMetrics_group_targeting_content_urls": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_content_excluded_urls": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_content_video_youtube_videos": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_content_video_excluded_youtube_videos": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_content_video_youtube_channels": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_content_video_excluded_youtube_channels": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_content_video_positions": { "type": "array", "items": { "type": "string", "enum": [ "PREROLL", "MIDROLL", "POSTROLL", "INSTREAM", "OUTSTREAM" ] } }, "AdsReportMetrics_group_targeting_content_video_player_sizes": { "type": "array", "items": { "type": "string", "enum": [ "SMALL", "LARGE", "HD" ] } }, "AdsReportMetrics_group_targeting_content_video_durations": { "type": "array", "items": { "type": "string", "enum": [ "SHORT", "MEDIUM", "LONG" ] } }, "AdsReportMetrics_group_targeting_content_video": { "type": "object", "properties": { "youtube_videos": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_video_youtube_videos" }, "excluded_youtube_videos": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_video_excluded_youtube_videos" }, "youtube_channels": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_video_youtube_channels" }, "excluded_youtube_channels": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_video_excluded_youtube_channels" }, "positions": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_video_positions" }, "player_sizes": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_video_player_sizes" }, "durations": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_video_durations" } } }, "AdsReportMetrics_group_targeting_content": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "excluded_keywords": { "type": "array", "items": { "$ref": "#/definitions/AdsKeyword" } }, "topics": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "excluded_topics": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "urls": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_urls" }, "excluded_urls": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_excluded_urls" }, "video": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content_video" } } }, "AdsReportMetrics_group_targeting_brand_safety_excluded_publisher_categories": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_brand_safety_excluded_content_labels": { "type": "array", "items": { "type": "string" }, "description": "Google Ads ContentLabelType" }, "AdsReportMetrics_group_targeting_brand_safety_brand_safety_content_filter_levels": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_brand_safety_publisher_visibility_categories": { "type": "array", "items": { "type": "string", "enum": [ "limited", "standard", "expanded" ] } }, "AdsReportMetrics_group_targeting_brand_safety_block_list_ids": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group_targeting_brand_safety": { "type": "object", "properties": { "excluded_publisher_categories": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_brand_safety_excluded_publisher_categories" }, "excluded_content_labels": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_brand_safety_excluded_content_labels", "description": "Google Ads ContentLabelType" }, "brand_safety_content_filter_levels": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_brand_safety_brand_safety_content_filter_levels" }, "publisher_visibility_categories": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_brand_safety_publisher_visibility_categories" }, "block_list_ids": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_brand_safety_block_list_ids" } }, "description": "Brand safety (Meta: excluded_publisher_categories, etc.; Google" }, "AdsReportMetrics_group_targeting_optimization": { "type": "object", "properties": { "mode": { "type": "string", "description": "Google: bid_only falsetrue", "enum": [ "TARGETING", "OBSERVATION" ] }, "advantage_audience": { "type": "boolean" }, "advantage_placements": { "type": "boolean" }, "targeting_optimization_expansion_all": { "type": "boolean" } }, "description": "Optimization (Meta: targeting_automation; Google: observation vs targeting mode)" }, "AdsReportMetrics_group_targeting": { "type": "object", "properties": { "geographic": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_geographic" }, "demographic": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_demographic", "description": "Demographic targeting (Meta: age_min, age_max, genders)" }, "audience": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_audience" }, "placement": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_placement" }, "device": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_device" }, "language": { "type": "array", "items": { "$ref": "#/definitions/TargetRef" } }, "content": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_content" }, "brand_safety": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_brand_safety", "description": "Brand safety (Meta: excluded_publisher_categories, etc.; Google" }, "schedule": { "type": "array", "items": { "$ref": "#/definitions/AdSchedule" } }, "optimization": { "$ref": "#/definitions/AdsReportMetrics_group_targeting_optimization", "description": "Optimization (Meta: targeting_automation; Google: observation vs targeting mode)" } } }, "AdsReportMetrics_group_bid_strategy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIXED_BID", "MAXIMIZE_SPEND", "PERFORMANCE_GOAL", "YOUTUBE_AND_PARTNERS" ] }, "fixed_bid_amount": { "type": "number" }, "performance_goal_type": { "type": "string", "enum": [ "UNSPECIFIED", "CPA", "CPC", "VIEWABLE_CPM", "CUSTOM_ALGO", "CIVA", "IVO_TEN", "AV_VIEWED", "REACH" ] }, "performance_goal_amount": { "type": "number" }, "max_average_cpm_bid_amount": { "type": "number" }, "custom_bidding_algorithm_id": { "type": "string" }, "raise_bid_for_deals": { "type": "boolean" }, "youtube_and_partners_type": { "type": "string", "enum": [ "UNSPECIFIED", "MANUAL_CPV", "MANUAL_CPM", "TARGET_CPA", "TARGET_CPM", "RESERVE_CPM", "MAXIMIZE_LIFT", "MAXIMIZE_CONVERSIONS", "TARGET_CPV", "TARGET_ROAS", "MAXIMIZE_CONVERSION_VALUE" ] }, "youtube_and_partners_value": { "type": "string" }, "target_roas": { "type": "number", "description": "Target ROAS e.g. 2.5 = 250% (Google)" } }, "required": [ "type" ], "description": "YOUTUBE_AND_PARTNERS" }, "AdsReportMetrics_group_pacing": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "UNSPECIFIED", "DAILY", "FLIGHT" ] }, "type": { "type": "string" }, "daily_max_amount": { "type": "number" }, "daily_max_impressions": { "type": "number" } } }, "AdsReportMetrics_group_frequency_cap": { "type": "object", "properties": { "is_unlimited": { "type": "boolean" }, "time_unit": { "type": "string", "enum": [ "UNSPECIFIED", "LIFETIME", "MONTHS", "WEEKS", "DAYS", "HOURS", "MINUTES" ] }, "time_unit_count": { "type": "number" }, "max_impressions": { "type": "number" }, "max_views": { "type": "number" } } }, "AdsReportMetrics_group_creative_ids": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_group": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "parent_id": { "type": "string" }, "campaign_id": { "type": "string" }, "organization_id": { "type": "string" }, "insertionorder_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "effective_status": { "type": "string", "enum": [ "UNSPECIFIED", "SERVING", "LIMITED", "LEARNING", "PAUSED", "PENDING", "ENDED", "MISCONFIGURED", "NOT_ELIGIBLE", "ARCHIVED", "REMOVED" ] }, "targeting": { "$ref": "#/definitions/AdsReportMetrics_group_targeting" }, "bid_amount": { "type": "number" }, "bid_strategy": { "$ref": "#/definitions/AdsReportMetrics_group_bid_strategy", "description": "YOUTUBE_AND_PARTNERS" }, "budget_amount": { "type": "number" }, "budget_period": { "type": "string", "enum": [ "DAILY", "MONTHLY", "TOTAL", "LIFETIME" ] }, "budget_allocation_type": { "type": "string", "enum": [ "UNSPECIFIED", "AUTOMATIC", "FIXED", "UNLIMITED" ] }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "budget_unit": { "type": "string", "enum": [ "UNSPECIFIED", "CURRENCY", "IMPRESSIONS" ] }, "budget_max_amount": { "type": "number" }, "type": { "type": "string", "enum": [ "TEXT", "IMAGE", "VIDEO", "RESPONSIVE", "SHOPPING", "APP", "CALL", "CAROUSEL", "SOCIAL", "DISPLAY", "SEARCH", "AUDIO", "YOUTUBE", "NATIVE", "CTV", "DOOH", "PERFORMANCE_MAX" ] }, "has_eu_political_ads": { "type": "boolean" }, "pacing": { "$ref": "#/definitions/AdsReportMetrics_group_pacing" }, "frequency_cap": { "$ref": "#/definitions/AdsReportMetrics_group_frequency_cap" }, "creative_ids": { "$ref": "#/definitions/AdsReportMetrics_group_creative_ids" }, "optimization_goal": { "type": "string", "description": "Optimization goals for ads_group (cross-platform; platform-specific values allowed as pass-through)", "enum": [ "REACH", "IMPRESSIONS", "LINK_CLICKS", "LANDING_PAGE_VIEWS", "CONVERSIONS", "LEAD_GENERATION", "APP_INSTALLS", "APP_ENGAGEMENT", "VIDEO_VIEWS", "ENGAGEMENT", "PAGE_LIKES", "MESSAGES" ] }, "billing_event": { "type": "string", "description": "Billing events for ads_group (what you pay for; cross-platform; platform-specific values allowed as pass-through)", "enum": [ "IMPRESSIONS", "LINK_CLICKS", "VIDEO_VIEWS", "APP_INSTALLS", "ENGAGEMENT", "PAGE_LIKES", "MESSAGES", "POST_ENGAGEMENT", "PURCHASE", "NONE" ] }, "currency": { "type": "string" }, "promoted": { "type": "array", "items": { "$ref": "#/definitions/AdsPromoted" } }, "language_locale": { "type": "string", "description": "Language + region, ISO 639-1 with region (e.g. en-US); LinkedIn locale" }, "creative_selection": { "type": "string", "description": "Creative rotation strategy (LinkedIn creativeSelection)", "enum": [ "OPTIMIZED", "ROUND_ROBIN" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsReportMetrics_ad_creative_ids": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_ad": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "campaign_id": { "type": "string" }, "group_id": { "type": "string", "description": "(reference to AdsGroup)" }, "organization_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "ad_type": { "type": "string", "enum": [ "TEXT", "IMAGE", "VIDEO", "RESPONSIVE", "SHOPPING", "APP", "CALL", "CAROUSEL", "SOCIAL", "DISPLAY", "SEARCH", "AUDIO", "YOUTUBE", "NATIVE", "CTV", "DOOH", "PERFORMANCE_MAX" ] }, "advertiser_name": { "type": "string" }, "creative_ids": { "$ref": "#/definitions/AdsReportMetrics_ad_creative_ids" }, "creative_asset_url": { "type": "string" }, "ad_copy": { "type": "string" }, "headline": { "type": "string" }, "description": { "type": "string" }, "cta": { "type": "string" }, "final_url": { "type": "string" }, "display_url": { "type": "string" }, "path1": { "type": "string" }, "path2": { "type": "string" }, "promoted": { "type": "array", "items": { "$ref": "#/definitions/AdsPromoted" } }, "logo_creative_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsReportMetrics_creative_asset_urls": { "type": "array", "items": { "type": "string" }, "description": "Hosted asset mode (best-effort, provider-specific" }, "AdsReportMetrics_creative_labels": { "type": "array", "items": { "type": "string" } }, "AdsReportMetrics_creative": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "campaign_id": { "type": "string" }, "group_id": { "type": "string", "description": "(reference to AdsGroup)" }, "item_id": { "type": "string", "description": "references Commerce Item ID (reference to CommerceItem)" }, "organization_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "creative_type": { "type": "string", "enum": [ "UNSPECIFIED", "STANDARD", "EXPANDABLE", "VIDEO", "NATIVE", "AUDIO", "PUBLISHER_HOSTED", "ASSET_BASED", "IMAGE", "DOCUMENT", "SHARE" ] }, "hosting_source": { "type": "string", "enum": [ "UNSPECIFIED", "CM", "THIRD_PARTY", "HOSTED", "RICH_MEDIA", "PUBLISHER_HOSTED" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "asset_urls": { "$ref": "#/definitions/AdsReportMetrics_creative_asset_urls", "description": "Hosted asset mode (best-effort, provider-specific" }, "link_url": { "type": "string", "description": "Destination URL for creatives with links" }, "url_tags": { "type": "string", "description": "Appended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template" }, "body": { "type": "string" }, "title": { "type": "string" }, "cta": { "type": "string" }, "third_party_tag": { "type": "string" }, "vast_tag_url": { "type": "string" }, "external_creative_reference": { "type": "string" }, "external_placement_reference": { "type": "string" }, "external_ad_reference": { "type": "string" }, "promoted": { "type": "array", "items": { "$ref": "#/definitions/AdsPromoted" } }, "path1": { "type": "string", "description": "Display URL path 1 (Microsoft RSA Path1)" }, "path2": { "type": "string", "description": "Display URL path 2 (Microsoft RSA Path2)" }, "data": { "type": "string" }, "labels": { "$ref": "#/definitions/AdsReportMetrics_creative_labels" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsReportMetrics_insertionorder_pacing": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "UNSPECIFIED", "DAILY", "FLIGHT" ] }, "type": { "type": "string" }, "daily_max_amount": { "type": "number" }, "daily_max_impressions": { "type": "number" } } }, "AdsReportMetrics_insertionorder_frequency_cap": { "type": "object", "properties": { "is_unlimited": { "type": "boolean" }, "time_unit": { "type": "string", "enum": [ "UNSPECIFIED", "LIFETIME", "MONTHS", "WEEKS", "DAYS", "HOURS", "MINUTES" ] }, "time_unit_count": { "type": "number" }, "max_impressions": { "type": "number" }, "max_views": { "type": "number" } } }, "AdsReportMetrics_insertionorder_kpi": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "UNSPECIFIED", "CPM", "CPC", "CPA", "CTR", "VIEWABILITY", "CPIAVC", "CPE", "CPV", "CLICK_CVR", "IMPRESSION_CVR", "VCPM", "VTR", "AUDIO_COMPLETION_RATE", "VIDEO_COMPLETION_RATE", "CPCL", "CPCV", "TOS10", "MAXIMIZE_PACING", "CUSTOM_IMPRESSION_VALUE_OVER_COST", "OTHER" ] }, "amount": { "type": "number" }, "percentage": { "type": "number" }, "string_value": { "type": "string" }, "algorithm_id": { "type": "string" } } }, "AdsReportMetrics_insertionorder_bid_strategy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIXED_BID", "MAXIMIZE_SPEND", "PERFORMANCE_GOAL", "YOUTUBE_AND_PARTNERS" ] }, "fixed_bid_amount": { "type": "number" }, "performance_goal_type": { "type": "string", "enum": [ "UNSPECIFIED", "CPA", "CPC", "VIEWABLE_CPM", "CUSTOM_ALGO", "CIVA", "IVO_TEN", "AV_VIEWED", "REACH" ] }, "performance_goal_amount": { "type": "number" }, "max_average_cpm_bid_amount": { "type": "number" }, "custom_bidding_algorithm_id": { "type": "string" }, "raise_bid_for_deals": { "type": "boolean" }, "youtube_and_partners_type": { "type": "string", "enum": [ "UNSPECIFIED", "MANUAL_CPV", "MANUAL_CPM", "TARGET_CPA", "TARGET_CPM", "RESERVE_CPM", "MAXIMIZE_LIFT", "MAXIMIZE_CONVERSIONS", "TARGET_CPV", "TARGET_ROAS", "MAXIMIZE_CONVERSION_VALUE" ] }, "youtube_and_partners_value": { "type": "string" }, "target_roas": { "type": "number", "description": "Target ROAS e.g. 2.5 = 250% (Google)" } }, "required": [ "type" ], "description": "YOUTUBE_AND_PARTNERS" }, "AdsReportMetrics_insertionorder": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "campaign_id": { "type": "string" }, "status": { "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED" ] }, "pacing": { "$ref": "#/definitions/AdsReportMetrics_insertionorder_pacing" }, "frequency_cap": { "$ref": "#/definitions/AdsReportMetrics_insertionorder_frequency_cap" }, "kpi": { "$ref": "#/definitions/AdsReportMetrics_insertionorder_kpi" }, "budget_unit": { "type": "string", "enum": [ "UNSPECIFIED", "CURRENCY", "IMPRESSIONS" ] }, "budget_segments": { "type": "array", "items": { "$ref": "#/definitions/AdsInsertionorderBudgetSegment" } }, "bid_strategy": { "$ref": "#/definitions/AdsReportMetrics_insertionorder_bid_strategy", "description": "YOUTUBE_AND_PARTNERS" }, "reference": { "type": "string", "description": "client's reference ID for the insertion order" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsReportMetrics_keyword": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "text": { "type": "string" }, "match_type": { "type": "string" }, "engine_id": { "type": "string" }, "landing_page": { "type": "string" } }, "required": [ "id" ] }, "AdsReportMetrics_placement": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ] }, "AdsReportMetrics": { "type": "object", "properties": { "value": { "type": "number" }, "type": { "type": "string", "enum": [ "CLICKS", "IMPRESSIONS", "CONVERSIONS", "COST", "CTR", "CPC", "CONVERSION_VALUE", "CPA", "ROAS", "CPM", "ECPM", "ENGAGEMENT", "VIDEO_COMPLETIONS", "VIDEO_VIEWS", "LEADS", "ENGAGEMENTS", "SAVES", "LIKES", "SHARES", "COMMENTS", "FOLLOWS", "POST_CLICK_CONVERSIONS", "VIEW_THROUGH_CONVERSIONS", "ALL_CONVERSIONS", "ALL_CONVERSION_VALUE", "INTERACTIONS", "REVENUE", "MEDIA_COST", "TOTAL_MEDIA_COST", "VIDEO_PLAYS", "VIDEO_QUARTILE_25", "VIDEO_QUARTILE_50", "VIDEO_QUARTILE_75", "VIDEO_QUARTILE_100", "VIDEO_AVG_TIME_WATCHED", "VIDEO_THRUPLAY", "VIEWABLE_IMPRESSIONS", "MEASURABLE_IMPRESSIONS", "VIEWABILITY_RATE", "BILLABLE_IMPRESSIONS", "DATA_FEES", "PLATFORM_FEES", "PROFIT", "LANDING_PAGE_CLICKS", "LEAD_FORM_OPENS", "AD_UNIT_CLICKS", "CARD_CLICKS", "CARD_IMPRESSIONS", "COMMENT_LIKES", "COMPANY_PAGE_CLICKS", "ACTION_CLICKS", "TEXT_URL_CLICKS", "OTHER_ENGAGEMENTS", "OPENS", "TOTAL_ENGAGEMENTS", "UNIQUE_IMPRESSIONS", "UNIQUE_CLICKS", "VIRAL_IMPRESSIONS", "VIRAL_CLICKS", "VIRAL_LIKES", "VIRAL_COMMENTS", "VIRAL_SHARES", "VIRAL_FOLLOWS", "VIRAL_VIDEO_PLAYS", "VIRAL_VIDEO_VIEWS", "VIRAL_VIDEO_COMPLETIONS", "VIRAL_VIDEO_QUARTILE_25", "VIRAL_VIDEO_QUARTILE_50", "VIRAL_VIDEO_QUARTILE_75", "VIRAL_LEADS", "VIRAL_LEAD_FORM_OPENS", "VIRAL_LANDING_PAGE_CLICKS", "VIRAL_CONVERSIONS", "VIRAL_POST_CLICK_CONVERSIONS", "VIRAL_VIEW_THROUGH_CONVERSIONS", "VIRAL_ENGAGEMENTS", "GMAIL_SECONDARY_CLICKS", "AVERAGE_CPV", "VIDEO_VIEWS_FROM_SEARCH", "CROSS_DEVICE_CONVERSIONS", "ABSOLUTE_TOP_IMPRESSION_SHARE", "TOP_IMPRESSION_SHARE", "ABSOLUTE_TOP_IMPRESSION_RATE_PERCENT", "TOP_IMPRESSION_RATE_PERCENT", "VIDEO_FULLSCREENS", "VIDEO_PAUSES", "VIDEO_MUTES", "VIDEO_SKIPS", "COMPANION_CLICKS", "COMPANION_VIEWS", "ACTIVE_VIEW_AVG_TIME", "ELIGIBLE_IMPRESSIONS", "EARNED_VIEWS", "UNIQUE_VIEWERS", "COST_USD", "VIRAL_CARD_CLICKS", "VIRAL_CARD_IMPRESSIONS", "VIRAL_COMPANY_PAGE_CLICKS", "VIRAL_VIDEO_FULLSCREENS", "VIRAL_OTHER_ENGAGEMENTS", "LEAD_GEN_CONTACT_SHARES", "LEAD_GEN_INTERESTED_CLICKS", "CM360_POST_CLICK_REVENUE", "CM360_POST_VIEW_REVENUE", "SCROLLS", "MEDIA_FEE_1", "MEDIA_FEE_2", "MEDIA_FEE_3", "MEDIA_FEE_4", "MEDIA_FEE_5", "ACTIVE_VIEW_DIST_UNMEASURABLE", "ACTIVE_VIEW_DIST_UNVIEWABLE", "ACTIVE_VIEW_DIST_VIEWABLE", "ACTIVE_VIEW_AUDIBLE_VISIBLE_COMPLETE", "ACTIVE_VIEW_VISIBLE_10S", "NOT_MEASURABLE_IMPRESSIONS", "NOT_VIEWABLE_IMPRESSIONS", "1D_VIEW", "1D_CLICK", "7D_VIEW", "7D_CLICK", "14D_CLICK", "28D_VIEW", "28D_CLICK", "30D_CLICK", "VISITS", "AUDIO_MUTES" ] }, "dimension": { "type": "string", "enum": [ "DATE", "PLATFORM", "PLATFORM_POSITION", "DEVICE" ] }, "dimension_value": { "type": "string" }, "campaign": { "$ref": "#/definitions/AdsReportMetrics_campaign" }, "group": { "$ref": "#/definitions/AdsReportMetrics_group" }, "ad": { "$ref": "#/definitions/AdsReportMetrics_ad" }, "creative": { "$ref": "#/definitions/AdsReportMetrics_creative" }, "insertionorder": { "$ref": "#/definitions/AdsReportMetrics_insertionorder" }, "keyword": { "$ref": "#/definitions/AdsReportMetrics_keyword" }, "placement": { "$ref": "#/definitions/AdsReportMetrics_placement" } } }, "AdsReportMetrics_List": { "type": "array", "items": { "$ref": "#/definitions/AdsReportMetrics" } }, "AdsReport": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "currency": { "type": "string" }, "metrics": { "type": "array", "items": { "$ref": "#/definitions/AdsReportMetrics" } }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "organization_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} } }, "AdsTarget": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "description": "Targeting search types for ads_target list endpoint (Meta: adinterest, adbehavior, adlocale, adgeolocation; Google: geoTargetConstants, user_interest, topic_constant, language_constant)", "enum": [ "INTEREST", "BEHAVIOR", "LOCALE", "COUNTRY", "REGION", "CITY", "ZIP", "US_DMA", "TOPIC", "USER_LIST", "CARRIER", "DEVICE_MODEL", "OS_VERSION" ] }, "is_active": { "type": "boolean" }, "parent_id": { "type": "string" }, "audience_count_min": { "type": "number" }, "audience_count_max": { "type": "number" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AdsMetadata" } }, "raw": {} }, "required": [ "id" ], "description": "Targeting search result (for ads_target list endpoint)" }, "LmsCourse_languages": { "type": "array", "items": { "type": "string" } }, "LmsCourse_categories": { "type": "array", "items": { "type": "string" } }, "LmsMedia_languages": { "type": "array", "items": { "type": "string" }, "description": "ISO 2-digit language codes" }, "LmsMedia": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "IMAGE", "HEADSHOT", "VIDEO", "WEB", "DOCUMENT", "TEXT", "HTML", "OTHER" ] }, "thumbnail_url": { "type": "string" }, "content": { "type": "string", "description": "Inline text/HTML/markdown content (use when url is empty or for embedded content) " }, "languages": { "$ref": "#/definitions/LmsMedia_languages", "description": "ISO 2-digit language codes" } } }, "LmsMedias": { "type": "array", "items": { "$ref": "#/definitions/LmsMedia" } }, "LmsReference": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "LmsReferences": { "type": "array", "items": { "$ref": "#/definitions/LmsReference" } }, "LmsCourse_content_ids": { "type": "array", "items": { "type": "string" } }, "LmsCourse_skills": { "type": "array", "items": { "type": "string" } }, "LmsMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "LmsMetadatas": { "type": "array", "items": { "$ref": "#/definitions/LmsMetadata" } }, "LmsCourse": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "is_private": { "type": "boolean" }, "is_active": { "type": "boolean" }, "price_amount": { "type": "number", "description": "How much the course costs" }, "languages": { "$ref": "#/definitions/LmsCourse_languages" }, "categories": { "$ref": "#/definitions/LmsCourse_categories" }, "currency": { "type": "string", "description": "The currency code (ISO) of the course price" }, "media": { "type": "array", "items": { "$ref": "#/definitions/LmsMedia" } }, "instructors": { "type": "array", "items": { "$ref": "#/definitions/LmsReference" } }, "students": { "type": "array", "items": { "$ref": "#/definitions/LmsReference" } }, "content_ids": { "$ref": "#/definitions/LmsCourse_content_ids" }, "skills": { "$ref": "#/definitions/LmsCourse_skills" }, "duration_minutes": { "type": "number" }, "provider_name": { "type": "string" }, "published_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "time_estimate_minutes": { "type": "number" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LmsMetadata" } }, "raw": {} } }, "LmsClass_languages": { "type": "array", "items": { "type": "string" } }, "LmsClass": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "media": { "type": "array", "items": { "$ref": "#/definitions/LmsMedia" } }, "course_id": { "type": "string", "description": "(reference to Course)" }, "languages": { "$ref": "#/definitions/LmsClass_languages" }, "instructors": { "type": "array", "items": { "$ref": "#/definitions/LmsReference" } }, "students": { "type": "array", "items": { "$ref": "#/definitions/LmsReference" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LmsMetadata" } }, "raw": {} } }, "LmsEmail": { "type": "object", "properties": {} }, "LmsEmails": { "type": "array", "items": { "$ref": "#/definitions/LmsEmail" } }, "LmsTelephone": { "type": "object", "properties": { "telephone": { "type": "string" }, "type": { "type": "string", "enum": [ "WORK", "HOME", "OTHER", "FAX", "MOBILE" ] } }, "required": [ "telephone" ] }, "LmsTelephones": { "type": "array", "items": { "$ref": "#/definitions/LmsTelephone" } }, "LmsStudent_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "LmsStudent": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/LmsEmail" } }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/LmsTelephone" } }, "address": { "$ref": "#/definitions/LmsStudent_address" }, "image_url": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LmsMetadata" } }, "raw": {} } }, "LmsInstructor": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/LmsEmail" } }, "title": { "type": "string" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/LmsTelephone" } }, "image_url": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LmsMetadata" } }, "raw": {} } }, "LmsContent_course_ids": { "type": "array", "items": { "type": "string" } }, "LmsContent_languages": { "type": "array", "items": { "type": "string" } }, "LmsContent_categories": { "type": "array", "items": { "type": "string" } }, "LmsSubject": { "type": "object", "properties": { "name": { "type": "string" }, "rank": { "type": "number", "description": "Depth of this subject in the provider's topic hierarchy (0 = top level)" } } }, "LmsSubjects": { "type": "array", "items": { "$ref": "#/definitions/LmsSubject" }, "description": "Topic taxonomy as {name, rank} pairs carrying the full ancestor chain (rank = depth, 0 = top level)" }, "LmsContent_skills": { "type": "array", "items": { "type": "string" } }, "LmsContent_tags": { "type": "array", "items": { "type": "string" } }, "LmsContentLocalization": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "language": { "type": "string" } } }, "LmsContentLocalizations": { "type": "array", "items": { "$ref": "#/definitions/LmsContentLocalization" } }, "LmsContent_collection_ids": { "type": "array", "items": { "type": "string" } }, "LmsContent": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "external_reference": { "type": "string" }, "course_ids": { "$ref": "#/definitions/LmsContent_course_ids" }, "name": { "type": "string" }, "description": { "type": "string" }, "languages": { "$ref": "#/definitions/LmsContent_languages" }, "media": { "type": "array", "items": { "$ref": "#/definitions/LmsMedia" } }, "is_active": { "type": "boolean" }, "duration_minutes": { "type": "number" }, "categories": { "$ref": "#/definitions/LmsContent_categories" }, "subjects": { "type": "array", "items": { "$ref": "#/definitions/LmsSubject" }, "description": "Topic taxonomy as {name, rank} pairs carrying the full ancestor chain (rank = depth, 0 = top level)" }, "skills": { "$ref": "#/definitions/LmsContent_skills" }, "tags": { "$ref": "#/definitions/LmsContent_tags" }, "difficulty": { "type": "string", "description": "Difficulty or level of the content (e.g. Beginner, Intermediate, Advanced)" }, "sort_order": { "type": "number" }, "provider_name": { "type": "string" }, "short_description": { "type": "string" }, "localizations": { "type": "array", "items": { "$ref": "#/definitions/LmsContentLocalization" } }, "collection_ids": { "$ref": "#/definitions/LmsContent_collection_ids", "description": "(reference to CommerceCollection)" }, "instructors": { "type": "array", "items": { "$ref": "#/definitions/LmsReference" } }, "published_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LmsMetadata" } }, "raw": {} } }, "LmsCollection": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "media": { "type": "array", "items": { "$ref": "#/definitions/LmsMedia" } }, "is_active": { "type": "boolean" }, "parent_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LmsMetadata" } }, "raw": {} } }, "LmsActivity": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "content_id": { "type": "string" }, "course_id": { "type": "string", "description": "For providers that track at course level (e.g., Learnupon enrollments) (reference to Course)" }, "student_id": { "type": "string", "description": "(reference to LmsStudent)" }, "duration_minutes": { "type": "number" }, "assigned_grade": { "type": "string" }, "is_completed": { "type": "boolean" }, "progress_percentage": { "type": "number" }, "started_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "completed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LmsMetadata" } }, "raw": {} } }, "RepoOrganization_user_ids": { "type": "array", "items": { "type": "string" }, "description": "id values of the users/employees associated with this organization" }, "RepoMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "RepoMetadatas": { "type": "array", "items": { "$ref": "#/definitions/RepoMetadata" } }, "RepoOrganization": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "avatar_url": { "type": "string" }, "web_url": { "type": "string" }, "user_ids": { "$ref": "#/definitions/RepoOrganization_user_ids", "description": "id values of the users/employees associated with this organization (reference to HrisEmployee)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/RepoMetadata" } }, "raw": {} } }, "RepoRepository": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "owner": { "type": "string" }, "is_private": { "type": "boolean" }, "web_url": { "type": "string" }, "org_id": { "type": "string", "description": "(reference to RepoOrganization)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/RepoMetadata" } }, "raw": {} }, "required": [ "name" ] }, "RepoBranch": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "repo_id": { "type": "string", "description": "(reference to RepoRepository)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/RepoMetadata" } }, "raw": {} }, "required": [ "name", "repo_id" ] }, "RepoCommit_pullrequest_ids": { "type": "array", "items": { "type": "string" } }, "RepoCommit": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "repo_id": { "type": "string", "description": "(reference to RepoRepository)" }, "message": { "type": "string" }, "branch_id": { "type": "string", "description": "(reference to RepoBranch)" }, "pullrequest_ids": { "$ref": "#/definitions/RepoCommit_pullrequest_ids" }, "lines_added": { "type": "number" }, "lines_deleted": { "type": "number" }, "lines_changed": { "type": "number" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/RepoMetadata" } }, "raw": {} }, "required": [ "repo_id" ] }, "RepoPullrequest_user_ids": { "type": "array", "items": { "type": "string" } }, "RepoPullrequest_labels": { "type": "array", "items": { "type": "string" } }, "RepoPullrequest_commit_ids": { "type": "array", "items": { "type": "string" } }, "RepoPullrequest": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_ids": { "$ref": "#/definitions/RepoPullrequest_user_ids", "description": "(reference to HrisEmployee)" }, "repo_id": { "type": "string", "description": "(reference to RepoRepository)" }, "title": { "type": "string" }, "notes": { "type": "string" }, "target_branch_id": { "type": "string" }, "source_branch_id": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED" ] }, "labels": { "$ref": "#/definitions/RepoPullrequest_labels" }, "closed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "commit_ids": { "$ref": "#/definitions/RepoPullrequest_commit_ids", "description": "(reference to RepoCommit)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/RepoMetadata" } }, "raw": {} } }, "MetadataMetadata_options": { "type": "array", "items": { "type": "string" } }, "MetadataMetadata_objects": { "type": "object", "additionalProperties": { "type": "string" } }, "MetadataMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "slug": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "original_format": { "type": "string" }, "options": { "$ref": "#/definitions/MetadataMetadata_options" }, "object_type": { "type": "string", "description": "This is the unified object type that this metadata is associated with. eg. crm_contact or commerce_item" }, "objects": { "$ref": "#/definitions/MetadataMetadata_objects" }, "is_required": { "type": "boolean", "description": "When true, this metadata slug is required for create for this integration." }, "raw": {} }, "required": [ "name", "object_type" ] }, "FormField_choices": { "type": "array", "items": { "type": "string" }, "description": "For select/radio/checkbox fields" }, "FormField": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT", "TEXTAREA", "NUMBER", "EMAIL", "URL", "DATE", "TIME", "DATETIME", "PHONE", "BOOLEAN", "SINGLE_SELECT", "MULTIPLE_SELECT", "FILE_UPLOAD", "RATING", "SCALE", "MATRIX", "SECTION_HEADER", "OTHER" ] }, "is_required": { "type": "boolean" }, "is_active": { "type": "boolean" }, "choices": { "$ref": "#/definitions/FormField_choices", "description": "For select/radio/checkbox fields" }, "default_value": { "type": "string" }, "min": { "type": "number" }, "max": { "type": "number" }, "pattern": { "type": "string" }, "min_length": { "type": "number" }, "max_length": { "type": "number" }, "order": { "type": "number" } }, "required": [ "name", "type" ] }, "FormFields": { "type": "array", "items": { "$ref": "#/definitions/FormField" } }, "FormsMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "FormsMetadatas": { "type": "array", "items": { "$ref": "#/definitions/FormsMetadata" } }, "FormsForm": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/FormField" } }, "is_active": { "type": "boolean" }, "published_url": { "type": "string" }, "response_count": { "type": "number" }, "has_multiple_submissions": { "type": "boolean" }, "has_progress_bar": { "type": "boolean" }, "has_shuffle_questions": { "type": "boolean" }, "confirmation_message": { "type": "string" }, "confirmation_redirect_url": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/FormsMetadata" } }, "raw": {} } }, "FormAnswer_file_ids": { "type": "array", "items": { "type": "string" }, "description": "references StorageFile ID" }, "FormAnswer": { "type": "object", "properties": { "field_id": { "type": "string" }, "field_name": { "type": "string" }, "value": { "type": "string", "description": "Can be string, number, boolean, array, etc." }, "file_ids": { "$ref": "#/definitions/FormAnswer_file_ids", "description": "references StorageFile ID" } }, "required": [ "field_id" ] }, "FormAnswers": { "type": "array", "items": { "$ref": "#/definitions/FormAnswer" } }, "FormsSubmission": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "form_id": { "type": "string" }, "respondent_email": { "type": "string" }, "respondent_name": { "type": "string" }, "answers": { "type": "array", "items": { "$ref": "#/definitions/FormAnswer" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/FormsMetadata" } }, "raw": {} }, "required": [ "form_id", "answers" ] }, "DatastoreMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "DatastoreMetadatas": { "type": "array", "items": { "$ref": "#/definitions/DatastoreMetadata" } }, "DatastoreDatabase": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "web_url": { "type": "string" }, "is_active": { "type": "boolean" }, "password": { "type": "string" }, "region": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/DatastoreMetadata" } }, "raw": {} } }, "DatastoreField_default_value_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreField_default_value": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreField_default_value_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreField": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "CURRENCY", "URL", "EMAIL", "PHONE", "LINKED_RECORD", "RELATION" ] }, "original_type": { "type": "string" }, "is_required": { "type": "boolean" }, "is_indexed": { "type": "boolean" }, "is_primary_key": { "type": "boolean" }, "is_unique": { "type": "boolean" }, "is_nullable": { "type": "boolean" }, "max_length": { "type": "number" }, "precision": { "type": "number" }, "scale": { "type": "number" }, "default_value": { "$ref": "#/definitions/DatastoreField_default_value" }, "description": { "type": "string" }, "raw": {} }, "required": [ "name", "type", "original_type" ] }, "DatastoreFields": { "type": "array", "items": { "$ref": "#/definitions/DatastoreField" } }, "DatastoreRelationship": { "type": "object", "properties": { "name": { "type": "string" }, "field": { "type": "string" }, "table_id": { "type": "string", "description": "target Database Table ID" }, "type": { "type": "string", "enum": [ "ONE", "MANY" ] } }, "required": [ "name", "field", "table_id", "type" ] }, "DatastoreRelationships": { "type": "array", "items": { "$ref": "#/definitions/DatastoreRelationship" } }, "DatastoreTable": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "database_id": { "type": "string", "description": "source Database ID" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/DatastoreField" } }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/DatastoreRelationship" } }, "web_url": { "type": "string" }, "parent_id": { "type": "string" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/DatastoreMetadata" } }, "raw": {} } }, "DatastoreFieldValue_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFieldValue": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFieldValue_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreRecord_fields": { "type": "object", "additionalProperties": { "$ref": "#/definitions/DatastoreFieldValue" } }, "DatastoreRecord": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "database_id": { "type": "string", "description": "source Database ID" }, "table_id": { "type": "string", "description": "source Database Table ID" }, "fields": { "$ref": "#/definitions/DatastoreRecord_fields" }, "row_number": { "type": "number" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/DatastoreMetadata" } }, "raw": {} }, "required": [ "fields" ] }, "DatastoreQuery_query_select": { "type": "array", "items": { "type": "string" } }, "DatastoreQueryExpand_select": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_eq_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_eq": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_eq_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition_neq_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_neq": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_neq_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition_gt_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_gt": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_gt_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition_gte_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_gte": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_gte_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition_lt_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_lt": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_lt_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition_lte_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_lte": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_lte_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition_like_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_like": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_like_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition_ilike_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_ilike": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_ilike_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFieldValues": { "type": "array", "items": { "$ref": "#/definitions/DatastoreFieldValue" } }, "DatastoreFilter_condition_contains_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_contains": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_contains_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition_not_contains_selection": { "type": "array", "items": { "type": "string" } }, "DatastoreFilter_condition_not_contains": { "type": "object", "properties": { "string": { "type": "string" }, "number": { "type": "number" }, "boolean": { "type": "boolean" }, "date": { "type": "string" }, "selection": { "$ref": "#/definitions/DatastoreFilter_condition_not_contains_selection" }, "is_null": { "type": "boolean" } } }, "DatastoreFilter_condition": { "type": "object", "properties": { "eq": { "$ref": "#/definitions/DatastoreFilter_condition_eq" }, "neq": { "$ref": "#/definitions/DatastoreFilter_condition_neq" }, "gt": { "$ref": "#/definitions/DatastoreFilter_condition_gt" }, "gte": { "$ref": "#/definitions/DatastoreFilter_condition_gte" }, "lt": { "$ref": "#/definitions/DatastoreFilter_condition_lt" }, "lte": { "$ref": "#/definitions/DatastoreFilter_condition_lte" }, "like": { "$ref": "#/definitions/DatastoreFilter_condition_like" }, "ilike": { "$ref": "#/definitions/DatastoreFilter_condition_ilike" }, "in": { "type": "array", "items": { "$ref": "#/definitions/DatastoreFieldValue" } }, "contains": { "$ref": "#/definitions/DatastoreFilter_condition_contains" }, "not_contains": { "$ref": "#/definitions/DatastoreFilter_condition_not_contains" }, "is_null": { "type": "boolean" }, "is_not_null": { "type": "boolean" } } }, "DatastoreFilter": { "type": "object", "properties": { "field": { "type": "string" }, "condition": { "$ref": "#/definitions/DatastoreFilter_condition" } }, "required": [ "field", "condition" ] }, "DatastoreFilters": { "type": "array", "items": { "$ref": "#/definitions/DatastoreFilter" } }, "DatastoreQueryExpand_filter_ands": { "type": "array", "items": {} }, "DatastoreQueryExpand_filter_ors": { "type": "array", "items": {} }, "DatastoreQueryExpand_filter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FILTER", "AND", "OR" ] }, "filters": { "type": "array", "items": { "$ref": "#/definitions/DatastoreFilter" } }, "and": { "$ref": "#/definitions/DatastoreQueryExpand_filter_and" }, "or": { "$ref": "#/definitions/DatastoreQueryExpand_filter_or" } }, "required": [ "type" ] }, "DatastoreQueryExpand_expand": { "type": "object", "additionalProperties": {} }, "DatastoreQueryExpand": { "type": "object", "properties": { "select": { "$ref": "#/definitions/DatastoreQueryExpand_select" }, "filter": { "$ref": "#/definitions/DatastoreQueryExpand_filter" }, "limit": { "type": "number" }, "expand": { "$ref": "#/definitions/DatastoreQueryExpand_expand" } } }, "DatastoreQuery_query_expand": { "type": "object", "additionalProperties": { "$ref": "#/definitions/DatastoreQueryExpand" } }, "DatastoreQuery_query_filter_ands": { "type": "array", "items": {} }, "DatastoreQuery_query_filter_ors": { "type": "array", "items": {} }, "DatastoreQuery_query_filter": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FILTER", "AND", "OR" ] }, "filters": { "type": "array", "items": { "$ref": "#/definitions/DatastoreFilter" } }, "and": { "$ref": "#/definitions/DatastoreQuery_query_filter_and" }, "or": { "$ref": "#/definitions/DatastoreQuery_query_filter_or" } }, "required": [ "type" ] }, "DatastoreQuery_query_sort_fields": { "type": "array", "items": { "type": "string" } }, "DatastoreQuery_query_aggregate_sum": { "type": "object", "properties": { "field": { "type": "string" }, "alias": { "type": "string" } }, "required": [ "field" ] }, "DatastoreQuery_query_aggregate_avg": { "type": "object", "properties": { "field": { "type": "string" }, "alias": { "type": "string" } }, "required": [ "field" ] }, "DatastoreQuery_query_aggregate_min": { "type": "object", "properties": { "field": { "type": "string" }, "alias": { "type": "string" } }, "required": [ "field" ] }, "DatastoreQuery_query_aggregate_max": { "type": "object", "properties": { "field": { "type": "string" }, "alias": { "type": "string" } }, "required": [ "field" ] }, "DatastoreQuery_query_aggregate_group_by": { "type": "array", "items": { "type": "string" } }, "DatastoreQuery_query_aggregate": { "type": "object", "properties": { "count": { "type": "boolean" }, "sum": { "$ref": "#/definitions/DatastoreQuery_query_aggregate_sum" }, "avg": { "$ref": "#/definitions/DatastoreQuery_query_aggregate_avg" }, "min": { "$ref": "#/definitions/DatastoreQuery_query_aggregate_min" }, "max": { "$ref": "#/definitions/DatastoreQuery_query_aggregate_max" }, "group_by": { "$ref": "#/definitions/DatastoreQuery_query_aggregate_group_by" } } }, "DatastoreQuery_query": { "type": "object", "properties": { "sql": { "type": "string", "description": "Raw SQL – when set, executed directly (table_id optional)" }, "select": { "$ref": "#/definitions/DatastoreQuery_query_select" }, "expand": { "$ref": "#/definitions/DatastoreQuery_query_expand" }, "filter": { "$ref": "#/definitions/DatastoreQuery_query_filter" }, "sort_fields": { "$ref": "#/definitions/DatastoreQuery_query_sort_fields" }, "sort_order": { "type": "string", "enum": [ "asc", "desc" ] }, "limit": { "type": "number" }, "offset": { "type": "number" }, "aggregate": { "$ref": "#/definitions/DatastoreQuery_query_aggregate" }, "is_count_only": { "type": "boolean" } } }, "DatastoreRecords": { "type": "array", "items": { "$ref": "#/definitions/DatastoreRecord" } }, "DatastoreQuery_response_aggregates_sum": { "type": "object", "additionalProperties": { "type": "number" } }, "DatastoreQuery_response_aggregates_avg": { "type": "object", "additionalProperties": { "type": "number" } }, "DatastoreQuery_response_aggregates_min": { "type": "object", "additionalProperties": { "type": "number" } }, "DatastoreQuery_response_aggregates_max": { "type": "object", "additionalProperties": { "type": "number" } }, "": { "type": "object", "additionalProperties": { "$ref": "#/definitions/DatastoreFieldValue" } }, "DatastoreQuery_response_aggregates_groups": { "type": "array", "items": { "$ref": "#/definitions/" } }, "DatastoreQuery_response_aggregates": { "type": "object", "properties": { "count": { "type": "number" }, "sum": { "$ref": "#/definitions/DatastoreQuery_response_aggregates_sum" }, "avg": { "$ref": "#/definitions/DatastoreQuery_response_aggregates_avg" }, "min": { "$ref": "#/definitions/DatastoreQuery_response_aggregates_min" }, "max": { "$ref": "#/definitions/DatastoreQuery_response_aggregates_max" }, "groups": { "$ref": "#/definitions/DatastoreQuery_response_aggregates_groups" } } }, "DatastoreQuery_response": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/DatastoreRecord" } }, "aggregates": { "$ref": "#/definitions/DatastoreQuery_response_aggregates" }, "total_count": { "type": "number" } } }, "DatastoreQuery": { "type": "object", "properties": { "table_id": { "type": "string" }, "database_id": { "type": "string" }, "query": { "$ref": "#/definitions/DatastoreQuery_query" }, "response": { "$ref": "#/definitions/DatastoreQuery_response" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/DatastoreMetadata" } }, "raw": {} } }, "ShippingShipment_from_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" }, "name": { "type": "string", "description": "Recipientsender name" }, "company_name": { "type": "string", "description": "Company name (for commercial addresses)" }, "telephone": { "type": "string", "description": "Phone number (required by FedEx, UPS, DHL)" }, "email": { "type": "string", "description": "Email address (for delivery notifications)" }, "is_residential": { "type": "boolean", "description": "Alias for address_type === 'RESIDENTIAL'" }, "is_validated": { "type": "boolean", "description": "Whether address has been validated" }, "delivery_instructions": { "type": "string", "description": "Special delivery notes" } }, "description": "Origin address" }, "ShippingShipment_to_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" }, "name": { "type": "string", "description": "Recipientsender name" }, "company_name": { "type": "string", "description": "Company name (for commercial addresses)" }, "telephone": { "type": "string", "description": "Phone number (required by FedEx, UPS, DHL)" }, "email": { "type": "string", "description": "Email address (for delivery notifications)" }, "is_residential": { "type": "boolean", "description": "Alias for address_type === 'RESIDENTIAL'" }, "is_validated": { "type": "boolean", "description": "Whether address has been validated" }, "delivery_instructions": { "type": "string", "description": "Special delivery notes" } }, "description": "Destination address" }, "ShippingPackage": { "type": "object", "properties": { "weight": { "type": "number", "description": "Weight of the package" }, "weight_unit": { "type": "string", "description": "Unit for weight (g, kg, oz, lb)", "enum": [ "g", "kg", "oz", "lb" ] }, "length": { "type": "number", "description": "Length of the package" }, "width": { "type": "number", "description": "Width of the package" }, "height": { "type": "number", "description": "Height of the package" }, "size_unit": { "type": "string", "description": "Unit for dimensions (cm, inch)", "enum": [ "cm", "inch" ] }, "description": { "type": "string", "description": "Description of the package contents" }, "value": { "type": "number", "description": "Declared value of the package" }, "currency": { "type": "string", "description": "ISO 4217 currency code" }, "tracking_number": { "type": "string", "description": "Package-level tracking (for multi-package shipments)" }, "insured_amount": { "type": "number", "description": "Insured value for this package" } } }, "ShippingPackages": { "type": "array", "items": { "$ref": "#/definitions/ShippingPackage" }, "description": "Multiple packages (alternative to package)" }, "ShippingShipment_return_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" }, "name": { "type": "string", "description": "Recipientsender name" }, "company_name": { "type": "string", "description": "Company name (for commercial addresses)" }, "telephone": { "type": "string", "description": "Phone number (required by FedEx, UPS, DHL)" }, "email": { "type": "string", "description": "Email address (for delivery notifications)" }, "is_residential": { "type": "boolean", "description": "Alias for address_type === 'RESIDENTIAL'" }, "is_validated": { "type": "boolean", "description": "Whether address has been validated" }, "delivery_instructions": { "type": "string", "description": "Special delivery notes" } }, "description": "Return address (may differ from from_address)" }, "ShippingCustomsItem": { "type": "object", "properties": { "description": { "type": "string", "description": "Item description" }, "quantity": { "type": "number", "description": "Quantity" }, "amount": { "type": "number", "description": "Value per unit" }, "currency": { "type": "string" }, "weight": { "type": "number", "description": "Weight per unit" }, "weight_unit": { "type": "string", "enum": [ "g", "kg", "oz", "lb" ] }, "harmonized_tariff_code": { "type": "string", "description": "HS code" }, "country_of_origin": { "type": "string", "description": "Country of origin (ISO code)" }, "sku": { "type": "string", "description": "SKU" } } }, "ShippingCustomsItems": { "type": "array", "items": { "$ref": "#/definitions/ShippingCustomsItem" }, "description": "Customs items" }, "ShippingShipment_customs_restrictions": { "type": "array", "items": { "type": "string" }, "description": "Any restrictions" }, "ShippingShipment_customs": { "type": "object", "properties": { "contents_type": { "type": "string", "enum": [ "MERCHANDISE", "DOCUMENTS", "GIFT", "RETURNED_GOODS", "SAMPLE", "OTHER" ] }, "description": { "type": "string", "description": "Explanation of contents" }, "amount": { "type": "number", "description": "Customs declared value" }, "currency": { "type": "string" }, "duties_paid_by": { "type": "string", "enum": [ "SENDER", "RECIPIENT", "THIRD_PARTY" ] }, "taxes_paid_by": { "type": "string", "enum": [ "SENDER", "RECIPIENT", "THIRD_PARTY" ] }, "shipper_eori": { "type": "string", "description": "Exporter EORI number" }, "recipient_eori": { "type": "string", "description": "Importer EORI number" }, "shipper_tax_number": { "type": "string", "description": "Exporter tax ID" }, "recipient_tax_number": { "type": "string", "description": "Importer tax ID" }, "items": { "type": "array", "items": { "$ref": "#/definitions/ShippingCustomsItem" }, "description": "Customs items" }, "restrictions": { "$ref": "#/definitions/ShippingShipment_customs_restrictions", "description": "Any restrictions" }, "non_delivery_option": { "type": "string", "enum": [ "RETURN", "ABANDON" ] } }, "description": "Customs information" }, "ShippingShipment_insurance": { "type": "object", "properties": { "insured_value": { "type": "number", "description": "Insured value" }, "currency": { "type": "string" }, "insurance_provider": { "type": "string", "description": "Insurance provider name" }, "insurance_provider_code": { "type": "string", "description": "Provider code" }, "insurance_cost": { "type": "number", "description": "Cost of insurance" }, "insurance_cost_currency": { "type": "string" }, "coverage_type": { "type": "string", "enum": [ "STANDARD", "PREMIUM", "CUSTOM" ] }, "coverage_amount": { "type": "number", "description": "Coverage amount (may differ from insured_value)" } }, "description": "Insurance details" }, "ShippingShipment_special_instructions": { "type": "array", "items": { "type": "string" }, "description": "Array of special instructions" }, "ShippingShipmentLineitem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this fulfillment line" }, "item_id": { "type": "string", "description": "Reference to the CommerceItem being fulfilled (reference to CommerceItem)" }, "item_variant_id": { "type": "string", "description": "Reference to the CommerceItemvariant being fulfilled (reference to CommerceCommerceItemvariant)" }, "order_lineitem_id": { "type": "string", "description": "The order line being fulfilled" }, "quantity": { "type": "number", "description": "Units fulfilled on this line" }, "item_name": { "type": "string", "description": "Item name (for display)" }, "sku": { "type": "string", "description": "Item SKU" } } }, "ShippingShipmentLineitems": { "type": "array", "items": { "$ref": "#/definitions/ShippingShipmentLineitem" }, "description": "Item-level fulfillment lines (what shipped); used by commerce-platform fulfillments" }, "ShippingMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "ShippingMetadatas": { "type": "array", "items": { "$ref": "#/definitions/ShippingMetadata" } }, "ShippingShipment": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this shipment object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this shipment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this shipment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "order_id": { "type": "string", "description": "Reference to commerce_order or accounting_order" }, "organization_id": { "type": "string", "description": "ref -> accounting Organization this shipment belongs to (multi-company ERPs)" }, "from_address": { "$ref": "#/definitions/ShippingShipment_from_address", "description": "Origin address" }, "to_address": { "$ref": "#/definitions/ShippingShipment_to_address", "description": "Destination address" }, "packages": { "type": "array", "items": { "$ref": "#/definitions/ShippingPackage" }, "description": "Array of packages in this shipment" }, "carrier_id": { "type": "string", "description": "Reference to the carrier" }, "service_code": { "type": "string", "description": "Code for the shipping service used" }, "status": { "type": "string", "description": "Current status of the shipment", "enum": [ "PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED" ] }, "rate_id": { "type": "string", "description": "Optional reference to the selected rate (for traceability)" }, "label_id": { "type": "string", "description": "Optional reference to the shipping label" }, "tracking_id": { "type": "string", "description": "Optional reference to the tracking information" }, "shipped_at": { "type": "string", "format": "date-time", "description": "When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "rate_amount": { "type": "number", "description": "The rate amount used (may differ from shipping_cost due to adjustments)" }, "rate_currency": { "type": "string", "description": "Currency for rate_amount" }, "rate_service_name": { "type": "string", "description": "Service name from the rate (e.g., \"Priority Mail\")" }, "rate_estimated_days": { "type": "number", "description": "Estimated delivery days from the rate" }, "rate_estimated_delivery_at": { "type": "string", "format": "date-time", "description": "Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "is_rate_guaranteed": { "type": "boolean", "description": "Whether delivery is guaranteed (from rate)" }, "return_address": { "$ref": "#/definitions/ShippingShipment_return_address", "description": "Return address (may differ from from_address)" }, "return_authorization_number": { "type": "string", "description": "RMA number if return shipment" }, "warehouse_location_id": { "type": "string", "description": "Origin warehouselocation ID; points to CommerceLocation" }, "warehouse_location_name": { "type": "string", "description": "Origin warehouse location name" }, "customs": { "$ref": "#/definitions/ShippingShipment_customs", "description": "Customs information" }, "is_international": { "type": "boolean", "description": "Whether shipment is international" }, "insurance": { "$ref": "#/definitions/ShippingShipment_insurance", "description": "Insurance details" }, "special_instructions": { "$ref": "#/definitions/ShippingShipment_special_instructions", "description": "Array of special instructions" }, "is_signature_required": { "type": "boolean", "description": "Signature required on delivery" }, "is_adult_signature_required": { "type": "boolean", "description": "Adult signature required" }, "reference_number": { "type": "string", "description": "Customer reference number" }, "is_return": { "type": "boolean", "description": "Whether this is a return shipment" }, "original_shipment_id": { "type": "string", "description": "Reference to original shipment if return; points to ShippingShipment" }, "return_reason": { "type": "string", "description": "Reason for return" }, "return_type": { "type": "string", "description": "Type of return", "enum": [ "CUSTOMER", "VENDOR", "WARRANTY", "DEFECTIVE", "OTHER" ] }, "carrier_name": { "type": "string", "description": "Human-readable carrier/provider name when there is no carrier record to reference (e.g. commerce-platform fulfillments)" }, "tracking_url": { "type": "string", "description": "Carrier tracking URL for this shipment" }, "lineitems": { "type": "array", "items": { "$ref": "#/definitions/ShippingShipmentLineitem" }, "description": "Item-level fulfillment lines (what shipped); used by commerce-platform fulfillments" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ShippingMetadata" } }, "raw": { "description": "The raw data returned by the integration for this shipment" } } }, "ShippingLabel": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this label object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this label object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this label object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "shipment_id": { "type": "string", "description": "Reference to the shipment" }, "tracking_number": { "type": "string", "description": "Tracking number for the shipment" }, "label_url": { "type": "string", "description": "URL to download the label" }, "label_format": { "type": "string", "description": "Format of the label (PDF, PNG, ZPL, EPL2)", "enum": [ "PDF", "PNG", "ZPL", "EPL2", "PDF_4X6", "PDF_4X8", "PNG_4X6", "PNG_4X8" ] }, "status": { "type": "string", "description": "Status of the label", "enum": [ "PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED" ] }, "is_voided": { "type": "boolean", "description": "Whether label has been voided" }, "label_cost": { "type": "number", "description": "Cost to purchase label" }, "label_cost_currency": { "type": "string" }, "rate_id": { "type": "string", "description": "Rate used for this label; points to ShippingRate" }, "service_code": { "type": "string", "description": "Service code used" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ShippingMetadata" } }, "raw": { "description": "The raw data returned by the integration for this label" } } }, "ShippingTrackingEvent_location_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" }, "name": { "type": "string", "description": "Recipientsender name" }, "company_name": { "type": "string", "description": "Company name (for commercial addresses)" }, "telephone": { "type": "string", "description": "Phone number (required by FedEx, UPS, DHL)" }, "email": { "type": "string", "description": "Email address (for delivery notifications)" }, "is_residential": { "type": "boolean", "description": "Alias for address_type === 'RESIDENTIAL'" }, "is_validated": { "type": "boolean", "description": "Whether address has been validated" }, "delivery_instructions": { "type": "string", "description": "Special delivery notes" } } }, "ShippingTrackingEvent": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "The date that this tracking event object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "description": { "type": "string", "description": "Description of the tracking event" }, "status": { "type": "string", "description": "Status at the time of this event", "enum": [ "PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED" ] }, "event_code": { "type": "string", "description": "Carrier-specific event code" }, "carrier_status_code": { "type": "string", "description": "Carrier's status code at this event" }, "location_address": { "$ref": "#/definitions/ShippingTrackingEvent_location_address" }, "location_id": { "type": "string", "description": "Location ID; points to CommerceLocation (reference to ShippingLocation)" }, "location_name": { "type": "string", "description": "Location name" }, "notes": { "type": "string", "description": "Additional notes" }, "signed_by": { "type": "string", "description": "Who signed for delivery" } } }, "ShippingTrackingEvents": { "type": "array", "items": { "$ref": "#/definitions/ShippingTrackingEvent" }, "description": "Array of tracking events" }, "ShippingTracking": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this tracking object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this tracking object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this tracking object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "shipment_id": { "type": "string", "description": "Reference to the shipment" }, "tracking_number": { "type": "string", "description": "Tracking number for the shipment" }, "status": { "type": "string", "description": "Current status of the shipment", "enum": [ "PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED" ] }, "events": { "type": "array", "items": { "$ref": "#/definitions/ShippingTrackingEvent" }, "description": "Array of tracking events" }, "estimated_delivery": { "type": "string", "format": "date-time", "description": "Estimated delivery date" }, "actual_delivery_at": { "type": "string", "format": "date-time", "description": "Actual delivery timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "status_description": { "type": "string", "description": "Human-readable status" }, "carrier_id": { "type": "string", "description": "Reference to the carrier" }, "carrier_status_code": { "type": "string", "description": "Carrier's status code" }, "carrier_status_description": { "type": "string", "description": "Carrier's status description" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ShippingMetadata" } }, "raw": { "description": "The raw data returned by the integration for this tracking" } } }, "ShippingRate_from_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" }, "name": { "type": "string", "description": "Recipientsender name" }, "company_name": { "type": "string", "description": "Company name (for commercial addresses)" }, "telephone": { "type": "string", "description": "Phone number (required by FedEx, UPS, DHL)" }, "email": { "type": "string", "description": "Email address (for delivery notifications)" }, "is_residential": { "type": "boolean", "description": "Alias for address_type === 'RESIDENTIAL'" }, "is_validated": { "type": "boolean", "description": "Whether address has been validated" }, "delivery_instructions": { "type": "string", "description": "Special delivery notes" } }, "description": "Origin address" }, "ShippingRate_to_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" }, "name": { "type": "string", "description": "Recipientsender name" }, "company_name": { "type": "string", "description": "Company name (for commercial addresses)" }, "telephone": { "type": "string", "description": "Phone number (required by FedEx, UPS, DHL)" }, "email": { "type": "string", "description": "Email address (for delivery notifications)" }, "is_residential": { "type": "boolean", "description": "Alias for address_type === 'RESIDENTIAL'" }, "is_validated": { "type": "boolean", "description": "Whether address has been validated" }, "delivery_instructions": { "type": "string", "description": "Special delivery notes" } }, "description": "Destination address" }, "ShippingRateSurcharge": { "type": "object", "properties": { "code": { "type": "string", "description": "Surcharge type (e.g., \"RESIDENTIAL\", \"FUEL\", \"SIGNATURE\")" }, "name": { "type": "string", "description": "Human-readable name" }, "amount": { "type": "number", "description": "Surcharge amount" }, "description": { "type": "string", "description": "Description of surcharge" } } }, "ShippingRateSurcharges": { "type": "array", "items": { "$ref": "#/definitions/ShippingRateSurcharge" }, "description": "Additional charges" }, "ShippingRateRate": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "base_amount": { "type": "number", "description": "Base shipping rate" }, "tax_amount": { "type": "number" }, "discount_amount": { "type": "number", "description": "Applied discount" }, "surcharges": { "type": "array", "items": { "$ref": "#/definitions/ShippingRateSurcharge" }, "description": "Additional charges" }, "rate_source": { "type": "string", "description": "Source of rate (e.g., \"carrier\", \"negotiated\", \"account\")" }, "is_negotiated_rate": { "type": "boolean", "description": "Whether this is a negotiated rate" }, "estimated_days": { "type": "number", "description": "Estimated delivery time in days" }, "delivery_days": { "type": "number", "description": "Delivery days (integer)" }, "estimated_delivery_end_at": { "type": "string", "format": "date-time", "description": "Specific delivery date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "estimated_delivery_start_at": { "type": "string", "format": "date-time", "description": "Time window (e.g., \"10:00 AM - 2:00 PM\") (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "delivery_terms": { "type": "string", "description": "Delivery duration terms (e.g., \"3-5 business days\")" }, "transit_hours": { "type": "number", "description": "Transit time in hours" }, "is_guaranteed": { "type": "boolean", "description": "Whether delivery is guaranteed" }, "package_type": { "type": "string", "description": "Package type (e.g., \"package\", \"envelope\", \"flat\")" }, "is_trackable": { "type": "boolean", "description": "Whether shipment is trackable" }, "is_active": { "type": "boolean", "description": "Whether rate is currently available" } }, "required": [ "title" ] }, "ShippingRateRates": { "type": "array", "items": { "$ref": "#/definitions/ShippingRateRate" } }, "ShippingRate": { "type": "object", "properties": { "shipment_id": { "type": "string", "description": "Reference to the shipping object (if rate is for existing shipment)" }, "currency": { "type": "string" }, "from_address": { "$ref": "#/definitions/ShippingRate_from_address", "description": "Origin address" }, "to_address": { "$ref": "#/definitions/ShippingRate_to_address", "description": "Destination address" }, "packages": { "type": "array", "items": { "$ref": "#/definitions/ShippingPackage" }, "description": "Multiple packages (alternative to package)" }, "ship_by_at": { "type": "string", "format": "date-time", "description": "Latest date to ship (from order) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "carrier_id": { "type": "string", "description": "Reference to the carrier" }, "id": { "type": "string", "description": "Unique identifier for this rate object" }, "rates": { "type": "array", "items": { "$ref": "#/definitions/ShippingRateRate" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ShippingMetadata" } }, "raw": {} } }, "ShippingCarrier": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this carrier object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this carrier object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this carrier object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the carrier" }, "code": { "type": "string", "description": "Carrier code (e.g., \"usps\", \"fedex\", \"ups\")" }, "is_active": { "type": "boolean", "description": "Whether the carrier is currently active" }, "logo_url": { "type": "string", "description": "Carrier logo URL" }, "website_url": { "type": "string", "description": "Carrier website" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ShippingMetadata" } }, "raw": { "description": "The raw data returned by the integration for this carrier" } } }, "SigningMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "SigningMetadatas": { "type": "array", "items": { "$ref": "#/definitions/SigningMetadata" } }, "SigningDocument": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this signing document" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this signing document was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this signing document was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Document/envelope title" }, "description": { "type": "string", "description": "Message to signers" }, "status": { "type": "string", "description": "Current status of the signing document", "enum": [ "DRAFT", "SENT", "DELIVERED", "IN_PROGRESS", "COMPLETED", "DECLINED", "VOIDED", "EXPIRED" ] }, "sent_at": { "type": "string", "format": "date-time", "description": "When sent for signature (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "completed_at": { "type": "string", "format": "date-time", "description": "When all signatures were collected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "expires_at": { "type": "string", "format": "date-time", "description": "Signing deadline (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "template_id": { "type": "string", "description": "If created from a template; points to SigningTemplate" }, "download_url": { "type": "string", "description": "URL to download the signed document" }, "creator_id": { "type": "string", "description": "User who created the signing document" }, "raw": { "description": "The raw data returned by the integration" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/SigningMetadata" } } } }, "SigningSignatory": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this signatory" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this signatory was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this signatory was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "document_id": { "type": "string", "description": "Parent signing document; points to SigningDocument" }, "name": { "type": "string", "description": "Full name of the signatory" }, "email": { "type": "string", "description": "Email address of the signatory" }, "role": { "type": "string", "description": "Role of the signatory", "enum": [ "SIGNER", "CC", "APPROVER", "IN_PERSON_SIGNER", "VIEWER" ] }, "status": { "type": "string", "description": "Current status of this signatory", "enum": [ "PENDING", "SENT", "DELIVERED", "SIGNED", "DECLINED", "ERROR" ] }, "order": { "type": "number", "description": "Signing order (1, 2, 3...)" }, "signed_at": { "type": "string", "format": "date-time", "description": "When this signatory signed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "decline_reason": { "type": "string", "description": "Reason for declining (if status is DECLINED)" }, "raw": { "description": "The raw data returned by the integration" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/SigningMetadata" } } } }, "SigningTemplate": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this template" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this template was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this template was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Template name" }, "description": { "type": "string", "description": "Template description" }, "is_active": { "type": "boolean", "description": "Whether the template is active/available" }, "creator_id": { "type": "string", "description": "User who created the template" }, "raw": { "description": "The raw data returned by the integration" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/SigningMetadata" } } } }, "ClubsGroup_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } }, "description": "The group's address" }, "ClubsGroup_activity_types": { "type": "array", "items": { "type": "string" }, "description": "The activity types the group focuses on" }, "ClubsMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "ClubsMetadatas": { "type": "array", "items": { "$ref": "#/definitions/ClubsMetadata" } }, "ClubsGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this group" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this group was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this group was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The group's name" }, "description": { "type": "string", "description": "The group's description" }, "sport_type": { "type": "string", "description": "The primary sport of the group", "enum": [ "RUNNING", "CYCLING", "SWIMMING", "TRIATHLON", "WALKING", "HIKING", "OTHER" ] }, "group_type": { "type": "string", "description": "The group type", "enum": [ "CASUAL_CLUB", "RACING_TEAM", "SHOP", "COMPANY", "OTHER" ] }, "address": { "$ref": "#/definitions/ClubsGroup_address", "description": "The group's address" }, "member_count": { "type": "number", "description": "The number of members in the group" }, "following_count": { "type": "number", "description": "The number of athletes the group follows" }, "post_count": { "type": "number", "description": "The number of posts in the group" }, "is_private": { "type": "boolean", "description": "Whether the group is private" }, "is_verified": { "type": "boolean", "description": "Whether the group is verified" }, "is_featured": { "type": "boolean", "description": "Whether the group is featured" }, "is_admin": { "type": "boolean", "description": "Whether the authenticated user is an admin of the group" }, "is_owner": { "type": "boolean", "description": "Whether the authenticated user is the owner of the group" }, "membership_status": { "type": "string", "description": "The authenticated user's membership status", "enum": [ "MEMBER", "PENDING", "NONE" ] }, "url": { "type": "string", "description": "The group's vanity URL" }, "profile_image_url": { "type": "string", "description": "URL to the group's profile picture" }, "cover_image_url": { "type": "string", "description": "URL to the group's cover photo" }, "activity_types": { "$ref": "#/definitions/ClubsGroup_activity_types", "description": "The activity types the group focuses on" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ClubsMetadata" } }, "raw": { "description": "The raw data returned by the integration for this group" } }, "description": "SummaryClub / DetailedClub, but generic across providers (TeamSnap team, PlayHQ org, etc.)." }, "ClubsMember": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this member (not provided by Strava)" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this member was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this member was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The full name of the member (first name + last initial for Strava)" }, "first_name": { "type": "string", "description": "The member's first name" }, "last_name": { "type": "string", "description": "The member's last name (a single initial for Strava)" }, "group_id": { "type": "string", "description": "The group this member belongs to (reference to HrisGroup)" }, "is_admin": { "type": "boolean", "description": "Whether the member is an admin of the group" }, "is_owner": { "type": "boolean", "description": "Whether the member is the owner of the group" }, "membership_status": { "type": "string", "description": "The member's membership status", "enum": [ "MEMBER", "PENDING", "NONE" ] }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ClubsMetadata" } }, "raw": { "description": "The raw data returned by the integration for this member" } }, "description": "`lastname` is only a single initial. We do not synthesize an id, so `id` is typically absent." }, "ClubsActivity": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this activity (not provided by ClubActivity)" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this activity was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this activity was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "group_id": { "type": "string", "description": "The group this activity was listed under (reference to HrisGroup)" }, "name": { "type": "string", "description": "The name of the activity" }, "description": { "type": "string", "description": "The description of the activity (DetailedActivity only)" }, "type": { "type": "string", "description": "The activity type", "enum": [ "RUNNING", "CYCLING", "SWIMMING", "TRIATHLON", "WALKING", "HIKING", "OTHER" ] }, "athlete_id": { "type": "string", "description": "The id of the athlete who performed the activity (DetailedActivity only)" }, "athlete_name": { "type": "string", "description": "The full name of the athlete" }, "distance": { "type": "number", "description": "The activity's distance, in meters" }, "moving_time": { "type": "number", "description": "The activity's moving time, in seconds" }, "elapsed_time": { "type": "number", "description": "The activity's elapsed time, in seconds" }, "total_elevation_gain": { "type": "number", "description": "The activity's total elevation gain, in meters" }, "elevation_high": { "type": "number", "description": "The activity's highest elevation, in meters (DetailedActivity only)" }, "elevation_low": { "type": "number", "description": "The activity's lowest elevation, in meters (DetailedActivity only)" }, "start_at": { "type": "string", "format": "date-time", "description": "When the activity started (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "timezone": { "type": "string", "description": "The timezone of the activity" }, "achievement_count": { "type": "number", "description": "The number of achievements gained during this activity" }, "kudos_count": { "type": "number", "description": "The number of kudos given for this activity" }, "comment_count": { "type": "number", "description": "The number of comments for this activity" }, "athlete_count": { "type": "number", "description": "The number of athletes that took part in this activity" }, "photo_count": { "type": "number", "description": "The number of Instagram photos for this activity" }, "average_speed": { "type": "number", "description": "The activity's average speed, in meters per second" }, "max_speed": { "type": "number", "description": "The activity's max speed, in meters per second" }, "average_cadence": { "type": "number", "description": "The activity's average cadence" }, "average_heartrate": { "type": "number", "description": "The activity's average heart rate, in beats per minute" }, "max_heartrate": { "type": "number", "description": "The activity's max heart rate, in beats per minute" }, "average_watts": { "type": "number", "description": "The activity's average power output, in watts" }, "max_watts": { "type": "number", "description": "The activity's max power output, in watts" }, "weighted_average_watts": { "type": "number", "description": "The activity's weighted average power output, in watts" }, "kilojoules": { "type": "number", "description": "The total work done, in kilojoules" }, "calories": { "type": "number", "description": "The number of kilocalories consumed during this activity" }, "has_heartrate": { "type": "boolean", "description": "Whether the activity has heart rate data" }, "is_trainer": { "type": "boolean", "description": "Whether this activity was recorded on a training machine" }, "is_commute": { "type": "boolean", "description": "Whether this activity is a commute" }, "is_manual": { "type": "boolean", "description": "Whether this activity was created manually" }, "is_private": { "type": "boolean", "description": "Whether this activity is private" }, "map_polyline": { "type": "string", "description": "The detailed polyline of the activity's map" }, "map_summary_polyline": { "type": "string", "description": "The summary polyline of the activity's map" }, "workout_type": { "type": "number", "description": "The activity's workout type" }, "suffer_score": { "type": "number", "description": "The activity's relative effort score" }, "pr_count": { "type": "number", "description": "The number of personal records set during this activity" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ClubsMetadata" } }, "raw": { "description": "The raw data returned by the integration for this activity" } }, "description": "ClubActivity (getClubActivitiesById, NO id) and the full DetailedActivity (getActivityById)." }, "ClubsEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this event" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this event was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this event was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "group_id": { "type": "string", "description": "The group this event belongs to (reference to HrisGroup)" }, "name": { "type": "string", "description": "The event name (or a \"Home vs Away\" matchup label)" }, "description": { "type": "string", "description": "A description or notes for the event" }, "type": { "type": "string", "description": "The event type", "enum": [ "GAME", "PRACTICE", "OTHER" ] }, "status": { "type": "string", "description": "The event status", "enum": [ "SCHEDULED", "CANCELED", "TBD", "FINAL" ] }, "start_at": { "type": "string", "format": "date-time", "description": "When the event starts (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "When the event ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "timezone": { "type": "string", "description": "The timezone of the event" }, "duration_minutes": { "type": "number", "description": "The scheduled duration, in minutes" }, "location_id": { "type": "string", "description": "The id of the location for this event (reference to ClubsLocation)" }, "location_name": { "type": "string", "description": "The name of the location for this event" }, "opponent_id": { "type": "string", "description": "The id of the opposing team (single-opponent providers)" }, "opponent_name": { "type": "string", "description": "The name of the opposing team" }, "home_team_name": { "type": "string", "description": "The home team's name (homeaway providers)" }, "away_team_name": { "type": "string", "description": "The away team's name (homeaway providers)" }, "home_score": { "type": "number", "description": "The home team's score" }, "away_score": { "type": "number", "description": "The away team's score" }, "score_for": { "type": "number", "description": "The connected groupteam's score (team-vs-opponent providers)" }, "score_against": { "type": "number", "description": "The opponent's score (team-vs-opponent providers)" }, "is_home": { "type": "boolean", "description": "Whether the connected groupteam is the home side" }, "url": { "type": "string", "description": "A URL to the event" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ClubsMetadata" } }, "raw": { "description": "The raw data returned by the integration for this event" } }, "description": "(home-vs-away competitors with scores). Distinct from the fitness-oriented IClubsActivity." }, "ClubsLocation_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "description": "ISO 2-digit country code" } } }, "ClubsLocation": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this location" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this location was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this location was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "group_id": { "type": "string", "description": "The group this location is associated with (reference to HrisGroup)" }, "name": { "type": "string", "description": "The location name" }, "address": { "$ref": "#/definitions/ClubsLocation_address" }, "latitude": { "type": "number", "description": "The latitude" }, "longitude": { "type": "number", "description": "The longitude" }, "telephone": { "type": "string", "description": "A contact phone number for the location" }, "url": { "type": "string", "description": "A URL for the location" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ClubsMetadata" } }, "raw": { "description": "The raw data returned by the integration for this location" } }, "description": "formatted address string + lat/long) and PlayHQ venues (structured address parts)." }, "AnalyticsMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "AnalyticsMetadatas": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsMetadata" } }, "AnalyticsProperty": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "timezone": { "type": "string" }, "currency": { "type": "string" }, "industry": { "type": "string" }, "parent_id": { "type": "string", "description": "points to AnalyticsProperty" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsMetadata" } }, "raw": {} } }, "AnalyticsEvent_metadata": { "type": "object", "additionalProperties": {} }, "AnalyticsEvent": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "event_type": { "type": "string", "enum": [ "PAGE_VIEW", "SCREEN_VIEW", "CLICK", "FORM_SUBMIT", "PURCHASE", "SIGN_UP", "LOGIN", "LOGOUT", "SEARCH", "VIDEO_PLAY", "VIDEO_COMPLETE", "FILE_DOWNLOAD", "SCROLL", "SESSION_START", "FIRST_VISIT", "CUSTOM" ] }, "visitor_id": { "type": "string", "description": "points to AnalyticsVisitor" }, "property_id": { "type": "string", "description": "points to AnalyticsProperty" }, "session_id": { "type": "string", "description": "points to AnalyticsSession" }, "page_url": { "type": "string" }, "page_title": { "type": "string" }, "page_referrer": { "type": "string" }, "device": { "type": "string" }, "browser": { "type": "string" }, "os": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "region": { "type": "string" }, "city": { "type": "string" }, "metadata": { "$ref": "#/definitions/AnalyticsEvent_metadata" }, "value": { "type": "number" }, "currency": { "type": "string" }, "utm_source": { "type": "string" }, "utm_medium": { "type": "string" }, "utm_campaign": { "type": "string" }, "utm_term": { "type": "string" }, "utm_content": { "type": "string" }, "raw": {} } }, "AnalyticsSession": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "property_id": { "type": "string", "description": "points to AnalyticsProperty" }, "visitor_id": { "type": "string" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "duration_seconds": { "type": "number" }, "landing_page": { "type": "string", "description": "Session attributes" }, "exit_page": { "type": "string", "description": "Session attributes" }, "page_views": { "type": "number", "description": "Session attributes" }, "events_count": { "type": "number", "description": "Session attributes" }, "source": { "type": "string", "description": "Acquisition" }, "medium": { "type": "string" }, "campaign": { "type": "string" }, "device": { "type": "string" }, "browser": { "type": "string" }, "os": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "is_bounce": { "type": "boolean", "description": "Engagement" }, "is_conversion": { "type": "boolean", "description": "Engagement" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsMetadata" } }, "raw": {} } }, "AnalyticsVisitor_metadata": { "type": "object", "additionalProperties": {} }, "AnalyticsVisitor": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "property_id": { "type": "string", "description": "points to AnalyticsProperty" }, "email": { "type": "string" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "age": { "type": "number" }, "gender": { "type": "string", "enum": [ "MALE", "FEMALE", "INTERSEX", "TRANS", "NON_BINARY" ] }, "country": { "type": "string" }, "country_code": { "type": "string" }, "city": { "type": "string" }, "language": { "type": "string" }, "timezone": { "type": "string" }, "first_seen_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "last_seen_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "total_sessions": { "type": "number" }, "total_page_views": { "type": "number" }, "total_events": { "type": "number" }, "metadata": { "$ref": "#/definitions/AnalyticsVisitor_metadata" }, "raw": {} } }, "AnalyticsReportMetrics": { "type": "object", "properties": { "value": { "type": "number" }, "type": { "type": "string", "description": "Traffic metrics", "enum": [ "USERS", "NEW_USERS", "SESSIONS", "PAGE_VIEWS", "UNIQUE_PAGE_VIEWS", "SCREENS", "EVENTS", "AVERAGE_SESSION_DURATION", "PAGES_PER_SESSION", "BOUNCE_RATE", "ENGAGEMENT_RATE", "EVENTS_PER_SESSION", "CONVERSIONS", "CONVERSION_RATE", "GOAL_COMPLETIONS", "GOAL_VALUE", "TRANSACTIONS", "REVENUE", "AVERAGE_ORDER_VALUE", "ECOMMERCE_CONVERSION_RATE", "SESSIONS_BY_SOURCE", "USERS_BY_SOURCE", "CONVERSIONS_BY_SOURCE", "VIDEO_VIEWS", "WATCH_TIME", "AVERAGE_VIEW_DURATION", "AVERAGE_VIEW_PERCENTAGE", "LIKES", "DISLIKES", "COMMENTS", "SHARES", "SUBSCRIBERS_GAINED", "SUBSCRIBERS_LOST" ] }, "dimension": { "type": "string", "description": "new vs returning", "enum": [ "DATE", "HOUR", "DAY_OF_WEEK", "WEEK", "MONTH", "YEAR", "PAGE", "PAGE_TITLE", "EVENT_NAME", "SOURCE", "MEDIUM", "CAMPAIGN", "COUNTRY", "CITY", "DEVICE_TYPE", "BROWSER", "OS", "USER_TYPE", "LANDING_PAGE", "VIDEO" ] }, "dimension_value": { "type": "string" } } }, "AnalyticsReportMetrics_List": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsReportMetrics" } }, "AnalyticsReport": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "property_id": { "type": "string", "description": "points to AnalyticsProperty" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metrics": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsReportMetrics" } }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/AnalyticsMetadata" } }, "raw": {} } }, "CdpProfile_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" } }, "description": "The address of the profile" }, "CdpIdentifier": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the identifier (eg. EMAIL, USER_ID, ANONYMOUS_ID)", "enum": [ "EMAIL", "USER_ID", "ANONYMOUS_ID", "DEVICE_ID", "PHONE", "CRM_ID", "LOYALTY_ID", "OTHER" ] }, "value": { "type": "string", "description": "The identifier value that resolves to the profile" }, "is_primary": { "type": "boolean", "description": "Whether this is the primary identifier for the profile" }, "encoding": { "type": "string", "description": "The encoding of the identifier value (eg. raw, sha256)" }, "source": { "type": "string", "description": "The source that provided this identifier" } }, "required": [ "value" ] }, "CdpIdentifiers": { "type": "array", "items": { "$ref": "#/definitions/CdpIdentifier" }, "description": "The identifiers that link this event to a profile" }, "CdpMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string", "description": "The attribute/trait key (eg. lifetime_value)" }, "value": { "description": "The attribute/trait value" }, "namespace": { "type": "string", "description": "The scope or origin of the attribute (eg. computed, event, visitor)" }, "format": { "type": "string", "description": "The data type of the attribute value", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "ARRAY", "OBJECT" ] }, "extra_data": {} } }, "CdpMetadatas": { "type": "array", "items": { "$ref": "#/definitions/CdpMetadata" } }, "CdpProfileSegment": { "type": "object", "properties": { "segment_id": { "type": "string", "description": "The segment/audience this profile belongs to; points to CdpSegment" }, "name": { "type": "string", "description": "The name of the segment/audience" }, "joined_at": { "type": "string", "format": "date-time", "description": "When the profile joined the segment (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "expires_at": { "type": "string", "format": "date-time", "description": "When the profile's membership expires (if applicable) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "CdpProfileSegments": { "type": "array", "items": { "$ref": "#/definitions/CdpProfileSegment" }, "description": "The segments/audiences this profile currently belongs to" }, "CdpConsent": { "type": "object", "properties": { "purpose": { "type": "string", "description": "The consent purpose or objective (eg. marketing, analytics)" }, "status": { "type": "string", "description": "The consent status for this purpose", "enum": [ "GRANTED", "DENIED", "PENDING" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "When the consent status was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "CdpConsents": { "type": "array", "items": { "$ref": "#/definitions/CdpConsent" }, "description": "The consent/privacy preferences of the profile" }, "CdpProfile": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this profile object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this profile object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this profile object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The full name of the profile" }, "first_name": { "type": "string", "description": "The first name of the profile" }, "last_name": { "type": "string", "description": "The last name of the profile" }, "email": { "type": "string", "description": "The primary email address of the profile" }, "telephone": { "type": "string", "description": "The primary telephone number of the profile" }, "gender": { "type": "string", "description": "The gender of the profile", "enum": [ "MALE", "FEMALE", "INTERSEX", "TRANS", "NON_BINARY" ] }, "birthdate": { "type": "string", "description": "The birth date of the profile" }, "title": { "type": "string", "description": "The job title of the profile" }, "company": { "type": "string", "description": "The company/organization name of the profile" }, "address": { "$ref": "#/definitions/CdpProfile_address", "description": "The address of the profile" }, "identifiers": { "type": "array", "items": { "$ref": "#/definitions/CdpIdentifier" }, "description": "The typed identifiers stitched to this profile" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CdpMetadata" }, "description": "The traits/attributes of the profile" }, "segments": { "type": "array", "items": { "$ref": "#/definitions/CdpProfileSegment" }, "description": "The segments/audiences this profile currently belongs to" }, "is_anonymous": { "type": "boolean", "description": "Whether the profile is anonymous (no known identity)" }, "consent": { "type": "array", "items": { "$ref": "#/definitions/CdpConsent" }, "description": "The consent/privacy preferences of the profile" }, "source_id": { "type": "string", "description": "The cdp_source this profile originated from; points to CdpSource" }, "raw": { "description": "The raw data returned by the integration for this profile" } } }, "CdpSegment": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this segment object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this segment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the segment/audience" }, "slug": { "type": "string", "description": "The data-plane handle/key used to identify segment membership in profiles and destinations" }, "description": { "type": "string", "description": "The description of the segment/audience" }, "definition": { "type": "string", "description": "The membership rule/query that defines the segment" }, "type": { "type": "string", "description": "The type of entity the segment targets (USERS, ACCOUNTS, LINKED)", "enum": [ "USERS", "ACCOUNTS", "LINKED" ] }, "compute_mode": { "type": "string", "description": "How the segment membership is computed (REALTIME or BATCH)", "enum": [ "REALTIME", "BATCH" ] }, "size": { "type": "number", "description": "The number of profiles currently in the segment" }, "is_active": { "type": "boolean", "description": "Whether the segment is active/enabled" }, "source_id": { "type": "string", "description": "The cdp_source this segment originated from; points to CdpSource" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CdpMetadata" } }, "raw": { "description": "The raw data returned by the integration for this segment" } } }, "CdpEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this event object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this event object was ingested (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The specific event name (eg. \"Product Purchased\")" }, "type": { "type": "string", "description": "The unified structural category of the event", "enum": [ "TRACK", "PAGE", "SCREEN", "IDENTIFY", "GROUP", "ALIAS" ] }, "occurred_at": { "type": "string", "format": "date-time", "description": "When the event actually happened (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "profile_id": { "type": "string", "description": "The profile this event is associated with; points to CdpProfile" }, "identifiers": { "type": "array", "items": { "$ref": "#/definitions/CdpIdentifier" }, "description": "The identifiers that link this event to a profile" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CdpMetadata" }, "description": "The event payload/properties" }, "source": { "type": "string", "description": "The source that produced this event" }, "source_id": { "type": "string", "description": "The cdp_source this event originated from; points to CdpSource" }, "raw": { "description": "The raw data returned by the integration for this event" } } }, "CdpSource": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this source object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this source object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this source object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the inbound data source" }, "slug": { "type": "string", "description": "A stable handle/key for the source" }, "type": { "type": "string", "description": "The connector/source type (eg. the provider's connector slug or plugin id)" }, "direction": { "type": "string", "description": "SOURCE, or BIDIRECTIONAL for import+export connectors", "enum": [ "SOURCE", "DESTINATION", "BIDIRECTIONAL" ] }, "is_enabled": { "type": "boolean", "description": "Whether the source is active/enabled" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CdpMetadata" } }, "raw": { "description": "The raw data returned by the integration for this source" } } }, "CdpDestination": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this destination object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this destination object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this destination object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the outbound activation destination" }, "slug": { "type": "string", "description": "A stable handle/key for the destination" }, "type": { "type": "string", "description": "The connector/destination type (eg. the provider's connector slug or plugin id)" }, "direction": { "type": "string", "description": "DESTINATION, or BIDIRECTIONAL for import+export connectors", "enum": [ "SOURCE", "DESTINATION", "BIDIRECTIONAL" ] }, "is_enabled": { "type": "boolean", "description": "Whether the destination is active/enabled" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CdpMetadata" } }, "raw": { "description": "The raw data returned by the integration for this destination" } } }, "CdpActivation": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this activation object" }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this activation object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The name of the activation/sync job" }, "segment_id": { "type": "string", "description": "The cdp_segment being activated; points to CdpSegment" }, "destination_id": { "type": "string", "description": "The cdp_destination the data is sent to; points to CdpDestination" }, "source_id": { "type": "string", "description": "The cdp_source the data originates from; points to CdpSource" }, "schedule": { "type": "string", "description": "The activation schedule or mode (eg. cron, interval, realtime, batch)" }, "status": { "type": "string", "description": "The current status of the activation", "enum": [ "ACTIVE", "PAUSED", "ERROR", "PENDING" ] }, "last_run_at": { "type": "string", "format": "date-time", "description": "When the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "is_enabled": { "type": "boolean", "description": "Whether the activation is active/enabled" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/CdpMetadata" } }, "raw": { "description": "The raw data returned by the integration for this activation" } } }, "PerformanceMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "PerformanceMetadatas": { "type": "array", "items": { "$ref": "#/definitions/PerformanceMetadata" } }, "PerformanceCycle": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "description": "whether this is a review cycle or a goal cycle/timeframe", "enum": [ "REVIEW", "GOAL", "OTHER" ] }, "status": { "type": "string", "enum": [ "DRAFT", "SCHEDULED", "ACTIVE", "CLOSED", "OTHER" ] }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PerformanceMetadata" } }, "raw": {} } }, "PerformanceReviewQuestion_answers": { "type": "array", "items": { "type": "string" }, "description": "all answer values; single-answer questions have one element" }, "PerformanceReviewQuestion": { "type": "object", "properties": { "question": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT", "SINGLE_SELECT", "MULTI_SELECT", "RATING", "OTHER" ] }, "answers": { "$ref": "#/definitions/PerformanceReviewQuestion_answers", "description": "all answer values; single-answer questions have one element" } }, "required": [ "question" ] }, "PerformanceReviewQuestions": { "type": "array", "items": { "$ref": "#/definitions/PerformanceReviewQuestion" } }, "PerformanceReview": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "the HR Employee being reviewed (reference to HrisEmployee)" }, "reviewer_user_id": { "type": "string", "description": "the HR Employee that wrote this review (reference to HrisEmployee)" }, "cycle_id": { "type": "string", "description": "pointer to the Performance Cycle object" }, "template_identifier": { "type": "string", "description": "id of the review template/form this review is based on" }, "type": { "type": "string", "enum": [ "SELF", "MANAGER", "PEER", "UPWARD", "OTHER" ] }, "status": { "type": "string", "enum": [ "DRAFT", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "SHARED", "ACKNOWLEDGED", "OTHER" ] }, "rating": { "type": "number", "description": "the overall rating/score of this review" }, "rating_maximum": { "type": "number", "description": "the maximum possible rating/score on the provider's scale" }, "rating_description": { "type": "string", "description": "label of the rating on the provider's scale (e.g. \"Exceeds expectations\")" }, "comment": { "type": "string", "description": "the overall/summary comment of this review" }, "questions": { "type": "array", "items": { "$ref": "#/definitions/PerformanceReviewQuestion" } }, "is_acknowledged": { "type": "boolean", "description": "whether the reviewee acknowledged this review" }, "submitted_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "completed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PerformanceMetadata" } }, "raw": {} }, "required": [ "user_id" ] }, "PerformanceGoal_user_ids": { "type": "array", "items": { "type": "string" }, "description": "HR Employees that own or share this goal; the first element is the primary owner" }, "PerformanceGoalMilestone": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "target_value": { "type": "number" }, "current_value": { "type": "number" }, "unit": { "type": "string", "description": "unit of the target/current values (e.g. %, USD, count)" }, "weight": { "type": "number" }, "is_completed": { "type": "boolean" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } }, "required": [ "name" ] }, "PerformanceGoalMilestones": { "type": "array", "items": { "$ref": "#/definitions/PerformanceGoalMilestone" }, "description": "milestones or key results for this goal" }, "PerformanceGoal": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" }, "user_ids": { "$ref": "#/definitions/PerformanceGoal_user_ids", "description": "HR Employees that own or share this goal; the first element is the primary owner (reference to HrisEmployee)" }, "company_id": { "type": "string" }, "parent_id": { "type": "string", "description": "id of the parent goal, for goal alignment / OKR trees" }, "cycle_id": { "type": "string", "description": "pointer to the Performance Cycle object (goal cycle or timeframe)" }, "type": { "type": "string", "enum": [ "INDIVIDUAL", "TEAM", "DEPARTMENT", "COMPANY", "OTHER" ] }, "status": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "CLOSED", "OTHER" ] }, "progress": { "type": "number", "description": "progress percentage from 0 to 100" }, "weight": { "type": "number", "description": "the weight of this goal when the provider weighs goals in reviews" }, "start_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "due_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "completed_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "milestones": { "type": "array", "items": { "$ref": "#/definitions/PerformanceGoalMilestone" }, "description": "milestones or key results for this goal" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PerformanceMetadata" } }, "raw": {} } }, "PerformanceFeedback_tags": { "type": "array", "items": { "type": "string" }, "description": "badges or company values attached to this feedback" }, "PerformanceFeedback": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "user_id": { "type": "string", "description": "the HR Employee that this feedback is about (reference to HrisEmployee)" }, "author_user_id": { "type": "string", "description": "the HR Employee that gave this feedback (reference to HrisEmployee)" }, "type": { "type": "string", "description": "praise/recognition, constructive feedback, or a response to a feedback request", "enum": [ "PRAISE", "FEEDBACK", "REQUESTED", "OTHER" ] }, "message": { "type": "string" }, "tags": { "$ref": "#/definitions/PerformanceFeedback_tags", "description": "badges or company values attached to this feedback" }, "is_visible": { "type": "boolean", "description": "true when publicly visible (e.g. praise wall); false when private or manager-only" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/PerformanceMetadata" } }, "raw": {} }, "required": [ "user_id" ] }, "SocialMedia": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider media id, when the media is individually addressable" }, "url": { "type": "string", "description": "URL of the media asset" }, "alt": { "type": "string", "description": "Accessibility caption / alt text" }, "type": { "type": "string", "description": "Type of media", "enum": [ "PHOTO", "VIDEO", "GIF", "OTHER" ] }, "height": { "type": "number", "description": "Media height in pixels" }, "width": { "type": "number", "description": "Media width in pixels" }, "position": { "type": "number", "description": "Ordering of the media within the post; 1 is the first" } }, "required": [ "url" ] }, "SocialMedias": { "type": "array", "items": { "$ref": "#/definitions/SocialMedia" }, "description": "Media assets attached to the post" }, "SocialPost_call_to_action": { "type": "object", "properties": { "type": { "type": "string", "description": "The call-to-action button type", "enum": [ "BOOK", "ORDER", "SHOP", "LEARN_MORE", "SIGN_UP", "CALL", "OTHER" ] }, "url": { "type": "string", "description": "The URL the call-to-action points to" } }, "description": "Call-to-action button on the post" }, "SocialPost_metrics": { "type": "object", "properties": { "like_count": { "type": "number", "description": "Number of likes/reactions" }, "comment_count": { "type": "number", "description": "Number of comments/replies" }, "share_count": { "type": "number", "description": "Number of shares/reposts" }, "quote_count": { "type": "number", "description": "Number of quotes" }, "view_count": { "type": "number", "description": "Number of views/impressions" }, "bookmark_count": { "type": "number", "description": "Number of bookmarks/saves" } }, "description": "Engagement metrics for the post" }, "SocialMetadata": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "value": {}, "namespace": { "type": "string" }, "format": { "type": "string", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": {} } }, "SocialMetadatas": { "type": "array", "items": { "$ref": "#/definitions/SocialMetadata" } }, "SocialPost": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the post" }, "created_at": { "type": "string", "format": "date-time", "description": "When the post was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the post was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "profile_id": { "type": "string", "description": "The social profile (page/handle/listing) that owns this post" }, "parent_post_id": { "type": "string", "description": "The post this one replies to or references" }, "title": { "type": "string", "description": "Optional post title/headline" }, "body": { "type": "string", "description": "The main text content of the post" }, "status": { "type": "string", "description": "Publication status of the post", "enum": [ "DRAFT", "SCHEDULED", "PUBLISHED", "REJECTED", "PROCESSING", "DELETED", "OTHER" ] }, "type": { "type": "string", "description": "The kind of post", "enum": [ "POST", "REPLY", "REPOST", "QUOTE", "EVENT", "OFFER", "ALERT", "STORY", "OTHER" ] }, "media": { "type": "array", "items": { "$ref": "#/definitions/SocialMedia" }, "description": "Media assets attached to the post" }, "url": { "type": "string", "description": "Public permalink to the post" }, "language": { "type": "string", "description": "Language code of the post content" }, "scheduled_at": { "type": "string", "format": "date-time", "description": "When the post is scheduled to publish (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "call_to_action": { "$ref": "#/definitions/SocialPost_call_to_action", "description": "Call-to-action button on the post" }, "metrics": { "$ref": "#/definitions/SocialPost_metrics", "description": "Engagement metrics for the post" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/SocialMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "SocialProfile_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } }, "description": "Structured postal address" }, "SocialProfile_metrics": { "type": "object", "properties": { "follower_count": { "type": "number", "description": "Number of followers" }, "following_count": { "type": "number", "description": "Number of accounts this profile follows" }, "post_count": { "type": "number", "description": "Total number of posts published by this profile" } }, "description": "Audience metrics for the profile" }, "SocialProfile": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the profile" }, "created_at": { "type": "string", "format": "date-time", "description": "When the profile was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the profile was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the profile" }, "username": { "type": "string", "description": "Handle/username/store code" }, "parent_id": { "type": "string", "description": "Parent profile id when profiles are nested (e.g. account → location)" }, "description": { "type": "string", "description": "Bio or description of the profile" }, "url": { "type": "string", "description": "Public URL of the profile" }, "website_url": { "type": "string", "description": "External website linked from the profile" }, "avatar_url": { "type": "string", "description": "Profile image URL" }, "phone": { "type": "string", "description": "Contact phone number" }, "location": { "type": "string", "description": "Free-text location/locale string" }, "address": { "$ref": "#/definitions/SocialProfile_address", "description": "Structured postal address" }, "category": { "type": "string", "description": "Primary category of the profile" }, "is_verified": { "type": "boolean", "description": "Whether the profile is verified" }, "is_private": { "type": "boolean", "description": "Whether the profile is private/protected" }, "metrics": { "$ref": "#/definitions/SocialProfile_metrics", "description": "Audience metrics for the profile" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/SocialMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "SocialReview_reply": { "type": "object", "properties": { "content": { "type": "string", "description": "The reply text from the business" }, "created_at": { "type": "string", "format": "date-time", "description": "When the reply was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the reply was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } }, "description": "The business's reply to the review" }, "SocialReview": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the review" }, "created_at": { "type": "string", "format": "date-time", "description": "When the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "profile_id": { "type": "string", "description": "The social profile (page/handle/listing) being reviewed" }, "rating": { "type": "number", "description": "Star rating, typically 1-5" }, "title": { "type": "string", "description": "Optional review title/headline" }, "content": { "type": "string", "description": "The review text" }, "author_name": { "type": "string", "description": "Display name of the reviewer" }, "author_avatar_url": { "type": "string", "description": "Profile image URL of the reviewer" }, "author_location": { "type": "string", "description": "Free-text location of the reviewer" }, "reply": { "$ref": "#/definitions/SocialReview_reply", "description": "The business's reply to the review" }, "url": { "type": "string", "description": "Public permalink to the review" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/SocialMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "SocialInsight": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the insight data point" }, "created_at": { "type": "string", "format": "date-time", "description": "When the insight was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "profile_id": { "type": "string", "description": "The social profile these stats belong to" }, "post_id": { "type": "string", "description": "Optional: the post these stats belong to" }, "date": { "type": "string", "format": "date-time", "description": "The day/timestamp of the data point" }, "period": { "type": "string", "description": "The aggregation period of the value", "enum": [ "DAY", "WEEK", "MONTH", "LIFETIME", "TOTAL", "OTHER" ] }, "metric": { "type": "string", "description": "The metric being reported", "enum": [ "FOLLOWERS", "FOLLOWING", "POSTS", "IMPRESSIONS", "REACH", "ENGAGEMENT", "PROFILE_VIEWS", "CLICKS", "VIDEO_VIEWS", "LIKES", "COMMENTS", "SHARES", "SAVES", "OTHER" ] }, "value": { "type": "number", "description": "The metric value" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/SocialMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "LegalMatter_contact_ids": { "type": "array", "items": { "type": "string" }, "description": "CRM Contacts that are clients on this matter" }, "LegalMatter_company_ids": { "type": "array", "items": { "type": "string" }, "description": "CRM Companies that are clients on this matter" }, "LegalParty": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "pointer to a CRM Contact" }, "company_id": { "type": "string", "description": "pointer to a CRM Company" }, "role": { "type": "string", "description": "the party role on the matter", "enum": [ "CLIENT", "OPPOSING_PARTY", "OPPOSING_COUNSEL", "CO_COUNSEL", "WITNESS", "EXPERT", "JUDGE", "REFERRER", "OTHER" ] }, "description": { "type": "string", "description": "the vendor's free-text relationship description" } } }, "LegalParties": { "type": "array", "items": { "$ref": "#/definitions/LegalParty" }, "description": "all people and organizations related to this matter, with their role" }, "LegalMatter_user_ids": { "type": "array", "items": { "type": "string" }, "description": "other HR Employees assigned to this matter" }, "LegalMetadata": { "type": "object", "properties": { "id": { "type": "string", "description": "the custom field identifier" }, "slug": { "type": "string", "description": "the custom field key" }, "value": { "description": "the custom field value" }, "namespace": { "type": "string", "description": "the scope or origin of the custom field" }, "format": { "type": "string", "description": "the data type of the value", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "FILE", "TEXTAREA", "SINGLE_SELECT", "MULTIPLE_SELECT", "MEASUREMENT", "PRICE", "YES_NO", "CURRENCY", "URL" ] }, "extra_data": { "description": "additional data about the custom field" } } }, "LegalMetadatas": { "type": "array", "items": { "$ref": "#/definitions/LegalMetadata" }, "description": "custom field values" }, "LegalMatter": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier for the matter" }, "created_at": { "type": "string", "format": "date-time", "description": "when the matter was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "when the matter was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "the matter name" }, "number": { "type": "string", "description": "the firm's display/matter number" }, "description": { "type": "string", "description": "free-text description of the matter" }, "status": { "type": "string", "description": "the matter status", "enum": [ "PENDING", "OPEN", "CLOSED", "OTHER" ] }, "billing_method": { "type": "string", "description": "how the matter is billed", "enum": [ "HOURLY", "FLAT_FEE", "CONTINGENCY", "OTHER" ] }, "practicearea_id": { "type": "string", "description": "pointer to the Legal Practicearea object" }, "stage": { "type": "string", "description": "the matter stage name" }, "contact_ids": { "$ref": "#/definitions/LegalMatter_contact_ids", "description": "CRM Contacts that are clients on this matter" }, "company_ids": { "$ref": "#/definitions/LegalMatter_company_ids", "description": "CRM Companies that are clients on this matter" }, "parties": { "type": "array", "items": { "$ref": "#/definitions/LegalParty" }, "description": "all people and organizations related to this matter, with their role" }, "user_id": { "type": "string", "description": "HR Employee who is the responsible attorney (reference to HrisEmployee)" }, "originating_user_id": { "type": "string", "description": "HR Employee who is the originating attorney (reference to HrisEmployee)" }, "user_ids": { "$ref": "#/definitions/LegalMatter_user_ids", "description": "other HR Employees assigned to this matter (reference to HrisEmployee)" }, "client_reference": { "type": "string", "description": "the client's own reference number for this matter" }, "currency": { "type": "string", "description": "ISO 4217 currency code" }, "is_billable": { "type": "boolean", "description": "whether the matter is billable" }, "opened_at": { "type": "string", "format": "date-time", "description": "when the matter was opened (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "closed_at": { "type": "string", "format": "date-time", "description": "when the matter was closed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "pending_at": { "type": "string", "format": "date-time", "description": "when the matter became pending (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "statute_of_limitations_at": { "type": "string", "format": "date-time", "description": "statute of limitations deadline for the matter (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LegalMetadata" }, "description": "custom field values" }, "raw": { "description": "raw data from the integration" } } }, "LegalPracticearea": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier for the practice area" }, "created_at": { "type": "string", "format": "date-time", "description": "when the practice area was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "when the practice area was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "the practice area name" }, "type": { "type": "string", "description": "the normalized practice area type", "enum": [ "ADMINISTRATIVE", "ADMIRALTY_AND_MARITIME", "ANTI_TRUST_AND_COMPETITION", "APPELLATE", "BANKING_AND_FINANCE", "BANKRUPTCY", "BUSINESS_FORMATION_AND_COMPLIANCE", "CIVIL_LITIGATION", "CIVIL_RIGHTS_AND_CONSTITUTIONAL", "COLLECTIONS_AND_DEBT", "COMMERCIAL_AND_SALE_OF_GOODS", "COMMERCIAL_LITIGATION", "CONSTRUCTION", "CONSUMER_PROTECTION", "CONTRACTS", "CORPORATE_LITIGATION", "CRIMINAL", "DISABILITY_AND_SOCIAL_SECURITY", "EDUCATION", "ELDER", "EMPLOYMENT_AND_LABOR", "ENERGY_AND_ENVIRONMENTAL", "ETHICS", "FAMILY", "FOOD_AND_DRUG", "GENERAL_PRACTICE", "GOVERNMENT", "HEALTHCARE", "IMMIGRATION", "IN_HOUSE_COUNSEL", "INSURANCE", "INTELLECTUAL_PROPERTY", "INTERNATIONAL", "JUVENILE", "LEGAL_AID", "MEDIATION_AND_ARBITRATION", "MEDICAL_MALPRACTICE", "MILITARY", "MULTI_PRACTICE", "NON_PROFIT_AND_PRO_BONO", "OTHER", "PERSONAL_INJURY", "PRIVACY_AND_INFORMATION_SECURITY", "PRIVATE_CLIENT", "PRODUCT_LIABILITY", "REAL_ESTATE", "SCIENCE_AND_TECHNOLOGY", "SECURITIES_AND_MERGERS_AND_ACQUISITIONS", "SMALL_CLAIMS", "SPORTS_AND_ENTERTAINMENT_AND_GAMING", "TAX", "TELECOMMUNICATIONS", "TRAFFIC_OFFENSES", "TRANSPORTATION", "TRIBAL", "TRUSTS", "WILLS_AND_ESTATES", "WORKERS_COMPENSATION" ] }, "code": { "type": "string", "description": "the practice area code" }, "is_active": { "type": "boolean", "description": "whether the practice area is active" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LegalMetadata" }, "description": "custom field values" }, "raw": { "description": "raw data from the integration" } } }, "LegalTimeentry": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier for the time entry" }, "created_at": { "type": "string", "format": "date-time", "description": "when the time entry was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "when the time entry was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "matter_id": { "type": "string", "description": "pointer to the Legal Matter this time is recorded against" }, "user_id": { "type": "string", "description": "HR Employee who is the timekeeper (reference to HrisEmployee)" }, "description": { "type": "string", "description": "description of the work performed" }, "worked_at": { "type": "string", "format": "date-time", "description": "date the work was performed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "minutes": { "type": "number", "description": "duration worked, in minutes" }, "billable_minutes": { "type": "number", "description": "billable duration after rounding, in minutes" }, "rate_amount": { "type": "number", "description": "hourly rate, or the flat amount for flat-rate entries" }, "total_amount": { "type": "number", "description": "total amount of the time entry" }, "currency": { "type": "string", "description": "ISO 4217 currency code" }, "is_billable": { "type": "boolean", "description": "whether the time entry is billable" }, "is_billed": { "type": "boolean", "description": "whether the time entry has been billed" }, "invoice_id": { "type": "string", "description": "pointer to the Accounting Invoice this time was billed on (reference to AccountingInvoice)" }, "activity_code": { "type": "string", "description": "UTBMS/LEDES activity code" }, "task_code": { "type": "string", "description": "UTBMS/LEDES task code" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LegalMetadata" }, "description": "custom field values" }, "raw": { "description": "raw data from the integration" } } }, "LegalExpense": { "type": "object", "properties": { "id": { "type": "string", "description": "unique identifier for the expense" }, "created_at": { "type": "string", "format": "date-time", "description": "when the expense was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "when the expense was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "matter_id": { "type": "string", "description": "pointer to the Legal Matter this expense is recorded against" }, "user_id": { "type": "string", "description": "HR Employee who incurred or recorded the expense (reference to HrisEmployee)" }, "description": { "type": "string", "description": "free-text description of the expense" }, "incurred_at": { "type": "string", "format": "date-time", "description": "date the expense was incurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "quantity": { "type": "number", "description": "number of units" }, "price_amount": { "type": "number", "description": "unit price" }, "total_amount": { "type": "number", "description": "total amount of the expense" }, "currency": { "type": "string", "description": "ISO 4217 currency code" }, "type": { "type": "string", "description": "hard cost, soft cost or other", "enum": [ "HARD_COST", "SOFT_COST", "OTHER" ] }, "category": { "type": "string", "description": "the vendor's expense category name" }, "is_billable": { "type": "boolean", "description": "whether the expense is billable" }, "is_billed": { "type": "boolean", "description": "whether the expense has been billed" }, "invoice_id": { "type": "string", "description": "pointer to the Accounting Invoice this expense was billed on (reference to AccountingInvoice)" }, "expense_code": { "type": "string", "description": "UTBMS/LEDES expense code" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/LegalMetadata" }, "description": "custom field values" }, "raw": { "description": "raw data from the integration" } } }, "ComputeInstance_allowed_actions": { "type": "array", "items": { "type": "string", "enum": [ "START", "STOP", "RESTART", "PAUSE", "RESUME", "TERMINATE" ] }, "description": "Lifecycle actions the vendor currently allows" }, "ComputeInstance_volume_ids": { "type": "array", "items": { "type": "string" }, "description": "Volumes mounted on the instance" }, "ComputeEndpoint": { "type": "object", "properties": { "port": { "type": "number", "description": "The port inside the instance" }, "protocol": { "type": "string", "description": "The protocol served on this port", "enum": [ "HTTP", "HTTPS", "TCP", "UDP", "OTHER" ] }, "url": { "type": "string", "description": "Public or proxied URL for this port" }, "is_auth_required": { "type": "boolean", "description": "Whether the URL requires a vendor access token" } } }, "ComputeEndpoints": { "type": "array", "items": { "$ref": "#/definitions/ComputeEndpoint" }, "description": "Exposed ports and their URLs" }, "ComputeInstance_ssh": { "type": "object", "properties": { "host": { "type": "string", "description": "SSH host" }, "port": { "type": "number", "description": "SSH port" }, "username": { "type": "string", "description": "SSH username" } }, "description": "SSH connection details" }, "ComputeEnv": { "type": "object", "properties": { "name": { "type": "string", "description": "Environment variable name" }, "value": { "type": "string", "description": "Environment variable value (write-only; never returned)" } }, "required": [ "name" ] }, "ComputeEnvs": { "type": "array", "items": { "$ref": "#/definitions/ComputeEnv" }, "description": "Environment variables (write-only values) set when creating the service" }, "ComputeMetadata": { "type": "object", "properties": { "id": { "type": "string", "description": "The label, tag or metadata identifier" }, "slug": { "type": "string", "description": "The label, tag or metadata key" }, "value": { "description": "The label, tag or metadata value" }, "namespace": { "type": "string", "description": "The origin of the value (eg. labels, tags, metadata)" }, "format": { "type": "string", "description": "The data type of the value", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "ARRAY", "OBJECT" ] }, "extra_data": { "description": "Additional data about the value" } } }, "ComputeMetadatas": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" } }, "ComputeInstance": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the instance" }, "created_at": { "type": "string", "format": "date-time", "description": "When the instance was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the instance was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the instance" }, "type": { "type": "string", "description": "The kind of compute unit", "enum": [ "CONTAINER", "VM", "BAREMETAL", "SANDBOX", "OTHER" ] }, "status": { "type": "string", "description": "Normalized lifecycle status; set on update to start, stop, pause, resume, restart or terminate", "enum": [ "PROVISIONING", "STARTING", "RUNNING", "STOPPING", "STOPPED", "PAUSING", "PAUSED", "RESUMING", "RESTARTING", "TERMINATING", "TERMINATED", "PREEMPTED", "ERROR", "OTHER" ] }, "status_reason": { "type": "string", "description": "Vendor explanation of the current status (eg. shutdown or failure reason)" }, "allowed_actions": { "$ref": "#/definitions/ComputeInstance_allowed_actions", "description": "Lifecycle actions the vendor currently allows" }, "market": { "type": "string", "description": "Pricing market the instance runs in", "enum": [ "ON_DEMAND", "SPOT", "RESERVED", "COMMUNITY", "OTHER" ] }, "region_id": { "type": "string", "description": "The region the instance runs in" }, "template_id": { "type": "string", "description": "The template the instance was created from" }, "image": { "type": "string", "description": "Container or OS image, when not created from a template" }, "source_snapshot_id": { "type": "string", "description": "The snapshot the instance was restored or forked from" }, "parent_instance_id": { "type": "string", "description": "The instance this one was forked from" }, "gputype_id": { "type": "string", "description": "The GPU or instance type of this instance" }, "gpu_model": { "type": "string", "description": "Normalized GPU model", "enum": [ "NVIDIA_GB300", "NVIDIA_B300", "NVIDIA_GB200", "NVIDIA_B200", "NVIDIA_GH200", "NVIDIA_H200", "NVIDIA_H100_SXM", "NVIDIA_H100_PCIE", "NVIDIA_H100_NVL", "NVIDIA_A100_SXM_80GB", "NVIDIA_A100_PCIE_80GB", "NVIDIA_A100_40GB", "NVIDIA_L40S", "NVIDIA_L40", "NVIDIA_L4", "NVIDIA_A40", "NVIDIA_A10", "NVIDIA_RTX_PRO_6000", "NVIDIA_RTX_6000_ADA", "NVIDIA_RTX_A6000", "NVIDIA_RTX_A5000", "NVIDIA_RTX_A4000", "NVIDIA_RTX_5090", "NVIDIA_RTX_4090", "NVIDIA_RTX_3090", "NVIDIA_V100", "NVIDIA_T4", "AMD_MI355X", "AMD_MI325X", "AMD_MI300X", "AMD_MI250", "OTHER" ] }, "gpu_count": { "type": "number", "description": "Number of GPUs attached (0 for CPU-only)" }, "sku": { "type": "string", "description": "The vendor's own SKU or size name" }, "cpu_count": { "type": "number", "description": "Number of vCPUs; may be fractional" }, "memory_mb": { "type": "number", "description": "System memory in MiB" }, "disk_mb": { "type": "number", "description": "Disk size in MiB" }, "architecture": { "type": "string", "description": "CPU architecture", "enum": [ "X86_64", "ARM64", "OTHER" ] }, "price_amount": { "type": "number", "description": "List price for the instance" }, "price_unit": { "type": "string", "description": "Unit that price_amount is quoted in", "enum": [ "PER_GPU_HOUR", "PER_INSTANCE_HOUR", "OTHER" ] }, "currency": { "type": "string", "description": "Currency of price_amount (ISO 4217)" }, "volume_ids": { "$ref": "#/definitions/ComputeInstance_volume_ids", "description": "Volumes mounted on the instance" }, "endpoints": { "type": "array", "items": { "$ref": "#/definitions/ComputeEndpoint" }, "description": "Exposed ports and their URLs" }, "ssh": { "$ref": "#/definitions/ComputeInstance_ssh", "description": "SSH connection details" }, "has_internet_access": { "type": "boolean", "description": "Whether outbound network access is allowed" }, "timeout_seconds": { "type": "number", "description": "Seconds until the instance expires; set on update to extend it" }, "expires_at": { "type": "string", "format": "date-time", "description": "When the instance will expire (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "on_expire": { "type": "string", "description": "What happens when the instance expires", "enum": [ "TERMINATE", "PAUSE", "STOP", "OTHER" ] }, "idle_timeout_seconds": { "type": "number", "description": "Seconds of inactivity before on_idle applies" }, "on_idle": { "type": "string", "description": "What happens when the instance is idle", "enum": [ "TERMINATE", "PAUSE", "STOP", "OTHER" ] }, "project_identifier": { "type": "string", "description": "Vendor project, team or app that groups the instance (reference to TaskProject)" }, "service_id": { "type": "string", "description": "The service (app) this instance runs for, on hosting platforms" }, "env": { "type": "array", "items": { "$ref": "#/definitions/ComputeEnv" }, "description": "Environment variables (write-only values)" }, "started_at": { "type": "string", "format": "date-time", "description": "When the instance last started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "terminated_at": { "type": "string", "format": "date-time", "description": "When the instance was terminated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" }, "description": "Vendor labels, tags and metadata" }, "raw": { "description": "Raw data from integration" } } }, "ComputeTemplate_aliases": { "type": "array", "items": { "type": "string" }, "description": "Alternative names or tags for the template" }, "ComputeTemplate_ports_List": { "type": "array", "items": { "type": "number" }, "description": "Ports exposed by instances from this template" }, "ComputeTemplate": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the template" }, "created_at": { "type": "string", "format": "date-time", "description": "When the template was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the template was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the template" }, "aliases": { "$ref": "#/definitions/ComputeTemplate_aliases", "description": "Alternative names or tags for the template" }, "image": { "type": "string", "description": "Container or OS image" }, "dockerfile": { "type": "string", "description": "Dockerfile used to build the template" }, "start_command": { "type": "string", "description": "Command run when an instance starts" }, "status": { "type": "string", "description": "Normalized build status", "enum": [ "PENDING", "BUILDING", "READY", "FAILED", "OTHER" ] }, "gpu_model": { "type": "string", "description": "Default GPU model", "enum": [ "NVIDIA_GB300", "NVIDIA_B300", "NVIDIA_GB200", "NVIDIA_B200", "NVIDIA_GH200", "NVIDIA_H200", "NVIDIA_H100_SXM", "NVIDIA_H100_PCIE", "NVIDIA_H100_NVL", "NVIDIA_A100_SXM_80GB", "NVIDIA_A100_PCIE_80GB", "NVIDIA_A100_40GB", "NVIDIA_L40S", "NVIDIA_L40", "NVIDIA_L4", "NVIDIA_A40", "NVIDIA_A10", "NVIDIA_RTX_PRO_6000", "NVIDIA_RTX_6000_ADA", "NVIDIA_RTX_A6000", "NVIDIA_RTX_A5000", "NVIDIA_RTX_A4000", "NVIDIA_RTX_5090", "NVIDIA_RTX_4090", "NVIDIA_RTX_3090", "NVIDIA_V100", "NVIDIA_T4", "AMD_MI355X", "AMD_MI325X", "AMD_MI300X", "AMD_MI250", "OTHER" ] }, "gpu_count": { "type": "number", "description": "Default number of GPUs" }, "cpu_count": { "type": "number", "description": "Default number of vCPUs" }, "memory_mb": { "type": "number", "description": "Default memory in MiB" }, "disk_mb": { "type": "number", "description": "Default disk in MiB" }, "ports": { "$ref": "#/definitions/ComputeTemplate_ports", "description": "Ports exposed by instances from this template" }, "env": { "type": "array", "items": { "$ref": "#/definitions/ComputeEnv" }, "description": "Default environment variables (write-only values)" }, "is_public": { "type": "boolean", "description": "Whether the template is publicly shared" }, "last_used_at": { "type": "string", "format": "date-time", "description": "When an instance was last started from this template (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" }, "description": "Vendor labels, tags and metadata" }, "raw": { "description": "Raw data from integration" } } }, "ComputePrice": { "type": "object", "properties": { "market": { "type": "string", "description": "Pricing market", "enum": [ "ON_DEMAND", "SPOT", "RESERVED", "COMMUNITY", "OTHER" ] }, "region_id": { "type": "string", "description": "Region the price applies to, when it varies by region" }, "price_amount": { "type": "number", "description": "List price" }, "price_unit": { "type": "string", "description": "Unit that price_amount is quoted in", "enum": [ "PER_GPU_HOUR", "PER_INSTANCE_HOUR", "OTHER" ] }, "currency": { "type": "string", "description": "Currency of price_amount (ISO 4217)" } } }, "ComputePrices": { "type": "array", "items": { "$ref": "#/definitions/ComputePrice" }, "description": "List prices by market and region" }, "ComputeAvailability": { "type": "object", "properties": { "region_id": { "type": "string", "description": "The region this availability applies to" }, "level": { "type": "string", "description": "Normalized stock level", "enum": [ "NONE", "LOW", "MEDIUM", "HIGH", "OTHER" ] }, "quantity": { "type": "number", "description": "Number of units available, when the vendor reports a count" } } }, "ComputeAvailabilities": { "type": "array", "items": { "$ref": "#/definitions/ComputeAvailability" }, "description": "Availability by region" }, "ComputeGputype": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the GPU or instance type (vendor SKU)" }, "created_at": { "type": "string", "format": "date-time", "description": "When the GPU type was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the GPU type was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the type" }, "gpu_model": { "type": "string", "description": "Normalized GPU model", "enum": [ "NVIDIA_GB300", "NVIDIA_B300", "NVIDIA_GB200", "NVIDIA_B200", "NVIDIA_GH200", "NVIDIA_H200", "NVIDIA_H100_SXM", "NVIDIA_H100_PCIE", "NVIDIA_H100_NVL", "NVIDIA_A100_SXM_80GB", "NVIDIA_A100_PCIE_80GB", "NVIDIA_A100_40GB", "NVIDIA_L40S", "NVIDIA_L40", "NVIDIA_L4", "NVIDIA_A40", "NVIDIA_A10", "NVIDIA_RTX_PRO_6000", "NVIDIA_RTX_6000_ADA", "NVIDIA_RTX_A6000", "NVIDIA_RTX_A5000", "NVIDIA_RTX_A4000", "NVIDIA_RTX_5090", "NVIDIA_RTX_4090", "NVIDIA_RTX_3090", "NVIDIA_V100", "NVIDIA_T4", "AMD_MI355X", "AMD_MI325X", "AMD_MI300X", "AMD_MI250", "OTHER" ] }, "gpu_manufacturer": { "type": "string", "description": "GPU manufacturer", "enum": [ "NVIDIA", "AMD", "INTEL", "OTHER" ] }, "sku": { "type": "string", "description": "The vendor's own SKU or type name" }, "gpu_count": { "type": "number", "description": "GPUs included in one unit of this type" }, "gpu_memory_mb": { "type": "number", "description": "Memory per GPU in MiB" }, "cpu_count": { "type": "number", "description": "vCPUs included in one unit of this type" }, "memory_mb": { "type": "number", "description": "System memory in MiB" }, "disk_mb": { "type": "number", "description": "Local disk in MiB" }, "architecture": { "type": "string", "description": "CPU architecture", "enum": [ "X86_64", "ARM64", "OTHER" ] }, "prices": { "type": "array", "items": { "$ref": "#/definitions/ComputePrice" }, "description": "List prices by market and region" }, "availability": { "type": "array", "items": { "$ref": "#/definitions/ComputeAvailability" }, "description": "Availability by region" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "ComputeRegion_gpu_models": { "type": "array", "items": { "type": "string", "enum": [ "NVIDIA_GB300", "NVIDIA_B300", "NVIDIA_GB200", "NVIDIA_B200", "NVIDIA_GH200", "NVIDIA_H200", "NVIDIA_H100_SXM", "NVIDIA_H100_PCIE", "NVIDIA_H100_NVL", "NVIDIA_A100_SXM_80GB", "NVIDIA_A100_PCIE_80GB", "NVIDIA_A100_40GB", "NVIDIA_L40S", "NVIDIA_L40", "NVIDIA_L4", "NVIDIA_A40", "NVIDIA_A10", "NVIDIA_RTX_PRO_6000", "NVIDIA_RTX_6000_ADA", "NVIDIA_RTX_A6000", "NVIDIA_RTX_A5000", "NVIDIA_RTX_A4000", "NVIDIA_RTX_5090", "NVIDIA_RTX_4090", "NVIDIA_RTX_3090", "NVIDIA_V100", "NVIDIA_T4", "AMD_MI355X", "AMD_MI325X", "AMD_MI300X", "AMD_MI250", "OTHER" ] }, "description": "GPU models offered in this region" }, "ComputeRegion": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the region or data center" }, "created_at": { "type": "string", "format": "date-time", "description": "When the region was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the region was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the region" }, "location": { "type": "string", "description": "Free-text location (eg. city or state)" }, "country": { "type": "string", "description": "Country code" }, "gpu_models": { "$ref": "#/definitions/ComputeRegion_gpu_models", "description": "GPU models offered in this region" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "ComputeVolume_instance_ids": { "type": "array", "items": { "type": "string" }, "description": "Instances the volume is mounted on" }, "ComputeVolume": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the volume" }, "created_at": { "type": "string", "format": "date-time", "description": "When the volume was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the volume was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the volume" }, "type": { "type": "string", "description": "The kind of volume", "enum": [ "STANDARD", "HIGH_PERFORMANCE", "SHARED", "LOCAL", "OTHER" ] }, "status": { "type": "string", "description": "Normalized volume status", "enum": [ "CREATING", "AVAILABLE", "IN_USE", "DELETING", "ERROR", "OTHER" ] }, "size_mb": { "type": "number", "description": "Provisioned size in MiB" }, "used_mb": { "type": "number", "description": "Used space in MiB" }, "region_id": { "type": "string", "description": "The region the volume lives in" }, "availability_zone": { "type": "string", "description": "The availability zone within the region, where the vendor places volumes per zone" }, "instance_ids": { "$ref": "#/definitions/ComputeVolume_instance_ids", "description": "Instances the volume is mounted on" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" }, "description": "Vendor labels, tags and metadata" }, "raw": { "description": "Raw data from integration" } } }, "ComputeSnapshot": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the snapshot" }, "created_at": { "type": "string", "format": "date-time", "description": "When the snapshot was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the snapshot was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the snapshot" }, "instance_id": { "type": "string", "description": "The instance the snapshot was taken from" }, "volume_id": { "type": "string", "description": "The volume the snapshot was taken from" }, "type": { "type": "string", "description": "Whether memory state is included", "enum": [ "MEMORY", "DISK", "OTHER" ] }, "status": { "type": "string", "description": "Normalized snapshot status", "enum": [ "CREATING", "READY", "FAILED", "DELETING", "OTHER" ] }, "size_mb": { "type": "number", "description": "Snapshot size in MiB" }, "expires_at": { "type": "string", "format": "date-time", "description": "When the snapshot will be deleted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" }, "description": "Vendor labels, tags and metadata" }, "raw": { "description": "Raw data from integration" } } }, "ComputeUsage": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the usage record" }, "created_at": { "type": "string", "format": "date-time", "description": "When the usage record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the usage record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "Start of the usage period (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "End of the usage period (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "instance_id": { "type": "string", "description": "The instance the usage belongs to, when per-instance" }, "category": { "type": "string", "description": "What was consumed", "enum": [ "GPU", "CPU", "MEMORY", "STORAGE", "NETWORK", "OTHER" ] }, "quantity": { "type": "number", "description": "Amount consumed, in unit" }, "unit": { "type": "string", "description": "Unit of quantity", "enum": [ "GPU_HOUR", "VCPU_SECOND", "GB_SECOND", "GB_MONTH", "BYTE", "SECOND", "OTHER" ] }, "cost_amount": { "type": "number", "description": "Cost of the usage, when the vendor reports it" }, "currency": { "type": "string", "description": "Currency of cost_amount (ISO 4217)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "ComputeKey": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the key" }, "created_at": { "type": "string", "format": "date-time", "description": "When the key was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the key was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the key" }, "type": { "type": "string", "description": "The kind of credential", "enum": [ "SSH", "REGISTRY", "SECRET", "OTHER" ] }, "public_key": { "type": "string", "description": "SSH public key" }, "private_key": { "type": "string", "description": "SSH private key generated by the vendor; returned only in the create response" }, "fingerprint": { "type": "string", "description": "SSH key fingerprint" }, "registry_url": { "type": "string", "description": "Container registry URL (REGISTRY keys)" }, "username": { "type": "string", "description": "Registry or SSH username" }, "secret": { "type": "string", "description": "Registry password or secret value (write-only; never returned)" }, "instance_id": { "type": "string", "description": "The instance this key is scoped to, for per-instance keys" }, "expires_at": { "type": "string", "format": "date-time", "description": "When the key expires (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "ComputeService": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the service (app or project)" }, "created_at": { "type": "string", "format": "date-time", "description": "When the service was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the service was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Display name of the service" }, "type": { "type": "string", "description": "The kind of service", "enum": [ "WEB", "WORKER", "CRON", "STATIC", "PRIVATE", "OTHER" ] }, "status": { "type": "string", "description": "Normalized status; set to SUSPENDED or LIVE on update to suspend or resume", "enum": [ "CREATING", "DEPLOYING", "LIVE", "SUSPENDED", "FAILED", "OTHER" ] }, "runtime": { "type": "string", "description": "Runtime or framework (eg. node, python, docker, nextjs)" }, "region_id": { "type": "string", "description": "The region the service runs in" }, "gputype_id": { "type": "string", "description": "The plan or instance type the service runs on" }, "sku": { "type": "string", "description": "The vendor's own plan or size name" }, "instance_count": { "type": "number", "description": "Current number of running instances" }, "min_instance_count": { "type": "number", "description": "Autoscaling minimum" }, "max_instance_count": { "type": "number", "description": "Autoscaling maximum" }, "repo_url": { "type": "string", "description": "Source repository URL" }, "branch": { "type": "string", "description": "Source branch deployed" }, "image": { "type": "string", "description": "Container image, for image-based services" }, "build_command": { "type": "string", "description": "Build command" }, "start_command": { "type": "string", "description": "Start command" }, "url": { "type": "string", "description": "Public URL of the service" }, "project_identifier": { "type": "string", "description": "Vendor project, team or environment that groups the service (reference to TaskProject)" }, "env": { "type": "array", "items": { "$ref": "#/definitions/ComputeEnv" }, "description": "Environment variables (write-only values) set when creating the service" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" }, "description": "Vendor labels, tags and metadata" }, "raw": { "description": "Raw data from integration" } } }, "ComputeDeployment": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the deployment" }, "created_at": { "type": "string", "format": "date-time", "description": "When the deployment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the deployment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "service_id": { "type": "string", "description": "The service this deployment belongs to" }, "status": { "type": "string", "description": "Normalized deployment status; set to CANCELED on update to cancel", "enum": [ "QUEUED", "BUILDING", "DEPLOYING", "LIVE", "FAILED", "CANCELED", "SUPERSEDED", "OTHER" ] }, "trigger": { "type": "string", "description": "What started the deployment", "enum": [ "GIT", "MANUAL", "API", "ROLLBACK", "OTHER" ] }, "environment": { "type": "string", "description": "Target environment", "enum": [ "PRODUCTION", "PREVIEW", "DEVELOPMENT", "OTHER" ] }, "commit_identifier": { "type": "string", "description": "Source commit SHA (reference to RepoCommit)" }, "commit_message": { "type": "string", "description": "Source commit message" }, "branch": { "type": "string", "description": "Source branch" }, "image": { "type": "string", "description": "Container image deployed, for image-based services" }, "url": { "type": "string", "description": "URL where this deployment is served" }, "started_at": { "type": "string", "format": "date-time", "description": "When the build started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "finished_at": { "type": "string", "format": "date-time", "description": "When the deployment finished (live, failed or canceled) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "error": { "type": "string", "description": "Failure description" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" }, "description": "Vendor labels, tags and metadata" }, "raw": { "description": "Raw data from integration" } } }, "ComputeDomain": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the domain" }, "created_at": { "type": "string", "format": "date-time", "description": "When the domain was added (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the domain was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "service_id": { "type": "string", "description": "The service this domain routes to" }, "name": { "type": "string", "description": "The hostname (eg. app.example.com)" }, "status": { "type": "string", "description": "DNS/ownership verification status", "enum": [ "PENDING", "VERIFIED", "FAILED", "OTHER" ] }, "is_primary": { "type": "boolean", "description": "Whether this is the service's primary domain" }, "redirect_url": { "type": "string", "description": "Where the domain redirects, when it is a redirect" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "ComputeEnvvar_environments": { "type": "array", "items": { "type": "string", "enum": [ "PRODUCTION", "PREVIEW", "DEVELOPMENT", "OTHER" ] }, "description": "Environments the variable applies to" }, "ComputeEnvvar": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the environment variable" }, "created_at": { "type": "string", "format": "date-time", "description": "When the variable was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the variable was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "service_id": { "type": "string", "description": "The service the variable belongs to" }, "name": { "type": "string", "description": "Variable name" }, "value": { "type": "string", "description": "Variable value (write-only; never returned)" }, "environments": { "$ref": "#/definitions/ComputeEnvvar_environments", "description": "Environments the variable applies to" }, "is_secret": { "type": "boolean", "description": "Whether the vendor stores the value as a secret" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/ComputeMetadata" } }, "raw": { "description": "Raw data from integration" } } }, "HealthcareEmail": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address" }, "type": { "type": "string", "description": "The kind of email address (work, home or other)", "enum": [ "WORK", "HOME", "OTHER" ] } }, "required": [ "email" ] }, "HealthcareEmails": { "type": "array", "items": { "$ref": "#/definitions/HealthcareEmail" }, "description": "Email addresses for the location" }, "HealthcareTelephone": { "type": "object", "properties": { "telephone": { "type": "string", "description": "The telephone number" }, "type": { "type": "string", "description": "The kind of telephone number (work, home, mobile, fax or other)", "enum": [ "WORK", "HOME", "MOBILE", "FAX", "OTHER" ] } }, "required": [ "telephone" ] }, "HealthcareTelephones": { "type": "array", "items": { "$ref": "#/definitions/HealthcareTelephone" }, "description": "Phone and fax numbers for the location" }, "HealthcarePatient_address": { "type": "object", "properties": { "address1": { "type": "string", "description": "First line of the street address" }, "address2": { "type": "string", "description": "Second line of the street address" }, "city": { "type": "string", "description": "City or locality" }, "region": { "type": "string", "description": "Regional area (e.g., state in the U.S., province in Canada)" }, "postal_code": { "type": "string", "description": "Postal or ZIP code" }, "country": { "type": "string", "description": "Country" } }, "description": "Home address of the patient" }, "HealthcareIdentifier": { "type": "object", "properties": { "value": { "type": "string", "description": "The identifier value" }, "type": { "type": "string", "description": "The kind of identifier", "enum": [ "MRN", "NPI", "SSN", "DRIVERS_LICENSE", "PASSPORT", "INSURANCE", "OTHER" ] }, "system": { "type": "string", "description": "The namespace/system URI that issued the identifier" } }, "required": [ "value" ] }, "HealthcareIdentifiers": { "type": "array", "items": { "$ref": "#/definitions/HealthcareIdentifier" }, "description": "Business identifiers for the location" }, "HealthcarePatient_practitioner_ids": { "type": "array", "items": { "type": "string" }, "description": "The patient's primary care practitioners" }, "HealthcareMetadata": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the custom field" }, "value": { "description": "The custom field value" }, "namespace": { "type": "string", "description": "The scope or origin of the custom field" }, "format": { "type": "string", "description": "The data type of the value", "enum": [ "TEXT", "NUMBER", "DATE", "BOOLEAN", "ARRAY", "OBJECT" ] }, "extra_data": { "description": "Additional data about the custom field" }, "slug": { "type": "string", "description": "The custom field key" } } }, "HealthcareMetadatas": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "HealthcarePatient": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the patient" }, "created_at": { "type": "string", "format": "date-time", "description": "When the patient record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the patient record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Full name of the patient" }, "first_name": { "type": "string", "description": "Given name of the patient" }, "last_name": { "type": "string", "description": "Family name of the patient" }, "gender": { "type": "string", "description": "Administrative gender of the patient", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ] }, "birthdate": { "type": "string", "description": "Date of birth (YYYY-MM-DD)" }, "is_deceased": { "type": "boolean", "description": "Whether the patient is deceased" }, "deceased_at": { "type": "string", "format": "date-time", "description": "When the patient died (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/HealthcareEmail" }, "description": "Email addresses of the patient" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/HealthcareTelephone" }, "description": "Phone numbers of the patient" }, "address": { "$ref": "#/definitions/HealthcarePatient_address", "description": "Home address of the patient" }, "language": { "type": "string", "description": "Preferred language code of the patient" }, "identifiers": { "type": "array", "items": { "$ref": "#/definitions/HealthcareIdentifier" }, "description": "Business identifiers (e.g. MRN)" }, "practitioner_ids": { "$ref": "#/definitions/HealthcarePatient_practitioner_ids", "description": "The patient's primary care practitioners" }, "is_active": { "type": "boolean", "description": "Whether the patient record is in active use" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcarePractitioner_address": { "type": "object", "properties": { "address1": { "type": "string", "description": "First line of the street address" }, "address2": { "type": "string", "description": "Second line of the street address" }, "city": { "type": "string", "description": "City or locality" }, "region": { "type": "string", "description": "Regional area (e.g., state in the U.S., province in Canada)" }, "postal_code": { "type": "string", "description": "Postal or ZIP code" }, "country": { "type": "string", "description": "Country" } }, "description": "Work address of the practitioner" }, "HealthcareCode": { "type": "object", "properties": { "system": { "type": "string", "description": "The code system URI (e.g. http://loinc.org, http://snomed.info/sct)" }, "code": { "type": "string", "description": "The code within the system" }, "display": { "type": "string", "description": "Human-readable display text for the code" } } }, "HealthcareCodes": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the vaccine (e.g. CVX)" }, "HealthcarePractitioner_languages": { "type": "array", "items": { "type": "string" }, "description": "Language codes the practitioner can communicate in" }, "HealthcarePractitioner_location_ids": { "type": "array", "items": { "type": "string" }, "description": "Locations where the practitioner provides care" }, "HealthcarePractitioner": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the practitioner" }, "created_at": { "type": "string", "format": "date-time", "description": "When the practitioner record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the practitioner record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Full name of the practitioner" }, "first_name": { "type": "string", "description": "Given name of the practitioner" }, "last_name": { "type": "string", "description": "Family name of the practitioner" }, "title": { "type": "string", "description": "Professional title or prefix (e.g. Dr.)" }, "gender": { "type": "string", "description": "Administrative gender of the practitioner", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ] }, "emails": { "type": "array", "items": { "$ref": "#/definitions/HealthcareEmail" }, "description": "Email addresses of the practitioner" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/HealthcareTelephone" }, "description": "Phone numbers of the practitioner" }, "address": { "$ref": "#/definitions/HealthcarePractitioner_address", "description": "Work address of the practitioner" }, "image_url": { "type": "string", "description": "Photo of the practitioner" }, "identifiers": { "type": "array", "items": { "$ref": "#/definitions/HealthcareIdentifier" }, "description": "Business identifiers (e.g. NPI)" }, "specialties": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the practitioner's specialties" }, "qualifications": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for certifications, licenses and degrees" }, "languages": { "$ref": "#/definitions/HealthcarePractitioner_languages", "description": "Language codes the practitioner can communicate in" }, "location_ids": { "$ref": "#/definitions/HealthcarePractitioner_location_ids", "description": "Locations where the practitioner provides care" }, "is_active": { "type": "boolean", "description": "Whether the practitioner record is in active use" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareLocation_address": { "type": "object", "properties": { "address1": { "type": "string", "description": "First line of the street address" }, "address2": { "type": "string", "description": "Second line of the street address" }, "city": { "type": "string", "description": "City or locality" }, "region": { "type": "string", "description": "Regional area (e.g., state in the U.S., province in Canada)" }, "postal_code": { "type": "string", "description": "Postal or ZIP code" }, "country": { "type": "string", "description": "Country" } }, "description": "Postal address of the location" }, "HealthcareLocation": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the location" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the location record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "Name of the location" }, "description": { "type": "string", "description": "Description of the location" }, "parent_id": { "type": "string", "description": "The location this one is part of (e.g. a department within a hospital)" }, "organization_name": { "type": "string", "description": "Name of the organization that manages the location" }, "address": { "$ref": "#/definitions/HealthcareLocation_address", "description": "Postal address of the location" }, "telephones": { "type": "array", "items": { "$ref": "#/definitions/HealthcareTelephone" }, "description": "Phone and fax numbers for the location" }, "emails": { "type": "array", "items": { "$ref": "#/definitions/HealthcareEmail" }, "description": "Email addresses for the location" }, "latitude": { "type": "number", "description": "Latitude of the location" }, "longitude": { "type": "number", "description": "Longitude of the location" }, "identifiers": { "type": "array", "items": { "$ref": "#/definitions/HealthcareIdentifier" }, "description": "Business identifiers for the location" }, "is_active": { "type": "boolean", "description": "Whether the location is in active use" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareAppointment_practitioner_ids": { "type": "array", "items": { "type": "string" }, "description": "The practitioners participating in the appointment" }, "HealthcareAppointment_slot_ids": { "type": "array", "items": { "type": "string" }, "description": "The schedule slots this appointment occupies" }, "HealthcareAppointment": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the appointment" }, "created_at": { "type": "string", "format": "date-time", "description": "When the appointment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the appointment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "patient_id": { "type": "string", "description": "The patient attending the appointment" }, "practitioner_ids": { "$ref": "#/definitions/HealthcareAppointment_practitioner_ids", "description": "The practitioners participating in the appointment" }, "location_id": { "type": "string", "description": "Where the appointment takes place" }, "slot_ids": { "$ref": "#/definitions/HealthcareAppointment_slot_ids", "description": "The schedule slots this appointment occupies" }, "status": { "type": "string", "description": "Status of the appointment", "enum": [ "PROPOSED", "PENDING", "BOOKED", "ARRIVED", "CHECKED_IN", "FULFILLED", "CANCELLED", "NOSHOW", "WAITLIST", "ENTERED_IN_ERROR", "OTHER" ] }, "start_at": { "type": "string", "format": "date-time", "description": "When the appointment starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "When the appointment ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "description": { "type": "string", "description": "Short description shown on the appointment" }, "service_types": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the service/visit type being booked" }, "reasons": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the reason for the visit" }, "cancellation_reason": { "type": "string", "description": "Why the appointment was cancelled" }, "notes": { "type": "string", "description": "Free-text notes or comments" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareSlot": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the slot" }, "created_at": { "type": "string", "format": "date-time", "description": "When the slot was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the slot was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "practitioner_id": { "type": "string", "description": "The practitioner whose schedule the slot belongs to" }, "location_id": { "type": "string", "description": "Where the slot takes place" }, "status": { "type": "string", "description": "Availability of the slot", "enum": [ "FREE", "BUSY", "BUSY_UNAVAILABLE", "BUSY_TENTATIVE", "ENTERED_IN_ERROR", "OTHER" ] }, "start_at": { "type": "string", "format": "date-time", "description": "When the slot starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "When the slot ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "service_types": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the services that can be booked in the slot" }, "is_overbooked": { "type": "boolean", "description": "Whether the slot has been overbooked" }, "notes": { "type": "string", "description": "Free-text notes about the slot" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareEncounter_practitioner_ids": { "type": "array", "items": { "type": "string" }, "description": "The practitioners who participated in the encounter" }, "HealthcareEncounter_condition_ids": { "type": "array", "items": { "type": "string" }, "description": "Conditions diagnosed or addressed during the encounter" }, "HealthcareEncounter": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the encounter" }, "created_at": { "type": "string", "format": "date-time", "description": "When the encounter record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the encounter record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "patient_id": { "type": "string", "description": "The patient seen in the encounter" }, "practitioner_ids": { "$ref": "#/definitions/HealthcareEncounter_practitioner_ids", "description": "The practitioners who participated in the encounter" }, "location_id": { "type": "string", "description": "Where the encounter took place" }, "appointment_id": { "type": "string", "description": "The appointment that scheduled this encounter" }, "condition_ids": { "$ref": "#/definitions/HealthcareEncounter_condition_ids", "description": "Conditions diagnosed or addressed during the encounter" }, "status": { "type": "string", "description": "Status of the encounter", "enum": [ "PLANNED", "ARRIVED", "TRIAGED", "IN_PROGRESS", "ONLEAVE", "FINISHED", "CANCELLED", "ENTERED_IN_ERROR", "UNKNOWN", "OTHER" ] }, "type": { "type": "string", "description": "Class of the encounter (e.g. ambulatory, inpatient)", "enum": [ "AMBULATORY", "EMERGENCY", "INPATIENT", "OBSERVATION", "HOME_HEALTH", "VIRTUAL", "OTHER" ] }, "reasons": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the reason for the encounter" }, "start_at": { "type": "string", "format": "date-time", "description": "When the encounter started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "When the encounter ended (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareCondition": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the condition" }, "created_at": { "type": "string", "format": "date-time", "description": "When the condition record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the condition record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "patient_id": { "type": "string", "description": "The patient who has the condition" }, "encounter_id": { "type": "string", "description": "The encounter in which the condition was recorded" }, "practitioner_id": { "type": "string", "description": "The practitioner who recorded or asserted the condition" }, "name": { "type": "string", "description": "Human-readable name of the condition" }, "codes": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the condition (e.g. ICD-10, SNOMED CT)" }, "status": { "type": "string", "description": "Clinical status of the condition", "enum": [ "ACTIVE", "RECURRENCE", "RELAPSE", "INACTIVE", "REMISSION", "RESOLVED", "OTHER" ] }, "type": { "type": "string", "description": "Category of the condition", "enum": [ "PROBLEM", "DIAGNOSIS", "HEALTH_CONCERN", "OTHER" ] }, "onset_at": { "type": "string", "format": "date-time", "description": "When the condition began (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "resolved_at": { "type": "string", "format": "date-time", "description": "When the condition resolved (abatement) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "recorded_at": { "type": "string", "format": "date-time", "description": "When the condition was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "notes": { "type": "string", "description": "Free-text notes about the condition" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareAllergy": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the allergy/intolerance" }, "created_at": { "type": "string", "format": "date-time", "description": "When the allergy record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the allergy record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "patient_id": { "type": "string", "description": "The patient who has the allergy" }, "encounter_id": { "type": "string", "description": "The encounter in which the allergy was recorded" }, "practitioner_id": { "type": "string", "description": "The practitioner who recorded or asserted the allergy" }, "name": { "type": "string", "description": "Human-readable name of the substance" }, "codes": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the substance (e.g. RxNorm, SNOMED CT)" }, "status": { "type": "string", "description": "Clinical status of the allergy", "enum": [ "ACTIVE", "INACTIVE", "RESOLVED", "OTHER" ] }, "type": { "type": "string", "description": "Category of the substance", "enum": [ "FOOD", "MEDICATION", "ENVIRONMENT", "BIOLOGIC", "OTHER" ] }, "criticality": { "type": "string", "description": "Potential severity of future reactions", "enum": [ "LOW", "HIGH", "UNABLE_TO_ASSESS", "OTHER" ] }, "reactions": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for observed reaction manifestations (e.g. hives, anaphylaxis)" }, "onset_at": { "type": "string", "format": "date-time", "description": "When the allergy was first identified (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "recorded_at": { "type": "string", "format": "date-time", "description": "When the allergy was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "notes": { "type": "string", "description": "Free-text notes about the allergy" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareMedication": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the medication order/prescription" }, "created_at": { "type": "string", "format": "date-time", "description": "When the medication record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the medication record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "patient_id": { "type": "string", "description": "The patient the medication is for" }, "encounter_id": { "type": "string", "description": "The encounter in which the medication was ordered" }, "practitioner_id": { "type": "string", "description": "The practitioner who prescribed the medication" }, "name": { "type": "string", "description": "Human-readable name of the medication" }, "codes": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the medication (e.g. RxNorm)" }, "status": { "type": "string", "description": "Status of the medication order", "enum": [ "DRAFT", "ACTIVE", "ON_HOLD", "COMPLETED", "STOPPED", "CANCELLED", "ENTERED_IN_ERROR", "UNKNOWN", "OTHER" ] }, "dosage": { "type": "string", "description": "Free-text dosage instructions (e.g. \"1 tablet by mouth twice daily\")" }, "refill_count": { "type": "number", "description": "Number of refills authorized" }, "authored_at": { "type": "string", "format": "date-time", "description": "When the medication was prescribed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "start_at": { "type": "string", "format": "date-time", "description": "When the patient should start taking the medication (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "end_at": { "type": "string", "format": "date-time", "description": "When the patient should stop taking the medication (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "notes": { "type": "string", "description": "Free-text notes about the medication" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareObservation_reference_range": { "type": "object", "properties": { "low_value": { "type": "number", "description": "Lower bound of the range" }, "high_value": { "type": "number", "description": "Upper bound of the range" }, "unit": { "type": "string", "description": "Unit of the range bounds" }, "text": { "type": "string", "description": "Text description of the range" } }, "description": "Normal range for the result" }, "HealthcareObservationComponent": { "type": "object", "properties": { "name": { "type": "string", "description": "Human-readable name of the component" }, "codes": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the component (e.g. LOINC)" }, "value_number": { "type": "number", "description": "Numeric component value" }, "value_unit": { "type": "string", "description": "Unit of the numeric component value" }, "value_text": { "type": "string", "description": "Text or coded component value" }, "interpretation": { "type": "string", "description": "Interpretation of the component value", "enum": [ "NORMAL", "ABNORMAL", "LOW", "HIGH", "CRITICAL_LOW", "CRITICAL_HIGH", "OTHER" ] } } }, "HealthcareObservationComponents": { "type": "array", "items": { "$ref": "#/definitions/HealthcareObservationComponent" }, "description": "Component results (e.g. systolic and diastolic blood pressure)" }, "HealthcareObservation": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the observation" }, "created_at": { "type": "string", "format": "date-time", "description": "When the observation record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the observation record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "patient_id": { "type": "string", "description": "The patient the observation is about" }, "encounter_id": { "type": "string", "description": "The encounter in which the observation was made" }, "practitioner_id": { "type": "string", "description": "The practitioner who performed the observation" }, "name": { "type": "string", "description": "Human-readable name of what was observed" }, "codes": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for what was observed (e.g. LOINC)" }, "status": { "type": "string", "description": "Status of the observation result", "enum": [ "REGISTERED", "PRELIMINARY", "FINAL", "AMENDED", "CORRECTED", "CANCELLED", "ENTERED_IN_ERROR", "UNKNOWN", "OTHER" ] }, "type": { "type": "string", "description": "Category of the observation", "enum": [ "LABORATORY", "VITAL_SIGNS", "SOCIAL_HISTORY", "IMAGING", "SURVEY", "EXAM", "PROCEDURE", "THERAPY", "ACTIVITY", "OTHER" ] }, "value_number": { "type": "number", "description": "Numeric result value" }, "value_unit": { "type": "string", "description": "Unit of the numeric result (e.g. mg/dL)" }, "value_text": { "type": "string", "description": "Text or coded result value" }, "interpretation": { "type": "string", "description": "Interpretation of the result (e.g. high, low)", "enum": [ "NORMAL", "ABNORMAL", "LOW", "HIGH", "CRITICAL_LOW", "CRITICAL_HIGH", "OTHER" ] }, "reference_range": { "$ref": "#/definitions/HealthcareObservation_reference_range", "description": "Normal range for the result" }, "components": { "type": "array", "items": { "$ref": "#/definitions/HealthcareObservationComponent" }, "description": "Component results (e.g. systolic and diastolic blood pressure)" }, "observed_at": { "type": "string", "format": "date-time", "description": "When the observation was made (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "issued_at": { "type": "string", "format": "date-time", "description": "When the result was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "notes": { "type": "string", "description": "Free-text notes about the observation" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "HealthcareImmunization": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the immunization" }, "created_at": { "type": "string", "format": "date-time", "description": "When the immunization record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the immunization record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "patient_id": { "type": "string", "description": "The patient who was immunized" }, "encounter_id": { "type": "string", "description": "The encounter in which the vaccine was administered" }, "practitioner_id": { "type": "string", "description": "The practitioner who administered the vaccine" }, "location_id": { "type": "string", "description": "Where the vaccine was administered" }, "name": { "type": "string", "description": "Human-readable name of the vaccine" }, "codes": { "type": "array", "items": { "$ref": "#/definitions/HealthcareCode" }, "description": "Codings for the vaccine (e.g. CVX)" }, "status": { "type": "string", "description": "Status of the immunization", "enum": [ "COMPLETED", "NOT_DONE", "ENTERED_IN_ERROR", "OTHER" ] }, "administered_at": { "type": "string", "format": "date-time", "description": "When the vaccine was administered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "lot_number": { "type": "string", "description": "Vaccine lot number" }, "expires_at": { "type": "string", "format": "date-time", "description": "Vaccine expiration date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "notes": { "type": "string", "description": "Free-text notes about the immunization" }, "metadata": { "type": "array", "items": { "$ref": "#/definitions/HealthcareMetadata" }, "description": "Custom field values" }, "raw": { "description": "Raw data from integration" } } }, "Notification": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this notification object", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "workspace_id": { "type": "string", "description": "(reference to KmsSpace)", "readOnly": true }, "description": { "type": "string", "description": "Longer description of this notification" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "user_name": { "type": "string" }, "workspace_name": { "type": "string" }, "webhook_id": { "type": "string" }, "connection_id": { "type": "string" }, "integration_type": { "type": "string" }, "integration_name": { "type": "string" }, "sent_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "event": { "type": "string", "enum": [ "USER_CREATED", "USER_DELETED", "CONNECTION_HEALTHY", "CONNECTION_UNHEALTHY", "CONNECTION_CREATED", "CONNECTION_UPDATED", "CONNECTION_DELETED", "CONNECTION_PAUSED", "CONNECTION_UNPAUSED", "INTEGRATION_ACTIVATED", "INTEGRATION_DEACTIVATED", "INTEGRATION_UPDATED", "WORKSPACE_UPDATED", "WORKSPACE_OVER_LIMIT", "WORKSPACE_80PERCENT_LIMIT", "WEBHOOK_CREATED", "WEBHOOK_DELETED", "WEBHOOK_UNHEALTHY", "WEBHOOK_PAUSED", "WEBHOOK_UNPAUSED" ] } }, "description": "A notification of an event that occurred in you account." }, "Connection_permissions": { "type": "array", "items": { "type": "string", "enum": [ "accounting_account_read", "accounting_account_write", "accounting_transaction_read", "accounting_transaction_write", "accounting_journal_read", "accounting_journal_write", "accounting_invoice_read", "accounting_invoice_write", "accounting_bill_read", "accounting_bill_write", "accounting_vendorcredit_read", "accounting_vendorcredit_write", "accounting_creditmemo_read", "accounting_creditmemo_write", "accounting_contact_read", "accounting_contact_write", "accounting_expense_read", "accounting_expense_write", "accounting_expensereport_read", "accounting_expensereport_write", "accounting_purchasereceipt_read", "accounting_purchasereceipt_write", "accounting_taxrate_read", "accounting_taxrate_write", "accounting_paymentterm_read", "accounting_paymentterm_write", "accounting_organization_read", "accounting_order_read", "accounting_order_write", "accounting_purchaseorder_read", "accounting_purchaseorder_write", "accounting_salesorder_read", "accounting_salesorder_write", "accounting_salesreceipt_read", "accounting_salesreceipt_write", "accounting_trialbalance_read", "accounting_trialbalance_write", "accounting_profitloss_read", "accounting_profitloss_write", "accounting_balancesheet_read", "accounting_balancesheet_write", "accounting_category_read", "accounting_category_write", "payment_payment_read", "payment_payment_write", "accounting_cashflow_read", "accounting_cashflow_write", "accounting_quote_read", "accounting_quote_write", "accounting_agedreceivable_read", "accounting_agedpayable_read", "accounting_project_read", "accounting_project_write", "accounting_bankfeedaccount_read", "accounting_bankfeedaccount_write", "accounting_bankfeedtransaction_read", "accounting_bankfeedtransaction_write", "payment_payout_read", "payment_refund_read", "payment_link_read", "payment_link_write", "payment_subscription_read", "payment_subscription_write", "commerce_item_read", "commerce_item_write", "commerce_collection_read", "commerce_collection_write", "commerce_inventory_read", "commerce_inventory_write", "commerce_location_read", "commerce_location_write", "commerce_review_read", "commerce_review_write", "commerce_saleschannel_read", "commerce_saleschannel_write", "commerce_itemvariant_read", "commerce_itemvariant_write", "commerce_reservation_read", "commerce_reservation_write", "commerce_availability_read", "commerce_availability_write", "verification_package_read", "verification_request_read", "verification_request_write", "assessment_package_read", "assessment_package_write", "assessment_order_write", "ats_activity_read", "ats_activity_write", "ats_application_read", "ats_application_write", "ats_applicationstatus_read", "ats_candidate_read", "ats_candidate_write", "ats_interview_read", "ats_interview_write", "ats_job_read", "ats_job_write", "ats_company_read", "ats_company_write", "ats_document_read", "ats_document_write", "ats_scorecard_read", "ats_scorecard_write", "crm_company_read", "crm_company_write", "crm_contact_read", "crm_contact_write", "crm_deal_read", "crm_deal_write", "crm_event_read", "crm_event_write", "crm_lead_read", "crm_lead_write", "crm_pipeline_read", "crm_pipeline_write", "crm_taxonomy_read", "martech_list_read", "martech_list_write", "martech_member_read", "martech_member_write", "martech_campaign_read", "martech_campaign_write", "martech_report_read", "martech_report_write", "ticketing_customer_read", "ticketing_customer_write", "ticketing_ticket_read", "ticketing_ticket_write", "ticketing_note_read", "ticketing_note_write", "ticketing_category_read", "ticketing_category_write", "hris_employee_read", "hris_employee_write", "hris_group_read", "hris_group_write", "hris_payslip_read", "hris_payslip_write", "hris_timeoff_read", "hris_timeoff_write", "hris_timeshift_read", "hris_timeshift_write", "hris_attendance_read", "hris_attendance_write", "hris_company_read", "hris_company_write", "hris_location_read", "hris_location_write", "hris_device_read", "hris_device_write", "hris_deduction_read", "hris_deduction_write", "hris_benefit_read", "hris_benefit_write", "hris_bankaccount_read", "hris_bankaccount_write", "hris_document_read", "hris_document_write", "hris_taxonomy_read", "hris_taxonomy_write", "hris_job_read", "hris_job_write", "hris_payroll_read", "hris_payroll_write", "hris_paycode_read", "hris_paycode_write", "hris_earning_read", "hris_earning_write", "uc_call_read", "uc_contact_read", "uc_contact_write", "uc_comment_read", "uc_comment_write", "uc_recording_read", "uc_scorecard_read", "uc_scorecardtemplate_read", "storage_file_read", "storage_file_write", "webhook", "genai_model_read", "genai_prompt_read", "genai_prompt_write", "genai_embedding_read", "genai_embedding_write", "genai_task_read", "genai_task_write", "genai_agent_read", "genai_agent_write", "genai_organization_read", "genai_organization_write", "genai_skill_read", "genai_skill_write", "genai_memory_read", "genai_memory_write", "messaging_message_read", "messaging_message_write", "messaging_channel_read", "messaging_channel_write", "messaging_event_read", "messaging_event_write", "kms_space_read", "kms_space_write", "kms_page_read", "kms_page_write", "kms_comment_read", "kms_comment_write", "task_project_read", "task_project_write", "task_task_read", "task_task_write", "task_change_read", "task_comment_read", "task_comment_write", "scim_users_read", "scim_users_write", "scim_groups_read", "scim_groups_write", "lms_course_read", "lms_course_write", "lms_class_read", "lms_class_write", "lms_student_read", "lms_student_write", "lms_instructor_read", "lms_instructor_write", "lms_content_read", "lms_content_write", "lms_collection_read", "lms_collection_write", "lms_activity_read", "lms_activity_write", "repo_organization_read", "repo_organization_write", "repo_repository_read", "repo_repository_write", "repo_branch_read", "repo_branch_write", "repo_commit_read", "repo_commit_write", "repo_pullrequest_read", "repo_pullrequest_write", "metadata_metadata_read", "metadata_metadata_write", "calendar_calendar_read", "calendar_calendar_write", "calendar_event_read", "calendar_event_write", "calendar_busy_read", "calendar_link_read", "calendar_link_write", "calendar_recording_read", "calendar_recording_write", "calendar_webinar_read", "calendar_webinar_write", "enrich_person_read", "enrich_company_read", "ads_ad_read", "ads_ad_write", "ads_campaign_read", "ads_campaign_write", "ads_group_read", "ads_group_write", "ads_report_read", "ads_organization_read", "ads_organization_write", "ads_creative_read", "ads_creative_write", "ads_asset_read", "ads_asset_write", "ads_insertionorder_read", "ads_insertionorder_write", "ads_target_read", "ads_promoted_read", "analytics_property_read", "analytics_property_write", "analytics_event_read", "analytics_event_write", "analytics_session_read", "analytics_visitor_read", "analytics_visitor_write", "analytics_report_read", "forms_form_read", "forms_form_write", "forms_submission_read", "forms_submission_write", "shipping_shipment_read", "shipping_shipment_write", "shipping_label_read", "shipping_label_write", "shipping_tracking_read", "shipping_rate_read", "shipping_rate_write", "shipping_carrier_read", "signing_document_read", "signing_document_write", "signing_signatory_read", "signing_signatory_write", "signing_template_read", "signing_template_write", "clubs_group_read", "clubs_group_write", "clubs_member_read", "clubs_member_write", "clubs_activity_read", "clubs_activity_write", "clubs_location_read", "clubs_location_write", "clubs_event_read", "clubs_event_write", "datastore_database_read", "datastore_database_write", "datastore_table_read", "datastore_table_write", "datastore_record_read", "datastore_record_write", "datastore_query_read", "datastore_query_write", "cdp_profile_read", "cdp_profile_write", "cdp_segment_read", "cdp_segment_write", "cdp_event_read", "cdp_event_write", "cdp_source_read", "cdp_source_write", "cdp_destination_read", "cdp_destination_write", "cdp_activation_read", "cdp_activation_write", "performance_cycle_read", "performance_review_read", "performance_review_write", "performance_goal_read", "performance_goal_write", "performance_feedback_read", "performance_feedback_write", "social_post_read", "social_post_write", "social_profile_read", "social_profile_write", "social_review_read", "social_review_write", "social_insight_read", "social_insight_write", "legal_matter_read", "legal_matter_write", "legal_practicearea_read", "legal_practicearea_write", "legal_timeentry_read", "legal_timeentry_write", "legal_expense_read", "legal_expense_write", "compute_instance_read", "compute_instance_write", "compute_template_read", "compute_template_write", "compute_gputype_read", "compute_region_read", "compute_volume_read", "compute_volume_write", "compute_snapshot_read", "compute_snapshot_write", "compute_usage_read", "compute_key_read", "compute_key_write", "compute_service_read", "compute_service_write", "compute_deployment_read", "compute_deployment_write", "compute_domain_read", "compute_domain_write", "compute_envvar_read", "compute_envvar_write", "healthcare_patient_read", "healthcare_patient_write", "healthcare_practitioner_read", "healthcare_practitioner_write", "healthcare_location_read", "healthcare_location_write", "healthcare_appointment_read", "healthcare_appointment_write", "healthcare_slot_read", "healthcare_slot_write", "healthcare_encounter_read", "healthcare_encounter_write", "healthcare_condition_read", "healthcare_condition_write", "healthcare_allergy_read", "healthcare_allergy_write", "healthcare_medication_read", "healthcare_medication_write", "healthcare_observation_read", "healthcare_observation_write", "healthcare_immunization_read", "healthcare_immunization_write" ] } }, "Connection_categories": { "type": "array", "items": { "type": "string", "enum": [ "passthrough", "hris", "ats", "auth", "saml", "crm", "enrich", "martech", "ticketing", "uc", "accounting", "storage", "commerce", "payment", "genai", "messaging", "kms", "task", "scim", "lms", "repo", "metadata", "calendar", "verification", "ads", "analytics", "forms", "shipping", "assessment", "signing", "clubs", "datastore", "cdp", "performance", "social", "legal", "compute", "healthcare" ] }, "description": "The Integration categories that this connection supports" }, "Connection_auth_emails": { "type": "array", "items": { "type": "string" } }, "Connection_auth_other_auth_info": { "type": "array", "items": { "type": "string" }, "description": "When integration.auth_type = \"other\", this field contains the authentication credentials in the same order as token_names" }, "Connection_auth": { "type": "object", "properties": { "token": { "type": "string" }, "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "expiry_date": { "type": "string", "format": "date-time" }, "expires_in": { "type": "number" }, "emails": { "$ref": "#/definitions/Connection_auth_emails" }, "name": { "type": "string" }, "user_id": { "type": "string", "description": "(reference to HrisEmployee)" }, "app_id": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "consumer_key": { "type": "string" }, "consumer_secret": { "type": "string" }, "meta": { "readOnly": true }, "state": { "type": "string" }, "other_auth_info": { "$ref": "#/definitions/Connection_auth_other_auth_info", "description": "When integration.auth_type = \"other\", this field contains the authentication credentials in the same order as token_names" }, "api_url": { "type": "string" }, "authorize_url": { "type": "string" }, "token_url": { "type": "string" }, "refresh_url": { "type": "string" }, "pem": { "type": "string", "description": "the PEM X.509 certificate in Base64 ASCII format" }, "key": { "type": "string", "description": "the private KEY X.509 certificate in Base64 ASCII format" }, "refresh_token_expires_in": { "type": "number" }, "refresh_token_expires_date": { "type": "string", "format": "date-time" }, "dev_api_key": { "type": "string" }, "audience": { "type": "string" } }, "description": "An authentication object that represents a specific authorized user's connection to an integration." }, "Connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this integration object", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "The last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "workspace_id": { "type": "string", "description": "(reference to KmsSpace)", "readOnly": true }, "integration_type": { "type": "string", "description": "The integration type" }, "integration_name": { "type": "string" }, "external_xref": { "type": "string", "description": "customer's user ID" }, "permissions": { "$ref": "#/definitions/Connection_permissions" }, "categories": { "$ref": "#/definitions/Connection_categories", "description": "The Integration categories that this connection supports" }, "auth": { "$ref": "#/definitions/Connection_auth", "description": "An authentication object that represents a specific authorized user's connection to an integration." }, "is_paused": { "type": "boolean", "description": "Whether this integration has exceed the monthly limit of the plan", "readOnly": true }, "environment": { "type": "string" }, "last_healthy_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "last_unhealthy_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "last_unhealthy_code": { "type": "string", "description": "The HTTP status code that caused the last unhealthy status" }, "secretsmanager_id": { "type": "string", "description": "the ID of the SecretsManager object" }, "secretsmanager_key": { "type": "string", "description": "the key/path/name of the secret within the vault" } }, "required": [ "integration_type", "permissions", "categories" ], "description": "A connection represents a specific authentication of an integration." }, "ConnectionReauth": { "type": "object", "properties": { "reauth_token": { "type": "string", "description": "Pass as reauth_token (together with connection_id) on the \"Authorize or re-authorize a connection\" URL" }, "expires_at": { "type": "string", "description": "The token is single-use and expires at this time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" } } }, "SecretsManagerInstructions": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "aws", "azure", "gcp", "hashicorp", "composio", "1password", "bitwarden", "doppler", "akeyless", "pipedream", "alibabacloud" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "instructions": { "type": "string" } }, "required": [ "key", "label" ] }, "SecretsManagerSecret": { "type": "object", "properties": { "id": { "type": "string", "description": "maps to secretsmanager_id in ISecretsManager" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "SecretsManager_auth": { "type": "object", "additionalProperties": { "type": "string" }, "description": "secrets-manager specific authentication values" }, "SecretsManager_dcs": { "type": "array", "items": { "type": "string" }, "description": "data-regions" }, "SecretsManager": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "type": { "type": "string", "enum": [ "aws", "azure", "gcp", "hashicorp", "composio", "1password", "bitwarden", "doppler", "akeyless", "pipedream", "alibabacloud" ] }, "name": { "type": "string" }, "workspace_id": { "type": "string", "description": "(reference to KmsSpace)" }, "auth": { "$ref": "#/definitions/SecretsManager_auth", "description": "secrets-manager specific authentication values" }, "dcs": { "$ref": "#/definitions/SecretsManager_dcs", "description": "data-regions" } }, "required": [ "type", "name", "auth" ] }, "Issue_type": { "type": "array", "items": { "type": "string" } }, "Issue": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "COMPLETED", "NEW", "ROADMAP", "IN_PROGRESS", "ON_HOLD", "VALIDATING", "REJECTED" ] }, "url": { "type": "string" }, "workspace_id": { "type": "string", "description": "(reference to KmsSpace)" }, "type": { "$ref": "#/definitions/Issue_type" }, "resolution_time": { "type": "number" }, "ticket_ref": { "type": "string" }, "size": { "type": "number", "description": "1-5, 1 is lowest" }, "importance": { "type": "number", "description": "1-5, 1 is lowest" }, "customer_note": { "type": "string" } }, "required": [ "title", "status", "workspace_id", "ticket_ref" ] }, "Integration_categories": { "type": "array", "items": { "type": "string", "enum": [ "passthrough", "hris", "ats", "auth", "saml", "crm", "enrich", "martech", "ticketing", "uc", "accounting", "storage", "commerce", "payment", "genai", "messaging", "kms", "task", "scim", "lms", "repo", "metadata", "calendar", "verification", "ads", "analytics", "forms", "shipping", "assessment", "signing", "clubs", "datastore", "cdp", "performance", "social", "legal", "compute", "healthcare" ] }, "description": "The categories of support solutions that this integration has" }, "Integration_token_names": { "type": "array", "items": { "type": "string" }, "description": "if auth_types = 'token'" }, "Integration_token_instructions": { "type": "array", "items": { "type": "string" }, "description": "instructions for the user on how to find the token/key" }, "IntegrationSupport_methods": { "type": "object", "additionalProperties": { "type": "boolean" } }, "IntegrationSupport_inbound_fields": { "type": "object", "additionalProperties": { "type": "string" } }, "IntegrationSupport_outbound_fields": { "type": "object", "additionalProperties": { "type": "string" } }, "IntegrationSupport_webhook_events_updated": { "type": "array", "items": { "type": "string", "enum": [ "virtual", "native" ] } }, "IntegrationSupport_webhook_events_created": { "type": "array", "items": { "type": "string", "enum": [ "virtual", "native" ] } }, "IntegrationSupport_webhook_events_deleted": { "type": "array", "items": { "type": "string", "enum": [ "virtual", "native" ] } }, "IntegrationSupport_webhook_events": { "type": "object", "properties": { "updated": { "$ref": "#/definitions/IntegrationSupport_webhook_events_updated" }, "created": { "$ref": "#/definitions/IntegrationSupport_webhook_events_created" }, "deleted": { "$ref": "#/definitions/IntegrationSupport_webhook_events_deleted" } } }, "IntegrationSupport_raw_objects": { "type": "array", "items": { "type": "string" }, "description": "objects that we map from in the integration" }, "IntegrationSupport_slow_fields": { "type": "array", "items": { "type": "string" } }, "IntegrationSupport": { "type": "object", "properties": { "methods": { "$ref": "#/definitions/IntegrationSupport_methods" }, "inbound_fields": { "$ref": "#/definitions/IntegrationSupport_inbound_fields" }, "outbound_fields": { "$ref": "#/definitions/IntegrationSupport_outbound_fields" }, "webhook_events": { "$ref": "#/definitions/IntegrationSupport_webhook_events" }, "raw_objects": { "$ref": "#/definitions/IntegrationSupport_raw_objects", "description": "objects that we map from in the integration" }, "slow_fields": { "$ref": "#/definitions/IntegrationSupport_slow_fields" }, "from_webhook": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_sort_by_name": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_sort_by_created_at": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_sort_by_updated_at": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_updated_gte": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_user_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_assigned_user_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_user_mentioned_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_customer_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_company_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_contact_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_application_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_candidate_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_deal_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_job_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_invoice_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_order": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_query": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_limit": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_offset": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_root_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_list_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_interview_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_location_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_collection_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_ticket_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_parent_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_account_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_item_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_space_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_channel_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_page_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_type": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_link_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_project_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_item_variant_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_raw_fields": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_student_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_class_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_instructor_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_course_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_teacher_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_repo_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_org_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_calendar_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_task_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_agent_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "search_twitter": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "search_name": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "search_linkedinurl": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "search_email": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "search_domain": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_event_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_start_gte": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_end_lt": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_lead_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_call_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_document_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_payment_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_status": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_branch_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_pipeline_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_category_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_package_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_expand": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_parent_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_project_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_company_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_task_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_channel_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_calendar_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_event_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_updated_gte": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_limit": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_channel_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_parent_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_contact_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_deal_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_company_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_user_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_user_mentioned_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_type": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_ticket_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_expand": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_status": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_start_gte": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_end_lt": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_task_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_space_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_repo_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_project_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_pipeline_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_page_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_org_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_location_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_list_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_job_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_item_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_fields": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_event_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_customer_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_collection_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_candidate_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_call_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_branch_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_application_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_item_variant_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_calendar_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_lead_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_payslip_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_benefit_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_saleschannel_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_saleschannel_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_campaign_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_ad_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_group_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_campaign_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_ad_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_group_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_form_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_form_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_form_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_order_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_order_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_order_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_carrier_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_carrier_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_carrier_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_shipment_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_shipment_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_shipment_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_label_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_label_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_label_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_member_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_member_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_member_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_content_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_course_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_course_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_student_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_student_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_type": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_link_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_bill_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_invoice_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_bill_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_benefit_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_payment_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_fulltext": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_io_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_io_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_io_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_size": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_template_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_template_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_template_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_list_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_reference": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_reference": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_account_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_database_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_database_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_database_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_table_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_table_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_table_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_property_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_visitor_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_session_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_profile_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_property_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_property_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_session_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_session_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_visitor_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_visitor_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_medium": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_source": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_dimension": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_goal": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_role_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_effective_status": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_assigned_user_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_profile_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_segment_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_cycle_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_cycle_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_bankfeedaccount_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_bankfeedaccount_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_post_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_post_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_approver_user_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_approver_user_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_effective_status": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "native_webhook_updated_gte": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_destination_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_email": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_matter_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_matter_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_practicearea_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_practicearea_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_region_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_instance_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_service_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_patient_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_patient_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "list_practitioner_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] }, "virtual_webhook_practitioner_id": { "type": "string", "enum": [ "supported-required", "supported", "not-supported" ] } }, "required": [ "raw_objects" ] }, "Integration_support": { "type": "object", "additionalProperties": { "$ref": "#/definitions/IntegrationSupport" } }, "Integration": { "type": "object", "properties": { "type": { "type": "string", "description": "Identifier for this integration" }, "created_at": { "type": "string", "description": "Date that this integration was supported (YYYY-MM-DD) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "updated_at": { "type": "string", "description": "YYYY-MM-DD (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "name": { "type": "string", "description": "The integration's name" }, "is_active": { "type": "boolean", "description": "Is this integration active in this workspace" }, "categories": { "$ref": "#/definitions/Integration_categories", "description": "The categories of support solutions that this integration has" }, "api_docs_url": { "type": "string", "description": "The URL of the integration's API documentation" }, "logo_url": { "type": "string", "description": "The URL of the integration's logo" }, "in_progress": { "type": "boolean", "description": "If this integration is not yet available as it is currently being built by unified.to" }, "is_hidden": { "type": "boolean" }, "color": { "type": "string", "description": "button background color for AUTH" }, "text_color": { "type": "string", "description": "text color for AUTH" }, "fa_icon": { "type": "string", "description": "font-awesome icon" }, "token_names": { "$ref": "#/definitions/Integration_token_names", "description": "if auth_types = 'token'" }, "token_instructions": { "$ref": "#/definitions/Integration_token_instructions", "description": "instructions for the user on how to find the token/key" }, "web_url": { "type": "string", "description": "URL for the software vendor" }, "rate_limit_description": { "type": "string" }, "beta": { "type": "boolean", "description": "This integration is new and is still considered \"beta\"" }, "requires_cname": { "type": "boolean", "description": "OAuth requires a custom API domain (CNAME) for provider verification" }, "support": { "$ref": "#/definitions/Integration_support" }, "tested_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, "sandbox": {}, "partnership": {}, "saml": {}, "description": { "type": "string" }, "api": {}, "featured": { "type": "boolean" }, "popularity": { "type": "number" }, "active_healthy_connections": { "type": "number" } }, "required": [ "type", "name", "categories" ], "description": "Informational object for supported integrations." }, "Webhook_runs": { "type": "array", "items": { "type": "string" }, "description": "An array of the most recent virtual webhook runs" }, "Webhook_filters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Supported on virtual webhooks, and on native webhooks for many integrations. Check the integration's Feature Support tab for which filters apply. Filters the integration doesn't support are accepted but have no effect. Some integrations require a filter; if it's missing, create returns an error naming the integration and the filter." }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "workspace_id": { "type": "string", "description": "(reference to KmsSpace)", "readOnly": true }, "connection_id": { "type": "string" }, "hook_url": { "type": "string", "description": "The URL of the webhook" }, "object_type": { "type": "string", "description": "The object to return (eg. CRM \"contact\")", "enum": [ "accounting_account", "accounting_transaction", "accounting_journal", "accounting_contact", "accounting_invoice", "accounting_bill", "accounting_vendorcredit", "accounting_creditmemo", "accounting_taxrate", "accounting_paymentterm", "accounting_organization", "accounting_order", "accounting_salesorder", "accounting_salesreceipt", "accounting_purchaseorder", "accounting_balancesheet", "accounting_profitloss", "accounting_trialbalance", "accounting_category", "accounting_expense", "accounting_expensereport", "accounting_purchasereceipt", "accounting_cashflow", "accounting_quote", "accounting_agedreceivable", "accounting_agedpayable", "accounting_project", "accounting_bankfeedaccount", "accounting_bankfeedtransaction", "payment_payment", "payment_link", "payment_payout", "payment_refund", "payment_subscription", "commerce_item", "commerce_collection", "commerce_inventory", "commerce_location", "commerce_review", "commerce_saleschannel", "commerce_itemvariant", "commerce_reservation", "commerce_availability", "verification_package", "verification_request", "assessment_package", "assessment_order", "ats_activity", "ats_application", "ats_applicationstatus", "ats_candidate", "ats_document", "ats_interview", "ats_job", "ats_scorecard", "ats_company", "crm_company", "crm_contact", "crm_deal", "crm_event", "crm_lead", "crm_pipeline", "crm_taxonomy", "hris_employee", "hris_group", "hris_payslip", "hris_timeoff", "hris_company", "hris_location", "hris_device", "hris_timeshift", "hris_attendance", "hris_deduction", "hris_benefit", "hris_bankaccount", "hris_document", "hris_taxonomy", "hris_job", "hris_payroll", "hris_paycode", "hris_earning", "martech_list", "martech_member", "martech_campaign", "martech_report", "passthrough", "ticketing_note", "ticketing_ticket", "ticketing_customer", "ticketing_category", "uc_contact", "uc_call", "uc_comment", "uc_recording", "uc_scorecard", "uc_scorecardtemplate", "enrich_person", "enrich_company", "storage_file", "genai_model", "genai_prompt", "genai_embedding", "genai_task", "genai_agent", "genai_organization", "genai_skill", "genai_memory", "messaging_message", "messaging_channel", "messaging_event", "kms_space", "kms_page", "kms_comment", "task_project", "task_task", "task_comment", "task_change", "scim_users", "scim_groups", "lms_course", "lms_class", "lms_student", "lms_instructor", "lms_content", "lms_collection", "lms_activity", "repo_organization", "repo_repository", "repo_branch", "repo_commit", "repo_pullrequest", "metadata_metadata", "calendar_calendar", "calendar_event", "calendar_busy", "calendar_link", "calendar_recording", "calendar_webinar", "ads_organization", "ads_ad", "ads_campaign", "ads_report", "ads_group", "ads_creative", "ads_asset", "ads_insertionorder", "ads_target", "ads_promoted", "analytics_property", "analytics_event", "analytics_session", "analytics_visitor", "analytics_report", "forms_form", "forms_submission", "shipping_carrier", "shipping_rate", "shipping_shipment", "shipping_label", "shipping_tracking", "signing_document", "signing_signatory", "signing_template", "clubs_group", "clubs_member", "clubs_activity", "clubs_location", "clubs_event", "datastore_database", "datastore_table", "datastore_record", "datastore_query", "cdp_profile", "cdp_segment", "cdp_event", "cdp_source", "cdp_destination", "cdp_activation", "performance_cycle", "performance_review", "performance_goal", "performance_feedback", "social_post", "social_profile", "social_review", "social_insight", "legal_matter", "legal_practicearea", "legal_timeentry", "legal_expense", "compute_instance", "compute_template", "compute_gputype", "compute_region", "compute_volume", "compute_snapshot", "compute_usage", "compute_key", "compute_service", "compute_deployment", "compute_domain", "compute_envvar", "healthcare_patient", "healthcare_practitioner", "healthcare_location", "healthcare_appointment", "healthcare_slot", "healthcare_encounter", "healthcare_condition", "healthcare_allergy", "healthcare_medication", "healthcare_observation", "healthcare_immunization" ] }, "interval": { "type": "number", "description": "Virtual webhooks only. How often (in minutes) Unified.to checks for new or updated records. Minimum 1 on paid plans, 60 on free. Ignored for native webhooks." }, "checked_at": { "type": "string", "format": "date-time", "description": "Read-only. The time Unified.to last recorded a check on this webhook. Behaviour varies by webhook implementation, so don't use this field to tell whether a webhook is still running. Use is_healthy, and subscribe to WEBHOOK_UNHEALTHY on the notifications webhook, to monitor health. (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "integration_type": { "type": "string", "readOnly": true }, "environment": { "type": "string", "readOnly": true }, "event": { "type": "string", "description": "The event to subscribe to. \"deleted\" is supported on native webhooks, and on virtual webhooks where the integration supports it. Check the integration's Feature Support tab.", "enum": [ "updated", "created", "deleted" ] }, "runs": { "$ref": "#/definitions/Webhook_runs", "description": "An array of the most recent virtual webhook runs", "readOnly": true }, "fields": { "type": "string" }, "webhook_type": { "type": "string", "description": "\"native\" registers with the integration, which sends events as they happen. \"virtual\" checks for changes on \"interval\". Optional on create; if omitted, Unified.to picks a supported type for the object. Requesting a type the integration doesn't support returns 400. Set on create only: changes sent on update are ignored without an error. Delete and recreate the webhook to change type.", "enum": [ "virtual", "native" ] }, "meta": { "readOnly": true }, "is_healthy": { "type": "boolean", "description": "Read-only. True while the webhook can operate or recover; a transient failure may still be retrying. False after retries are exhausted or a non-retryable failure such as broken connection auth. Cannot be reset; recreate the webhook.", "readOnly": true }, "page_max_limit": { "type": "number" }, "filters": { "$ref": "#/definitions/Webhook_filters", "description": "Supported on virtual webhooks, and on native webhooks for many integrations. Check the integration's Feature Support tab for which filters apply. Filters the integration doesn't support are accepted but have no effect. Some integrations require a filter; if it's missing, create returns an error naming the integration and the filter." }, "db_type": { "type": "string", "enum": [ "mongodb", "mysql", "postgres", "mssql", "mariadb", "supabase", "snowflake" ] }, "db_url": { "type": "string" }, "db_schema": { "type": "string" }, "db_name_prefix": { "type": "string" }, "is_paused": { "type": "boolean" }, "is_beta": { "type": "boolean" } }, "required": [ "connection_id", "object_type", "event" ], "description": "A webhook is used to POST new, updated, or deleted records to your server." }, "ApiCall": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this API call", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "The date that this object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)", "readOnly": true }, "connection_id": { "type": "string" }, "workspace_id": { "type": "string", "description": "(reference to KmsSpace)", "readOnly": true }, "integration_type": { "type": "string", "description": "The integration type" }, "external_xref": { "type": "string", "description": "your customer's user ID" }, "name": { "type": "string", "description": "The called name of the API method" }, "path": { "type": "string", "description": "The called API method's HTTP verb and route path (PUT /crm/{integration}/deak/{id})" }, "size": { "type": "number", "description": "The size of the response" }, "status": { "type": "string", "description": "The resulting HTTP status code (200)" }, "error": { "type": "string", "description": "The error description (if status code is >= 400)" }, "ip_address": { "type": "string" }, "type": { "type": "string", "description": "The type of API Call being logged", "enum": [ "login", "webhook", "inbound", "mcp" ] }, "method": { "type": "string" }, "environment": { "type": "string" }, "webhook_id": { "type": "string" }, "is_billable": { "type": "boolean" }, "user_agent": { "type": "string" }, "unified_response_time": { "type": "number" }, "endapi_response_time": { "type": "number" } }, "required": [ "integration_type", "name", "path", "status", "type", "method" ] }, "Environment": { "type": "object" }, "Environments_List": { "type": "array", "items": { "type": "string" }, "description": "A list of environments in the workspace." }, "ScimUser_schemas": { "type": "array", "items": { "type": "string", "enum": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User", "urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User", "urn:ietf:params:scim:schemas:extension:peakon:2.0:User" ] } }, "ScimUser_meta": { "type": "object", "properties": { "resourceType": { "type": "string", "enum": [ "User", "Group" ] }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" }, "version": { "type": "string" } } }, "ScimUser_name": { "type": "object", "properties": { "formatted": { "type": "string" }, "familyName": { "type": "string" }, "givenName": { "type": "string" }, "middleName": { "type": "string" }, "honorificPrefix": { "type": "string" }, "honorificSuffix": { "type": "string" } } }, "ScimPhoneNumber": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "work", "home", "other", "mobile", "fax", "pager" ] }, "value": { "type": "string" }, "display": { "type": "string" }, "primary": { "type": "boolean" } } }, "ScimPhoneNumbers": { "type": "array", "items": { "$ref": "#/definitions/ScimPhoneNumber" } }, "ScimEmail": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "work", "home", "other" ] }, "value": { "type": "string" }, "primary": { "type": "boolean" }, "display": { "type": "string" } }, "required": [ "type" ] }, "ScimEmails": { "type": "array", "items": { "$ref": "#/definitions/ScimEmail" } }, "ScimIms": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "aim", "qtalk", "icq", "xmpp", "msn", "skype", "qq", "yahoo" ] }, "value": { "type": "string" }, "display": { "type": "string" }, "primary": { "type": "boolean" } } }, "ScimIms_List": { "type": "array", "items": { "$ref": "#/definitions/ScimIms" } }, "ScimPhoto": { "type": "object", "properties": { "value": { "type": "string", "description": "URL" }, "display": { "type": "string" }, "type": { "type": "string", "enum": [ "photo", "thumbnail" ] }, "primary": { "type": "boolean" } } }, "ScimPhotos": { "type": "array", "items": { "$ref": "#/definitions/ScimPhoto" } }, "ScimAddress": { "type": "object", "properties": { "formatted": { "type": "string" }, "streetAddress": { "type": "string", "description": "could be multi-line" }, "locality": { "type": "string", "description": "city" }, "region": { "type": "string", "description": "stateprovince" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "type": { "type": "string", "enum": [ "work", "home", "other" ] } } }, "ScimAddresses": { "type": "array", "items": { "$ref": "#/definitions/ScimAddress" } }, "ScimUserGroups": { "type": "object", "properties": { "value": { "type": "string", "description": "ID" }, "$ref": { "type": "string" }, "display": { "type": "string" }, "type": { "type": "string", "enum": [ "direct", "indirect" ] } }, "required": [ "value" ] }, "ScimUserGroups_List": { "type": "array", "items": { "$ref": "#/definitions/ScimUserGroups" } }, "ScimEntitlement": { "type": "object", "properties": { "value": { "type": "string" }, "display": { "type": "string" }, "type": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ] }, "ScimEntitlements": { "type": "array", "items": { "$ref": "#/definitions/ScimEntitlement" } }, "ScimRole": { "type": "object", "properties": { "value": { "type": "string", "description": "value of the role" }, "display": { "type": "string" }, "type": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ] }, "ScimRoles": { "type": "array", "items": { "$ref": "#/definitions/ScimRole" } }, "ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User_manager": { "type": "object", "properties": { "value": { "type": "string", "description": "The \"id\" of the SCIM resource representing the user's manager. RECOMMENDED." }, "managerId": { "type": "string", "description": "alias for value?" }, "$ref": { "type": "string", "description": "The URI of the SCIM resource representing the User's manager. RECOMMENDED." }, "displayName": { "type": "string", "description": "The displayName of the user's manager. This attribute is OPTIONAL, and mutability is \"readOnly\"." }, "type": { "type": "string", "enum": [ "direct", "indirect" ] } }, "description": "\"id\" attribute of another User." }, "ScimManager": { "type": "object", "properties": { "value": { "type": "string", "description": "The \"id\" of the SCIM resource representing the user's manager. RECOMMENDED." }, "managerId": { "type": "string", "description": "alias for value?" }, "$ref": { "type": "string", "description": "The URI of the SCIM resource representing the User's manager. RECOMMENDED." }, "displayName": { "type": "string", "description": "The displayName of the user's manager. This attribute is OPTIONAL, and mutability is \"readOnly\"." }, "type": { "type": "string", "enum": [ "direct", "indirect" ] } }, "description": "\"id\" attribute of another User." }, "ScimManagers": { "type": "array", "items": { "$ref": "#/definitions/ScimManager" } }, "ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User": { "type": "object", "properties": { "employeeNumber": { "type": "string" }, "costCenter": { "type": "string", "description": "Identifies the name of a cost center." }, "organization": { "type": "string", "description": "Identifies the name of an organization." }, "division": { "type": "string", "description": "Identifies the name of a division." }, "department": { "type": "string", "description": "Identifies the name of a department." }, "manager": { "$ref": "#/definitions/ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User_manager", "description": "\"id\" attribute of another User." }, "additionalManagers": { "type": "array", "items": { "$ref": "#/definitions/ScimManager" } }, "level": { "type": "string" }, "startDate": { "type": "string", "format": "date-time", "description": "2011-03-25" }, "endDate": { "type": "string", "format": "date-time", "description": "2022-02-25" }, "birthday": { "type": "string", "format": "date-time", "description": "1985-07-20" }, "gender": { "type": "string", "enum": [ "male", "female" ] }, "location": { "type": "string", "description": "Berlin" }, "currency": { "type": "string", "description": "User currency" } }, "description": "an organization." }, "ScimUser_urn_ietf_params_scim_schemas_extension_lattice_attributes_1_0_User": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "description": "\"2022-03-08\"," }, "birthDate": { "type": "string", "format": "date-time", "description": "\"1987-10-06\"," }, "gender": { "type": "string", "enum": [ "male", "female" ] }, "sexualOrientation": { "type": "string", "enum": [ "Queer", "Heterosexual", "Straight" ] }, "ethnicity": { "type": "string", "enum": [ "Caucasian", "East Asian", "Middle Eastern", "Black", "Biracial (South Asian & Caucasian)", "Filipino", "South Asian", "Indian", "White", "Asian" ] }, "People Manager (Reviews)": { "type": "string", "description": "'People Manager'," }, "Salary Information": { "type": "string", "description": "'130000'," }, "Remote Work - Location": { "type": "string", "description": "'Ontario'," }, "Job Level": { "type": "string", "description": "'M3'," }, "Sub Departments": { "type": "string" } } }, "ScimUser_urn_ietf_params_scim_schemas_extension_peakon_2_0_User": { "type": "object", "properties": { "Gender": { "type": "string", "enum": [ "Female", "Male" ] }, "Team": { "type": "string" }, "Manager": { "type": "string" }, "Date of Birth": { "type": "string", "format": "date-time" } } }, "ScimUser": { "type": "object", "properties": { "id": { "type": "string" }, "schemas": { "$ref": "#/definitions/ScimUser_schemas" }, "externalId": { "type": "string" }, "userType": { "type": "string", "description": "'Employee','Super Admin', 'General Admin', 'Account Manager', 'User Manager', 'Workflow Manager', 'Experience Manager', 'Author','Reporter','Contractor,'Intern','Temp','External','Unknown']" }, "userName": { "type": "string" }, "meta": { "$ref": "#/definitions/ScimUser_meta" }, "name": { "$ref": "#/definitions/ScimUser_name" }, "displayName": { "type": "string" }, "nickName": { "type": "string" }, "profileUrl": { "type": "string" }, "title": { "type": "string" }, "preferredLanguage": { "type": "string" }, "locale": { "type": "string" }, "timezone": { "type": "string" }, "active": { "type": "boolean" }, "password": { "type": "string" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/definitions/ScimPhoneNumber" } }, "emails": { "type": "array", "items": { "$ref": "#/definitions/ScimEmail" } }, "ims": { "type": "array", "items": { "$ref": "#/definitions/ScimIms" } }, "photos": { "type": "array", "items": { "$ref": "#/definitions/ScimPhoto" } }, "addresses": { "type": "array", "items": { "$ref": "#/definitions/ScimAddress" } }, "groups": { "type": "array", "items": { "$ref": "#/definitions/ScimUserGroups" } }, "entitlements": { "type": "array", "items": { "$ref": "#/definitions/ScimEntitlement" } }, "roles": { "type": "array", "items": { "$ref": "#/definitions/ScimRole" }, "description": "Student, Faculty, ..." }, "x509Certificates": { "type": "array", "items": { "$ref": "#/definitions/ScimRole" } }, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "$ref": "#/definitions/ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User", "description": "an organization." }, "urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User": { "$ref": "#/definitions/ScimUser_urn_ietf_params_scim_schemas_extension_lattice_attributes_1_0_User" }, "urn:ietf:params:scim:schemas:extension:peakon:2.0:User": { "$ref": "#/definitions/ScimUser_urn_ietf_params_scim_schemas_extension_peakon_2_0_User" } } }, "ScimGroupMember": { "type": "object", "properties": { "value": { "type": "string", "description": "ID of user" }, "$ref": { "type": "string", "description": "url to user" }, "display": { "type": "string", "description": "user name" }, "type": { "type": "string", "description": "NOT STANDARD", "enum": [ "User", "Group" ] }, "operation": { "type": "string", "description": "ONLY USED ON UPDATES", "enum": [ "add", "delete" ] } }, "required": [ "value" ] }, "ScimGroupMembers": { "type": "array", "items": { "$ref": "#/definitions/ScimGroupMember" }, "description": "An array of members" }, "ScimGroup_meta": { "type": "object", "properties": { "resourceType": { "type": "string", "enum": [ "User", "Group" ] }, "created": { "type": "string" }, "lastModified": { "type": "string" }, "location": { "type": "string" }, "version": { "type": "string" } } }, "ScimGroup_schemas": { "type": "array", "items": { "type": "string", "enum": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ] }, "description": "Array of schema URIs" }, "ScimGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "The group's unique id" }, "externalId": { "type": "string", "description": "A groups id in an external system" }, "displayName": { "type": "string", "description": "The group's display name" }, "groupType": { "type": "string", "description": "Organization [NOT STANDARD]" }, "members": { "type": "array", "items": { "$ref": "#/definitions/ScimGroupMember" }, "description": "An array of members" }, "meta": { "$ref": "#/definitions/ScimGroup_meta" }, "schemas": { "$ref": "#/definitions/ScimGroup_schemas", "description": "Array of schema URIs" } }, "required": [ "displayName" ] } } }