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-aliases-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 Aliases 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 Aliases
  description: Create and manage email aliases for your verified domains. Route specific email addresses to different webhooks.
  externalDocs:
    description: Alias configuration guide
    url: https://emailconnect.eu/help/alias-options-explained
paths:
  /api/aliases:
    get:
      tags:
      - User Aliases
      summary: List aliases for a domain
      description: Retrieve all aliases for a specific domain.
      security:
      - userApiKey: []
      parameters:
      - name: domainId
        in: query
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopl002uru1qqyx7b18a
        description: Domain ID to filter aliases
      responses:
        '200':
          description: List of aliases
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Alias'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getApiAliases
      x-operation-id-source: derived
    post:
      tags:
      - User Aliases
      summary: Create a new alias
      description: Create a new email alias for a domain.
      security:
      - userApiKey: []
      parameters:
      - name: domainId
        in: query
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopl002uru1qqyx7b18a
        description: Domain ID for the alias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAliasPayload'
      responses:
        '201':
          description: Alias created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: postApiAliases
      x-operation-id-source: derived
  /api/aliases/{aliasId}:
    get:
      tags:
      - User Aliases
      summary: Get alias details
      description: Retrieve details for a specific alias.
      security:
      - userApiKey: []
      parameters:
      - name: aliasId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopp002wru1qk18cowjg
        description: Alias ID
      responses:
        '200':
          description: Alias details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getApiAliasesByAliasId
      x-operation-id-source: derived
    put:
      tags:
      - User Aliases
      summary: Update an alias
      description: Update the destination email for an alias.
      security:
      - userApiKey: []
      parameters:
      - name: aliasId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopp002wru1qk18cowjg
        description: Alias ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAliasPayload'
      responses:
        '200':
          description: Alias updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: putApiAliasesByAliasId
      x-operation-id-source: derived
    delete:
      tags:
      - User Aliases
      summary: Delete an alias
      description: Delete an email alias.
      security:
      - userApiKey: []
      parameters:
      - name: aliasId
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9]{25}$
          example: cmbw6hopp002wru1qk18cowjg
        description: Alias ID
      responses:
        '204':
          description: Alias deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: deleteApiAliasesByAliasId
      x-operation-id-source: derived
components:
  schemas:
    CreateAliasPayload:
      type: object
      properties:
        localPart:
          type: string
          example: support
          description: Local part of the email address (e.g., "support") or "*" for catch-all. Combined with domainId to form the full address.
        domainId:
          type: string
          example: cmbw6hopl002uru1qqyx7b18a
          description: ID of the domain to create alias for
        webhookId:
          type: string
          example: cmbw62nwc002bru1qf7d72akd
          description: ID of the webhook to use for this alias
        active:
          type: boolean
          default: true
      required:
      - localPart
      - domainId
      - webhookId
    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
    Alias:
      type: object
      properties:
        id:
          type: string
          example: cmbw6hopp002wru1qk18cowjg
          readOnly: true
        email:
          type: string
          example: support@example.com
          description: Full email address or catch-all pattern (*@domain.com)
        active:
          type: boolean
          example: true
        domainId:
          type: string
          example: cmbw6hopl002uru1qqyx7b18a
        webhookId:
          type: string
          example: cmbw62nwc002bru1qf7d72akd
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        configuration:
          type:
          - object
          - 'null'
          properties:
            allowAttachments:
              type: boolean
            includeEnvelope:
              type: boolean
            includeHtml:
              type: boolean
            includeText:
              type: boolean
            includeLinks:
              type: boolean
            attachmentHandling:
              type: string
              enum:
              - inline
              - storage
            s3Folder:
              type: string
        domain:
          type: object
          properties:
            id:
              type: string
            domain:
              type: string
            verified:
              type: boolean
        webhook:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            url:
              type: string
            verified:
              type: boolean
            hasSecret:
              type: boolean
      required:
      - id
      - email
      - active
      - domainId
      - webhookId
    UpdateAliasPayload:
      type: object
      properties:
        email:
          type: string
          example: newsupport@example.com
          description: Full email address or catch-all pattern (e.g., support@domain.com or *@domain.com)
        webhookId:
          type: string
          example: cmbw62nwc002bru1qf7d72akd
          description: ID of the webhook to use for this alias
        active:
          type: boolean
        allowAttachments:
          type:
          - boolean
          - 'null'
        includeEnvelope:
          type:
          - boolean
          - 'null'
        includeHtml:
          type:
          - boolean
          - 'null'
        includeText:
          type:
          - boolean
          - 'null'
        includeLinks:
          type:
          - boolean
          - 'null'
        attachmentHandling:
          type:
          - string
          - 'null'
          enum:
          - inline
          - storage
        s3Folder:
          type:
          - string
          - 'null'
      minProperties: 1
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request payload or parameters.
      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'
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key for user authentication. Find your API key in your account settings.