├── graphql └── .keep ├── asyncapi └── .keep ├── openapi ├── slack │ └── web │ │ ├── icon.png │ │ └── 1.7.0 │ │ └── .metadata.json ├── asana │ └── asana │ │ ├── icon.png │ │ └── 1.0 │ │ └── .metadata.json ├── google │ ├── gmail │ │ ├── icon.png │ │ └── v1 │ │ │ └── .metadata.json │ └── calendar │ │ ├── icon.png │ │ └── v3 │ │ └── .metadata.json ├── openai │ ├── audio │ │ ├── icon.png │ │ └── 2.1.0 │ │ │ └── .metadata.json │ ├── chat │ │ ├── icon.png │ │ └── 2.3.0 │ │ │ └── .metadata.json │ ├── images │ │ ├── icon.png │ │ └── 2.1.0 │ │ │ └── .metadata.json │ ├── assistants │ │ ├── icon.png │ │ └── 2.1.0 │ │ │ └── .metadata.json │ └── finetunes │ │ ├── icon.png │ │ └── 2.1.0 │ │ └── .metadata.json ├── candid │ ├── premier │ │ ├── icon.png │ │ └── 1.0 │ │ │ └── .metadata.json │ ├── essentials │ │ ├── icon.png │ │ └── 1.0 │ │ │ └── .metadata.json │ └── charityCheckPdf │ │ ├── icon.png │ │ └── 1.0 │ │ ├── .metadata.json │ │ └── openapi.yaml ├── docusign │ ├── admin │ │ ├── icon.png │ │ └── v2.1 │ │ │ └── .metadata.json │ ├── click │ │ ├── icon.png │ │ └── v1 │ │ │ └── .metadata.json │ └── esign │ │ ├── icon.png │ │ └── v2.1 │ │ └── .metadata.json ├── github │ └── github │ │ ├── icon.png │ │ └── v3 │ │ └── .metadata.json ├── stripe │ └── stripe │ │ ├── icon.png │ │ └── 2024-06-20 │ │ └── .metadata.json ├── twilio │ └── twilio │ │ ├── icon.png │ │ └── 1.51.0 │ │ └── .metadata.json ├── discord │ └── discord │ │ ├── 10 │ │ └── .metadata.json │ │ └── icon.png ├── hubspot │ ├── crm.lists │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.imports │ │ ├── icon.png │ │ └── v3 │ │ │ ├── .metadata.json │ │ │ └── openapi.yaml │ ├── crm.owners │ │ ├── icon.png │ │ └── v3 │ │ │ ├── .metadata.json │ │ │ └── openapi.yaml │ ├── crm.pipelines │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.properties │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.associations │ │ ├── icon.png │ │ └── v4 │ │ │ └── .metadata.json │ ├── marketing.emails │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── marketing.events │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── marketing.forms │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── automation.actions │ │ ├── icon.png │ │ └── v4 │ │ │ └── .metadata.json │ ├── crm.commerce.carts │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.commerce.orders │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.commerce.quotes │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.commerce.taxes │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.deals │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.leads │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.schemas │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.tickets │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── marketing.campaigns │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.engagements.calls │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.engagements.notes │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.engagements.tasks │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.companies │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.contacts │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.lineitems │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.products │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.associationsSchema │ │ ├── icon.png │ │ └── v4 │ │ │ └── .metadata.json │ ├── crm.commerce.discounts │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.engagements.emails │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.engagements.meetings │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.extensions.timelines │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── marketing.subscriptions │ │ ├── icon.png │ │ └── v4 │ │ │ ├── .metadata.json │ │ │ └── openapi.yaml │ ├── marketing.transactional │ │ ├── icon.png │ │ └── v3 │ │ │ ├── .metadata.json │ │ │ └── openapi.yaml │ ├── crm.engagements.communications │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ ├── crm.objects.feedbackSubmissions │ │ ├── icon.png │ │ └── v3 │ │ │ └── .metadata.json │ └── crm.extensions.videoConferencing │ │ ├── icon.png │ │ └── v3 │ │ ├── .metadata.json │ │ └── openapi.yaml ├── twitter │ └── twitter │ │ ├── icon.png │ │ └── 2.100 │ │ └── .metadata.json ├── zendesk │ └── zendesk │ │ ├── icon.png │ │ └── 2.0.0 │ │ └── .metadata.json ├── guidewire │ └── insuranceNow │ │ ├── icon.png │ │ └── 5.0.0 │ │ └── .metadata.json ├── dayforce │ └── dayforce │ │ └── v1 │ │ └── .metadata.json └── shopify │ └── admin │ └── 2025-01 │ └── .metadata.json ├── .github ├── pull_request_template.md └── issue_template.md ├── .gitignore ├── README.md └── LICENSE /graphql/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /asyncapi/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /openapi/slack/web/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/slack/web/icon.png -------------------------------------------------------------------------------- /openapi/asana/asana/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/asana/asana/icon.png -------------------------------------------------------------------------------- /openapi/google/gmail/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/google/gmail/icon.png -------------------------------------------------------------------------------- /openapi/openai/audio/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/openai/audio/icon.png -------------------------------------------------------------------------------- /openapi/openai/chat/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/openai/chat/icon.png -------------------------------------------------------------------------------- /openapi/candid/premier/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/candid/premier/icon.png -------------------------------------------------------------------------------- /openapi/docusign/admin/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/docusign/admin/icon.png -------------------------------------------------------------------------------- /openapi/docusign/click/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/docusign/click/icon.png -------------------------------------------------------------------------------- /openapi/docusign/esign/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/docusign/esign/icon.png -------------------------------------------------------------------------------- /openapi/github/github/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/github/github/icon.png -------------------------------------------------------------------------------- /openapi/openai/images/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/openai/images/icon.png -------------------------------------------------------------------------------- /openapi/stripe/stripe/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/stripe/stripe/icon.png -------------------------------------------------------------------------------- /openapi/twilio/twilio/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/twilio/twilio/icon.png -------------------------------------------------------------------------------- /openapi/candid/essentials/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/candid/essentials/icon.png -------------------------------------------------------------------------------- /openapi/discord/discord/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/discord/discord/icon.png -------------------------------------------------------------------------------- /openapi/google/calendar/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/google/calendar/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.lists/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.lists/icon.png -------------------------------------------------------------------------------- /openapi/openai/assistants/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/openai/assistants/icon.png -------------------------------------------------------------------------------- /openapi/openai/finetunes/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/openai/finetunes/icon.png -------------------------------------------------------------------------------- /openapi/twitter/twitter/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/twitter/twitter/icon.png -------------------------------------------------------------------------------- /openapi/zendesk/zendesk/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/zendesk/zendesk/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.imports/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.imports/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.owners/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.owners/icon.png -------------------------------------------------------------------------------- /openapi/candid/charityCheckPdf/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/candid/charityCheckPdf/icon.png -------------------------------------------------------------------------------- /openapi/guidewire/insuranceNow/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/guidewire/insuranceNow/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.pipelines/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.pipelines/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.properties/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.properties/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.associations/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.associations/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/marketing.emails/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/marketing.emails/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/marketing.events/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/marketing.events/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/marketing.forms/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/marketing.forms/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/automation.actions/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/automation.actions/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.carts/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.commerce.carts/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.orders/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.commerce.orders/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.quotes/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.commerce.quotes/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.taxes/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.commerce.taxes/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.deals/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.deals/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.leads/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.leads/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.schemas/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.schemas/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.tickets/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.tickets/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/marketing.campaigns/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/marketing.campaigns/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.calls/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.engagements.calls/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.notes/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.engagements.notes/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.tasks/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.engagements.tasks/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.companies/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.companies/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.contacts/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.contacts/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.lineitems/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.lineitems/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.products/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.products/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.associationsSchema/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.associationsSchema/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.discounts/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.commerce.discounts/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.emails/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.engagements.emails/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.meetings/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.engagements.meetings/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.extensions.timelines/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.extensions.timelines/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/marketing.subscriptions/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/marketing.subscriptions/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/marketing.transactional/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/marketing.transactional/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.communications/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.engagements.communications/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.feedbackSubmissions/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.objects.feedbackSubmissions/icon.png -------------------------------------------------------------------------------- /openapi/hubspot/crm.extensions.videoConferencing/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wso2/api-specs/main/openapi/hubspot/crm.extensions.videoConferencing/icon.png -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | ## Purpose 2 | 3 | 4 | 5 | Fixes: 6 | -------------------------------------------------------------------------------- /openapi/asana/asana/1.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Asana REST API", 3 | "baseUrl": "https://app.asana.com/api/1.0", 4 | "documentationUrl": "https://developers.asana.com/reference/rest-api-reference", 5 | "description": "Asana is a popular project management and team collaboration tool that enables teams to organize, track, and manage their work and projects", 6 | "tags": ["management", "collaboration", "project management"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/candid/charityCheckPdf/1.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Candid Charity Check PDF API", 3 | "baseUrl": "https://api.candid.org/charity-check-pdf", 4 | "documentationUrl": "https://candid.org/use-our-data/apis", 5 | "description": "The Charity Check PDF API allows you to generate PDF reports containing comprehensive information about nonprofit organizations", 6 | "tags": ["charity", "nonprofit", "pdf", "reports", "candid"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/candid/essentials/1.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Candid Essentials API", 3 | "baseUrl": "https://api.candid.org/essentials/v1", 4 | "documentationUrl": "https://candid.org/use-our-data/apis", 5 | "description": "The Candid Essentials API provides core nonprofit data and information services, offering essential details about charitable organizations", 6 | "tags": ["charity", "nonprofit", "essentials", "organizations", "candid"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/google/gmail/v1/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Gmail API", 3 | "baseUrl": "https://gmail.googleapis.com/gmail/v1", 4 | "documentationUrl": "https://developers.google.com/gmail/api/", 5 | "description": "The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels. It provides programmatic access to Gmail features for developers", 6 | "tags": ["gmail", "email", "messages", "labels", "google", "communication"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/candid/premier/1.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Candid Premier API", 3 | "baseUrl": "https://api.candid.org/premier/v1", 4 | "documentationUrl": "https://candid.org/use-our-data/apis", 5 | "description": "The Candid Premier API offers comprehensive access to detailed nonprofit data, including financial information, program details, and organizational metrics", 6 | "tags": ["charity", "nonprofit", "premier", "organizations", "financials", "candid"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/docusign/click/v1/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "DocuSign Click API", 3 | "baseUrl": "https://api.docusign.com/click", 4 | "documentationUrl": "https://developers.docusign.com/docs/click-api", 5 | "description": "The DocuSign Click API enables the creation and management of clickwrap agreements. It allows you to create, manage, and track online agreements that users accept by clicking", 6 | "tags": ["docusign", "click", "clickwrap", "agreements", "acceptance"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/google/calendar/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Google Calendar API", 3 | "baseUrl": "https://www.googleapis.com/calendar/v3", 4 | "documentationUrl": "https://developers.google.com/calendar/api", 5 | "description": "The Google Calendar API allows you to manage calendars, events, and access controls. It enables integration with Google Calendar for creating and managing calendar data", 6 | "tags": ["calendar", "events", "scheduling", "google", "time-management"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/docusign/esign/v2.1/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "DocuSign eSignature API", 3 | "baseUrl": "https://api.docusign.com/restapi", 4 | "documentationUrl": "https://developers.docusign.com/docs/esign-rest-api", 5 | "description": "The DocuSign eSignature API provides electronic signature capabilities, enabling the creation, sending, and management of electronic signatures and documents", 6 | "tags": ["docusign", "esignature", "electronic-signature", "documents", "signing"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/automation.actions/v4/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot Automation Actions API", 3 | "baseUrl": "https://api.hubapi.com/automation/v4/actions", 4 | "documentationUrl": "https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions", 5 | "description": "The HubSpot Automation Actions API allows you to create and manage custom workflow actions in HubSpot's automation platform", 6 | "tags": ["automation", "workflow", "actions", "hubspot"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/github/github/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "GitHub REST API", 3 | "baseUrl": "https://api.github.com", 4 | "documentationUrl": "https://docs.github.com/rest", 5 | "description": "The GitHub REST API allows you to manage GitHub resources such as repositories, issues, pull requests, and more. It provides comprehensive access to GitHub's features for developers and integrators", 6 | "tags": ["github", "git", "version-control", "repositories", "issues", "pull-requests", "actions"] 7 | } 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | *.jar 15 | *.war 16 | *.nar 17 | *.ear 18 | *.zip 19 | *.tar.gz 20 | *.rar 21 | 22 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 23 | hs_err_pid* 24 | replay_pid* 25 | 26 | # IDE files 27 | .idea/ 28 | *.iml 29 | .vscode 30 | 31 | # OS files 32 | .DS_Store 33 | Thumbs.db 34 | -------------------------------------------------------------------------------- /openapi/dayforce/dayforce/v1/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Dayforce HCM API", 3 | "baseUrl": "https://ustest241-services.dayforcehcm.com/Api", 4 | "documentationUrl": "https://developers.dayforce.com/", 5 | "description": "Dayforce HCM API provides access to Ceridian's Human Capital Management system, allowing integration with workforce management, payroll, benefits, HR, talent management, and other employee data", 6 | "tags": ["hcm", "hr", "payroll", "workforce", "employees", "ceridian", "dayforce"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/docusign/admin/v2.1/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "DocuSign Admin API", 3 | "baseUrl": "https://api.docusign.com/management", 4 | "documentationUrl": "https://developers.docusign.com/docs/admin-api", 5 | "description": "The DocuSign Admin API enables management of DocuSign accounts, users, and organizations. It provides capabilities for account configuration, user management, and organization-wide settings", 6 | "tags": ["docusign", "admin", "management", "accounts", "users", "organizations"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/discord/discord/10/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Discord HTTP API", 3 | "baseUrl": "https://discord.com/api/v10", 4 | "documentationUrl": "https://discord.com/developers/docs", 5 | "description": "Discord's HTTP API enables developers to interact with Discord servers, channels, users, and messages. It provides comprehensive access to Discord's features including bot creation, server management, and real-time communication", 6 | "tags": ["discord", "chat", "messaging", "gaming", "bots", "webhooks", "real-time"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/shopify/admin/2025-01/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Shopify Admin REST API" 3 | "baseUrl": "https://admin.shopify.com/api/2025-01" 4 | "documentationUrl": "https://shopify.dev/api/admin-rest" 5 | "description": "Shopify is a complete commerce platform that lets you start, grow, and manage a business. The Admin REST API lets you build apps for merchants using Shopify. You can read and write data about products, orders, inventory, shipping, online store, and much more." 6 | "tags": ["tags": ["ecommerce", "retail", "commerce", "admin", "shopify"]], 7 | } 8 | -------------------------------------------------------------------------------- /.github/issue_template.md: -------------------------------------------------------------------------------- 1 | ## Description 2 | 3 | 4 | 5 | ## Current Behavior 6 | 7 | 8 | 9 | ## Expected Behavior 10 | 11 | 12 | 13 | ## Possible Solution 14 | 15 | 16 | 17 | ## Steps to Reproduce 18 | 19 | 20 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.associations/v4/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Associations API", 3 | "baseUrl": "https://api.hubapi.com/crm/v4/associations", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4", 5 | "description": "The HubSpot CRM Associations API v4 enables management of relationships between CRM objects. It allows creating, retrieving, updating, and deleting associations between records and activities in HubSpot's CRM", 6 | "tags": ["crm", "associations", "relationships", "hubspot", "objects"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.carts/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Carts API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/carts", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/commerce/carts", 5 | "description": "The HubSpot CRM Carts API enables managing ecommerce cart data in HubSpot. It allows tracking when customers add products to their cart and storing purchase information, which is particularly useful for syncing data with external ecommerce platforms", 6 | "tags": ["crm", "carts", "ecommerce", "shopping", "commerce", "hubspot"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/guidewire/insuranceNow/5.0.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Guidewire InsuranceNow Cloud API", 3 | "baseUrl": "https://api.insurancenow.guidewire.com/v5", 4 | "documentationUrl": "https://docs.guidewire.com/cloud-api/insurancenow", 5 | "description": "The Guidewire InsuranceNow Cloud API provides comprehensive access to insurance operations including policy management, claims processing, and customer engagement. It enables automation and integration with the cloud-based InsuranceNow platform", 6 | "tags": ["insurance", "policy-management", "claims", "guidewire", "insurancenow", "cloud"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.associationsSchema/v4/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Associations Schema API", 3 | "baseUrl": "https://api.hubapi.com/crm/v4/associations", 4 | "documentationUrl": "https://developers.hubspot.com/docs/reference/api/crm/associations/associations-schema", 5 | "description": "The HubSpot CRM Associations Schema API enables understanding and defining relationships between different types of CRM records and activities. It allows you to manage how different CRM objects can relate to one another and create custom associations", 6 | "tags": ["crm", "associations", "schema", "relationships", "hubspot", "definitions"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/openai/audio/2.1.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "OpenAI Audio API", 3 | "baseUrl": "https://api.openai.com/v1", 4 | "documentationUrl": "https://platform.openai.com/docs/api-reference/audio", 5 | "description": "The OpenAI Audio API provides functionality for audio processing and generation. It enables the conversion between audio and text, allowing for speech-to-text transcription and text-to-speech synthesis. The API supports various audio formats and provides high-quality audio processing capabilities. It's particularly useful for applications requiring voice interaction, audio transcription, or speech synthesis.", 6 | "tags": ["openai", "audio", "speech", "transcription", "synthesis", "voice", "processing"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/openai/assistants/2.1.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "OpenAI Assistants API", 3 | "baseUrl": "https://api.openai.com/v1", 4 | "documentationUrl": "https://platform.openai.com/docs/api-reference/assistants", 5 | "description": "The OpenAI Assistants API enables the creation and management of AI assistants that can call models and use tools. It provides functionality for building intelligent agents that can process information, interact with users, and perform various tasks. The API supports the creation of assistants with specific capabilities, tools, and knowledge bases, allowing for customized AI interactions and workflows.", 6 | "tags": ["openai", "assistants", "ai", "models", "tools", "automation", "integration"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/slack/web/1.7.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Slack Web API", 3 | "baseUrl": "https://slack.com/api", 4 | "documentationUrl": "https://api.slack.com/web", 5 | "description": "The Slack Web API provides a comprehensive set of methods for interacting with the Slack platform through HTTP RPC-based calls. It requires OAuth 2.0-based authentication with user, bot, or workspace tokens that have the necessary OAuth scopes. The API enables integration with Slack's messaging, collaboration, and workspace management features, allowing developers to build applications that interact with Slack channels, users, messages, and other platform components.", 6 | "tags": ["slack", "web", "messaging", "collaboration", "oauth", "integration", "workspace"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/twilio/twilio/1.51.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Twilio API", 3 | "baseUrl": "https://api.twilio.com/2010-04-01", 4 | "documentationUrl": "https://www.twilio.com/docs/usage/api", 5 | "description": "The Twilio API provides a comprehensive set of endpoints for communication services, including SMS, voice calls, video, and messaging. It enables developers to integrate telecommunication capabilities into their applications, allowing for sending and receiving messages, making and receiving calls, and managing communication workflows. The API supports various communication channels and provides tools for building scalable communication solutions.", 6 | "tags": ["twilio", "sms", "voice", "messaging", "communication", "telephony", "integration"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/openai/chat/2.3.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "OpenAI Chat API", 3 | "baseUrl": "https://api.openai.com/v1", 4 | "documentationUrl": "https://platform.openai.com/docs/api-reference/chat", 5 | "description": "The OpenAI Chat API enables the creation of conversational AI applications. It provides functionality for generating human-like text responses in a chat format, supporting multi-turn conversations and context-aware interactions. The API allows for fine-tuning of conversation parameters, including model selection, temperature, and response length. It's particularly useful for building chatbots, virtual assistants, and other conversational AI applications.", 6 | "tags": ["openai", "chat", "conversation", "ai", "chatbot", "assistant", "generation"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/openai/images/2.1.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "OpenAI Images API", 3 | "baseUrl": "https://api.openai.com/v1", 4 | "documentationUrl": "https://platform.openai.com/docs/api-reference/images", 5 | "description": "The OpenAI Images API enables the generation and manipulation of images using AI. It provides functionality for creating images from text descriptions, editing existing images, and generating variations of images. The API supports various image formats and styles, allowing for creative and practical image generation applications. It's particularly useful for applications requiring AI-generated visual content, image editing, or creative design assistance.", 6 | "tags": ["openai", "images", "generation", "editing", "ai", "art", "design"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.taxes/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Commerce Taxes API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/taxes", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/commerce/taxes", 5 | "description": "The HubSpot CRM Commerce Taxes API enables the creation and management of tax records that can be included in quotes. It's specifically designed to handle various tax scenarios, such as applying percentage-based sales tax based on state requirements. The API provides functionality for creating, reading, updating, and archiving tax records, along with support for batch operations and searching capabilities.", 6 | "tags": ["crm", "commerce", "taxes", "quotes", "sales", "hubspot", "financial"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.lists/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Lists API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/lists", 4 | "documentationUrl": "https://developers.hubspot.com/beta-docs/guides/api/crm/lists/overview", 5 | "description": "The HubSpot CRM Lists API enables the management of list memberships for object lists in HubSpot. It provides functionality for creating, updating, and managing lists of contacts, companies, and other CRM objects. The API is particularly useful for bulk operations, such as adding multiple contacts to a list or removing company records from a company list. It supports various list types and membership management operations.", 6 | "tags": ["crm", "lists", "contacts", "companies", "hubspot", "membership", "segmentation"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/twitter/twitter/2.100/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Twitter API v2", 3 | "baseUrl": "https://api.twitter.com/2", 4 | "documentationUrl": "https://developer.twitter.com/en/docs/twitter-api", 5 | "description": "The Twitter API v2 provides a comprehensive set of endpoints for interacting with Twitter's platform. It enables developers to access and manage tweets, user profiles, bookmarks, and other Twitter data. The API supports various features including tweet creation, user management, and data analytics. It's particularly useful for building applications that integrate with Twitter's social media platform, enabling tweet management, user engagement, and data analysis.", 6 | "tags": ["twitter", "social-media", "tweets", "users", "bookmarks", "analytics", "integration"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.imports/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Imports API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/imports", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/imports", 5 | "description": "The HubSpot CRM Imports API enables the import of CRM records and activities into your HubSpot account. It supports importing various types of data including contacts, companies, and notes. The API is particularly useful for scenarios like importing contact lists from events or webinars, or migrating data from other systems into HubSpot. It provides functionality for managing import processes, mapping data fields, and handling import results.", 6 | "tags": ["crm", "imports", "data-migration", "hubspot", "contacts", "companies", "records"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/stripe/stripe/2024-06-20/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Stripe API", 3 | "baseUrl": "https://api.stripe.com/v1", 4 | "documentationUrl": "https://docs.stripe.com/api", 5 | "description": "The Stripe API provides a comprehensive set of endpoints for processing payments, managing subscriptions, handling refunds, and managing customer data. It supports various payment methods, currencies, and payment flows. The API enables businesses to accept payments, manage recurring billing, handle disputes, and integrate with Stripe's suite of financial services. It's particularly useful for e-commerce platforms, subscription services, and any application requiring payment processing capabilities.", 6 | "tags": ["stripe", "payments", "subscriptions", "e-commerce", "billing", "financial", "integration"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.calls/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Engagements Calls API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/calls", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/engagements/calls", 5 | "description": "The HubSpot CRM Engagements Calls API enables the logging and management of call engagements with prospects and customers. It's particularly useful for teams using external calling services, allowing them to integrate call information into their HubSpot account. The API provides functionality for creating, reading, updating, and managing call records, ensuring all customer communication is tracked within the HubSpot CRM.", 6 | "tags": ["crm", "engagements", "calls", "telephony", "hubspot", "communications", "interactions"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/openai/finetunes/2.1.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "OpenAI Fine-tunes API", 3 | "baseUrl": "https://api.openai.com/v1", 4 | "documentationUrl": "https://platform.openai.com/docs/api-reference/fine-tuning", 5 | "description": "The OpenAI Fine-tunes API enables the customization of OpenAI models through fine-tuning. It allows you to train models on your specific data to improve performance for particular tasks or domains. The API provides functionality for creating, managing, and deploying fine-tuned models, supporting various training parameters and model configurations. It's particularly useful for organizations that need specialized AI models tailored to their specific use cases and data.", 6 | "tags": ["openai", "fine-tuning", "models", "training", "customization", "machine-learning", "ai"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.products/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Objects Products API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/products", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/commerce/products", 5 | "description": "The HubSpot CRM Objects Products API enables the creation and management of product records in your HubSpot product library. It's particularly useful for preparing product launches, allowing you to create a set of products to represent new offerings. Sales teams can then use these product records when creating payment links, invoices, and other sales documents. The API provides comprehensive functionality for managing your product catalog within the CRM.", 6 | "tags": ["crm", "products", "objects", "hubspot", "catalog", "sales", "inventory"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.emails/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Engagements Emails API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/emails", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/engagements/email", 5 | "description": "The HubSpot CRM Engagements Emails API enables the association of email communications with records in the CRM. It's particularly useful for teams using third-party email providers, allowing them to programmatically log email data to associated records in HubSpot. The API supports including various metadata fields such as email headers, subject lines, and body content, ensuring comprehensive tracking of all email communications within the HubSpot CRM.", 6 | "tags": ["crm", "engagements", "emails", "hubspot", "communications", "tracking", "metadata"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.meetings/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Engagements Meetings API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/meetings", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/engagements/meetings", 5 | "description": "The HubSpot CRM Engagements Meetings API enables the tracking and management of meeting engagements with prospects and customers. It's particularly useful for integrating external meeting scheduling services with HubSpot or supplementing the built-in HubSpot meetings tool. The API allows you to create, read, update, and manage meeting records, helping you maintain a comprehensive view of all customer interactions within the HubSpot CRM.", 6 | "tags": ["crm", "engagements", "meetings", "scheduling", "hubspot", "calendar", "interactions"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.contacts/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Objects Contacts API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/contacts", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/objects/contacts", 5 | "description": "The HubSpot CRM Objects Contacts API enables the management of contact records in the CRM. It provides comprehensive functionality for creating, reading, updating, and managing contact information. The API is particularly useful for integrating contact data with external systems, allowing you to retrieve contact information by ID and maintain contact records across different platforms. It supports various contact-related operations and data management features.", 6 | "tags": ["crm", "contacts", "objects", "hubspot", "integration", "data", "management"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/marketing.emails/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot Marketing Emails API", 3 | "baseUrl": "https://api.hubapi.com/marketing/v3/emails", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/marketing/emails/marketing-emails", 5 | "description": "The HubSpot Marketing Emails API enables the creation, management, and analysis of marketing emails. It provides functionality for programmatically creating marketing emails and retrieving their send statistics. The API allows you to access detailed information about email performance, similar to what you can see in the HubSpot interface. It supports comprehensive email marketing functionality, including email creation, management, and analytics.", 6 | "tags": ["marketing", "emails", "hubspot", "analytics", "statistics", "campaigns", "automation"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/zendesk/zendesk/2.0.0/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Zendesk Support API", 3 | "baseUrl": "https://{subdomain}.zendesk.com/api/v2", 4 | "documentationUrl": "https://developer.zendesk.com/api-reference", 5 | "description": "The Zendesk Support API provides a comprehensive set of endpoints for managing customer support operations. It enables integration with Zendesk's support platform, allowing for ticket management, user administration, and automation of support workflows. The API supports various features including ticket creation and management, user and organization management, automation rules, and reporting. It's particularly useful for building applications that integrate with Zendesk's customer support platform.", 6 | "tags": ["zendesk", "support", "tickets", "customer-service", "automation", "helpdesk", "integration"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.tasks/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Engagements Tasks API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/tasks", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/engagements/tasks", 5 | "description": "The HubSpot CRM Engagements Tasks API enables the creation and management of task engagements within the CRM. It's particularly useful for teams using third-party project management services, allowing them to create and manage tasks associated with CRM records directly in HubSpot. The API provides functionality for creating, reading, updating, and managing task records, ensuring all customer-related tasks are properly tracked and managed within the HubSpot CRM.", 6 | "tags": ["crm", "engagements", "tasks", "hubspot", "project-management", "tracking", "workflow"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.tickets/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Objects Tickets API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/tickets", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/objects/tickets", 5 | "description": "The HubSpot CRM Objects Tickets API enables the creation and management of ticket records in the CRM. It's particularly useful for customer support teams to track and manage customer requests and issues. When a customer contacts the support team for help, the API allows you to create a ticket to track that request and maintain a record for future reference. The API provides comprehensive functionality for managing the entire lifecycle of support tickets within the CRM.", 6 | "tags": ["crm", "tickets", "objects", "hubspot", "support", "customer-service", "tracking"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/marketing.forms/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot Marketing Forms API", 3 | "baseUrl": "https://api.hubapi.com/marketing/v3/forms", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/marketing/forms/forms", 5 | "description": "The HubSpot Marketing Forms API enables the creation and management of forms in your HubSpot account. These forms can be embedded on your website to collect submissions from visitors. The API is particularly useful for programmatically modifying form elements based on complex use cases or data from third-party services, such as dynamically displaying fields based on external data sources. It provides comprehensive functionality for managing form configurations and submissions.", 6 | "tags": ["marketing", "forms", "hubspot", "website", "submissions", "integration", "dynamic-fields"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.orders/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Commerce Orders API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/orders", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/commerce/orders", 5 | "description": "The HubSpot CRM Commerce Orders API enables the management of ecommerce purchase data within HubSpot's CRM. It allows you to create and track individual orders when buyers make purchases, including the ability to update orders with tracking information after shipping labels are created. This API is particularly valuable for maintaining synchronization between HubSpot and external ecommerce platforms like Shopify and NetSuite, ensuring consistent order data across your commerce ecosystem.", 6 | "tags": ["crm", "commerce", "orders", "ecommerce", "hubspot", "shipping", "tracking"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.leads/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Objects Leads API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/leads", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/objects/leads", 5 | "description": "The HubSpot CRM Objects Leads API enables the management of lead records in the CRM. Leads represent contacts or companies that have shown interest in your products or services and are potential customers. The API is particularly useful for tracking the sales prospecting journey, allowing you to create and manage lead records when existing contacts express interest in purchasing. It provides functionality for creating, reading, updating, and managing lead information throughout the sales process.", 6 | "tags": ["crm", "leads", "objects", "hubspot", "sales", "prospecting", "conversion"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.lineitems/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Objects Line Items API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/line_items", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/commerce/line-items", 5 | "description": "The HubSpot CRM Objects Line Items API enables the management of line items in deals and quotes. It allows you to add instances of products to sales documents, either by creating them from existing products or as standalone items. The API is particularly useful for creating quotes for sales reps to send to potential buyers, enabling the addition of goods and services to the quotes. It provides functionality for creating, reading, updating, and managing line items within the CRM.", 6 | "tags": ["crm", "line-items", "objects", "hubspot", "quotes", "products", "sales"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.owners/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Owners API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/owners", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/owners", 5 | "description": "The HubSpot CRM Owners API enables the management of owners in the CRM system. Owners are used to assign CRM objects to specific people in your organization. The API provides functionality to retrieve a list of available owners for an account, which can then be used to assign ownership of CRM records. For accounts with team functionality, the API also provides information about which teams an owner can access and their primary team. This is particularly useful for managing record assignments across your organization.", 6 | "tags": ["crm", "owners", "hubspot", "teams", "assignments", "organization", "management"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.notes/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Engagements Notes API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/notes", 4 | "documentationUrl": "https://developers.hubspot.com/beta-docs/guides/api/crm/engagements/notes", 5 | "description": "The HubSpot CRM Engagements Notes API enables the creation and management of note engagements within the CRM. It's particularly useful for documenting offline conversations with customers, allowing you to add important takeaways and details to their contact records. The API provides functionality for creating, reading, updating, and managing note records, ensuring all customer interactions and important information are properly documented and accessible within the HubSpot CRM.", 6 | "tags": ["crm", "engagements", "notes", "hubspot", "documentation", "interactions", "records"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/marketing.events/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot Marketing Events API", 3 | "baseUrl": "https://api.hubapi.com/marketing/v3/marketing-events", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/marketing/marketing-events", 5 | "description": "The HubSpot Marketing Events API enables the management of marketing events as CRM objects. It allows you to track marketing events, such as webinars, along with the contacts who registered and attended. The API is particularly useful for integrating external systems that handle event registration with HubSpot CRM, ensuring that attendee data and behavior are properly synced. It provides comprehensive functionality for managing marketing events and their associated contact data.", 6 | "tags": ["marketing", "events", "hubspot", "webinars", "registration", "tracking", "integration"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.quotes/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Commerce Quotes API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/quotes", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/commerce/quotes", 5 | "description": "The HubSpot CRM Commerce Quotes API enables the creation and management of sales quotes for sharing pricing information with potential buyers. It's particularly useful for creating contract proposals, such as for service packages or recurring services. The API supports comprehensive quote management including creating, reading, updating, and archiving quotes, as well as batch operations and searching capabilities. This makes it ideal for businesses that need to streamline their quote generation and management process.", 6 | "tags": ["crm", "commerce", "quotes", "sales", "pricing", "hubspot", "proposals"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.deals/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Objects Deals API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/deals", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/objects/deals", 5 | "description": "The HubSpot CRM Objects Deals API enables the creation and management of deal records in the CRM. It's particularly useful for sales teams to track the negotiation process with prospective customers, from initial contact through to closed deals. The API provides functionality for creating, updating, and managing deal records, including the ability to update deal stages as they progress through the sales pipeline. It supports comprehensive deal management features for tracking sales opportunities and customer relationships.", 6 | "tags": ["crm", "deals", "objects", "hubspot", "sales", "pipeline", "opportunities"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/marketing.campaigns/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot Marketing Campaigns API", 3 | "baseUrl": "https://api.hubapi.com/marketing/v3/campaigns", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/marketing/campaigns", 5 | "description": "The HubSpot Marketing Campaigns API enables the management of marketing campaign data. It provides endpoints for creating, reading, updating, and deleting marketing campaigns, allowing you to manage HubSpot campaigns from external applications. The API is particularly useful for integrating campaign management with external systems and transferring campaign data to external data warehouses for analytics purposes. It supports comprehensive campaign management functionality for marketing professionals.", 6 | "tags": ["marketing", "campaigns", "hubspot", "analytics", "data-warehouse", "integration", "management"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.companies/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Object Companies API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/companies", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/objects/companies", 5 | "description": "The HubSpot CRM Object Companies API enables the management of company records in the CRM. It's particularly useful for creating and maintaining company records when new customers sign up with their business email addresses, helping to establish relationships between customers and their companies. The API provides comprehensive functionality for creating, reading, updating, and managing company records, which sales teams can use to identify and pursue additional sales opportunities within the same organization.", 6 | "tags": ["crm", "companies", "objects", "hubspot", "sales", "business", "relationships"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.properties/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Properties API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/properties", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/properties", 5 | "description": "The HubSpot CRM Properties API enables the management of object properties in the CRM system. All HubSpot objects store data in both default and custom properties, and this API provides access to read and modify these properties. It's particularly useful for creating and managing custom properties, such as multi-select properties for storing contract data on company records. The API provides comprehensive functionality for defining, updating, and managing the properties that store data across different object types in the CRM.", 6 | "tags": ["crm", "properties", "hubspot", "custom-fields", "metadata", "data-storage", "configuration"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.commerce.discounts/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Commerce Discounts API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/discounts", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/commerce/discounts", 5 | "description": "The HubSpot CRM Commerce Discounts API enables the creation and management of discount records within HubSpot's CRM. It allows you to create, read, update, and delete discount records that can be applied to quotes and other commerce objects. The API supports features such as batch operations, basic CRUD operations, and searching for discounts based on specific criteria. This API is particularly useful for businesses that want to implement discount strategies, such as first-time buyer discounts, and manage them programmatically.", 6 | "tags": ["crm", "commerce", "discounts", "quotes", "hubspot", "ecommerce"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.extensions.timelines/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Extensions Timelines API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/timeline", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/extensions/timeline", 5 | "description": "The HubSpot CRM Extensions Timelines API enables the creation and configuration of custom events that can be displayed in the timelines of CRM objects such as contacts, companies, tickets, or deals. This feature allows apps to enhance the CRM experience by adding custom events and data to object timelines, including the ability to display external data through iframes. It's particularly useful for tracking custom user interactions, sign-up flows, and other application-specific events within the HubSpot CRM timeline view.", 6 | "tags": ["crm", "extensions", "timelines", "events", "hubspot", "custom", "tracking"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.pipelines/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Pipelines API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/pipelines", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/pipelines", 5 | "description": "The HubSpot CRM Pipelines API enables the management of pipelines in the CRM system. Pipelines represent distinct stages in workflows, such as deal closing or support ticket processing. The API supports both deals and tickets object types, allowing you to read and modify pipeline configurations. It's particularly useful for streamlining customer support processes by managing ticket pipelines and their stages. The API provides comprehensive functionality for creating, updating, and managing pipeline stages to track the progress of deals and support tickets.", 6 | "tags": ["crm", "pipelines", "hubspot", "workflow", "stages", "deals", "tickets"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.schemas/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Objects Schemas API", 3 | "baseUrl": "https://api.hubapi.com/crm-object-schemas/v3/schemas", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/objects/custom-objects", 5 | "description": "The HubSpot CRM Objects Schemas API enables the definition and management of custom object schemas in the HubSpot CRM. Schemas define how custom objects store and represent information, including details about object types, properties, and associations. The API is particularly useful for creating custom objects with specific properties and filters, such as creating a new object type for storing car information at a dealership. It provides functionality for managing the structure and behavior of custom objects within the CRM.", 6 | "tags": ["crm", "schemas", "objects", "hubspot", "custom-objects", "metadata", "enterprise"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/marketing.transactional/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot Marketing Transactional API", 3 | "baseUrl": "https://api.hubapi.com/marketing/v3/transactional", 4 | "documentationUrl": "https://developers.hubspot.com/beta-docs/guides/api/marketing/emails/transactional-emails", 5 | "description": "The HubSpot Marketing Transactional API enables the sending of transactional emails from a dedicated IP address to your contacts. It's particularly useful for sending essential business communications, such as transaction receipts after customer purchases, account updates, or terms of service changes. The API provides functionality for single-send emails and supports public SMTP tokens for secure email delivery. It's designed for sending critical business communications that require reliable delivery.", 6 | "tags": ["marketing", "transactional", "hubspot", "emails", "smtp", "communications", "business"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.engagements.communications/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Engagements Communications API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/communications", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/engagements/communications", 5 | "description": "The HubSpot CRM Engagements Communications API enables the tracking and management of communication engagements across multiple channels. It's particularly useful for teams that interact with contacts through various channels not directly connected to HubSpot, allowing them to centralize all customer communications in one place. The API provides functionality for creating, reading, updating, and managing communication records, ensuring comprehensive tracking of all customer interactions within the HubSpot CRM.", 6 | "tags": ["crm", "engagements", "communications", "hubspot", "interactions", "channels", "tracking"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.extensions.videoConferencing/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Extensions Video Conferencing API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/extensions/video-conferencing", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/extensions/video-conferencing", 5 | "description": "The HubSpot CRM Extensions Video Conferencing API enables integration with video conferencing applications, allowing HubSpot to add video conference links to meeting requests with contacts. It's particularly useful for companies that frequently conduct meetings through platforms like Zoom, enabling users to seamlessly add video conferencing information to meeting invitations scheduled in HubSpot. The API provides functionality for configuring and managing video conferencing settings within the CRM.", 6 | "tags": ["crm", "extensions", "video-conferencing", "meetings", "hubspot", "zoom", "integration"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/marketing.subscriptions/v4/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot Marketing Subscriptions API", 3 | "baseUrl": "https://api.hubapi.com/communication-preferences/v4", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/marketing/subscriptions", 5 | "description": "The HubSpot Marketing Subscriptions API enables the management of communication preferences and subscriptions for contacts. It allows you to programmatically subscribe or unsubscribe contacts from email subscription types, or unsubscribe them from all email communications. The API is particularly useful for ensuring contact opt-in statuses are properly updated when changes occur through external services. It provides comprehensive functionality for managing communication preferences, including support for business units.", 6 | "tags": ["marketing", "subscriptions", "hubspot", "communications", "preferences", "opt-in", "business-units"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.objects.feedbackSubmissions/v3/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "HubSpot CRM Objects Feedback Submissions API", 3 | "baseUrl": "https://api.hubapi.com/crm/v3/objects/feedback_submissions", 4 | "documentationUrl": "https://developers.hubspot.com/docs/guides/api/crm/objects/feedback-submissions", 5 | "description": "The HubSpot CRM Objects Feedback Submissions API enables the retrieval and management of feedback survey responses. It supports various types of feedback surveys including NPS (Net Promoter Score), CSAT (Customer Satisfaction), CES (Customer Effort Score), and custom feedback surveys. The API is particularly useful for gathering customer sentiment data, such as preparing for product redesigns or analyzing customer satisfaction trends. It provides functionality for accessing and managing feedback data submitted through HubSpot's survey tools.", 6 | "tags": ["crm", "feedback", "surveys", "nps", "csat", "ces", "customer-sentiment"] 7 | } 8 | -------------------------------------------------------------------------------- /openapi/candid/charityCheckPdf/1.0/openapi.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.1 2 | info: 3 | title: CharityCheckPdf 4 | description: 5 | This end-point will allow you to retrieve organization's Charity Check 6 | information in PDF format. API returns the byte stream. 7 | version: "1.0" 8 | servers: 9 | - url: https://apidata.guidestar.org/charitycheckpdf 10 | - url: https://api.candid.org/charitycheckpdf 11 | paths: 12 | "/v1/pdf/{ein}": 13 | get: 14 | summary: "/charitycheckpdf/v1/pdf" 15 | description: 16 | Generate a PDF report to validate nonprofit status and eligibility 17 | with a 100% IRS-compliant charity check. 18 | operationId: charitycheckpdf_v1 19 | parameters: 20 | - name: ein 21 | in: path 22 | description: Employer Identification Number. 23 | example: 13-1837418 24 | required: true 25 | schema: 26 | type: string 27 | default: 13-1837418 28 | responses: 29 | "200": 30 | description: OK 31 | content: 32 | application/pdf: 33 | schema: 34 | type: object 35 | description: 36 | PDF containing charity check information for the organization 37 | with the given ein 38 | "400": 39 | description: Bad Request 40 | content: 41 | application/json: 42 | schema: 43 | "$ref": "#/components/schemas/BadRequest" 44 | text/json: 45 | schema: 46 | "$ref": "#/components/schemas/BadRequest" 47 | "401": 48 | description: Unauthorized 49 | content: 50 | application/json: 51 | schema: 52 | "$ref": "#/components/schemas/Unauthorized" 53 | text/json: 54 | schema: 55 | "$ref": "#/components/schemas/Unauthorized" 56 | "403": 57 | description: Forbidden 58 | content: 59 | application/json: 60 | schema: 61 | "$ref": "#/components/schemas/Forbidden" 62 | text/json: 63 | schema: 64 | "$ref": "#/components/schemas/Forbidden" 65 | "404": 66 | description: No Results Found 67 | content: 68 | application/json: 69 | schema: 70 | "$ref": "#/components/schemas/NotFound" 71 | text/json: 72 | schema: 73 | "$ref": "#/components/schemas/NotFound" 74 | "406": 75 | description: Not Acceptable 76 | content: 77 | application/json: 78 | schema: 79 | "$ref": "#/components/schemas/NotAcceptable" 80 | text/json: 81 | schema: 82 | "$ref": "#/components/schemas/NotAcceptable" 83 | "429": 84 | description: Too Many Requests 85 | content: 86 | application/json: 87 | schema: 88 | "$ref": "#/components/schemas/TooManyRequests" 89 | text/json: 90 | schema: 91 | "$ref": "#/components/schemas/TooManyRequests" 92 | "500": 93 | description: Internal Server Error 94 | content: 95 | application/json: 96 | schema: 97 | "$ref": "#/components/schemas/InternalServerError" 98 | text/json: 99 | schema: 100 | "$ref": "#/components/schemas/InternalServerError" 101 | components: 102 | schemas: 103 | BadRequest: 104 | type: object 105 | properties: 106 | code: 107 | type: string 108 | description: HTTP response status code. 109 | example: 400 110 | message: 111 | type: string 112 | description: Diagnostic message for response status 113 | example: The request cannot be fulfilled due to bad syntax. 114 | Unauthorized: 115 | type: object 116 | properties: 117 | code: 118 | type: string 119 | description: HTTP response status code. 120 | example: 401 121 | message: 122 | type: string 123 | description: Diagnostic message for response status 124 | example: 125 | Access denied due to missing subscription key. Make sure to include 126 | subscription key when making requests to an API. 127 | Forbidden: 128 | type: object 129 | properties: 130 | code: 131 | type: string 132 | description: HTTP response status code. 133 | example: 403 134 | message: 135 | type: string 136 | description: Diagnostic message for response status 137 | example: 138 | Forbidden, we found insufficient permissions to grant access to 139 | the resources. Please check the detailed message of the response. 140 | NotFound: 141 | type: object 142 | properties: 143 | code: 144 | type: string 145 | description: HTTP response status code. 146 | example: 404 147 | message: 148 | type: string 149 | description: Diagnostic message for response status 150 | example: 151 | Request was processed successfully but we could not find the resource 152 | ein 153 | NotAcceptable: 154 | type: object 155 | properties: 156 | code: 157 | type: string 158 | description: HTTP response status code. 159 | example: 406 160 | message: 161 | type: string 162 | description: Diagnostic message for response status 163 | example: 164 | The requested resource is capable of generating only content not 165 | acceptable according to the Accept headers sent in the request. 166 | TooManyRequests: 167 | type: object 168 | properties: 169 | code: 170 | type: string 171 | description: HTTP response status code. 172 | example: 429 173 | message: 174 | type: string 175 | description: Diagnostic message for response status 176 | example: Rate limit is exceeded. Try again later. 177 | InternalServerError: 178 | type: object 179 | properties: 180 | code: 181 | type: string 182 | description: HTTP response status code. 183 | example: 500 184 | message: 185 | type: string 186 | description: Diagnostic message for response status 187 | example: 188 | Oh no!, this is bad, something went wrong... please contact API 189 | support! 190 | securitySchemes: 191 | apiKeyHeader: 192 | type: apiKey 193 | name: Subscription-Key 194 | in: header 195 | security: 196 | - apiKeyHeader: [] 197 | x-readme: 198 | explorer-enabled: true 199 | proxy-enabled: true 200 | samples-enabled: true 201 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # WSO2 API Specifications Repository 2 | 3 | This repository contains API contracts for various vendors and APIs in a standardized format. The goal of this repository is to provide a centralized location for API contracts that can be used for client/connector generation, testing, and documentation. 4 | 5 | ## Description 6 | 7 | ### Branching Strategy 8 | 9 | The repository will contain two primary branches: 10 | 11 | - `main` 12 | - `incubator` 13 | 14 | #### The `main` Branch 15 | 16 | The `main` branch contains the official API contracts that are stable and verified. 17 | 18 | #### The `incubator` Branch 19 | 20 | The `incubator` branch contains API contracts that are under development, experimental, or non-official. An API contract can be added to this branch if it is not yet stable or verified. Once the API contract is stable and verified, it can be graduated to the `main` branch. 21 | 22 | ### Repository Structure 23 | 24 | This centralized repository is for storing API contracts in a standardized format such as OpenAPI, GraphQL SDL, AsyncAPI, or other relevant specifications. 25 | 26 | The repository structure would be organized as follows: 27 | 28 | ```shell 29 | 30 | api-specs/ 31 | ├── asyncapi/ 32 | ├── graphql/ 33 | └── openapi/ 34 | ``` 35 | 36 | > **Note:** Additional directories can be added in the future for other API contract specifications. 37 | 38 | The repository root contains subdirectories for each contract type, such as `openapi`, `graphql`, and `asyncapi`. Each subdirectory contains API contracts for different vendors, APIs, and versions. 39 | 40 | #### OpenAPI Contracts Directory Structure 41 | 42 | The following is the directory structure for OpenAPI specifications: 43 | 44 | 1. Each vendor has their own directory. (E.g.: `openapi/google`, `openapi/hubspot`, etc.) 45 | 2. Within the vendor directory, each API has its own directory. (E.g.: `openapi/google/docs`, `openapi/hubspot/crm.associations`, etc.) 46 | > **Note:** If the vendor and the API name are the same, the directory names would be the same. (E.g.: `openapi/asana/asana`, `openapi/dayforce/dayforce`, etc.) 47 | 3. If the API is categorized hierarchically, the API directory would be named with the hierarchy, separated with a dot (`.`). (E.g.: `openapi/hubspot/crm.associations`, `openapi/hubspot/automation.actions`, etc.) 48 | 4. Within the API directory, another directory would be created for each version of the API. (E.g.: `openapi/google/calendar/v3`, `openapi/hubspot/automation.actions/v4`, etc.) 49 | 5. Apart from the OpenAPI spec version directory, each API directory contains an `icon.png` file that contains the logo of the API. 50 | 6. Inside the API version directory, the OpenAPI spec file would be named as `openapi.yaml`. 51 | > **Note:** If an API contract is in the `JSON` format, it should be converted to `YAML` format before committing to the repository. 52 | 7. The relevant icon for the API would be placed in the API directory as `icon.png`. 53 | 8. A `.metadata.json` file would be placed in the API version directory to store metadata such as the API name, version, vendor, and other relevant information. 54 | 55 | ##### OpenAPI Metadata File Structure 56 | 57 | The `.metadata.json` file would contain the following information: 58 | 59 | - `name`: The human-readable name of the API. 60 | - `baseUrl`: The base URL of the API. This is added in metadata to easily identify the base URL of the API without parsing the OpenAPI spec. 61 | - `documentationUrl`: The URL to the API documentation, if available. 62 | - `description`: A brief description of the API. 63 | - `tags`: An array of tags that are relevant to the API. 64 | 65 | ```json 66 | { 67 | "name": "Google Docs API", 68 | "baseUrl": "https://docs.googleapis.com", 69 | "documentationUrl": "https://developers.google.com/docs", 70 | "description": "API Description", 71 | "tags": ["tag1", "tag2"] 72 | } 73 | ``` 74 | 75 | ###### Example: OpenAPI Contracts Directory Structure 76 | 77 | ```text 78 | api-specs/ 79 | └── openapi 80 | ├── asana 81 | │   └── asana 82 | │   ├── 1.0 83 | │   │   └── openapi.yaml 84 | │   └── icon.png 85 | ├── candid 86 | │   ├── charityCheckPdf 87 | │   │   ├── 1.0 88 | │   │   │   └── openapi.yaml 89 | │   │   └── icon.png 90 | │   ├── essentials 91 | │   │   ├── 1.0 92 | │   │   │   └── openapi.yaml 93 | │   │   └── icon.png 94 | │   └── premier 95 | │   ├── 1.0 96 | │   │   └── openapi.yaml 97 | │   └── icon.png 98 | ├── dayforce 99 | │   └── dayforce 100 | │   └── v1 101 | │   └── openapi.yaml 102 | ├── discord 103 | │   └── discord 104 | │   ├── 10 105 | │   │   └── openapi.yaml 106 | │   └── icon.png 107 | ├── docusign 108 | │   ├── admin 109 | │   │   ├── icon.png 110 | │   │   └── v2.1 111 | │   │   └── openapi.yaml 112 | │   ├── click 113 | │   │   ├── icon.png 114 | │   │   └── v1 115 | │   │   └── openapi.yaml 116 | │   └── esign 117 | │   ├── icon.png 118 | │   └── v2.1 119 | │   └── openapi.yaml 120 | ``` 121 | 122 | #### GraphQL Contracts Directory Structure 123 | 124 | The following is the directory structure for GraphQL specifications: 125 | 126 | 1. Each vendor has their own directory. (E.g.: `graphql/github`, `graphql/shopify`, etc.). 127 | 2. Within each vendor directory, each API has its own directory. (E.g.: `graphql/github/github`, `graphql/shopify/admin`, etc.). 128 | > **Note:** If the vendor and the API name are the same, the directory names would be the same. (E.g.: `graphql/github/github`.) 129 | 3. Each API directory will contain a `schema.graphql` file that contains the GraphQL schema. 130 | > **Note:** Since GraphQL APIs do not have versions, the schema file would be placed directly under the vendor directory. 131 | 4. The directory would also contain an `icon.png` file that contains the logo of the API. 132 | 5. This directory would also contain a `.metadata.json` file to store metadata. 133 | 134 | ##### GraphQL Metadata File Structure 135 | 136 | The `.metadata.json` file would contain the following information: 137 | 138 | - `name`: The human-readable name of the API. 139 | - `description`: A brief description of the API. 140 | - `endpoint`: The endpoint URL of the API. 141 | - `documentationUrl`: The URL to the API documentation, if available. 142 | - `tags`: An array of tags that are relevant to the API. 143 | 144 | ```json 145 | { 146 | "name": "GitHub GraphQL API", 147 | "description": "Access GitHub data using GraphQL. Query repositories, issues, users, and more.", 148 | "endpoint": "https://api.github.com/graphql", 149 | "documentationUrl": "https://docs.github.com/en/graphql", 150 | "tags": ["developer", "github"], 151 | } 152 | ``` 153 | 154 | ###### Example: GraphQL Contracts Directory Structure 155 | 156 | ```text 157 | api-specs/ 158 | └── graphql 159 | └── github 160 | └── github 161 | ├── .metadata.json 162 | ├── icon.png 163 | └── schema.graphql 164 | ``` 165 | 166 | #### AsyncAPI Contracts Directory Structure 167 | 168 | The AsyncAPI directory structure would be similar to the [OpenAPI directory structure](#openapi-contracts-directory-structure). The only difference is that the AsyncAPI spec file would be named as `asyncapi.yaml`. 169 | 170 | ###### Example: AsyncAPI Contracts Directory Structure 171 | 172 | ```text 173 | api-specs/ 174 | └── asyncapi 175 | └── slack 176 | └── events 177 | ├── 1.0.0 178 | │ └── asyncapi.yaml 179 | └── icon.png 180 | ``` 181 | 182 | ##### AsyncAPI Metadata File Structure 183 | 184 | The `.metadata.json` file would contain the following information: 185 | 186 | - `name`: The human-readable name of the API. 187 | - `description`: A brief description of the API. 188 | - `protocol`: The protocol used by the API. 189 | - `documentationUrl`: The URL to the API documentation, if available. 190 | - `tags`: An array of tags that are relevant to the API. 191 | 192 | ```json 193 | { 194 | "name": "Slack Events API", 195 | "description": "AsyncAPI contract for Slack Events API.", 196 | "protocol": "WebSocket", 197 | "documentationUrl": "https://api.slack.com/apis/events-api", 198 | "tags": ["slack", "events"], 199 | } 200 | ``` 201 | 202 | ### API Contract Validation 203 | 204 | An API contract is considered verified if _one of the following conditions_ is met: 205 | 206 | - The specification is from the official source. 207 | - The specification is used to generate and publish a connector/client and is tested and verified. 208 | 209 | The [`main`](https://github.com/wso2/api-specs/tree/main) branch contains only valid API contracts. The [`incubator`](https://github.com/wso2/api-specs/tree/incubator) branch may contain contracts that are not yet verified. 210 | 211 | ### API Contract Graduation 212 | 213 | If an API contract is not from the official source, it can be graduated to the `main` branch after the following conditions are met: 214 | 215 | - The API contract is used to generate a connector/client. 216 | - The generated connector/client is tested and verified against the live API. 217 | 218 | When graduating an API contract, the following steps should be followed: 219 | 220 | 1. Validate whether the API contract is in the correct format. 221 | * OpenAPI: The OpenAPI spec should be in YAML format and should follow the OpenAPI specification. 222 | * GraphQL: The GraphQL schema should be in SDL format and should follow the GraphQL specification. 223 | * AsyncAPI: The AsyncAPI spec should be in YAML format and should follow the AsyncAPI specification. 224 | 2. Add a valid `.metadata.json` file to the API version directory. 225 | 3. Add the relevant `icon.png` file to the API directory. 226 | 4. Send a pull request to the `main` branch. 227 | 228 | ## Reporting Issues 229 | 230 | If you find any issues with the exiting API specifications, please raise an issue in the [Issues](https://github.com/wso2/api-specs/issues) section of this repository. If you have a new API specification that you would like to contribute, please send a pull request, following the above conventions. 231 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.extensions.videoConferencing/v3/openapi.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.1 2 | info: 3 | title: Video Conferencing Extension 4 | description: 5 | These APIs allow you to specify URLs that can be used to interact with 6 | a video conferencing application, to allow HubSpot to add video conference links 7 | to meeting requests with contacts. 8 | version: v3 9 | x-hubspot-product-tier-requirements: 10 | marketing: FREE 11 | sales: FREE 12 | service: FREE 13 | cms: STARTER 14 | x-hubspot-documentation-banner: NONE 15 | x-hubspot-api-use-case: 16 | If your company often conducts meetings over Zoom, use this 17 | API to enable users to add Zoom information to meeting invitations when schedule 18 | meetings in HubSpot. 19 | x-hubspot-related-documentation: 20 | - name: Video Conference Guide 21 | url: https://developers.hubspot.com/docs/guides/api/crm/extensions/video-conferencing 22 | x-hubspot-introduction: 23 | Use the video conference API to add video conferencing options 24 | when scheduling a meeting in HubSpot. 25 | servers: 26 | - url: https://api.hubapi.com/crm/v3/extensions/videoconferencing/settings 27 | tags: 28 | - name: Settings 29 | paths: 30 | "/{appId}": 31 | get: 32 | tags: 33 | - Settings 34 | summary: Get settings 35 | description: 36 | Return the settings for a video conference application with the 37 | specified ID. 38 | operationId: get-/crm/v3/extensions/videoconferencing/settings/{appId}_getById 39 | parameters: 40 | - name: appId 41 | in: path 42 | description: 43 | The ID of the video conference application. This is the identifier 44 | of the application created in your HubSpot developer portal 45 | required: true 46 | style: simple 47 | explode: false 48 | schema: 49 | type: integer 50 | format: int32 51 | responses: 52 | "200": 53 | description: successful operation 54 | content: 55 | application/json: 56 | schema: 57 | "$ref": "#/components/schemas/ExternalSettings" 58 | default: 59 | description: An error occurred. 60 | content: 61 | "*/*": 62 | schema: 63 | "$ref": "#/components/schemas/Error" 64 | security: 65 | - developer_hapikey: [] 66 | put: 67 | tags: 68 | - Settings 69 | summary: Update settings 70 | description: 71 | Updates the settings for a video conference application with the 72 | specified ID. 73 | operationId: put-/crm/v3/extensions/videoconferencing/settings/{appId}_replace 74 | parameters: 75 | - name: appId 76 | in: path 77 | description: 78 | The ID of the video conference application. This is the identifier 79 | of the application created in your HubSpot developer portal 80 | required: true 81 | style: simple 82 | explode: false 83 | schema: 84 | type: integer 85 | format: int32 86 | requestBody: 87 | content: 88 | application/json: 89 | schema: 90 | "$ref": "#/components/schemas/ExternalSettings" 91 | required: true 92 | responses: 93 | "200": 94 | description: successful operation 95 | content: 96 | application/json: 97 | schema: 98 | "$ref": "#/components/schemas/ExternalSettings" 99 | default: 100 | description: An error occurred. 101 | content: 102 | "*/*": 103 | schema: 104 | "$ref": "#/components/schemas/Error" 105 | security: 106 | - developer_hapikey: [] 107 | delete: 108 | tags: 109 | - Settings 110 | summary: Delete settings 111 | description: 112 | Deletes the settings for a video conference application with the 113 | specified ID. 114 | operationId: delete-/crm/v3/extensions/videoconferencing/settings/{appId}_archive 115 | parameters: 116 | - name: appId 117 | in: path 118 | description: 119 | The ID of the video conference application. This is the identifier 120 | of the application created in your HubSpot developer portal 121 | required: true 122 | style: simple 123 | explode: false 124 | schema: 125 | type: integer 126 | format: int32 127 | responses: 128 | "204": 129 | description: No content 130 | content: {} 131 | default: 132 | description: An error occurred. 133 | content: 134 | "*/*": 135 | schema: 136 | "$ref": "#/components/schemas/Error" 137 | security: 138 | - developer_hapikey: [] 139 | components: 140 | schemas: 141 | ErrorDetail: 142 | required: 143 | - message 144 | type: object 145 | properties: 146 | subCategory: 147 | type: string 148 | description: 149 | A specific category that contains more specific detail about 150 | the error 151 | code: 152 | type: string 153 | description: The status code associated with the error detail 154 | in: 155 | type: string 156 | description: The name of the field or parameter in which the error was found 157 | context: 158 | type: object 159 | additionalProperties: 160 | type: array 161 | items: 162 | type: string 163 | description: Context about the error condition 164 | example: 165 | missingScopes: 166 | - scope1 167 | - scope2 168 | message: 169 | type: string 170 | description: 171 | A human readable message describing the error along with remediation 172 | steps where appropriate 173 | ExternalSettings: 174 | required: 175 | - createMeetingUrl 176 | type: object 177 | properties: 178 | userVerifyUrl: 179 | type: string 180 | description: 181 | The URL that HubSpot will use to verify that a user exists 182 | in the video conference application 183 | nullable: true 184 | example: https://example.com/user-verify 185 | fetchAccountsUri: 186 | type: string 187 | nullable: true 188 | example: https://example.xyz/1 189 | createMeetingUrl: 190 | type: string 191 | description: 192 | The URL that HubSpot will send requests to create a new video 193 | conference 194 | example: https://example.com/create-meeting 195 | updateMeetingUrl: 196 | type: string 197 | description: 198 | The URL that HubSpot will send updates to existing meetings. 199 | Typically called when the user changes the topic or times of a meeting 200 | nullable: true 201 | example: https://example.com/update-meeting 202 | deleteMeetingUrl: 203 | type: string 204 | description: 205 | The URL that HubSpot will send notifications of meetings that 206 | have been deleted in HubSpot 207 | nullable: true 208 | example: https://example.com/delete-meeting 209 | description: 210 | The URLs of the various actions provided by the video conferencing 211 | application. All URLs must use the `https` protocol 212 | example: 213 | createMeetingUrl: https://example.com/create-meeting 214 | updateMeetingUrl: https://example.com/update-meeting 215 | deleteMeetingUrl: https://example.com/delete-meeting 216 | userVerifyUrl: https://example.com/user-verify 217 | Error: 218 | required: 219 | - category 220 | - correlationId 221 | - message 222 | type: object 223 | properties: 224 | subCategory: 225 | type: string 226 | description: 227 | A specific category that contains more specific detail about 228 | the error 229 | context: 230 | type: object 231 | additionalProperties: 232 | type: array 233 | items: 234 | type: string 235 | description: Context about the error condition 236 | example: 237 | missingScopes: 238 | - scope1 239 | - scope2 240 | invalidPropertyName: 241 | - propertyValue 242 | correlationId: 243 | type: string 244 | description: 245 | A unique identifier for the request. Include this value with 246 | any error reports or support tickets 247 | format: uuid 248 | example: aeb5f871-7f07-4993-9211-075dc63e7cbf 249 | links: 250 | type: object 251 | additionalProperties: 252 | type: string 253 | description: 254 | A map of link names to associated URIs containing documentation 255 | about the error or recommended remediation steps 256 | example: 257 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 258 | message: 259 | type: string 260 | description: 261 | A human readable message describing the error along with remediation 262 | steps where appropriate 263 | example: Invalid input (details will vary based on the error) 264 | category: 265 | type: string 266 | description: The error category 267 | example: VALIDATION_ERROR 268 | errors: 269 | type: array 270 | description: further information about the error 271 | items: 272 | "$ref": "#/components/schemas/ErrorDetail" 273 | example: 274 | message: Invalid input (details will vary based on the error) 275 | correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf 276 | category: VALIDATION_ERROR 277 | links: 278 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 279 | responses: 280 | Error: 281 | description: An error occurred. 282 | content: 283 | "*/*": 284 | schema: 285 | "$ref": "#/components/schemas/Error" 286 | securitySchemes: 287 | developer_hapikey: 288 | type: apiKey 289 | description: HubSpot developer API key 290 | name: hapikey 291 | in: query 292 | x-hubspot-available-client-libraries: 293 | - PHP 294 | - Node 295 | - Ruby 296 | - Python 297 | x-hubspot-product-tier-requirements: 298 | marketing: FREE 299 | sales: FREE 300 | service: FREE 301 | cms: STARTER 302 | x-hubspot-documentation-banner: NONE 303 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.owners/v3/openapi.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.1 2 | info: 3 | title: CRM Crm Owners 4 | description: |- 5 | HubSpot uses **owners** to assign CRM objects to specific people in your organization. The endpoints described here are used to get a list of the owners that are available for an account. To assign an owner to an object, set the hubspot_owner_id property using the appropriate CRM object update or create a request. 6 | 7 | If teams are available for your HubSpot tier, these endpoints will also indicate which team(s) an owner can access, as well as which team is the owner's primary team. 8 | version: v3 9 | x-hubspot-product-tier-requirements: 10 | marketing: FREE 11 | sales: FREE 12 | service: FREE 13 | cms: STARTER 14 | x-hubspot-documentation-banner: NONE 15 | x-hubspot-api-use-case: Retrieve the owner IDs for all users in the account to later 16 | assign CRM records across the team. 17 | x-hubspot-related-documentation: 18 | - name: Owners Guide 19 | url: https://developers.hubspot.com/docs/guides/api/crm/owners 20 | x-hubspot-introduction: Each user in a HubSpot account is assigned an owner ID, 21 | which HubSpot uses to map the user to their assigned CRM records, activities, 22 | and more. Use the owners API to retrieve owner IDs and other related information 23 | for users in the account. To assign an owner to a CRM record, you can use the 24 | properties API to set the hubspot_owner_id property. 25 | servers: 26 | - url: https://api.hubapi.com/crm/v3/owners 27 | tags: 28 | - name: Owners 29 | paths: 30 | "/": 31 | get: 32 | tags: 33 | - Owners 34 | summary: Get a page of owners 35 | operationId: get-/crm/v3/owners/_getPage 36 | parameters: 37 | - name: email 38 | in: query 39 | description: Filter by email address (optional) 40 | required: false 41 | style: form 42 | explode: true 43 | schema: 44 | type: string 45 | - name: after 46 | in: query 47 | description: The paging cursor token of the last successfully read resource 48 | will be returned as the `paging.next.after` JSON property of a paged response 49 | containing more results 50 | required: false 51 | style: form 52 | explode: true 53 | schema: 54 | type: string 55 | - name: limit 56 | in: query 57 | description: The maximum number of results to display per page 58 | required: false 59 | style: form 60 | explode: true 61 | schema: 62 | type: integer 63 | format: int32 64 | default: 100 65 | - name: archived 66 | in: query 67 | description: Whether to return only results that have been archived 68 | required: false 69 | style: form 70 | explode: true 71 | schema: 72 | type: boolean 73 | default: false 74 | responses: 75 | '200': 76 | description: successful operation 77 | content: 78 | application/json: 79 | schema: 80 | "$ref": "#/components/schemas/CollectionResponsePublicOwnerForwardPaging" 81 | default: 82 | "$ref": "#/components/responses/Error" 83 | security: 84 | - private_apps_legacy: 85 | - contacts 86 | - private_apps: 87 | - crm.objects.owners.read 88 | - oauth2: 89 | - crm.objects.owners.read 90 | "/{ownerId}": 91 | get: 92 | tags: 93 | - Owners 94 | summary: Read an owner by given `id` or `userId` 95 | operationId: get-/crm/v3/owners/{ownerId}_getById 96 | parameters: 97 | - name: ownerId 98 | in: path 99 | required: true 100 | style: simple 101 | explode: false 102 | schema: 103 | type: integer 104 | format: int32 105 | - name: idProperty 106 | in: query 107 | description: The property to search by. Defaults to `id` 108 | required: false 109 | style: form 110 | explode: true 111 | schema: 112 | type: string 113 | default: id 114 | enum: 115 | - id 116 | - userId 117 | - name: archived 118 | in: query 119 | description: Whether to return only results that have been archived 120 | required: false 121 | style: form 122 | explode: true 123 | schema: 124 | type: boolean 125 | default: false 126 | responses: 127 | '200': 128 | description: successful operation 129 | content: 130 | application/json: 131 | schema: 132 | "$ref": "#/components/schemas/PublicOwner" 133 | default: 134 | "$ref": "#/components/responses/Error" 135 | security: 136 | - private_apps_legacy: 137 | - contacts 138 | - private_apps: 139 | - crm.objects.owners.read 140 | - oauth2: 141 | - crm.objects.owners.read 142 | components: 143 | schemas: 144 | ErrorDetail: 145 | required: 146 | - message 147 | type: object 148 | properties: 149 | subCategory: 150 | type: string 151 | description: A specific category that contains more specific detail about 152 | the error 153 | code: 154 | type: string 155 | description: The status code associated with the error detail 156 | in: 157 | type: string 158 | description: The name of the field or parameter in which the error was found 159 | context: 160 | type: object 161 | additionalProperties: 162 | type: array 163 | items: 164 | type: string 165 | description: Context about the error condition 166 | example: 167 | missingScopes: 168 | - scope1 169 | - scope2 170 | message: 171 | type: string 172 | description: A human readable message describing the error along with remediation 173 | steps where appropriate 174 | ForwardPaging: 175 | type: object 176 | properties: 177 | next: 178 | "$ref": "#/components/schemas/NextPage" 179 | description: Details about forward pagination used to retrieve the next set 180 | of results in a paginated response 181 | PublicOwner: 182 | required: 183 | - archived 184 | - createdAt 185 | - id 186 | - type 187 | - updatedAt 188 | type: object 189 | properties: 190 | firstName: 191 | type: string 192 | description: The first name of the owner 193 | example: John 194 | lastName: 195 | type: string 196 | description: The last name of the owner 197 | example: Smith 198 | createdAt: 199 | type: string 200 | description: The date and time the owner was created 201 | format: datetime 202 | example: '2019-10-30T03:30:17.883+00:00' 203 | archived: 204 | type: boolean 205 | description: Whether the owner has been archived 206 | example: false 207 | teams: 208 | type: array 209 | description: The teams that the owner is a member of 210 | example: 211 | - id: '178588' 212 | name: West Coast Sales 213 | primary: true 214 | - id: '178590' 215 | name: California Sales 216 | primary: false 217 | items: 218 | "$ref": "#/components/schemas/PublicTeam" 219 | id: 220 | type: string 221 | description: The unique identifier for the owner 222 | example: '6166860' 223 | userIdIncludingInactive: 224 | type: integer 225 | description: The unique identifier for the owner, including inactive owners 226 | format: int32 227 | type: 228 | type: string 229 | description: The type of owner 230 | enum: 231 | - PERSON 232 | - QUEUE 233 | userId: 234 | type: integer 235 | description: The unique identifier for the owner 236 | format: int32 237 | example: 1296619 238 | email: 239 | type: string 240 | description: The email address of the owner 241 | example: jsmith@example.com 242 | updatedAt: 243 | type: string 244 | description: The date and time the owner was last updated 245 | format: datetime 246 | example: '2019-12-07T16:50:06.678+00:00' 247 | description: Represents a HubSpot owner, which can be either an individual (PERSON) 248 | or a queue (QUEUE), along with their associated details 249 | example: 250 | id: '6166860' 251 | email: jsmith@example.com 252 | firstName: John 253 | lastName: Smith 254 | userId: 1296619 255 | createdAt: '2019-10-30T03:30:17.883Z' 256 | updatedAt: '2019-12-07T16:50:06.678Z' 257 | archived: false 258 | teams: 259 | - id: '178588' 260 | name: West Coast Sales 261 | primary: true 262 | - id: '178590' 263 | name: California Sales 264 | primary: false 265 | PublicTeam: 266 | required: 267 | - id 268 | - name 269 | - primary 270 | type: object 271 | properties: 272 | name: 273 | type: string 274 | description: The name of the team 275 | id: 276 | type: string 277 | description: The unique identifier for the team 278 | primary: 279 | type: boolean 280 | description: Whether the team is the primary team 281 | description: Represents a HubSpot team with a name, a unique identifier, and 282 | a flag indicating whether it is the primary team 283 | Error: 284 | required: 285 | - category 286 | - correlationId 287 | - message 288 | type: object 289 | properties: 290 | subCategory: 291 | type: string 292 | description: A specific category that contains more specific detail about 293 | the error 294 | context: 295 | type: object 296 | additionalProperties: 297 | type: array 298 | items: 299 | type: string 300 | description: Context about the error condition 301 | example: 302 | missingScopes: 303 | - scope1 304 | - scope2 305 | invalidPropertyName: 306 | - propertyValue 307 | correlationId: 308 | type: string 309 | description: A unique identifier for the request. Include this value with 310 | any error reports or support tickets 311 | format: uuid 312 | example: aeb5f871-7f07-4993-9211-075dc63e7cbf 313 | links: 314 | type: object 315 | additionalProperties: 316 | type: string 317 | description: A map of link names to associated URIs containing documentation 318 | about the error or recommended remediation steps 319 | example: 320 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 321 | message: 322 | type: string 323 | description: A human readable message describing the error along with remediation 324 | steps where appropriate 325 | example: Invalid input (details will vary based on the error) 326 | category: 327 | type: string 328 | description: The error category 329 | example: VALIDATION_ERROR 330 | errors: 331 | type: array 332 | description: further information about the error 333 | items: 334 | "$ref": "#/components/schemas/ErrorDetail" 335 | example: 336 | message: Invalid input (details will vary based on the error) 337 | correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf 338 | category: VALIDATION_ERROR 339 | links: 340 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 341 | CollectionResponsePublicOwnerForwardPaging: 342 | required: 343 | - results 344 | type: object 345 | properties: 346 | paging: 347 | "$ref": "#/components/schemas/ForwardPaging" 348 | results: 349 | type: array 350 | description: A list of owners 351 | items: 352 | "$ref": "#/components/schemas/PublicOwner" 353 | description: Collection of owners with forward paging information for continued 354 | retrieval 355 | NextPage: 356 | required: 357 | - after 358 | type: object 359 | properties: 360 | link: 361 | type: string 362 | description: A link to the next page of results 363 | after: 364 | type: string 365 | description: The paging cursor token of the last successfully read resource 366 | will be returned as the `paging.next.after` JSON property of a paged response 367 | containing more results 368 | description: Information about the next page, including a link and the paging 369 | cursor token to retrieve more results 370 | responses: 371 | Error: 372 | description: An error occurred. 373 | content: 374 | "*/*": 375 | schema: 376 | "$ref": "#/components/schemas/Error" 377 | securitySchemes: 378 | oauth2: 379 | type: oauth2 380 | flows: 381 | authorizationCode: 382 | authorizationUrl: https://app.hubspot.com/oauth/authorize 383 | tokenUrl: https://api.hubapi.com/oauth/v1/token 384 | scopes: 385 | crm.objects.owners.read: " " 386 | private_apps_legacy: 387 | type: apiKey 388 | description: Used to authenticate requests from legacy private apps 389 | name: private-app-legacy 390 | in: header 391 | x-ballerina-name: privateAppLegacy 392 | private_apps: 393 | type: apiKey 394 | description: Used to authenticate requests from private apps 395 | name: private-app 396 | in: header 397 | x-ballerina-name: privateApp 398 | x-hubspot-available-client-libraries: 399 | - PHP 400 | - Node 401 | - Ruby 402 | - Python 403 | x-hubspot-product-tier-requirements: 404 | marketing: FREE 405 | sales: FREE 406 | service: FREE 407 | cms: STARTER 408 | x-hubspot-documentation-banner: NONE 409 | -------------------------------------------------------------------------------- /openapi/hubspot/marketing.transactional/v3/openapi.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.1 2 | info: 3 | title: Marketing Transactional Single Send 4 | version: v3 5 | x-hubspot-product-tier-requirements: 6 | marketing: PROFESSIONAL 7 | x-hubspot-documentation-banner: NONE 8 | x-hubspot-api-use-case: After a customer converts or purchases a product from your 9 | business, you want to send them a receipt of their transaction. 10 | x-hubspot-related-documentation: 11 | - name: Transactional Email Guide 12 | url: https://developers.hubspot.com/beta-docs/guides/api/marketing/emails/transactional-emails 13 | x-hubspot-introduction: Use the transactional email API to send emails from a dedicated 14 | IP address to your contacts for essential business transactions, including account 15 | updates or terms of service changes. 16 | servers: 17 | - url: https://api.hubapi.com/marketing/v3/transactional 18 | tags: 19 | - name: Single send 20 | - name: Public SMTP tokens 21 | paths: 22 | "/single-email/send": 23 | post: 24 | tags: 25 | - Single send 26 | summary: Send a single transactional email asynchronously. 27 | description: Asynchronously send a transactional email. Returns the status of 28 | the email send with a statusId that can be used to continuously query for 29 | the status using the Email Send Status API. 30 | operationId: post-/marketing/v3/transactional/single-email/send_sendEmail 31 | parameters: [] 32 | requestBody: 33 | description: A request object describing the email to send 34 | content: 35 | application/json: 36 | schema: 37 | "$ref": "#/components/schemas/PublicSingleSendRequestEgg" 38 | required: true 39 | responses: 40 | '200': 41 | description: successful operation 42 | content: 43 | application/json: 44 | schema: 45 | "$ref": "#/components/schemas/EmailSendStatusView" 46 | default: 47 | "$ref": "#/components/responses/Error" 48 | security: 49 | - oauth2_legacy: 50 | - transactional-email 51 | - private_apps_legacy: 52 | - transactional-email 53 | x-hubspot-rate-limit-exemptions: 54 | - daily 55 | - ten-secondly 56 | "/smtp-tokens": 57 | get: 58 | tags: 59 | - Public SMTP tokens 60 | summary: Query SMTP API tokens by campaign name or an emailCampaignId. 61 | description: Query multiple SMTP API tokens by campaign name or a single token 62 | by emailCampaignId. 63 | operationId: get-/marketing/v3/transactional/smtp-tokens_getTokensPage 64 | parameters: 65 | - name: campaignName 66 | in: query 67 | description: A name for the campaign tied to the SMTP API token 68 | required: false 69 | style: form 70 | explode: true 71 | schema: 72 | type: string 73 | - name: emailCampaignId 74 | in: query 75 | description: Identifier assigned to the campaign provided during the token 76 | creation 77 | required: false 78 | style: form 79 | explode: true 80 | schema: 81 | type: string 82 | - name: after 83 | in: query 84 | description: Starting point to get the next set of results 85 | required: false 86 | style: form 87 | explode: true 88 | schema: 89 | type: string 90 | - name: limit 91 | in: query 92 | description: Maximum number of tokens to return 93 | required: false 94 | style: form 95 | explode: true 96 | schema: 97 | type: integer 98 | format: int32 99 | responses: 100 | '200': 101 | description: successful operation 102 | content: 103 | application/json: 104 | schema: 105 | "$ref": "#/components/schemas/CollectionResponseSmtpApiTokenViewForwardPaging" 106 | default: 107 | "$ref": "#/components/responses/Error" 108 | security: 109 | - oauth2_legacy: 110 | - transactional-email 111 | - private_apps_legacy: 112 | - transactional-email 113 | post: 114 | tags: 115 | - Public SMTP tokens 116 | summary: Create a SMTP API token. 117 | description: Create a SMTP API token. 118 | operationId: post-/marketing/v3/transactional/smtp-tokens_createToken 119 | parameters: [] 120 | requestBody: 121 | description: A request object that includes the campaign name tied to the 122 | token and whether contacts should be created for email recipients 123 | content: 124 | application/json: 125 | schema: 126 | "$ref": "#/components/schemas/SmtpApiTokenRequestEgg" 127 | required: true 128 | responses: 129 | '201': 130 | description: successful operation 131 | content: 132 | application/json: 133 | schema: 134 | "$ref": "#/components/schemas/SmtpApiTokenView" 135 | default: 136 | "$ref": "#/components/responses/Error" 137 | security: 138 | - oauth2_legacy: 139 | - transactional-email 140 | - private_apps_legacy: 141 | - transactional-email 142 | "/smtp-tokens/{tokenId}/password-reset": 143 | post: 144 | tags: 145 | - Public SMTP tokens 146 | summary: Reset the password of an existing token. 147 | description: Allows the creation of a replacement password for a given token. 148 | Once the password is successfully reset, the old password for the token will 149 | be invalid. 150 | operationId: post-/marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset_resetPassword 151 | parameters: 152 | - name: tokenId 153 | in: path 154 | description: Identifier generated when a token is created 155 | required: true 156 | style: simple 157 | explode: false 158 | schema: 159 | type: string 160 | responses: 161 | '200': 162 | description: successful operation 163 | content: 164 | application/json: 165 | schema: 166 | "$ref": "#/components/schemas/SmtpApiTokenView" 167 | default: 168 | "$ref": "#/components/responses/Error" 169 | security: 170 | - oauth2_legacy: 171 | - transactional-email 172 | - private_apps_legacy: 173 | - transactional-email 174 | "/smtp-tokens/{tokenId}": 175 | get: 176 | tags: 177 | - Public SMTP tokens 178 | summary: Query a single token by ID. 179 | description: Query a single token by ID. 180 | operationId: get-/marketing/v3/transactional/smtp-tokens/{tokenId}_getTokenById 181 | parameters: 182 | - name: tokenId 183 | in: path 184 | description: Identifier generated when a token is created 185 | required: true 186 | style: simple 187 | explode: false 188 | schema: 189 | type: string 190 | responses: 191 | '200': 192 | description: successful operation 193 | content: 194 | application/json: 195 | schema: 196 | "$ref": "#/components/schemas/SmtpApiTokenView" 197 | default: 198 | "$ref": "#/components/responses/Error" 199 | security: 200 | - oauth2_legacy: 201 | - transactional-email 202 | - private_apps_legacy: 203 | - transactional-email 204 | delete: 205 | tags: 206 | - Public SMTP tokens 207 | summary: Delete a single token by ID. 208 | description: Delete a single token by ID. 209 | operationId: delete-/marketing/v3/transactional/smtp-tokens/{tokenId}_archiveToken 210 | parameters: 211 | - name: tokenId 212 | in: path 213 | description: Identifier generated when a token is created 214 | required: true 215 | style: simple 216 | explode: false 217 | schema: 218 | type: string 219 | responses: 220 | '204': 221 | description: No content 222 | content: {} 223 | default: 224 | "$ref": "#/components/responses/Error" 225 | security: 226 | - oauth2_legacy: 227 | - transactional-email 228 | - private_apps_legacy: 229 | - transactional-email 230 | components: 231 | schemas: 232 | CollectionResponseSmtpApiTokenViewForwardPaging: 233 | required: 234 | - results 235 | type: object 236 | properties: 237 | paging: 238 | "$ref": "#/components/schemas/ForwardPaging" 239 | results: 240 | type: array 241 | items: 242 | "$ref": "#/components/schemas/SmtpApiTokenView" 243 | EmailSendStatusView: 244 | required: 245 | - status 246 | - statusId 247 | type: object 248 | properties: 249 | eventId: 250 | "$ref": "#/components/schemas/EventIdView" 251 | completedAt: 252 | type: string 253 | description: Time when the send was completed 254 | format: datetime 255 | statusId: 256 | type: string 257 | description: Identifier used to query the status of the send 258 | sendResult: 259 | type: string 260 | description: Result of the send 261 | enum: 262 | - SENT 263 | - IDEMPOTENT_IGNORE 264 | - QUEUED 265 | - IDEMPOTENT_FAIL 266 | - THROTTLED 267 | - EMAIL_DISABLED 268 | - PORTAL_SUSPENDED 269 | - INVALID_TO_ADDRESS 270 | - BLOCKED_DOMAIN 271 | - PREVIOUSLY_BOUNCED 272 | - EMAIL_UNCONFIRMED 273 | - PREVIOUS_SPAM 274 | - PREVIOUSLY_UNSUBSCRIBED_MESSAGE 275 | - PREVIOUSLY_UNSUBSCRIBED_PORTAL 276 | - INVALID_FROM_ADDRESS 277 | - CAMPAIGN_CANCELLED 278 | - VALIDATION_FAILED 279 | - MTA_IGNORE 280 | - BLOCKED_ADDRESS 281 | - PORTAL_OVER_LIMIT 282 | - PORTAL_EXPIRED 283 | - PORTAL_MISSING_MARKETING_SCOPE 284 | - MISSING_TEMPLATE_PROPERTIES 285 | - MISSING_REQUIRED_PARAMETER 286 | - PORTAL_AUTHENTICATION_FAILURE 287 | - MISSING_CONTENT 288 | - CORRUPT_INPUT 289 | - TEMPLATE_RENDER_EXCEPTION 290 | - GRAYMAIL_SUPPRESSED 291 | - UNCONFIGURED_SENDING_DOMAIN 292 | - UNDELIVERABLE 293 | - CANCELLED_ABUSE 294 | - QUARANTINED_ADDRESS 295 | - ADDRESS_ONLY_ACCEPTED_ON_PROD 296 | - PORTAL_NOT_AUTHORIZED_FOR_APPLICATION 297 | - ADDRESS_LIST_BOMBED 298 | - ADDRESS_OPTED_OUT 299 | - RECIPIENT_FATIGUE_SUPPRESSED 300 | - TOO_MANY_RECIPIENTS 301 | - PREVIOUSLY_UNSUBSCRIBED_BRAND 302 | - NON_MARKETABLE_CONTACT 303 | - PREVIOUSLY_UNSUBSCRIBED_BUSINESS_UNIT 304 | - GDPR_DOI_ENABLED 305 | requestedAt: 306 | type: string 307 | description: Time when the send was requested 308 | format: datetime 309 | startedAt: 310 | type: string 311 | description: Time when the send began processing 312 | format: datetime 313 | status: 314 | type: string 315 | description: Status of the send request 316 | enum: 317 | - PENDING 318 | - PROCESSING 319 | - CANCELED 320 | - COMPLETE 321 | description: Describes the status of an email send request 322 | ErrorDetail: 323 | required: 324 | - message 325 | type: object 326 | properties: 327 | subCategory: 328 | type: string 329 | description: A specific category that contains more specific detail about 330 | the error 331 | code: 332 | type: string 333 | description: The status code associated with the error detail 334 | in: 335 | type: string 336 | description: The name of the field or parameter in which the error was found 337 | context: 338 | type: object 339 | additionalProperties: 340 | type: array 341 | items: 342 | type: string 343 | description: Context about the error condition 344 | example: 345 | missingScopes: 346 | - scope1 347 | - scope2 348 | message: 349 | type: string 350 | description: A human readable message describing the error along with remediation 351 | steps where appropriate 352 | SmtpApiTokenRequestEgg: 353 | required: 354 | - campaignName 355 | - createContact 356 | type: object 357 | properties: 358 | createContact: 359 | type: boolean 360 | description: Indicates whether a contact should be created for email recipients 361 | campaignName: 362 | type: string 363 | description: A name for the campaign tied to the SMTP API token 364 | description: A request object to create a SMTP API token 365 | ForwardPaging: 366 | type: object 367 | properties: 368 | next: 369 | "$ref": "#/components/schemas/NextPage" 370 | PublicSingleSendRequestEgg: 371 | required: 372 | - emailId 373 | - message 374 | type: object 375 | properties: 376 | customProperties: 377 | type: object 378 | additionalProperties: 379 | type: object 380 | properties: {} 381 | description: |- 382 | The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}. 383 | Note: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property 384 | emailId: 385 | type: integer 386 | description: The content ID for the transactional email, which can be found 387 | in email tool UI 388 | format: int32 389 | message: 390 | "$ref": "#/components/schemas/PublicSingleSendEmail" 391 | contactProperties: 392 | type: object 393 | additionalProperties: 394 | type: string 395 | description: The contactProperties field is a map of contact property values. 396 | Each contact property value contains a name and value property. Each property 397 | will get set on the contact record and will be visible in the template 398 | under {{ contact.NAME }}. Use these properties when you want to set a 399 | contact property while you’re sending the email. For example, when sending 400 | a reciept you may want to set a last_paid_date property, as the sending 401 | of the receipt will have information about the last payment 402 | description: A request to send a single transactional email asynchronously 403 | EventIdView: 404 | required: 405 | - created 406 | - id 407 | type: object 408 | properties: 409 | created: 410 | type: string 411 | description: Time of event creation 412 | format: datetime 413 | id: 414 | type: string 415 | description: Identifier of event 416 | format: uuid 417 | description: The ID of a send event 418 | Error: 419 | required: 420 | - category 421 | - correlationId 422 | - message 423 | type: object 424 | properties: 425 | subCategory: 426 | type: string 427 | description: A specific category that contains more specific detail about 428 | the error 429 | context: 430 | type: object 431 | additionalProperties: 432 | type: array 433 | items: 434 | type: string 435 | description: Context about the error condition 436 | example: 437 | missingScopes: 438 | - scope1 439 | - scope2 440 | invalidPropertyName: 441 | - propertyValue 442 | correlationId: 443 | type: string 444 | description: A unique identifier for the request. Include this value with 445 | any error reports or support tickets 446 | format: uuid 447 | example: aeb5f871-7f07-4993-9211-075dc63e7cbf 448 | links: 449 | type: object 450 | additionalProperties: 451 | type: string 452 | description: A map of link names to associated URIs containing documentation 453 | about the error or recommended remediation steps 454 | example: 455 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 456 | message: 457 | type: string 458 | description: A human readable message describing the error along with remediation 459 | steps where appropriate 460 | example: Invalid input (details will vary based on the error) 461 | category: 462 | type: string 463 | description: The error category 464 | example: VALIDATION_ERROR 465 | errors: 466 | type: array 467 | description: further information about the error 468 | items: 469 | "$ref": "#/components/schemas/ErrorDetail" 470 | example: 471 | message: Invalid input (details will vary based on the error) 472 | correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf 473 | category: VALIDATION_ERROR 474 | links: 475 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 476 | SmtpApiTokenView: 477 | required: 478 | - campaignName 479 | - createContact 480 | - createdAt 481 | - createdBy 482 | - emailCampaignId 483 | - id 484 | type: object 485 | properties: 486 | createdAt: 487 | type: string 488 | description: Timestamp generated when a token is created 489 | format: datetime 490 | password: 491 | type: string 492 | description: Password used to log into the HubSpot SMTP server 493 | createdBy: 494 | type: string 495 | description: Email address of the user that sent the token creation request 496 | createContact: 497 | type: boolean 498 | description: Indicates whether a contact should be created for email recipients 499 | id: 500 | type: string 501 | description: User name to log into the HubSpot SMTP server 502 | emailCampaignId: 503 | type: string 504 | description: Identifier assigned to the campaign provided in the token creation 505 | request 506 | campaignName: 507 | type: string 508 | description: A name for the campaign tied to the token 509 | description: A SMTP API token provides both an ID and password that can be used 510 | to send email through the HubSpot SMTP API 511 | NextPage: 512 | required: 513 | - after 514 | type: object 515 | properties: 516 | link: 517 | type: string 518 | description: '' 519 | after: 520 | type: string 521 | description: '' 522 | PublicSingleSendEmail: 523 | required: 524 | - to 525 | type: object 526 | properties: 527 | cc: 528 | type: array 529 | description: List of email addresses to send as Cc 530 | items: 531 | type: string 532 | sendId: 533 | type: string 534 | description: ID for a particular send. No more than one email will be sent 535 | per sendId 536 | bcc: 537 | type: array 538 | description: List of email addresses to send as Bcc 539 | items: 540 | type: string 541 | replyTo: 542 | type: array 543 | description: List of Reply-To header values for the email 544 | items: 545 | type: string 546 | from: 547 | type: string 548 | description: The From header for the email 549 | to: 550 | type: string 551 | description: The recipient of the email 552 | description: A JSON object containing anything you want to override 553 | responses: 554 | Error: 555 | description: An error occurred. 556 | content: 557 | "*/*": 558 | schema: 559 | "$ref": "#/components/schemas/Error" 560 | securitySchemes: 561 | oauth2_legacy: 562 | type: oauth2 563 | flows: 564 | authorizationCode: 565 | authorizationUrl: https://app.hubspot.com/oauth/authorize 566 | tokenUrl: https://api.hubapi.com/oauth/v1/token 567 | scopes: 568 | transactional-email: Transactional Emails 569 | private_apps_legacy: 570 | type: apiKey 571 | name: private-app-legacy 572 | in: header 573 | x-ballerina-name: privateAppLegacy 574 | x-hubspot-available-client-libraries: 575 | - PHP 576 | - Node 577 | - Ruby 578 | - Python 579 | x-hubspot-product-tier-requirements: 580 | marketing: PROFESSIONAL 581 | x-hubspot-documentation-banner: NONE 582 | -------------------------------------------------------------------------------- /openapi/hubspot/crm.imports/v3/openapi.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.1 2 | info: 3 | title: CRM Imports 4 | version: v3 5 | x-hubspot-product-tier-requirements: 6 | marketing: FREE 7 | sales: FREE 8 | service: FREE 9 | cms: FREE 10 | x-hubspot-documentation-banner: NONE 11 | x-hubspot-api-use-case: 12 | After a successful in-person webinar, use this API to import 13 | a set of contacts based on who signed up during the event. 14 | x-hubspot-related-documentation: 15 | - name: Import CRM Guide 16 | url: https://developers.hubspot.com/beta-docs/guides/api/crm/imports 17 | x-hubspot-introduction: 18 | Use the imports API to import CRM records and activities, 19 | such as contacts, companies, and notes, into your HubSpot account. 20 | servers: 21 | - url: https://api.hubapi.com/crm/v3/imports 22 | tags: 23 | - name: Core 24 | - name: Public_Imports 25 | paths: 26 | "/{importId}/cancel": 27 | post: 28 | tags: 29 | - Core 30 | summary: Cancel an active import 31 | description: This allows a developer to cancel an active import. 32 | operationId: post-/{importId}/cancel_cancel 33 | parameters: 34 | - name: importId 35 | in: path 36 | required: true 37 | style: simple 38 | explode: false 39 | schema: 40 | type: integer 41 | format: int64 42 | responses: 43 | "200": 44 | description: successful operation 45 | content: 46 | application/json: 47 | schema: 48 | "$ref": "#/components/schemas/ActionResponse" 49 | default: 50 | "$ref": "#/components/responses/Error" 51 | security: 52 | - oauth2_legacy: 53 | - crm.import 54 | - private_apps_legacy: 55 | - crm.import 56 | "/{importId}": 57 | get: 58 | tags: 59 | - Core 60 | summary: Get the information on any import 61 | description: A complete summary of an import record, including any updates. 62 | operationId: get-/{importId}_getById 63 | parameters: 64 | - name: importId 65 | in: path 66 | required: true 67 | style: simple 68 | explode: false 69 | schema: 70 | type: integer 71 | format: int64 72 | responses: 73 | "200": 74 | description: successful operation 75 | content: 76 | application/json: 77 | schema: 78 | "$ref": "#/components/schemas/PublicImportResponse" 79 | default: 80 | "$ref": "#/components/responses/Error" 81 | security: 82 | - oauth2_legacy: 83 | - crm.import 84 | - private_apps_legacy: 85 | - crm.import 86 | "/{importId}/errors": 87 | get: 88 | tags: 89 | - Public_Imports 90 | operationId: get-/{importId}/errors_getErrors 91 | parameters: 92 | - name: after 93 | in: query 94 | description: 95 | The paging cursor token of the last successfully read resource 96 | will be returned as the `paging.next.after` JSON property of a paged response 97 | containing more results 98 | required: false 99 | style: form 100 | explode: true 101 | schema: 102 | type: string 103 | - name: limit 104 | in: query 105 | description: The maximum number of results to display per page 106 | required: false 107 | style: form 108 | explode: true 109 | schema: 110 | type: integer 111 | format: int32 112 | - name: importId 113 | in: path 114 | required: true 115 | style: simple 116 | explode: false 117 | schema: 118 | type: integer 119 | format: int64 120 | - name: includeErrorMessage 121 | in: query 122 | description: Set to True to receive a message explaining the error 123 | required: false 124 | style: form 125 | explode: true 126 | schema: 127 | type: boolean 128 | - name: includeRowData 129 | in: query 130 | description: Set to True to receive the data values for the errored row 131 | required: false 132 | style: form 133 | explode: true 134 | schema: 135 | type: boolean 136 | responses: 137 | "200": 138 | description: successful operation 139 | content: 140 | application/json: 141 | schema: 142 | "$ref": "#/components/schemas/CollectionResponsePublicImportErrorForwardPaging" 143 | default: 144 | "$ref": "#/components/responses/Error" 145 | security: 146 | - oauth2_legacy: 147 | - crm.import 148 | - private_apps_legacy: 149 | - crm.import 150 | "/": 151 | get: 152 | tags: 153 | - Core 154 | summary: Get active imports 155 | description: Returns a paged list of active imports for this account. 156 | operationId: get-/_getPage 157 | parameters: 158 | - name: after 159 | in: query 160 | description: 161 | The paging cursor token of the last successfully read resource 162 | will be returned as the `paging.next.after` JSON property of a paged response 163 | containing more results 164 | required: false 165 | style: form 166 | explode: true 167 | schema: 168 | type: string 169 | - name: before 170 | in: query 171 | required: false 172 | style: form 173 | explode: true 174 | schema: 175 | type: string 176 | - name: limit 177 | in: query 178 | description: The maximum number of results to display per page 179 | required: false 180 | style: form 181 | explode: true 182 | schema: 183 | type: integer 184 | format: int32 185 | responses: 186 | "200": 187 | description: successful operation 188 | content: 189 | application/json: 190 | schema: 191 | "$ref": "#/components/schemas/CollectionResponsePublicImportResponse" 192 | default: 193 | "$ref": "#/components/responses/Error" 194 | security: 195 | - oauth2_legacy: 196 | - crm.import 197 | - private_apps_legacy: 198 | - crm.import 199 | post: 200 | tags: 201 | - Core 202 | summary: Start a new import 203 | description: 204 | Begins importing data from the specified file resources. This uploads 205 | the corresponding file and uses the import request object to convert rows 206 | in the files to objects. 207 | operationId: post-/_create 208 | parameters: [] 209 | requestBody: 210 | content: 211 | multipart/form-data: 212 | schema: 213 | "$ref": "#/components/schemas/Body" 214 | responses: 215 | "200": 216 | description: successful operation 217 | content: 218 | application/json: 219 | schema: 220 | "$ref": "#/components/schemas/PublicImportResponse" 221 | default: 222 | "$ref": "#/components/responses/Error" 223 | security: 224 | - oauth2_legacy: 225 | - crm.import 226 | - private_apps_legacy: 227 | - crm.import 228 | components: 229 | schemas: 230 | CollectionResponsePublicImportResponse: 231 | required: 232 | - results 233 | type: object 234 | properties: 235 | paging: 236 | "$ref": "#/components/schemas/Paging" 237 | results: 238 | type: array 239 | items: 240 | "$ref": "#/components/schemas/PublicImportResponse" 241 | Paging: 242 | type: object 243 | properties: 244 | next: 245 | "$ref": "#/components/schemas/NextPage" 246 | prev: 247 | "$ref": "#/components/schemas/PreviousPage" 248 | PublicObjectListRecord: 249 | required: 250 | - listId 251 | - objectType 252 | type: object 253 | properties: 254 | listId: 255 | type: string 256 | description: The ID of the list containing the imported objects 257 | example: "3" 258 | objectType: 259 | type: string 260 | description: The type of object contained in the list 261 | example: contacts 262 | Error: 263 | required: 264 | - category 265 | - correlationId 266 | - message 267 | type: object 268 | properties: 269 | subCategory: 270 | type: string 271 | description: 272 | A specific category that contains more specific detail about 273 | the error 274 | context: 275 | type: object 276 | additionalProperties: 277 | type: array 278 | items: 279 | type: string 280 | description: Context about the error condition 281 | example: 282 | missingScopes: 283 | - scope1 284 | - scope2 285 | invalidPropertyName: 286 | - propertyValue 287 | correlationId: 288 | type: string 289 | description: 290 | A unique identifier for the request. Include this value with 291 | any error reports or support tickets 292 | format: uuid 293 | example: aeb5f871-7f07-4993-9211-075dc63e7cbf 294 | links: 295 | type: object 296 | additionalProperties: 297 | type: string 298 | description: 299 | A map of link names to associated URIs containing documentation 300 | about the error or recommended remediation steps 301 | example: 302 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 303 | message: 304 | type: string 305 | description: 306 | A human readable message describing the error along with remediation 307 | steps where appropriate 308 | example: Invalid input (details will vary based on the error) 309 | category: 310 | type: string 311 | description: The error category 312 | example: VALIDATION_ERROR 313 | errors: 314 | type: array 315 | description: further information about the error 316 | items: 317 | "$ref": "#/components/schemas/ErrorDetail" 318 | example: 319 | message: Invalid input (details will vary based on the error) 320 | correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf 321 | category: VALIDATION_ERROR 322 | links: 323 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 324 | PropertyValue: 325 | required: 326 | - dataSensitivity 327 | - isEncrypted 328 | - isLargeValue 329 | - name 330 | - persistenceTimestamp 331 | - requestId 332 | - selectedByUser 333 | - selectedByUserTimestamp 334 | - source 335 | - sourceId 336 | - sourceLabel 337 | - sourceMetadata 338 | - sourceVid 339 | - timestamp 340 | - unit 341 | - updatedByUserId 342 | - useTimestampAsPersistenceTimestamp 343 | - value 344 | type: object 345 | properties: 346 | sourceId: 347 | type: string 348 | selectedByUser: 349 | type: boolean 350 | sourceLabel: 351 | type: string 352 | source: 353 | type: string 354 | enum: 355 | - UNKNOWN 356 | - IMPORT 357 | - API 358 | - FORM 359 | - ANALYTICS 360 | - MIGRATION 361 | - SALESFORCE 362 | - INTEGRATION 363 | - CONTACTS_WEB 364 | - WAL_INCREMENTAL 365 | - TASK 366 | - EMAIL 367 | - WORKFLOWS 368 | - CALCULATED 369 | - SOCIAL 370 | - BATCH_UPDATE 371 | - SIGNALS 372 | - BIDEN 373 | - DEFAULT 374 | - COMPANIES 375 | - DEALS 376 | - ASSISTS 377 | - PRESENTATIONS 378 | - TALLY 379 | - SIDEKICK 380 | - CRM_UI 381 | - MERGE_CONTACTS 382 | - PORTAL_USER_ASSOCIATOR 383 | - INTEGRATIONS_PLATFORM 384 | - BCC_TO_CRM 385 | - FORWARD_TO_CRM 386 | - ENGAGEMENTS 387 | - SALES 388 | - HEISENBERG 389 | - LEADIN 390 | - GMAIL_INTEGRATION 391 | - ACADEMY 392 | - SALES_MESSAGES 393 | - AVATARS_SERVICE 394 | - MERGE_COMPANIES 395 | - SEQUENCES 396 | - COMPANY_FAMILIES 397 | - MOBILE_IOS 398 | - MOBILE_ANDROID 399 | - CONTACTS 400 | - ASSOCIATIONS 401 | - EXTENSION 402 | - SUCCESS 403 | - BOT 404 | - INTEGRATIONS_SYNC 405 | - AUTOMATION_PLATFORM 406 | - CONVERSATIONS 407 | - EMAIL_INTEGRATION 408 | - CONTENT_MEMBERSHIP 409 | - QUOTES 410 | - BET_ASSIGNMENT 411 | - QUOTAS 412 | - BET_CRM_CONNECTOR 413 | - MEETINGS 414 | - MERGE_OBJECTS 415 | - RECYCLING_BIN 416 | - ADS 417 | - AI_GROUP 418 | - COMMUNICATOR 419 | - SETTINGS 420 | - PROPERTY_SETTINGS 421 | - PIPELINE_SETTINGS 422 | - COMPANY_INSIGHTS 423 | - BEHAVIORAL_EVENTS 424 | - PAYMENTS 425 | - GOALS 426 | - PORTAL_OBJECT_SYNC 427 | - APPROVALS 428 | - FILE_MANAGER 429 | - MARKETPLACE 430 | - INTERNAL_PROCESSING 431 | - FORECASTING 432 | - SLACK_INTEGRATION 433 | - CRM_UI_BULK_ACTION 434 | - WORKFLOW_CONTACT_DELETE_ACTION 435 | - ACCEPTANCE_TEST 436 | - PLAYBOOKS 437 | - CHATSPOT 438 | - FLYWHEEL_PRODUCT_DATA_SYNC 439 | - HELP_DESK 440 | - BILLING 441 | - DATA_ENRICHMENT 442 | - AUTOMATION_JOURNEY 443 | - MICROAPPS 444 | - INTENT 445 | - PROSPECTING_AGENT 446 | updatedByUserId: 447 | type: integer 448 | format: int32 449 | persistenceTimestamp: 450 | type: integer 451 | format: int64 452 | sourceMetadata: 453 | type: string 454 | dataSensitivity: 455 | type: string 456 | enum: 457 | - none 458 | - standard 459 | - high 460 | sourceVid: 461 | type: array 462 | items: 463 | type: integer 464 | format: int64 465 | unit: 466 | type: string 467 | requestId: 468 | type: string 469 | isEncrypted: 470 | type: boolean 471 | name: 472 | type: string 473 | useTimestampAsPersistenceTimestamp: 474 | type: boolean 475 | value: 476 | type: string 477 | selectedByUserTimestamp: 478 | type: integer 479 | format: int64 480 | timestamp: 481 | type: integer 482 | format: int64 483 | isLargeValue: 484 | type: boolean 485 | ImportRowCore: 486 | required: 487 | - containsEncryptedProperties 488 | - fileId 489 | - lineNumber 490 | - rowData 491 | type: object 492 | properties: 493 | rowData: 494 | type: array 495 | items: 496 | type: string 497 | containsEncryptedProperties: 498 | type: boolean 499 | lineNumber: 500 | type: integer 501 | format: int32 502 | pageName: 503 | type: string 504 | fileId: 505 | type: integer 506 | format: int32 507 | ImportTemplate: 508 | required: 509 | - templateId 510 | - templateType 511 | type: object 512 | properties: 513 | templateType: 514 | type: string 515 | enum: 516 | - admin_defined 517 | - previous_import 518 | - user_file 519 | templateId: 520 | type: integer 521 | format: int32 522 | ActionResponse: 523 | required: 524 | - completedAt 525 | - startedAt 526 | - status 527 | type: object 528 | properties: 529 | completedAt: 530 | type: string 531 | format: datetime 532 | requestedAt: 533 | type: string 534 | format: datetime 535 | startedAt: 536 | type: string 537 | format: datetime 538 | links: 539 | type: object 540 | additionalProperties: 541 | type: string 542 | status: 543 | type: string 544 | enum: 545 | - PENDING 546 | - PROCESSING 547 | - CANCELED 548 | - COMPLETE 549 | ErrorDetail: 550 | required: 551 | - message 552 | type: object 553 | properties: 554 | subCategory: 555 | type: string 556 | description: 557 | A specific category that contains more specific detail about 558 | the error 559 | code: 560 | type: string 561 | description: The status code associated with the error detail 562 | in: 563 | type: string 564 | description: The name of the field or parameter in which the error was found 565 | context: 566 | type: object 567 | additionalProperties: 568 | type: array 569 | items: 570 | type: string 571 | description: Context about the error condition 572 | example: 573 | missingScopes: 574 | - scope1 575 | - scope2 576 | message: 577 | type: string 578 | description: 579 | A human readable message describing the error along with remediation 580 | steps where appropriate 581 | ForwardPaging: 582 | type: object 583 | properties: 584 | next: 585 | "$ref": "#/components/schemas/NextPage" 586 | PublicImportError: 587 | required: 588 | - createdAt 589 | - errorType 590 | - id 591 | - sourceData 592 | type: object 593 | properties: 594 | createdAt: 595 | type: integer 596 | format: int32 597 | extraContext: 598 | type: string 599 | objectTypeId: 600 | type: string 601 | errorType: 602 | type: string 603 | enum: 604 | - INCORRECT_NUMBER_OF_COLUMNS 605 | - INVALID_OBJECT_ID 606 | - INVALID_ASSOCIATION_IDENTIFIER 607 | - NO_OBJECT_ID_FROM_ASSOCIATION_IDENTIFIER 608 | - MULTIPLE_COMPANIES_WITH_THIS_DOMAIN 609 | - PROPERTY_DEFINITION_NOT_FOUND 610 | - PROPERTY_VALUE_NOT_FOUND 611 | - COULD_NOT_FIND_OWNER 612 | - MULTIPLE_OWNERS_FOUND 613 | - COULD_NOT_FIND_BUSINESS_UNIT 614 | - COULD_NOT_PARSE_NUMBER 615 | - COULD_NOT_PARSE_DATE 616 | - COULD_NOT_PARSE_TERM 617 | - OUTSIDE_VALID_TIME_RANGE 618 | - OUTSIDE_VALID_TERM_RANGE 619 | - COULD_NOT_PARSE_ROW 620 | - INVALID_ENUMERATION_OPTION 621 | - AMBIGUOUS_ENUMERATION_OPTION 622 | - FAILED_VALIDATION 623 | - FAILED_TO_CREATE_ASSOCIATION 624 | - ASSOCIATION_LIMIT_EXCEEDED 625 | - FILE_NOT_FOUND 626 | - INVALID_COLUMN_CONFIGURATION 627 | - INVALID_FILE_TYPE 628 | - INVALID_SPREADSHEET 629 | - INVALID_SHEET_COUNT 630 | - FAILED_TO_PROCESS_OBJECT_WITH_EMPTY_PROPERTY_VALUES 631 | - UNKNOWN_BAD_REQUEST 632 | - GDPR_BLACKLISTED_EMAIL 633 | - DUPLICATE_ASSOCIATION_ID 634 | - LIMIT_EXCEEDED 635 | - PORTAL_WIDE_CUSTOM_OBJECT_LIMIT_EXCEEDED 636 | - INVALID_ALTERNATE_ID 637 | - INVALID_EMAIL 638 | - SECONDARY_EMAIL_WRITE_FAILURE 639 | - INVALID_DOMAIN 640 | - DUPLICATE_ROW_CONTENT 641 | - INVALID_NUMBER_SIZE 642 | - UNKNOWN_ERROR 643 | - FAILED_TO_OPT_OUT_CONTACT 644 | - INVALID_REQUIRED_PROPERTY 645 | - MISSING_REQUIRED_PROPERTY 646 | - DUPLICATE_ALTERNATE_ID 647 | - DUPLICATE_OBJECT_ID 648 | - DUPLICATE_UNIQUE_PROPERTY_VALUE 649 | - UNKNOWN_ASSOCIATION_RECORD_ID 650 | - INVALID_RECORD_ID 651 | - DUPLICATE_RECORD_ID 652 | - INVALID_CUSTOM_PROPERTY_VALIDATION 653 | - CREATE_ONLY_IMPORT 654 | - UPDATE_ONLY_IMPORT 655 | - COLUMN_TOO_LARGE 656 | - ROW_DATA_TOO_LARGE 657 | - MISSING_EVENT_TIMESTAMP 658 | - INVALID_EVENT_TIMESTAMP 659 | - INVALID_EVENT 660 | - DUPLICATE_EVENT 661 | - MISSING_EVENT_DEFINITION 662 | - INVALID_ASSOCIATION_KEY 663 | - ASSOCIATION_RECORD_NOT_FOUND 664 | - MISSING_OBJECT_DEFINITION 665 | - ASSOCIATION_LABEL_NOT_FOUND 666 | - MANY_ERRORS_IN_ROW 667 | invalidPropertyValue: 668 | "$ref": "#/components/schemas/PropertyValue" 669 | errorMessage: 670 | type: string 671 | knownColumnNumber: 672 | type: integer 673 | format: int32 674 | invalidValueToDisplay: 675 | type: string 676 | id: 677 | type: string 678 | sourceData: 679 | "$ref": "#/components/schemas/ImportRowCore" 680 | objectType: 681 | type: string 682 | enum: 683 | - CONTACT 684 | - COMPANY 685 | - DEAL 686 | - ENGAGEMENT 687 | - TICKET 688 | - OWNER 689 | - PRODUCT 690 | - LINE_ITEM 691 | - BET_DELIVERABLE_SERVICE 692 | - CONTENT 693 | - CONVERSATION 694 | - BET_ALERT 695 | - PORTAL 696 | - QUOTE 697 | - FORM_SUBMISSION_INBOUNDDB 698 | - QUOTA 699 | - UNSUBSCRIBE 700 | - COMMUNICATION 701 | - FEEDBACK_SUBMISSION 702 | - ATTRIBUTION 703 | - SALESFORCE_SYNC_ERROR 704 | - RESTORABLE_CRM_OBJECT 705 | - HUB 706 | - LANDING_PAGE 707 | - PRODUCT_OR_FOLDER 708 | - TASK 709 | - FORM 710 | - MARKETING_EMAIL 711 | - AD_ACCOUNT 712 | - AD_CAMPAIGN 713 | - AD_GROUP 714 | - AD 715 | - KEYWORD 716 | - CAMPAIGN 717 | - SOCIAL_CHANNEL 718 | - SOCIAL_POST 719 | - SITE_PAGE 720 | - BLOG_POST 721 | - IMPORT 722 | - EXPORT 723 | - CTA 724 | - TASK_TEMPLATE 725 | - AUTOMATION_PLATFORM_FLOW 726 | - OBJECT_LIST 727 | - NOTE 728 | - MEETING_EVENT 729 | - CALL 730 | - EMAIL 731 | - PUBLISHING_TASK 732 | - CONVERSATION_SESSION 733 | - CONTACT_CREATE_ATTRIBUTION 734 | - INVOICE 735 | - MARKETING_EVENT 736 | - CONVERSATION_INBOX 737 | - CHATFLOW 738 | - MEDIA_BRIDGE 739 | - SEQUENCE 740 | - SEQUENCE_STEP 741 | - FORECAST 742 | - SNIPPET 743 | - TEMPLATE 744 | - DEAL_CREATE_ATTRIBUTION 745 | - QUOTE_TEMPLATE 746 | - QUOTE_MODULE 747 | - QUOTE_MODULE_FIELD 748 | - QUOTE_FIELD 749 | - SEQUENCE_ENROLLMENT 750 | - SUBSCRIPTION 751 | - ACCEPTANCE_TEST 752 | - SOCIAL_BROADCAST 753 | - DEAL_SPLIT 754 | - DEAL_REGISTRATION 755 | - GOAL_TARGET 756 | - GOAL_TARGET_GROUP 757 | - PORTAL_OBJECT_SYNC_MESSAGE 758 | - FILE_MANAGER_FILE 759 | - FILE_MANAGER_FOLDER 760 | - SEQUENCE_STEP_ENROLLMENT 761 | - APPROVAL 762 | - APPROVAL_STEP 763 | - CTA_VARIANT 764 | - SALES_DOCUMENT 765 | - DISCOUNT 766 | - FEE 767 | - TAX 768 | - MARKETING_CALENDAR 769 | - PERMISSIONS_TESTING 770 | - PRIVACY_SCANNER_COOKIE 771 | - DATA_SYNC_STATE 772 | - WEB_INTERACTIVE 773 | - PLAYBOOK 774 | - FOLDER 775 | - PLAYBOOK_QUESTION 776 | - PLAYBOOK_SUBMISSION 777 | - PLAYBOOK_SUBMISSION_ANSWER 778 | - COMMERCE_PAYMENT 779 | - GSC_PROPERTY 780 | - SOX_PROTECTED_DUMMY_TYPE 781 | - BLOG_LISTING_PAGE 782 | - QUARANTINED_SUBMISSION 783 | - PAYMENT_SCHEDULE 784 | - PAYMENT_SCHEDULE_INSTALLMENT 785 | - MARKETING_CAMPAIGN_UTM 786 | - DISCOUNT_TEMPLATE 787 | - DISCOUNT_CODE 788 | - FEEDBACK_SURVEY 789 | - CMS_URL 790 | - SALES_TASK 791 | - SALES_WORKLOAD 792 | - USER 793 | - POSTAL_MAIL 794 | - SCHEMAS_BACKEND_TEST 795 | - PAYMENT_LINK 796 | - SUBMISSION_TAG 797 | - CAMPAIGN_STEP 798 | - SCHEDULING_PAGE 799 | - SOX_PROTECTED_TEST_TYPE 800 | - ORDER 801 | - MARKETING_SMS 802 | - PARTNER_ACCOUNT 803 | - CAMPAIGN_TEMPLATE 804 | - CAMPAIGN_TEMPLATE_STEP 805 | - PLAYLIST 806 | - CLIP 807 | - CAMPAIGN_BUDGET_ITEM 808 | - CAMPAIGN_SPEND_ITEM 809 | - MIC 810 | - CONTENT_AUDIT 811 | - CONTENT_AUDIT_PAGE 812 | - PLAYLIST_FOLDER 813 | - LEAD 814 | - ABANDONED_CART 815 | - EXTERNAL_WEB_URL 816 | - VIEW 817 | - VIEW_BLOCK 818 | - ROSTER 819 | - CART 820 | - AUTOMATION_PLATFORM_FLOW_ACTION 821 | - SOCIAL_PROFILE 822 | - PARTNER_CLIENT 823 | - ROSTER_MEMBER 824 | - MARKETING_EVENT_ATTENDANCE 825 | - ALL_PAGES 826 | - AI_FORECAST 827 | - CRM_PIPELINES_DUMMY_TYPE 828 | - KNOWLEDGE_ARTICLE 829 | - PROPERTY_INFO 830 | - DATA_PRIVACY_CONSENT 831 | - GOAL_TEMPLATE 832 | - SCORE_CONFIGURATION 833 | - AUDIENCE 834 | - PARTNER_CLIENT_REVENUE 835 | - AUTOMATION_JOURNEY 836 | - COMBO_EVENT_CONFIGURATION 837 | - CRM_OBJECTS_DUMMY_TYPE 838 | - CASE_STUDY 839 | - SERVICE 840 | - PODCAST_EPISODE 841 | - PARTNER_SERVICE 842 | - PROSPECTING_AGENT_CONTACT_ASSIGNMENT 843 | - UNKNOWN 844 | invalidValue: 845 | type: string 846 | PreviousPage: 847 | required: 848 | - before 849 | type: object 850 | properties: 851 | before: 852 | type: string 853 | link: 854 | type: string 855 | PublicImportMetadata: 856 | required: 857 | - counters 858 | - fileIds 859 | - objectLists 860 | type: object 861 | properties: 862 | counters: 863 | type: object 864 | additionalProperties: 865 | type: integer 866 | format: int32 867 | description: 868 | Summarized outcomes of each row a developer attempted to import 869 | into HubSpot 870 | example: 871 | TOTAL_ROWS: 2 872 | CREATED_OBJECTS: 1 873 | UPDATED_OBJECTS: 1 874 | UNIQUE_OBJECTS_WRITTEN: 2 875 | PROPERTY_VALUES_EMITTED: 2 876 | fileIds: 877 | type: array 878 | description: The IDs of files uploaded in the File Manager API 879 | example: 880 | - "3579849" 881 | items: 882 | type: string 883 | objectLists: 884 | type: array 885 | description: The lists containing the imported objects 886 | example: 887 | - listId: "3" 888 | objectType: contacts 889 | items: 890 | "$ref": "#/components/schemas/PublicObjectListRecord" 891 | CollectionResponsePublicImportErrorForwardPaging: 892 | required: 893 | - results 894 | type: object 895 | properties: 896 | paging: 897 | "$ref": "#/components/schemas/ForwardPaging" 898 | results: 899 | type: array 900 | items: 901 | "$ref": "#/components/schemas/PublicImportError" 902 | PublicImportResponse: 903 | required: 904 | - createdAt 905 | - id 906 | - mappedObjectTypeIds 907 | - metadata 908 | - optOutImport 909 | - state 910 | - updatedAt 911 | type: object 912 | properties: 913 | importTemplate: 914 | "$ref": "#/components/schemas/ImportTemplate" 915 | createdAt: 916 | type: string 917 | format: datetime 918 | example: "2020-01-14T22:45:00.153+00:00" 919 | metadata: 920 | "$ref": "#/components/schemas/PublicImportMetadata" 921 | importRequestJson: 922 | type: object 923 | properties: {} 924 | importSource: 925 | type: string 926 | enum: 927 | - API 928 | - CRM_UI 929 | - IMPORT 930 | - MOBILE_ANDROID 931 | - MOBILE_IOS 932 | - SALESFORCE 933 | importName: 934 | type: string 935 | state: 936 | type: string 937 | description: The status of the import 938 | example: DONE 939 | enum: 940 | - STARTED 941 | - PROCESSING 942 | - DONE 943 | - FAILED 944 | - CANCELED 945 | - DEFERRED 946 | - REVERTED 947 | id: 948 | type: string 949 | example: "1471" 950 | optOutImport: 951 | type: boolean 952 | description: 953 | Whether or not the import is a list of people disqualified 954 | from receiving emails 955 | example: false 956 | mappedObjectTypeIds: 957 | type: array 958 | items: 959 | type: string 960 | updatedAt: 961 | type: string 962 | format: datetime 963 | example: "2020-01-14T22:45:00.153+00:00" 964 | NextPage: 965 | required: 966 | - after 967 | type: object 968 | properties: 969 | link: 970 | type: string 971 | after: 972 | type: string 973 | Body: 974 | type: object 975 | properties: 976 | files: 977 | type: string 978 | format: binary 979 | importRequest: 980 | type: string 981 | responses: 982 | Error: 983 | description: An error occurred. 984 | content: 985 | "*/*": 986 | schema: 987 | "$ref": "#/components/schemas/Error" 988 | securitySchemes: 989 | oauth2_legacy: 990 | type: oauth2 991 | flows: 992 | authorizationCode: 993 | authorizationUrl: https://app.hubspot.com/oauth/authorize 994 | tokenUrl: https://api.hubapi.com/oauth/v1/token 995 | scopes: 996 | crm.import: Create or modify all your CRM data through bulk imports 997 | private_apps_legacy: 998 | type: apiKey 999 | name: private-app-legacy 1000 | in: header 1001 | x-ballerina-name: privateAppLegacy 1002 | x-hubspot-available-client-libraries: 1003 | - PHP 1004 | - Node 1005 | - Ruby 1006 | - Python 1007 | x-hubspot-product-tier-requirements: 1008 | marketing: FREE 1009 | sales: FREE 1010 | service: FREE 1011 | cms: FREE 1012 | x-hubspot-documentation-banner: NONE 1013 | -------------------------------------------------------------------------------- /openapi/hubspot/marketing.subscriptions/v4/openapi.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.1 2 | info: 3 | title: Communication Preferences Subscriptions 4 | version: v4 5 | x-hubspot-product-tier-requirements: 6 | marketing: FREE 7 | sales: FREE 8 | service: FREE 9 | cms: FREE 10 | x-hubspot-documentation-banner: NONE 11 | x-hubspot-api-use-case: Ensure a contact's opt-in status is updated if they opted 12 | out of communications from your business via a service external to HubSpot. 13 | x-hubspot-related-documentation: 14 | - name: Subscriptions preferences guide 15 | url: https://developers.hubspot.com/beta-docs/guides/api/marketing/subscriptions 16 | x-hubspot-introduction: Use the subscriptions API to programmatically subscribe 17 | or unsubscribe contacts from your email subscription types, or unsubscribe a contact 18 | from all email communication. These APIs also provide support for business units. 19 | servers: 20 | - url: https://api.hubapi.com/communication-preferences/v4 21 | tags: 22 | - name: Subscription status 23 | - name: Subscription definitions 24 | paths: 25 | "/statuses/batch/write": 26 | post: 27 | tags: 28 | - Subscription status 29 | summary: Batch update subscription status 30 | description: Update the subscription status for a set of contacts. 31 | operationId: post-/communication-preferences/v4/statuses/batch/write 32 | parameters: [] 33 | requestBody: 34 | content: 35 | application/json: 36 | schema: 37 | "$ref": "#/components/schemas/BatchInputPublicStatusRequest" 38 | required: true 39 | responses: 40 | '200': 41 | description: successful operation 42 | content: 43 | application/json: 44 | schema: 45 | "$ref": "#/components/schemas/BatchResponsePublicStatus" 46 | default: 47 | "$ref": "#/components/responses/Error" 48 | security: 49 | - private_apps: 50 | - communication_preferences.statuses.batch.write 51 | - oauth2: 52 | - communication_preferences.statuses.batch.write 53 | "/statuses/{subscriberIdString}/unsubscribe-all": 54 | get: 55 | tags: 56 | - Subscription status 57 | summary: Retrieve a contact's unsubscribed status 58 | description: Check whether a contact has unsubscribed from all email subscriptions. 59 | If a contact has not opted out of all communications, the response `results` 60 | array will be empty. 61 | operationId: get-/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all 62 | parameters: 63 | - name: subscriberIdString 64 | in: path 65 | description: The contact's email address 66 | required: true 67 | style: simple 68 | explode: false 69 | schema: 70 | type: string 71 | - name: businessUnitId 72 | in: query 73 | description: If you have the [business unit add-on](https://developers.hubspot.com/beta-docs/guides/api/settings/business-units-api), 74 | include this parameter to filter results by business unit ID. The default 75 | Account business unit will always use `0` 76 | required: false 77 | style: form 78 | explode: true 79 | schema: 80 | type: integer 81 | format: int64 82 | - name: verbose 83 | in: query 84 | description: Set to `true` to include the details of the updated subscription 85 | statuses in the response. Not including this parameter will result in an 86 | empty response 87 | required: false 88 | style: form 89 | explode: true 90 | schema: 91 | type: boolean 92 | default: false 93 | - name: channel 94 | in: query 95 | description: The channel type for the subscription type. Currently, the only 96 | supported channel type is `EMAIL` 97 | required: true 98 | style: form 99 | explode: true 100 | schema: 101 | type: string 102 | enum: 103 | - EMAIL 104 | - WHATSAPP 105 | - SMS 106 | responses: 107 | '200': 108 | description: successful operation 109 | content: 110 | application/json: 111 | schema: 112 | "$ref": "#/components/schemas/ActionResponseWithResultsPublicWideStatus" 113 | default: 114 | "$ref": "#/components/responses/Error" 115 | security: 116 | - private_apps_legacy: 117 | - communication_preferences.read 118 | - oauth2_legacy: 119 | - communication_preferences.read_write 120 | - private_apps_legacy: 121 | - communication_preferences.read_write 122 | - oauth2_legacy: 123 | - communication_preferences.read 124 | post: 125 | tags: 126 | - Subscription status 127 | summary: Unsubscribe a contact from all subscriptions 128 | description: Unsubscribe a contact from all email subscriptions. 129 | operationId: post-/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all 130 | parameters: 131 | - name: subscriberIdString 132 | in: path 133 | description: The contact's email address 134 | required: true 135 | style: simple 136 | explode: false 137 | schema: 138 | type: string 139 | - name: businessUnitId 140 | in: query 141 | description: If you have the [business unit add-on](https://developers.hubspot.com/beta-docs/guides/api/settings/business-units-api), 142 | include this parameter to filter results by business unit ID. The default 143 | Account business unit will always use `0` 144 | required: false 145 | style: form 146 | explode: true 147 | schema: 148 | type: integer 149 | format: int64 150 | - name: verbose 151 | in: query 152 | description: Set to `true` to include the details of the updated subscription 153 | statuses in the response. Not including this parameter will result in an 154 | empty response 155 | required: false 156 | style: form 157 | explode: true 158 | schema: 159 | type: boolean 160 | default: false 161 | - name: channel 162 | in: query 163 | description: The channel type for the subscription type. Currently, the only 164 | supported channel type is `EMAIL` 165 | required: true 166 | style: form 167 | explode: true 168 | schema: 169 | type: string 170 | enum: 171 | - EMAIL 172 | - WHATSAPP 173 | - SMS 174 | responses: 175 | '200': 176 | description: successful operation 177 | content: 178 | application/json: 179 | schema: 180 | "$ref": "#/components/schemas/ActionResponseWithResultsPublicStatus" 181 | default: 182 | "$ref": "#/components/responses/Error" 183 | security: 184 | - oauth2_legacy: 185 | - communication_preferences.write 186 | - oauth2_legacy: 187 | - communication_preferences.read_write 188 | - private_apps_legacy: 189 | - communication_preferences.write 190 | - private_apps_legacy: 191 | - communication_preferences.read_write 192 | "/statuses/batch/read": 193 | post: 194 | tags: 195 | - Subscription status 196 | summary: Batch retrieve subscription statuses 197 | description: Batch retrieve subscription statuses for a set of contacts. 198 | operationId: post-/communication-preferences/v4/statuses/batch/read 199 | parameters: 200 | - name: businessUnitId 201 | in: query 202 | description: If you have the [business unit add-on](https://developers.hubspot.com/beta-docs/guides/api/settings/business-units-api), 203 | include this parameter to filter results by business unit ID. The default 204 | Account business unit will always use `0` 205 | required: false 206 | style: form 207 | explode: true 208 | schema: 209 | type: integer 210 | format: int64 211 | - name: channel 212 | in: query 213 | description: The channel type for the subscription type. Currently, the only 214 | supported channel type is `EMAIL` 215 | required: true 216 | style: form 217 | explode: true 218 | schema: 219 | type: string 220 | enum: 221 | - EMAIL 222 | - WHATSAPP 223 | - SMS 224 | requestBody: 225 | content: 226 | application/json: 227 | schema: 228 | "$ref": "#/components/schemas/BatchInputString" 229 | required: true 230 | responses: 231 | '200': 232 | description: successful operation 233 | content: 234 | application/json: 235 | schema: 236 | "$ref": "#/components/schemas/BatchResponsePublicStatusBulkResponse" 237 | '207': 238 | description: multiple statuses 239 | content: 240 | application/json: 241 | schema: 242 | "$ref": "#/components/schemas/BatchResponsePublicStatusBulkResponseWithErrors" 243 | default: 244 | "$ref": "#/components/responses/Error" 245 | security: 246 | - private_apps: 247 | - communication_preferences.statuses.batch.read 248 | - oauth2: 249 | - communication_preferences.statuses.batch.read 250 | "/statuses/batch/unsubscribe-all": 251 | post: 252 | tags: 253 | - Subscription status 254 | summary: Batch unsubscribe contacts from all subscriptions 255 | description: Unsubscribe a set of contacts from all email subscriptions. 256 | operationId: post-/communication-preferences/v4/statuses/batch/unsubscribe-all 257 | parameters: 258 | - name: businessUnitId 259 | in: query 260 | description: If you have the [business unit add-on](https://developers.hubspot.com/beta-docs/guides/api/settings/business-units-api), 261 | include this parameter to filter results by business unit ID. The default 262 | Account business unit will always use `0` 263 | required: false 264 | style: form 265 | explode: true 266 | schema: 267 | type: integer 268 | format: int64 269 | - name: verbose 270 | in: query 271 | description: Set to `true` to include the details of the updated subscription 272 | statuses in the response. Not including this parameter will result in an 273 | empty response 274 | required: false 275 | style: form 276 | explode: true 277 | schema: 278 | type: boolean 279 | default: false 280 | - name: channel 281 | in: query 282 | description: The channel type for the subscription type. Currently, the only 283 | supported channel type is `EMAIL` 284 | required: true 285 | style: form 286 | explode: true 287 | schema: 288 | type: string 289 | enum: 290 | - EMAIL 291 | - WHATSAPP 292 | - SMS 293 | requestBody: 294 | content: 295 | application/json: 296 | schema: 297 | "$ref": "#/components/schemas/BatchInputString" 298 | required: true 299 | responses: 300 | '200': 301 | description: successful operation 302 | content: 303 | application/json: 304 | schema: 305 | "$ref": "#/components/schemas/BatchResponsePublicBulkOptOutFromAllResponse" 306 | default: 307 | "$ref": "#/components/responses/Error" 308 | security: 309 | - private_apps: 310 | - communication_preferences.statuses.batch.write 311 | - oauth2: 312 | - communication_preferences.statuses.batch.write 313 | "/definitions": 314 | get: 315 | tags: 316 | - Subscription definitions 317 | summary: Retrieve all subscription status definitions 318 | description: Get a list of subscription status definitions from the account. 319 | operationId: get-/communication-preferences/v4/definitions 320 | parameters: 321 | - name: businessUnitId 322 | in: query 323 | description: If you have the [business unit add-on](https://developers.hubspot.com/beta-docs/guides/api/settings/business-units-api), 324 | include this parameter to filter results by business unit ID. The default 325 | Account business unit will always use `0` 326 | required: false 327 | style: form 328 | explode: true 329 | schema: 330 | type: integer 331 | format: int64 332 | - name: includeTranslations 333 | in: query 334 | description: Set to `true` to return subscription translations associated 335 | with each definition 336 | required: false 337 | style: form 338 | explode: true 339 | schema: 340 | type: boolean 341 | responses: 342 | '200': 343 | description: successful operation 344 | content: 345 | application/json: 346 | schema: 347 | "$ref": "#/components/schemas/ActionResponseWithResultsSubscriptionDefinition" 348 | default: 349 | "$ref": "#/components/responses/Error" 350 | security: 351 | - private_apps_legacy: 352 | - communication_preferences.read 353 | - oauth2_legacy: 354 | - communication_preferences.read_write 355 | - private_apps_legacy: 356 | - communication_preferences.read_write 357 | - oauth2_legacy: 358 | - communication_preferences.read 359 | "/statuses/batch/unsubscribe-all/read": 360 | post: 361 | tags: 362 | - Subscription status 363 | summary: Batch retrieve contacts who have opted out of all communications 364 | description: Checks whether a set of contacts have opted out of all communications. 365 | operationId: post-/communication-preferences/v4/statuses/batch/unsubscribe-all/read 366 | parameters: 367 | - name: businessUnitId 368 | in: query 369 | description: If you have the [business unit add-on](https://developers.hubspot.com/beta-docs/guides/api/settings/business-units-api), 370 | include this parameter to filter results by business unit ID. The default 371 | Account business unit will always use `0` 372 | required: false 373 | style: form 374 | explode: true 375 | schema: 376 | type: integer 377 | format: int64 378 | - name: channel 379 | in: query 380 | description: The channel type for the subscription type. Currently, the only 381 | supported channel type is `EMAIL` 382 | required: true 383 | style: form 384 | explode: true 385 | schema: 386 | type: string 387 | enum: 388 | - EMAIL 389 | - WHATSAPP 390 | - SMS 391 | requestBody: 392 | content: 393 | application/json: 394 | schema: 395 | "$ref": "#/components/schemas/BatchInputString" 396 | required: true 397 | responses: 398 | '200': 399 | description: successful operation 400 | content: 401 | application/json: 402 | schema: 403 | "$ref": "#/components/schemas/BatchResponsePublicWideStatusBulkResponse" 404 | '207': 405 | description: multiple statuses 406 | content: 407 | application/json: 408 | schema: 409 | "$ref": "#/components/schemas/BatchResponsePublicWideStatusBulkResponseWithErrors" 410 | default: 411 | "$ref": "#/components/responses/Error" 412 | security: 413 | - private_apps: 414 | - communication_preferences.statuses.batch.read 415 | - oauth2: 416 | - communication_preferences.statuses.batch.read 417 | "/statuses/{subscriberIdString}": 418 | get: 419 | tags: 420 | - Subscription status 421 | summary: Get subscription preferences for a specific contact 422 | description: Retrieve a contact's current email subscription preferences. 423 | operationId: get-/communication-preferences/v4/statuses/{subscriberIdString} 424 | parameters: 425 | - name: subscriberIdString 426 | in: path 427 | description: The contact's email address 428 | required: true 429 | style: simple 430 | explode: false 431 | schema: 432 | type: string 433 | - name: businessUnitId 434 | in: query 435 | description: If you have the [business unit add-on](https://developers.hubspot.com/beta-docs/guides/api/settings/business-units-api), 436 | include this parameter to filter results by business unit ID. The default 437 | Account business unit will always use `0` 438 | required: false 439 | style: form 440 | explode: true 441 | schema: 442 | type: integer 443 | format: int64 444 | - name: channel 445 | in: query 446 | description: The channel type for the subscription type. Currently, the only 447 | supported channel type is `EMAIL` 448 | required: true 449 | style: form 450 | explode: true 451 | schema: 452 | type: string 453 | enum: 454 | - EMAIL 455 | - WHATSAPP 456 | - SMS 457 | responses: 458 | '200': 459 | description: successful operation 460 | content: 461 | application/json: 462 | schema: 463 | "$ref": "#/components/schemas/ActionResponseWithResultsPublicStatus" 464 | default: 465 | "$ref": "#/components/responses/Error" 466 | security: 467 | - private_apps_legacy: 468 | - communication_preferences.read 469 | - oauth2_legacy: 470 | - communication_preferences.read_write 471 | - private_apps_legacy: 472 | - communication_preferences.read_write 473 | - oauth2_legacy: 474 | - communication_preferences.read 475 | post: 476 | tags: 477 | - Subscription status 478 | summary: Update a contact's subscription status 479 | description: Set the subscription status of a specific contact. 480 | operationId: post-/communication-preferences/v4/statuses/{subscriberIdString} 481 | parameters: 482 | - name: subscriberIdString 483 | in: path 484 | description: The contact's email address 485 | required: true 486 | style: simple 487 | explode: false 488 | schema: 489 | type: string 490 | requestBody: 491 | content: 492 | application/json: 493 | schema: 494 | "$ref": "#/components/schemas/PartialPublicStatusRequest" 495 | required: true 496 | responses: 497 | '200': 498 | description: successful operation 499 | content: 500 | application/json: 501 | schema: 502 | "$ref": "#/components/schemas/ActionResponseWithResultsPublicStatus" 503 | default: 504 | "$ref": "#/components/responses/Error" 505 | security: 506 | - oauth2_legacy: 507 | - communication_preferences.write 508 | - oauth2_legacy: 509 | - communication_preferences.read_write 510 | - private_apps_legacy: 511 | - communication_preferences.write 512 | - private_apps_legacy: 513 | - communication_preferences.read_write 514 | components: 515 | schemas: 516 | ActionResponseWithResultsPublicWideStatus: 517 | required: 518 | - completedAt 519 | - results 520 | - startedAt 521 | - status 522 | type: object 523 | properties: 524 | completedAt: 525 | type: string 526 | format: date-time 527 | numErrors: 528 | type: integer 529 | format: int32 530 | requestedAt: 531 | type: string 532 | format: date-time 533 | startedAt: 534 | type: string 535 | format: date-time 536 | links: 537 | type: object 538 | additionalProperties: 539 | type: string 540 | results: 541 | type: array 542 | items: 543 | "$ref": "#/components/schemas/PublicWideStatus" 544 | errors: 545 | type: array 546 | items: 547 | "$ref": "#/components/schemas/StandardError" 548 | status: 549 | type: string 550 | enum: 551 | - PENDING 552 | - PROCESSING 553 | - CANCELED 554 | - COMPLETE 555 | BatchInputString: 556 | required: 557 | - inputs 558 | type: object 559 | properties: 560 | inputs: 561 | type: array 562 | items: 563 | type: string 564 | PublicStatusBulkResponse: 565 | required: 566 | - statuses 567 | - subscriberIdString 568 | type: object 569 | properties: 570 | subscriberIdString: 571 | type: string 572 | statuses: 573 | type: array 574 | items: 575 | "$ref": "#/components/schemas/PublicStatus" 576 | StandardError: 577 | required: 578 | - category 579 | - context 580 | - message 581 | - status 582 | type: object 583 | properties: 584 | subCategory: 585 | type: object 586 | properties: {} 587 | context: 588 | type: object 589 | additionalProperties: 590 | type: array 591 | items: 592 | type: string 593 | links: 594 | type: object 595 | additionalProperties: 596 | type: string 597 | id: 598 | type: string 599 | category: 600 | type: string 601 | message: 602 | type: string 603 | errors: 604 | type: array 605 | items: 606 | "$ref": "#/components/schemas/ErrorDetail" 607 | status: 608 | type: string 609 | PublicSubscriptionTranslation: 610 | required: 611 | - createdAt 612 | - description 613 | - languageCode 614 | - name 615 | - subscriptionId 616 | - updatedAt 617 | type: object 618 | properties: 619 | createdAt: 620 | type: integer 621 | format: int32 622 | name: 623 | type: string 624 | description: 625 | type: string 626 | subscriptionId: 627 | type: integer 628 | format: int32 629 | languageCode: 630 | type: string 631 | updatedAt: 632 | type: integer 633 | format: int32 634 | PartialPublicStatusRequest: 635 | required: 636 | - channel 637 | - statusState 638 | - subscriptionId 639 | type: object 640 | properties: 641 | statusState: 642 | type: string 643 | enum: 644 | - SUBSCRIBED 645 | - UNSUBSCRIBED 646 | - NOT_SPECIFIED 647 | channel: 648 | type: string 649 | enum: 650 | - EMAIL 651 | - WHATSAPP 652 | - SMS 653 | legalBasis: 654 | type: string 655 | enum: 656 | - LEGITIMATE_INTEREST_PQL 657 | - LEGITIMATE_INTEREST_CLIENT 658 | - PERFORMANCE_OF_CONTRACT 659 | - CONSENT_WITH_NOTICE 660 | - NON_GDPR 661 | - PROCESS_AND_STORE 662 | - LEGITIMATE_INTEREST_OTHER 663 | subscriptionId: 664 | type: integer 665 | format: int64 666 | legalBasisExplanation: 667 | type: string 668 | PublicStatus: 669 | required: 670 | - channel 671 | - source 672 | - status 673 | - subscriberIdString 674 | - subscriptionId 675 | - timestamp 676 | type: object 677 | properties: 678 | subscriptionName: 679 | type: string 680 | channel: 681 | type: string 682 | enum: 683 | - EMAIL 684 | - WHATSAPP 685 | - SMS 686 | subscriberIdString: 687 | type: string 688 | legalBasis: 689 | type: string 690 | nullable: true 691 | enum: 692 | - LEGITIMATE_INTEREST_PQL 693 | - LEGITIMATE_INTEREST_CLIENT 694 | - PERFORMANCE_OF_CONTRACT 695 | - CONSENT_WITH_NOTICE 696 | - NON_GDPR 697 | - PROCESS_AND_STORE 698 | - LEGITIMATE_INTEREST_OTHER 699 | setStatusSuccessReason: 700 | type: string 701 | nullable: true 702 | enum: 703 | - RESUBSCRIBE_OCCURRED 704 | - NO_STATUS_CHANGE 705 | - UNSUBSCRIBE_FROM_ALL_OCCURRED 706 | - REQUESTED_CHANGE_OCCURRED 707 | source: 708 | type: string 709 | subscriptionId: 710 | type: integer 711 | format: int32 712 | legalBasisExplanation: 713 | type: string 714 | nullable: true 715 | businessUnitId: 716 | type: integer 717 | format: int64 718 | status: 719 | type: string 720 | enum: 721 | - SUBSCRIBED 722 | - UNSUBSCRIBED 723 | - NOT_SPECIFIED 724 | timestamp: 725 | type: string 726 | format: date-time 727 | BatchResponsePublicStatus: 728 | required: 729 | - completedAt 730 | - results 731 | - startedAt 732 | - status 733 | type: object 734 | properties: 735 | completedAt: 736 | type: string 737 | format: date-time 738 | numErrors: 739 | type: integer 740 | format: int32 741 | requestedAt: 742 | type: string 743 | format: date-time 744 | startedAt: 745 | type: string 746 | format: date-time 747 | links: 748 | type: object 749 | additionalProperties: 750 | type: string 751 | results: 752 | type: array 753 | items: 754 | "$ref": "#/components/schemas/PublicStatus" 755 | errors: 756 | type: array 757 | items: 758 | "$ref": "#/components/schemas/StandardError" 759 | status: 760 | type: string 761 | enum: 762 | - PENDING 763 | - PROCESSING 764 | - CANCELED 765 | - COMPLETE 766 | BatchResponsePublicStatusBulkResponseWithErrors: 767 | required: 768 | - completedAt 769 | - results 770 | - startedAt 771 | - status 772 | type: object 773 | properties: 774 | completedAt: 775 | type: string 776 | format: date-time 777 | numErrors: 778 | type: integer 779 | format: int32 780 | requestedAt: 781 | type: string 782 | format: date-time 783 | startedAt: 784 | type: string 785 | format: date-time 786 | links: 787 | type: object 788 | additionalProperties: 789 | type: string 790 | results: 791 | type: array 792 | items: 793 | "$ref": "#/components/schemas/PublicStatusBulkResponse" 794 | errors: 795 | type: array 796 | items: 797 | "$ref": "#/components/schemas/StandardError" 798 | status: 799 | type: string 800 | enum: 801 | - PENDING 802 | - PROCESSING 803 | - CANCELED 804 | - COMPLETE 805 | Error: 806 | required: 807 | - category 808 | - correlationId 809 | - message 810 | type: object 811 | properties: 812 | subCategory: 813 | type: string 814 | description: A specific category that contains more specific detail about 815 | the error 816 | context: 817 | type: object 818 | additionalProperties: 819 | type: array 820 | items: 821 | type: string 822 | description: Context about the error condition 823 | example: 824 | missingScopes: 825 | - scope1 826 | - scope2 827 | invalidPropertyName: 828 | - propertyValue 829 | correlationId: 830 | type: string 831 | description: A unique identifier for the request. Include this value with 832 | any error reports or support tickets 833 | format: uuid 834 | example: aeb5f871-7f07-4993-9211-075dc63e7cbf 835 | links: 836 | type: object 837 | additionalProperties: 838 | type: string 839 | description: A map of link names to associated URIs containing documentation 840 | about the error or recommended remediation steps 841 | message: 842 | type: string 843 | description: A human readable message describing the error along with remediation 844 | steps where appropriate 845 | example: An error occurred 846 | category: 847 | type: string 848 | description: The error category 849 | errors: 850 | type: array 851 | description: further information about the error 852 | items: 853 | "$ref": "#/components/schemas/ErrorDetail" 854 | example: 855 | message: Invalid input (details will vary based on the error) 856 | correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf 857 | category: VALIDATION_ERROR 858 | links: 859 | knowledge-base: https://www.hubspot.com/products/service/knowledge-base 860 | PublicStatusRequest: 861 | required: 862 | - channel 863 | - statusState 864 | - subscriberIdString 865 | - subscriptionId 866 | type: object 867 | properties: 868 | statusState: 869 | type: string 870 | description: The status of the contact's subscription 871 | enum: 872 | - SUBSCRIBED 873 | - UNSUBSCRIBED 874 | - NOT_SPECIFIED 875 | channel: 876 | type: string 877 | description: The type of communication channel. Currently, only `EMAIL` 878 | is supported 879 | enum: 880 | - EMAIL 881 | - WHATSAPP 882 | - SMS 883 | subscriberIdString: 884 | type: string 885 | description: The contact's email address 886 | legalBasis: 887 | type: string 888 | description: The legal basis for communication 889 | enum: 890 | - LEGITIMATE_INTEREST_PQL 891 | - LEGITIMATE_INTEREST_CLIENT 892 | - PERFORMANCE_OF_CONTRACT 893 | - CONSENT_WITH_NOTICE 894 | - NON_GDPR 895 | - PROCESS_AND_STORE 896 | - LEGITIMATE_INTEREST_OTHER 897 | subscriptionId: 898 | type: integer 899 | description: The ID of the subscription to update 900 | format: int32 901 | legalBasisExplanation: 902 | type: string 903 | description: The explanation for the legal basis 904 | PublicWideStatusBulkResponse: 905 | required: 906 | - subscriberIdString 907 | - wideStatuses 908 | type: object 909 | properties: 910 | wideStatuses: 911 | type: array 912 | items: 913 | "$ref": "#/components/schemas/PublicWideStatus" 914 | subscriberIdString: 915 | type: string 916 | BatchResponsePublicStatusBulkResponse: 917 | required: 918 | - completedAt 919 | - results 920 | - startedAt 921 | - status 922 | type: object 923 | properties: 924 | completedAt: 925 | type: string 926 | format: date-time 927 | requestedAt: 928 | type: string 929 | format: date-time 930 | startedAt: 931 | type: string 932 | format: date-time 933 | links: 934 | type: object 935 | additionalProperties: 936 | type: string 937 | results: 938 | type: array 939 | items: 940 | "$ref": "#/components/schemas/PublicStatusBulkResponse" 941 | status: 942 | type: string 943 | enum: 944 | - PENDING 945 | - PROCESSING 946 | - CANCELED 947 | - COMPLETE 948 | ActionResponseWithResultsPublicStatus: 949 | required: 950 | - completedAt 951 | - results 952 | - startedAt 953 | - status 954 | type: object 955 | properties: 956 | completedAt: 957 | type: string 958 | format: date-time 959 | numErrors: 960 | type: integer 961 | format: int32 962 | requestedAt: 963 | type: string 964 | format: date-time 965 | startedAt: 966 | type: string 967 | format: date-time 968 | links: 969 | type: object 970 | additionalProperties: 971 | type: string 972 | results: 973 | type: array 974 | items: 975 | "$ref": "#/components/schemas/PublicStatus" 976 | errors: 977 | type: array 978 | items: 979 | "$ref": "#/components/schemas/StandardError" 980 | status: 981 | type: string 982 | enum: 983 | - PENDING 984 | - PROCESSING 985 | - CANCELED 986 | - COMPLETE 987 | BatchResponsePublicWideStatusBulkResponse: 988 | required: 989 | - completedAt 990 | - results 991 | - startedAt 992 | - status 993 | type: object 994 | properties: 995 | completedAt: 996 | type: string 997 | format: date-time 998 | requestedAt: 999 | type: string 1000 | format: date-time 1001 | startedAt: 1002 | type: string 1003 | format: date-time 1004 | links: 1005 | type: object 1006 | additionalProperties: 1007 | type: string 1008 | results: 1009 | type: array 1010 | items: 1011 | "$ref": "#/components/schemas/PublicWideStatusBulkResponse" 1012 | status: 1013 | type: string 1014 | enum: 1015 | - PENDING 1016 | - PROCESSING 1017 | - CANCELED 1018 | - COMPLETE 1019 | ErrorDetail: 1020 | required: 1021 | - message 1022 | type: object 1023 | properties: 1024 | subCategory: 1025 | type: string 1026 | description: A specific category that contains more specific detail about 1027 | the error 1028 | code: 1029 | type: string 1030 | description: The status code associated with the error detail 1031 | in: 1032 | type: string 1033 | description: The name of the field or parameter in which the error was found 1034 | context: 1035 | type: object 1036 | additionalProperties: 1037 | type: array 1038 | items: 1039 | type: string 1040 | description: Context about the error condition 1041 | example: 1042 | missingScopes: 1043 | - scope1 1044 | - scope2 1045 | message: 1046 | type: string 1047 | description: A human readable message describing the error along with remediation 1048 | steps where appropriate 1049 | PublicWideStatus: 1050 | required: 1051 | - channel 1052 | - status 1053 | - subscriberIdString 1054 | - timestamp 1055 | - wideStatusType 1056 | type: object 1057 | properties: 1058 | wideStatusType: 1059 | type: string 1060 | enum: 1061 | - PORTAL_WIDE 1062 | - BUSINESS_UNIT_WIDE 1063 | subscriberIdString: 1064 | type: string 1065 | channel: 1066 | type: string 1067 | enum: 1068 | - EMAIL 1069 | - WHATSAPP 1070 | - SMS 1071 | businessUnitId: 1072 | type: integer 1073 | format: int64 1074 | status: 1075 | type: string 1076 | enum: 1077 | - SUBSCRIBED 1078 | - UNSUBSCRIBED 1079 | - NOT_SPECIFIED 1080 | timestamp: 1081 | type: string 1082 | format: date-time 1083 | ActionResponseWithResultsSubscriptionDefinition: 1084 | required: 1085 | - completedAt 1086 | - results 1087 | - startedAt 1088 | - status 1089 | type: object 1090 | properties: 1091 | completedAt: 1092 | type: string 1093 | format: date-time 1094 | numErrors: 1095 | type: integer 1096 | format: int32 1097 | requestedAt: 1098 | type: string 1099 | format: date-time 1100 | startedAt: 1101 | type: string 1102 | format: date-time 1103 | links: 1104 | type: object 1105 | additionalProperties: 1106 | type: string 1107 | results: 1108 | type: array 1109 | items: 1110 | "$ref": "#/components/schemas/SubscriptionDefinition" 1111 | errors: 1112 | type: array 1113 | items: 1114 | "$ref": "#/components/schemas/StandardError" 1115 | status: 1116 | type: string 1117 | enum: 1118 | - PENDING 1119 | - PROCESSING 1120 | - CANCELED 1121 | - COMPLETE 1122 | BatchInputPublicStatusRequest: 1123 | required: 1124 | - inputs 1125 | type: object 1126 | properties: 1127 | inputs: 1128 | type: array 1129 | items: 1130 | "$ref": "#/components/schemas/PublicStatusRequest" 1131 | SubscriptionDefinition: 1132 | required: 1133 | - createdAt 1134 | - description 1135 | - id 1136 | - isActive 1137 | - isDefault 1138 | - isInternal 1139 | - name 1140 | - updatedAt 1141 | type: object 1142 | properties: 1143 | isInternal: 1144 | type: boolean 1145 | createdAt: 1146 | type: string 1147 | format: date-time 1148 | isDefault: 1149 | type: boolean 1150 | communicationMethod: 1151 | type: string 1152 | purpose: 1153 | type: string 1154 | name: 1155 | type: string 1156 | description: 1157 | type: string 1158 | id: 1159 | type: string 1160 | isActive: 1161 | type: boolean 1162 | businessUnitId: 1163 | type: integer 1164 | format: int64 1165 | subscriptionTranslations: 1166 | type: array 1167 | items: 1168 | "$ref": "#/components/schemas/PublicSubscriptionTranslation" 1169 | updatedAt: 1170 | type: string 1171 | format: date-time 1172 | BatchResponsePublicWideStatusBulkResponseWithErrors: 1173 | required: 1174 | - completedAt 1175 | - results 1176 | - startedAt 1177 | - status 1178 | type: object 1179 | properties: 1180 | completedAt: 1181 | type: string 1182 | format: date-time 1183 | numErrors: 1184 | type: integer 1185 | format: int32 1186 | requestedAt: 1187 | type: string 1188 | format: date-time 1189 | startedAt: 1190 | type: string 1191 | format: date-time 1192 | links: 1193 | type: object 1194 | additionalProperties: 1195 | type: string 1196 | results: 1197 | type: array 1198 | items: 1199 | "$ref": "#/components/schemas/PublicWideStatusBulkResponse" 1200 | errors: 1201 | type: array 1202 | items: 1203 | "$ref": "#/components/schemas/StandardError" 1204 | status: 1205 | type: string 1206 | enum: 1207 | - PENDING 1208 | - PROCESSING 1209 | - CANCELED 1210 | - COMPLETE 1211 | BatchResponsePublicBulkOptOutFromAllResponse: 1212 | required: 1213 | - completedAt 1214 | - results 1215 | - startedAt 1216 | - status 1217 | type: object 1218 | properties: 1219 | completedAt: 1220 | type: string 1221 | format: date-time 1222 | numErrors: 1223 | type: integer 1224 | format: int32 1225 | requestedAt: 1226 | type: string 1227 | format: date-time 1228 | startedAt: 1229 | type: string 1230 | format: date-time 1231 | links: 1232 | type: object 1233 | additionalProperties: 1234 | type: string 1235 | results: 1236 | type: array 1237 | items: 1238 | "$ref": "#/components/schemas/PublicBulkOptOutFromAllResponse" 1239 | errors: 1240 | type: array 1241 | items: 1242 | "$ref": "#/components/schemas/StandardError" 1243 | status: 1244 | type: string 1245 | enum: 1246 | - PENDING 1247 | - PROCESSING 1248 | - CANCELED 1249 | - COMPLETE 1250 | PublicBulkOptOutFromAllResponse: 1251 | required: 1252 | - subscriberIdString 1253 | type: object 1254 | properties: 1255 | subscriberIdString: 1256 | type: string 1257 | statuses: 1258 | type: array 1259 | items: 1260 | "$ref": "#/components/schemas/PublicStatus" 1261 | responses: 1262 | Error: 1263 | description: An error occurred. 1264 | content: 1265 | "*/*": 1266 | schema: 1267 | "$ref": "#/components/schemas/Error" 1268 | securitySchemes: 1269 | oauth2_legacy: 1270 | type: oauth2 1271 | flows: 1272 | authorizationCode: 1273 | authorizationUrl: https://app.hubspot.com/oauth/authorize 1274 | tokenUrl: https://api.hubapi.com/oauth/v1/token 1275 | scopes: 1276 | communication_preferences.read_write: Update contact subscription preferences 1277 | communication_preferences.read: Read contact subscription preferences 1278 | communication_preferences.write: Update contact subscription preferences 1279 | oauth2: 1280 | type: oauth2 1281 | flows: 1282 | authorizationCode: 1283 | authorizationUrl: https://app.hubspot.com/oauth/authorize 1284 | tokenUrl: https://api.hubapi.com/oauth/v1/token 1285 | scopes: 1286 | communication_preferences.statuses.batch.read: Batch read contact subscription 1287 | preferences 1288 | communication_preferences.statuses.batch.write: Batch update contact subscription 1289 | preferences 1290 | private_apps_legacy: 1291 | type: apiKey 1292 | name: private-app-legacy 1293 | in: header 1294 | x-ballerina-name: privateAppLegacy 1295 | private_apps: 1296 | type: apiKey 1297 | name: private-app 1298 | in: header 1299 | x-ballerina-name: privateApp 1300 | --------------------------------------------------------------------------------