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/emailconnect:emailconnect-user-domains-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

openapi: 3.2.0
info:
  title: EmailConnect.eu User Domains API
  version: 1.0.0
  description: '# EmailConnect.eu API Documentation


    Welcome to the EmailConnect.eu API!'
  contact:
    name: EmailConnect.eu Support
    email: support@emailconnect.eu
    url: https://app.emailconnect.eu
  license:
    name: Terms of Service
    url: https://emailconnect.eu/terms-of-service
servers:
- url: https://app.emailconnect.eu
  description: Production server
tags:
- name: User Domains
  description: Manage your email domains. Add domains, verify ownership, and configure email routing.
  externalDocs:
    description: Domain setup guide
    url: https://emailconnect.eu/help/domain-setup
paths:
  /api/domains:
    get:
      tags:
      - User Domains
      summary: List user domains
      description: Retrieve all domains owned by the authenticated user.
      security:
      - userApiKey: []
      responses:
        '200':
          description: List of user domains
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Domain'
        '401':
          $ref: '#/components/responses/Unauthorized'
      operationId: getApiDomains
      x-operation-id-source: derived
    post:
      tags:
      - User Domains
      summary: Add a new domain
      description: Add a new domain to your account. The domain will need to be verified before it can receive emails.
      security:
      - userApiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainPayload'
      responses:
        '201':
          description: Domain created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      operationId: postApiDomains
      x-operation-id-source: derived
  /api/domains/{domainId}:
    get:
      tags:
      - User Domains
      summary: Get domain details
      description: Retrieve details for a specific domain including verification status.
      security:
      - userApiKey: []
      parameters:
      - name: domainId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopl002uru1qqyx7b18a
        description: Domain ID
      responses:
        '200':
          description: Domain details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getApiDomainsByDomainId
      x-operation-id-source: derived
    delete:
      tags:
      - User Domains
      summary: Delete a domain
      description: Delete a domain and all associated aliases and webhooks.
      security:
      - userApiKey: []
      parameters:
      - name: domainId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopl002uru1qqyx7b18a
        description: Domain ID
      responses:
        '204':
          description: Domain deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: deleteApiDomainsByDomainId
      x-operation-id-source: derived
  /api/domains/{domainId}/status:
    put:
      tags:
      - User Domains
      summary: Toggle domain status
      description: Toggle the active status of a domain by ID.
      security:
      - userApiKey: []
      parameters:
      - name: domainId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopl002uru1qqyx7b18a
        description: Domain ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainStatusRequest'
      responses:
        '200':
          description: Domain status updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDomainStatusResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: putApiDomainsByDomainIdStatus
      x-operation-id-source: derived
  /api/domains/{domainId}/verify:
    post:
      tags:
      - User Domains
      summary: Trigger domain verification
      description: Manually trigger verification for a domain. This will check DNS records and update the verification status.
      security:
      - userApiKey: []
      parameters:
      - name: domainId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopl002uru1qqyx7b18a
        description: Domain ID
      responses:
        '200':
          description: Verification triggered successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: postApiDomainsByDomainIdVerify
      x-operation-id-source: derived
  /api/domains/{domainId}/webhook:
    put:
      tags:
      - User Domains
      summary: Update domain webhook
      description: Update the webhook configuration for a domain.
      security:
      - userApiKey: []
      parameters:
      - name: domainId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopl002uru1qqyx7b18a
        description: Domain ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                webhookId:
                  type: string
              required:
              - webhookId
      responses:
        '200':
          description: Domain webhook updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: putApiDomainsByDomainIdWebhook
      x-operation-id-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: Invalid input
      required:
      - statusCode
      - error
      - message
    UpdateDomainStatusResponse:
      type: object
      properties:
        success:
          type: boolean
        domain:
          type: object
          properties:
            id:
              type: string
              example: cmbw6hopl002uru1qqyx7b18a
            domain:
              type: string
            active:
              type: boolean
            updatedAt:
              type: string
              format: date-time
        message:
          type: string
    UpdateDomainStatusRequest:
      type: object
      properties:
        active:
          type: boolean
          description: New active status
      required:
      - active
    Domain:
      type: object
      properties:
        id:
          type: string
          example: cmbw6hopl002uru1qqyx7b18a
          readOnly: true
        domain:
          type: string
          example: example.com
        webhook:
          type:
          - object
          - 'null'
          properties:
            id:
              type: string
            name:
              type: string
            url:
              type: string
              format: uri
            verified:
              type: boolean
        webhookUrl:
          type:
          - string
          - 'null'
          format: uri
          example: https://myapp.com/webhook
        webhookName:
          type:
          - string
          - 'null'
          example: Main Webhook
        active:
          type: boolean
          example: true
        isVerified:
          type: boolean
          example: true
          readOnly: true
        verificationStatus:
          type: string
          enum:
          - PENDING
          - VERIFIED
          - ACTIVE
          - WARNING
          - SUSPENDED
          - FAILED
          example: VERIFIED
          readOnly: true
        configuration:
          type:
          - object
          - 'null'
          properties:
            allowAttachments:
              type: boolean
            includeEnvelope:
              type: boolean
        postfix_configured:
          type: boolean
          example: true
          readOnly: true
        mxStatus:
          type:
          - string
          - 'null'
          enum:
          - POINTS_HERE
          - ELSEWHERE
          - NONE
          - UNKNOWN
          example: POINTS_HERE
          readOnly: true
          description: 'Whether the domain''s MX points at our mail server, from the last verification check. Advisory: it does not affect `isVerified`. ELSEWHERE: the most preferred MX names another host. NONE: no MX record. UNKNOWN: the lookup failed. Null: not checked yet.'
        mxHosts:
          type: array
          items:
            type: string
          readOnly: true
          description: The MX hosts found at the last check, lowercased.
        expectedMxHosts:
          type: array
          items:
            type: string
          example:
          - mx1.emailconnect.eu
          readOnly: true
          description: The host(s) the domain's MX record should name.
        lastVerificationAttempt:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        nextVerificationCheck:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        verificationFailureCount:
          type: integer
          example: 0
          readOnly: true
        expectedTxtRecord:
          type:
          - string
          - 'null'
          readOnly: true
        aliases:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              email:
                type: string
              webhookName:
                type:
                - string
                - 'null'
              active:
                type: boolean
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
      required:
      - id
      - domain
      - active
      - isVerified
    DomainStatus:
      type: object
      properties:
        domain:
          type: string
          example: example.com
        isVerified:
          type: boolean
        dnsRecords:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                example: TXT
              name:
                type: string
                example: example.com or _dkim.example.com
              value:
                type: string
                example: verification-token or dkim-public-key
              status:
                type: string
                enum:
                - verified
                - pending
                - failed
                example: pending
    CreateDomainPayload:
      type: object
      properties:
        domain:
          type: string
          example: mydomain.com
          description: Domain name to add
        webhookId:
          type: string
          example: cmbw62nwc002bru1qf7d72akd
          description: ID of existing webhook to use
        webhookUrl:
          type: string
          format: uri
          example: https://myapp.com/webhook
          description: URL for new webhook (alternative to webhookId)
        webhookName:
          type: string
          example: My Domain Webhook
          description: Name for new webhook (used with webhookUrl)
        webhookDescription:
          type: string
          example: Handles emails for mydomain.com
          description: Description for new webhook
        createCatchAll:
          type: boolean
          default: true
          description: Whether to create a catch-all alias (*@domain.com)
        active:
          type: boolean
          default: true
          description: Whether domain should be active
      required:
      - domain
      oneOf:
      - required:
        - domain
        - webhookId
      - required:
        - domain
        - webhookUrl
        - webhookName
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication failed or missing API key for user endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request payload or parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key for user authentication. Find your API key in your account settings.