{ "openapi": "3.1.0", "info": { "title": "JustEmails API", "version": "1.0.0", "description": "REST API for JustEmails — unlimited-domain email hosting + transactional email. This spec is consumable by ChatGPT Custom GPTs, Zapier, n8n, Make, and any OpenAPI-aware tool. The same capabilities are also exposed via MCP at https://mcp.justemails.app/mcp for AI clients like Claude Desktop / Cursor / VS Code.", "contact": { "name": "JustEmails", "url": "https://justemails.app" }, "license": { "name": "Proprietary" }, "termsOfService": "https://justemails.app/terms" }, "servers": [ { "url": "https://justemails.app", "description": "Production" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "opaque", "description": "Create an API key at https://justemails.app/settings/api-keys and pass as `Authorization: Bearer `." } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } }, "Email": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "from": { "type": "string" }, "to": { "type": "string" }, "cc": { "type": [ "string", "null" ] }, "subject": { "type": [ "string", "null" ] }, "snippet": { "type": [ "string", "null" ] }, "folder": { "type": "string" }, "isRead": { "type": "boolean" }, "isStarred": { "type": "boolean" }, "isDraft": { "type": "boolean" }, "hasAttachments": { "type": "boolean" }, "receivedAt": { "type": "string", "format": "date-time" }, "mailboxId": { "type": "string", "format": "uuid" } } }, "Domain": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "verified": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } }, "Mailbox": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domainId": { "type": "string", "format": "uuid" }, "address": { "type": "string" }, "displayName": { "type": [ "string", "null" ] }, "mailboxType": { "type": "string", "enum": [ "shared", "personal" ] }, "hasCustomPassword": { "type": "boolean" } } }, "SendTransactionalRequest": { "type": "object", "required": [ "from", "to", "subject" ], "properties": { "from": { "type": "string", "format": "email", "description": "Sender address on a verified domain." }, "to": { "oneOf": [ { "type": "string", "format": "email" }, { "type": "array", "items": { "type": "string", "format": "email" }, "minItems": 1 } ] }, "cc": { "oneOf": [ { "type": "string", "format": "email" }, { "type": "array", "items": { "type": "string", "format": "email" } } ] }, "bcc": { "oneOf": [ { "type": "string", "format": "email" }, { "type": "array", "items": { "type": "string", "format": "email" } } ] }, "subject": { "type": "string", "maxLength": 998 }, "html": { "type": "string", "maxLength": 2000000 }, "text": { "type": "string", "maxLength": 2000000 }, "replyTo": { "type": "string", "format": "email" }, "idempotencyKey": { "type": "string", "maxLength": 255 }, "trackOpens": { "type": "boolean", "description": "Open tracking for this send (1x1 image in the HTML part). Omit for the account default, which is off. Approximate: Apple Mail Privacy Protection and image proxies load images without a reader." }, "trackClicks": { "type": "boolean", "description": "Click tracking for this send (HTML links rewritten to a signed justemails.app redirect; plain text untouched). Omit for the account default, which is off." }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 10 }, "headers": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Message": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "bounced", "complained", "opened", "clicked", "failed" ] }, "createdAt": { "type": "string", "format": "date-time" }, "events": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "at": { "type": "string", "format": "date-time" }, "detail": { "type": "string" } } } } } } } }, "paths": { "/api/v1/send": { "post": { "operationId": "sendTransactional", "summary": "Send a transactional email", "tags": [ "Send" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendTransactionalRequest" } } } }, "responses": { "200": { "description": "Enqueued for delivery", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/messages": { "get": { "operationId": "listMessages", "summary": "List transactional messages", "tags": [ "Send" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "tag", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } } } } }, "/api/v1/messages/{id}": { "get": { "operationId": "getMessage", "summary": "Get message status + event history", "tags": [ "Send" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Message" }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } } } } }, "/api/v1/emails": { "get": { "operationId": "listEmails", "summary": "List emails (unified inbox)", "tags": [ "Emails" ], "parameters": [ { "name": "folder", "in": "query", "schema": { "type": "string" } }, { "name": "mailboxId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "isRead", "in": "query", "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Email" } }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } } } }, "patch": { "operationId": "bulkEmailAction", "summary": "Bulk email action", "tags": [ "Emails" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "emailIds", "action" ], "properties": { "emailIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "action": { "type": "string" }, "folder": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/emails/{id}": { "get": { "operationId": "getEmail", "summary": "Get one email", "tags": [ "Emails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "operationId": "permanentDeleteEmail", "summary": "Permanently delete an email (trash/drafts/spam only)", "tags": [ "Emails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "operationId": "patchemailsById", "summary": "Update Emails", "tags": [ "emails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/search": { "get": { "operationId": "searchEmails", "summary": "Full-text search across emails", "tags": [ "Emails" ], "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/emails/send": { "post": { "operationId": "sendDashboardEmail", "summary": "Send from a mailbox (dashboard-style)", "tags": [ "Emails" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/emails/drafts": { "get": { "operationId": "listDrafts", "summary": "List drafts", "tags": [ "Emails" ], "responses": { "200": { "description": "OK" } } }, "post": { "operationId": "createDraft", "summary": "Create a draft", "tags": [ "Emails" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/emails/drafts/{id}": { "patch": { "operationId": "updateDraft", "summary": "Update a draft", "tags": [ "Emails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "operationId": "deleteDraft", "summary": "Delete a draft", "tags": [ "Emails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/domains": { "get": { "operationId": "listDomains", "summary": "List domains", "tags": [ "Domains" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Domain" } }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } } } }, "post": { "operationId": "addDomain", "summary": "Add a domain", "tags": [ "Domains" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/domains/{id}": { "get": { "operationId": "getDomain", "summary": "Get one domain", "tags": [ "Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "operationId": "deleteDomain", "summary": "Delete a domain (irreversible)", "tags": [ "Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "operationId": "patchdomainsById", "summary": "Update Domains", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/verify": { "post": { "operationId": "verifyDomain", "summary": "Trigger DNS verification", "tags": [ "Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/domains/{id}/mailboxes": { "get": { "operationId": "listMailboxes", "summary": "List mailboxes on a domain", "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Mailbox" } }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } } } }, "post": { "operationId": "createMailbox", "summary": "Create a mailbox", "tags": [ "Mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webhooks": { "get": { "operationId": "listWebhooks", "summary": "List webhooks", "tags": [ "Webhooks" ], "responses": { "200": { "description": "OK" } } }, "post": { "operationId": "createWebhook", "summary": "Register a webhook", "tags": [ "Webhooks" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing": { "get": { "operationId": "getBilling", "summary": "Get billing status", "tags": [ "Billing" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics": { "get": { "operationId": "getAnalytics", "summary": "Get analytics dashboard payload", "tags": [ "Analytics" ], "parameters": [ { "name": "range", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/oauth/authorize": { "post": { "operationId": "postapiOauthAuthorize", "summary": "Create Authorize", "tags": [ "oauth" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/oauth/register": { "post": { "operationId": "postapiOauthRegister", "summary": "Create Register", "tags": [ "oauth" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/oauth/revoke": { "post": { "operationId": "postapiOauthRevoke", "summary": "Create Revoke", "tags": [ "oauth" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/oauth/token": { "post": { "operationId": "postapiOauthToken", "summary": "Create Token", "tags": [ "oauth" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/account/api-settings": { "get": { "operationId": "getaccountApiSettings", "summary": "List Api Settings", "tags": [ "account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchaccountApiSettings", "summary": "Update Api Settings", "tags": [ "account" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/account/audit-log": { "get": { "operationId": "getaccountAuditLog", "summary": "List Audit Log", "tags": [ "account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/account/dedicated-ip": { "get": { "operationId": "getaccountDedicatedIp", "summary": "List Dedicated Ip", "tags": [ "account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/account/delete": { "post": { "operationId": "postaccountDelete", "summary": "Create Delete", "tags": [ "account" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/account/export": { "post": { "operationId": "postaccountExport", "summary": "Create Export", "tags": [ "account" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/account/quota": { "get": { "operationId": "getaccountQuota", "summary": "List Quota", "tags": [ "account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/account/trust-score": { "get": { "operationId": "getaccountTrustScore", "summary": "List Trust Score", "tags": [ "account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/analytics/domains/{domainId}": { "get": { "operationId": "getanalyticsDomainsByDomainId", "summary": "Get Domains", "tags": [ "analytics" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/analytics/org": { "get": { "operationId": "getanalyticsOrg", "summary": "List Org", "tags": [ "analytics" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/api-keys": { "get": { "operationId": "getapiKeys", "summary": "List Api Keys", "tags": [ "api-keys" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postapiKeys", "summary": "Create Api Keys", "tags": [ "api-keys" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/api-keys/{id}": { "get": { "operationId": "getapiKeysById", "summary": "Get Api Keys", "tags": [ "api-keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deleteapiKeysById", "summary": "Delete Api Keys", "tags": [ "api-keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/api-keys/analytics": { "get": { "operationId": "getapiKeysAnalytics", "summary": "List Analytics", "tags": [ "api-keys" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/billing/api-addon": { "post": { "operationId": "postbillingApiAddon", "summary": "Create Api Addon", "tags": [ "billing" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/billing/api-usage": { "get": { "operationId": "getbillingApiUsage", "summary": "List Api Usage", "tags": [ "billing" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/billing/cancel": { "post": { "operationId": "postbillingCancel", "summary": "Create Cancel", "tags": [ "billing" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletebillingCancel", "summary": "Delete Cancel", "tags": [ "billing" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/billing/checkout": { "post": { "operationId": "postbillingCheckout", "summary": "Create Checkout", "tags": [ "billing" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/billing/invoices": { "get": { "operationId": "getbillingInvoices", "summary": "List Invoices", "tags": [ "billing" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/billing/portal": { "post": { "operationId": "postbillingPortal", "summary": "Create Portal", "tags": [ "billing" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/billing/storage-addon": { "post": { "operationId": "postbillingStorageAddon", "summary": "Create Storage Addon", "tags": [ "billing" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/billing/usage": { "get": { "operationId": "getbillingUsage", "summary": "List Usage", "tags": [ "billing" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/compliance/can-spam-check": { "post": { "operationId": "postcomplianceCanSpamCheck", "summary": "Create Can Spam Check", "tags": [ "compliance" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/compliance/dpa": { "get": { "operationId": "getcomplianceDpa", "summary": "List Dpa", "tags": [ "compliance" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/compose/from-options": { "get": { "operationId": "getcomposeFromOptions", "summary": "List From Options", "tags": [ "compose" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/contacts/search": { "get": { "operationId": "getcontactsSearch", "summary": "List Search", "tags": [ "contacts" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/aliases": { "get": { "operationId": "getdomainsByIdAliases", "summary": "Get Aliases", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postdomainsByIdAliases", "summary": "Create Aliases", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/aliases/{aid}": { "patch": { "operationId": "patchdomainsByIdAliasesByAid", "summary": "Update Aliases", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "aid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletedomainsByIdAliasesByAid", "summary": "Delete Aliases", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "aid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/auto-provision": { "post": { "operationId": "postdomainsByIdAutoProvision", "summary": "Create Auto Provision", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/bimi": { "get": { "operationId": "getdomainsByIdBimi", "summary": "Get Bimi", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchdomainsByIdBimi", "summary": "Update Bimi", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/catch-all": { "patch": { "operationId": "patchdomainsByIdCatchAll", "summary": "Update Catch All", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/dane": { "get": { "operationId": "getdomainsByIdDane", "summary": "Get Dane", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postdomainsByIdDane", "summary": "Create Dane", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/dns-preview": { "post": { "operationId": "postdomainsByIdDnsPreview", "summary": "Create Dns Preview", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/dns-provider": { "get": { "operationId": "getdomainsByIdDnsProvider", "summary": "Get Dns Provider", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/domain-connect": { "get": { "operationId": "getdomainsByIdDomainConnect", "summary": "Get Domain Connect", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/existing-records": { "get": { "operationId": "getdomainsByIdExistingRecords", "summary": "Get Existing Records", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/mailboxes/{mid}": { "get": { "operationId": "getdomainsByIdMailboxesByMid", "summary": "Get Mailboxes", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchdomainsByIdMailboxesByMid", "summary": "Update Mailboxes", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletedomainsByIdMailboxesByMid", "summary": "Delete Mailboxes", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/mailboxes/{mid}/auto-responder": { "get": { "operationId": "getdomainsByIdMailboxesByMidAutoResponder", "summary": "Get Auto Responder", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchdomainsByIdMailboxesByMidAutoResponder", "summary": "Update Auto Responder", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/mailboxes/{mid}/forwarding-rules": { "get": { "operationId": "getdomainsByIdMailboxesByMidForwardingRules", "summary": "Get Forwarding Rules", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postdomainsByIdMailboxesByMidForwardingRules", "summary": "Create Forwarding Rules", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/mailboxes/{mid}/forwarding-rules/{ruleId}": { "patch": { "operationId": "patchdomainsByIdMailboxesByMidForwardingRulesByRuleId", "summary": "Update Forwarding Rules", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletedomainsByIdMailboxesByMidForwardingRulesByRuleId", "summary": "Delete Forwarding Rules", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/mailboxes/{mid}/forwarding-rules/reorder": { "patch": { "operationId": "patchdomainsByIdMailboxesByMidForwardingRulesReorder", "summary": "Update Reorder", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/mailboxes/{mid}/password": { "post": { "operationId": "postdomainsByIdMailboxesByMidPassword", "summary": "Create Password", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletedomainsByIdMailboxesByMidPassword", "summary": "Delete Password", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/mailboxes/{mid}/signature": { "get": { "operationId": "getdomainsByIdMailboxesByMidSignature", "summary": "Get Signature", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchdomainsByIdMailboxesByMidSignature", "summary": "Update Signature", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/verify/sse": { "get": { "operationId": "getdomainsByIdVerifySse", "summary": "Get Sse", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/domains/{id}/warmup": { "get": { "operationId": "getdomainsByIdWarmup", "summary": "Get Warmup", "tags": [ "domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/dovecot/notify": { "post": { "operationId": "postdovecotNotify", "summary": "Create Notify", "tags": [ "dovecot" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/{id}/block-options": { "get": { "operationId": "getemailsByIdBlockOptions", "summary": "Get Block Options", "tags": [ "emails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/{id}/report-spam": { "post": { "operationId": "postemailsByIdReportSpam", "summary": "Create Report Spam", "tags": [ "emails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/attachments": { "post": { "operationId": "postemailsAttachments", "summary": "Create Attachments", "tags": [ "emails" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/attachments/scan-status": { "get": { "operationId": "getemailsAttachmentsScanStatus", "summary": "List Scan Status", "tags": [ "emails" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/inbound": { "post": { "operationId": "postemailsInbound", "summary": "Create Inbound", "tags": [ "emails" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/move": { "post": { "operationId": "postemailsMove", "summary": "Create Move", "tags": [ "emails" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/reparse": { "post": { "operationId": "postemailsReparse", "summary": "Create Reparse", "tags": [ "emails" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/sent-copy": { "post": { "operationId": "postemailsSentCopy", "summary": "Create Sent Copy", "tags": [ "emails" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/sse": { "get": { "operationId": "getemailsSse", "summary": "List Sse", "tags": [ "emails" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/emails/unread-counts": { "get": { "operationId": "getemailsUnreadCounts", "summary": "List Unread Counts", "tags": [ "emails" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts": { "get": { "operationId": "getexternalAccounts", "summary": "List External Accounts", "tags": [ "external-accounts" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postexternalAccounts", "summary": "Create External Accounts", "tags": [ "external-accounts" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/{id}": { "get": { "operationId": "getexternalAccountsById", "summary": "Get External Accounts", "tags": [ "external-accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchexternalAccountsById", "summary": "Update External Accounts", "tags": [ "external-accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deleteexternalAccountsById", "summary": "Delete External Accounts", "tags": [ "external-accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/{id}/emails": { "get": { "operationId": "getexternalAccountsByIdEmails", "summary": "Get Emails", "tags": [ "external-accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/{id}/folders": { "get": { "operationId": "getexternalAccountsByIdFolders", "summary": "Get Folders", "tags": [ "external-accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/{id}/resync": { "post": { "operationId": "postexternalAccountsByIdResync", "summary": "Create Resync", "tags": [ "external-accounts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/oauth/google/callback": { "get": { "operationId": "getexternalAccountsOauthGoogleCallback", "summary": "List Callback", "tags": [ "external-accounts" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/oauth/google/start": { "get": { "operationId": "getexternalAccountsOauthGoogleStart", "summary": "List Start", "tags": [ "external-accounts" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/oauth/microsoft/callback": { "get": { "operationId": "getexternalAccountsOauthMicrosoftCallback", "summary": "List Callback", "tags": [ "external-accounts" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/oauth/microsoft/start": { "get": { "operationId": "getexternalAccountsOauthMicrosoftStart", "summary": "List Start", "tags": [ "external-accounts" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/test-connection": { "post": { "operationId": "postexternalAccountsTestConnection", "summary": "Create Test Connection", "tags": [ "external-accounts" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external-accounts/unread-counts": { "get": { "operationId": "getexternalAccountsUnreadCounts", "summary": "List Unread Counts", "tags": [ "external-accounts" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/external/emails/send": { "post": { "operationId": "postexternalEmailsSend", "summary": "Create Send", "tags": [ "external" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/folders": { "get": { "operationId": "getfolders", "summary": "List Folders", "tags": [ "folders" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postfolders", "summary": "Create Folders", "tags": [ "folders" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/folders/{id}": { "patch": { "operationId": "patchfoldersById", "summary": "Update Folders", "tags": [ "folders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletefoldersById", "summary": "Delete Folders", "tags": [ "folders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/identities": { "get": { "operationId": "getidentities", "summary": "List Identities", "tags": [ "identities" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/inbox/unified": { "get": { "operationId": "getinboxUnified", "summary": "List Unified", "tags": [ "inbox" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/mailboxes/{id}/folders": { "get": { "operationId": "getmailboxesByIdFolders", "summary": "Get Folders", "tags": [ "mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postmailboxesByIdFolders", "summary": "Create Folders", "tags": [ "mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/mailboxes/{id}/folders/{folderId}": { "patch": { "operationId": "patchmailboxesByIdFoldersByFolderId", "summary": "Update Folders", "tags": [ "mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "folderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletemailboxesByIdFoldersByFolderId", "summary": "Delete Folders", "tags": [ "mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "folderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/mailboxes/{id}/folders/reorder": { "post": { "operationId": "postmailboxesByIdFoldersReorder", "summary": "Create Reorder", "tags": [ "mailboxes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/domain-preferences": { "get": { "operationId": "getmeDomainPreferences", "summary": "List Domain Preferences", "tags": [ "me" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/domain-preferences/{domainId}": { "put": { "operationId": "putmeDomainPreferencesByDomainId", "summary": "Update Domain Preferences", "tags": [ "me" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletemeDomainPreferencesByDomainId", "summary": "Delete Domain Preferences", "tags": [ "me" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/domain-preferences/bulk": { "post": { "operationId": "postmeDomainPreferencesBulk", "summary": "Create Bulk", "tags": [ "me" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/mailbox-owner-names": { "get": { "operationId": "getmeMailboxOwnerNames", "summary": "List Mailbox Owner Names", "tags": [ "me" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/mailbox-password": { "post": { "operationId": "postmeMailboxPassword", "summary": "Create Mailbox Password", "tags": [ "me" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/mailbox-preferences": { "get": { "operationId": "getmeMailboxPreferences", "summary": "List Mailbox Preferences", "tags": [ "me" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/mailbox-preferences/{mailboxId}": { "put": { "operationId": "putmeMailboxPreferencesByMailboxId", "summary": "Update Mailbox Preferences", "tags": [ "me" ], "parameters": [ { "name": "mailboxId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletemeMailboxPreferencesByMailboxId", "summary": "Delete Mailbox Preferences", "tags": [ "me" ], "parameters": [ { "name": "mailboxId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/mailbox-preferences/bulk": { "post": { "operationId": "postmeMailboxPreferencesBulk", "summary": "Create Bulk", "tags": [ "me" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/me/profile": { "get": { "operationId": "getmeProfile", "summary": "List Profile", "tags": [ "me" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchmeProfile", "summary": "Update Profile", "tags": [ "me" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/messages/session": { "get": { "operationId": "getmessagesSession", "summary": "List Session", "tags": [ "messages" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/messages/session/{id}": { "get": { "operationId": "getmessagesSessionById", "summary": "Get Session", "tags": [ "messages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/{migrationId}/aliases": { "get": { "operationId": "getmigrationByMigrationIdAliases", "summary": "Get Aliases", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/{migrationId}/complete": { "get": { "operationId": "getmigrationByMigrationIdComplete", "summary": "Get Complete", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postmigrationByMigrationIdComplete", "summary": "Create Complete", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/{migrationId}/domains": { "get": { "operationId": "getmigrationByMigrationIdDomains", "summary": "Get Domains", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/{migrationId}/mailboxes": { "get": { "operationId": "getmigrationByMigrationIdMailboxes", "summary": "Get Mailboxes", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/{migrationId}/provision": { "post": { "operationId": "postmigrationByMigrationIdProvision", "summary": "Create Provision", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/{migrationId}/rollback": { "post": { "operationId": "postmigrationByMigrationIdRollback", "summary": "Create Rollback", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/{migrationId}/rollback-preview": { "get": { "operationId": "getmigrationByMigrationIdRollbackPreview", "summary": "Get Rollback Preview", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/{migrationId}/start": { "post": { "operationId": "postmigrationByMigrationIdStart", "summary": "Create Start", "tags": [ "migration" ], "parameters": [ { "name": "migrationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/callback/google": { "get": { "operationId": "getmigrationCallbackGoogle", "summary": "List Google", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/callback/microsoft": { "get": { "operationId": "getmigrationCallbackMicrosoft", "summary": "List Microsoft", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/callback/zoho": { "get": { "operationId": "getmigrationCallbackZoho", "summary": "List Zoho", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/cancel": { "post": { "operationId": "postmigrationCancel", "summary": "Create Cancel", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/cpanel/verify-credentials": { "post": { "operationId": "postmigrationCpanelVerifyCredentials", "summary": "Create Verify Credentials", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/cpanel/verify-credentials/status": { "get": { "operationId": "getmigrationCpanelVerifyCredentialsStatus", "summary": "List Status", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/discover-org": { "post": { "operationId": "postmigrationDiscoverOrg", "summary": "Create Discover Org", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/final-sync": { "post": { "operationId": "postmigrationFinalSync", "summary": "Create Final Sync", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/google/admin-consent": { "post": { "operationId": "postmigrationGoogleAdminConsent", "summary": "Create Admin Consent", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/google/admin-consent/status": { "get": { "operationId": "getmigrationGoogleAdminConsentStatus", "summary": "List Status", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/google/verify-consent": { "post": { "operationId": "postmigrationGoogleVerifyConsent", "summary": "Create Verify Consent", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/microsoft/admin-consent": { "post": { "operationId": "postmigrationMicrosoftAdminConsent", "summary": "Create Admin Consent", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/microsoft/admin-consent/status": { "get": { "operationId": "getmigrationMicrosoftAdminConsentStatus", "summary": "List Status", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/microsoft/verify-consent": { "post": { "operationId": "postmigrationMicrosoftVerifyConsent", "summary": "Create Verify Consent", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/mx-verify": { "get": { "operationId": "getmigrationMxVerify", "summary": "List Mx Verify", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/scan-google": { "post": { "operationId": "postmigrationScanGoogle", "summary": "Create Scan Google", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/scan-microsoft": { "post": { "operationId": "postmigrationScanMicrosoft", "summary": "Create Scan Microsoft", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/sse": { "get": { "operationId": "getmigrationSse", "summary": "List Sse", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/start": { "post": { "operationId": "postmigrationStart", "summary": "Create Start", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/status": { "get": { "operationId": "getmigrationStatus", "summary": "List Status", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/test-connection": { "post": { "operationId": "postmigrationTestConnection", "summary": "Create Test Connection", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/zoho/admin-consent": { "post": { "operationId": "postmigrationZohoAdminConsent", "summary": "Create Admin Consent", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/zoho/admin-consent/status": { "get": { "operationId": "getmigrationZohoAdminConsentStatus", "summary": "List Status", "tags": [ "migration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/migration/zoho/verify-consent": { "post": { "operationId": "postmigrationZohoVerifyConsent", "summary": "Create Verify Consent", "tags": [ "migration" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/oauth/connections": { "get": { "operationId": "getoauthConnections", "summary": "List Connections", "tags": [ "oauth" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/oauth/connections/{id}": { "delete": { "operationId": "deleteoauthConnectionsById", "summary": "Delete Connections", "tags": [ "oauth" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org": { "get": { "operationId": "getorg", "summary": "List Org", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postorg", "summary": "Create Org", "tags": [ "org" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/audit-log": { "get": { "operationId": "getorgAuditLog", "summary": "List Audit Log", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/invitations": { "get": { "operationId": "getorgInvitations", "summary": "List Invitations", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postorgInvitations", "summary": "Create Invitations", "tags": [ "org" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/invitations/{invitationId}": { "post": { "operationId": "postorgInvitationsByInvitationId", "summary": "Create Invitations", "tags": [ "org" ], "parameters": [ { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deleteorgInvitationsByInvitationId", "summary": "Delete Invitations", "tags": [ "org" ], "parameters": [ { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/invitations/accept": { "get": { "operationId": "getorgInvitationsAccept", "summary": "List Accept", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postorgInvitationsAccept", "summary": "Create Accept", "tags": [ "org" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/members": { "get": { "operationId": "getorgMembers", "summary": "List Members", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/members/{memberId}": { "get": { "operationId": "getorgMembersByMemberId", "summary": "Get Members", "tags": [ "org" ], "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchorgMembersByMemberId", "summary": "Update Members", "tags": [ "org" ], "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deleteorgMembersByMemberId", "summary": "Delete Members", "tags": [ "org" ], "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/members/{memberId}/domains": { "get": { "operationId": "getorgMembersByMemberIdDomains", "summary": "Get Domains", "tags": [ "org" ], "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "put": { "operationId": "putorgMembersByMemberIdDomains", "summary": "Update Domains", "tags": [ "org" ], "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/settings": { "get": { "operationId": "getorgSettings", "summary": "List Settings", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "patch": { "operationId": "patchorgSettings", "summary": "Update Settings", "tags": [ "org" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/transfer-ownership": { "get": { "operationId": "getorgTransferOwnership", "summary": "List Transfer Ownership", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postorgTransferOwnership", "summary": "Create Transfer Ownership", "tags": [ "org" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deleteorgTransferOwnership", "summary": "Delete Transfer Ownership", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/transfer-ownership/accept": { "post": { "operationId": "postorgTransferOwnershipAccept", "summary": "Create Accept", "tags": [ "org" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/transfer-ownership/decline": { "post": { "operationId": "postorgTransferOwnershipDecline", "summary": "Create Decline", "tags": [ "org" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/org/tree": { "get": { "operationId": "getorgTree", "summary": "List Tree", "tags": [ "org" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/send/webhook-status": { "post": { "operationId": "postsendWebhookStatus", "summary": "Create Webhook Status", "tags": [ "send" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/spam/quarantine": { "get": { "operationId": "getspamQuarantine", "summary": "List Quarantine", "tags": [ "spam" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postspamQuarantine", "summary": "Create Quarantine", "tags": [ "spam" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/spam/sender-rules": { "get": { "operationId": "getspamSenderRules", "summary": "List Sender Rules", "tags": [ "spam" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postspamSenderRules", "summary": "Create Sender Rules", "tags": [ "spam" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletespamSenderRules", "summary": "Delete Sender Rules", "tags": [ "spam" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/status": { "get": { "operationId": "getstatus", "summary": "List Status", "tags": [ "status" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/suppressions": { "get": { "operationId": "getsuppressions", "summary": "List Suppressions", "tags": [ "suppressions" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postsuppressions", "summary": "Create Suppressions", "tags": [ "suppressions" ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletesuppressions", "summary": "Delete Suppressions", "tags": [ "suppressions" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/suppressions/export": { "get": { "operationId": "getsuppressionsExport", "summary": "List Export", "tags": [ "suppressions" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/unsubscribe/{token}": { "get": { "operationId": "getunsubscribeByToken", "summary": "Get Unsubscribe", "tags": [ "unsubscribe" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "post": { "operationId": "postunsubscribeByToken", "summary": "Create Unsubscribe", "tags": [ "unsubscribe" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/webhooks/{id}": { "get": { "operationId": "getwebhooksById", "summary": "Get Webhooks", "tags": [ "webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } }, "delete": { "operationId": "deletewebhooksById", "summary": "Delete Webhooks", "tags": [ "webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/webhooks/{id}/deliveries": { "get": { "operationId": "getwebhooksByIdDeliveries", "summary": "Get Deliveries", "tags": [ "webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/webhooks/{id}/rotate-secret": { "post": { "operationId": "postwebhooksByIdRotateSecret", "summary": "Create Rotate Secret", "tags": [ "webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } }, "/api/v1/webhooks/{id}/test": { "post": { "operationId": "postwebhooksByIdTest", "summary": "Create Test", "tags": [ "webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ] } } } }, "401": { "description": "Missing or invalid API key" }, "4XX": { "description": "Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ] } } } } } } } } } }, "tags": [ { "name": "Analytics" }, { "name": "Billing" }, { "name": "Domains" }, { "name": "Emails" }, { "name": "Mailboxes" }, { "name": "Send" }, { "name": "Webhooks" }, { "name": "account" }, { "name": "analytics" }, { "name": "api-keys" }, { "name": "billing" }, { "name": "compliance" }, { "name": "compose" }, { "name": "contacts" }, { "name": "domains" }, { "name": "dovecot" }, { "name": "emails" }, { "name": "external" }, { "name": "external-accounts" }, { "name": "folders" }, { "name": "identities" }, { "name": "inbox" }, { "name": "mailboxes" }, { "name": "me" }, { "name": "messages" }, { "name": "migration" }, { "name": "oauth" }, { "name": "org" }, { "name": "send" }, { "name": "spam" }, { "name": "status" }, { "name": "suppressions" }, { "name": "unsubscribe" }, { "name": "webhooks" } ], "externalDocs": { "description": "Full MCP tool catalog + integration guides", "url": "https://mcp.justemails.app/docs" } }