Archestra AI

Archestra AI Incoming Email API

The Incoming Email API from Archestra AI — 4 operation(s) for incoming email.

GitHub OpenAPI

Operations 4

GET /api/incoming-email/status Get incoming email status #
POST /api/incoming-email/setup Setup incoming email webhook #
POST /api/incoming-email/renew Renew incoming email subscription #
DELETE /api/incoming-email/subscription Delete incoming email subscription #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/archestra/openapi/archestra-incoming-email-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-gemini-generate-content-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-gemini-generate-content-request-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-minimax-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-minimax-chat-completion-request-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-openrouter-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-perplexity-chat-completion-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/archestra:archestra-incoming-email-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

archestra-incoming-email-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Archestra Incoming Email API
  version: 1.4.0-rc.47
tags:
- name: Incoming Email
paths:
  /api/incoming-email/status:
    get:
      operationId: getIncomingEmailStatus
      tags:
      - Incoming Email
      description: 'Get the current incoming email webhook subscription status


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:read`: View every organization settings page, including messaging channels'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  isActive:
                    type: boolean
                  subscription:
                    type:
                    - object
                    - 'null'
                    properties:
                      id:
                        type: string
                      subscriptionId:
                        type: string
                      provider:
                        type: string
                      webhookUrl:
                        type: string
                      expiresAt:
                        type: string
                        format: date-time
                        pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    required:
                    - id
                    - subscriptionId
                    - provider
                    - webhookUrl
                    - expiresAt
                    additionalProperties: false
                required:
                - isActive
                - subscription
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:read
      summary: Get incoming email status
      x-summary-source: derived
  /api/incoming-email/setup:
    post:
      operationId: setupIncomingEmailWebhook
      tags:
      - Incoming Email
      description: 'Setup or renew incoming email webhook subscription


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                webhookUrl:
                  type: string
                  format: uri
              required:
              - webhookUrl
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  subscriptionId:
                    type: string
                  expiresAt:
                    type: string
                    format: date-time
                    pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                  message:
                    type: string
                required:
                - success
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Setup incoming email webhook
      x-summary-source: derived
  /api/incoming-email/renew:
    post:
      operationId: renewIncomingEmailSubscription
      tags:
      - Incoming Email
      description: 'Renew the incoming email webhook subscription


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  subscriptionId:
                    type: string
                  expiresAt:
                    type: string
                    format: date-time
                    pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                  message:
                    type: string
                required:
                - success
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Renew incoming email subscription
      x-summary-source: derived
  /api/incoming-email/subscription:
    delete:
      operationId: deleteIncomingEmailSubscription
      tags:
      - Incoming Email
      description: 'Delete the incoming email webhook subscription


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                required:
                - success
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Delete incoming email subscription
      x-summary-source: derived