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/foxnfe-com-br:foxnfe-com-br-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

openapi: 3.2.0
info:
  title: FOX NF-e Email API
  version: '1.20260923'
  description: Contrato derivado das rotas, regras Laravel e respostas estáticas. Condições de validação são descritas nos campos. x-source identifica a evidência. Valores dinâmicos sem tipo comprovado não recebem tipos inventados.
servers:
- url: https://www.foxnfe.com.br
tags:
- name: Email
paths:
  /api/v1/email/suppressions:
    get:
      operationId: get_api_v1_email_suppressions
      tags:
      - Email
      summary: EmailSuppression index
      x-source: app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:40
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      - plan.limits
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:43
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    data: null
          x-source:
          - app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:45
      security:
      - bearerAuth: []
    post:
      operationId: post_api_v1_email_suppressions
      tags:
      - Email
      summary: EmailSuppression store
      x-source: app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:48
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      - plan.limits
      - throttle:30,60
      - ability:certificates:write
      responses:
        '201':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: suppressed
                  email:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Modules/Notification/Services/EmailSuppressionService.php:25
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    status: suppressed
                    email: null
          x-source:
          - app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:63
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_email_suppressionsRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  email: integracao@example.invalid
                  reason: EXEMPLO_FICTICIO
  /api/v1/email/suppressions/release:
    post:
      operationId: post_api_v1_email_suppressions_release
      tags:
      - Email
      summary: EmailSuppression release
      x-source: app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:97
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      - plan.limits
      - throttle:30,60
      - ability:certificates:write
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: released
                  email:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Modules/Notification/Services/EmailSuppressionService.php:25
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    status: released
                    email: null
          x-source:
          - app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:111
        '404':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: not_found_or_already_released
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    error: not_found_or_already_released
          x-source:
          - app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:112
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_email_suppressions_releaseRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  email: integracao@example.invalid
  /api/v1/email/bounces:
    post:
      operationId: post_api_v1_email_bounces
      tags:
      - Email
      summary: EmailSuppression bounce
      x-source: app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:73
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      - plan.limits
      - throttle:30,60
      - ability:certificates:write
      responses:
        '201':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    anyOf:
                    - type: string
                      example: suppressed
                    - type: string
                      example: recorded
                  type:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:92
                  email:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Modules/Notification/Services/EmailSuppressionService.php:25
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value:
                    status: suppressed
                    type: null
                    email: null
          x-source:
          - app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:90
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_email_bouncesRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  email: integracao@example.invalid
                  type: hard
  /api/v1/email/deliveries/resend:
    post:
      operationId: post_api_v1_email_deliveries_resend
      tags:
      - Email
      summary: EmailDelivery resend
      x-source: app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:23
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      - plan.limits
      - throttle:10,60
      - ability:certificates:write
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                x-source: app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:38
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value: null
          x-source:
          - app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:52
        '404':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                x-source: app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:38
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value: null
          x-source:
          - app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:52
        '409':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                x-source: app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:38
              examples:
                estrutura_ficticia:
                  summary: Exemplo estrutural fictício; não é recibo de execução.
                  description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                  value: null
          x-source:
          - app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:52
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_email_deliveries_resendRequest'
            examples:
              estrutura_ficticia:
                summary: Exemplo estrutural fictício; não é recibo de execução.
                description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
                value:
                  dedupe_key: EXEMPLO_FICTICIO
components:
  schemas:
    post_api_v1_email_deliveries_resendRequest:
      type: object
      properties:
        dedupe_key:
          x-laravel-rules:
          - required
          - string
          - max:255
          type: string
          maxLength: 255
        allow_uncertain:
          x-laravel-rules:
          - sometimes
          - boolean
          type: boolean
        dry_run:
          x-laravel-rules:
          - sometimes
          - boolean
          type: boolean
      required:
      - dedupe_key
      x-source:
      - app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:25
    post_api_v1_email_suppressions_releaseRequest:
      type: object
      properties:
        email:
          x-laravel-rules:
          - required
          - email
          - max:255
          type: string
          format: email
          maxLength: 255
      required:
      - email
      x-source:
      - app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:99
    post_api_v1_email_suppressionsRequest:
      type: object
      properties:
        email:
          x-laravel-rules:
          - required
          - email
          - max:255
          type: string
          format: email
          maxLength: 255
        reason:
          x-laravel-rules:
          - required
          - string
          - max:255
          type: string
          maxLength: 255
      required:
      - email
      - reason
      x-source:
      - app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:50
    post_api_v1_email_bouncesRequest:
      type: object
      properties:
        email:
          x-laravel-rules:
          - required
          - email
          - max:255
          type: string
          format: email
          maxLength: 255
        type:
          x-laravel-rules:
          - required
          - string
          - in:hard,soft,complaint
          type: string
          enum:
          - hard
          - soft
          - complaint
        reason:
          x-laravel-rules:
          - nullable
          - string
          - max:200
          type:
          - string
          - 'null'
          maxLength: 200
      required:
      - email
      - type
      x-source:
      - app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:75
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer