> ## Documentation Index
> Fetch the complete documentation index at: https://empirical.run/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an allowed recipient

> Returns an allowed recipient. While pending, it checks for the verification email and explains why the latest one didn't count. Poll it after sending the email.



## OpenAPI

````yaml /api-reference/openapi.generated.json get /api/allowed-recipients/{id}
openapi: 3.1.0
info:
  title: Empirical API
  version: 1.0.0
  description: Programmatic access to Empirical test runs, snoozes, and more.
  contact:
    name: Empirical
    url: https://empirical.run
servers:
  - url: https://api.empirical.run
security:
  - Bearer: []
tags:
  - name: Test Runs
    description: Trigger, list, and inspect end-to-end test runs.
  - name: Test Cases
    description: >-
      Browse the Playwright test cases synced from a project's repository and
      manage their tags.
  - name: Environments
    description: >-
      Named deployment targets (slug + Playwright project filters) a project's
      tests run against.
  - name: Snoozes
    description: Temporarily suppress known test failures for specific Playwright tests.
  - name: KV
    description: >-
      Project-scoped key-value store shared by test runs, shards and agent
      sessions. Every entry expires; conditional writes make it safe for locks.
  - name: Analytics
    description: Aggregated test-run, test-count and test-case analytics for a project.
  - name: Allowed recipients
    description: >-
      Domains and addresses a project's inboxes may send email to, besides
      @empiricalrun.email addresses and people who emailed the inbox. Each one
      is verified in one of two ways. **Email from it**: send an email from the
      domain (any mailbox on it) or from the exact address to the verification
      address, with the verification code in the subject. It must pass DMARC.
      **Emailed code**, for addresses that can't send (e.g.
      `support@acme.zendesk.com`): we email the address a 6-digit code, and you
      enter it from wherever that address delivers. A domain covers exactly that
      domain, not its subdomains; add a subdomain such as `inbound.acme.com` on
      its own, and an email from `@acme.com` verifies it. Public mail providers
      (gmail.com, outlook.com and similar) can't be added as domains; add the
      exact address instead. An address also covers its plus-variants. Domains
      reserved for examples and tests (example.com, example.net, example.org,
      and anything under .test, .example, .invalid or .localhost) can't receive
      email, so codes are never emailed to them.
  - name: Badges
    description: Public README status badge images (SVG) for project environments.
  - name: Files
    description: >-
      Upload files of any type and get a link to use in tasks, sessions and
      messages. Agents should use the `upload_file` tool, which returns a
      project-wide `file@<id>` handle (`<id>` is the file `id` below).
  - name: Inboxes
    description: >-
      Test email addresses on @empiricalrun.email that a project claims. Only
      the claiming project can read an inbox, and only mail received after the
      claim. Typical flow: claim an address, sign up or log in to your app with
      it, then list the inbox's messages. Inboxes can also send mail, e.g. to
      test an app that processes inbound email: to @empiricalrun.email
      addresses, to anyone who emailed the inbox, and to the project's allowed
      recipients. Replies land back in the sending inbox.
  - name: Infra
    description: >-
      Infrastructure details customers configure against, such as static egress
      IPs.
  - name: Reporter Configuration
    description: Reporters a project can use in environment and run reporter configs.
  - name: Webhook Captures
    description: >-
      Throwaway URLs that record every request sent to them, for testing
      webhooks your app sends.
paths:
  /api/allowed-recipients/{id}:
    get:
      tags:
        - Allowed recipients
      summary: Get an allowed recipient
      description: >-
        Returns an allowed recipient. While pending, it checks for the
        verification email and explains why the latest one didn't count. Poll it
        after sending the email.
      operationId: getAllowedRecipient
      parameters:
        - schema:
            type: integer
            minimum: 1
            description: Allowed recipient ID.
          required: true
          description: Allowed recipient ID.
          name: id
          in: path
      responses:
        '200':
          description: The allowed recipient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedRecipientResponse'
        '404':
          description: Allowed recipient not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AllowedRecipientResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            recipient:
              $ref: '#/components/schemas/AllowedRecipient'
          required:
            - recipient
          description: Response payload.
      required:
        - data
    ErrorResponse:
      type: object
      properties:
        data:
          nullable: true
          description: Always null for error responses.
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message.
          required:
            - message
          description: Error details.
      required:
        - data
        - error
    AllowedRecipient:
      type: object
      properties:
        id:
          type: integer
          description: Allowed recipient ID.
        kind:
          type: string
          enum:
            - domain
            - address
          description: Whether this allows a whole domain or one address.
        value:
          type: string
          description: The domain (exact match), or the address without any `+tag`.
        status:
          type: string
          enum:
            - pending
            - verified
            - expired
          description: >-
            `pending` until verified, `expired` when verification didn't finish
            within 7 days. Add it again to renew.
        verification_address:
          type: string
          nullable: true
          description: Address to send the verification email to. Null once verified.
        verification_code:
          type: string
          nullable: true
          description: >-
            Code the verification email's subject must contain. Null once
            verified.
        expires_at:
          type: string
          nullable: true
          description: ISO 8601 time the pending verification expires. Null once verified.
        code_expires_at:
          type: string
          nullable: true
          description: >-
            ISO 8601 time the emailed 6-digit code expires, if one was sent and
            the recipient isn't verified yet.
        verified_at:
          type: string
          nullable: true
          description: ISO 8601 verification time.
        verified_via:
          type: string
          nullable: true
          enum:
            - email
            - code
          description: >-
            `email` when verified by an email from it, `code` when verified with
            an emailed code.
        verified_by:
          type: string
          nullable: true
          description: Sender of the verification email, when verified by email.
        last_rejection:
          type: string
          nullable: true
          description: >-
            Why the latest email to the verification address didn't verify it,
            if one arrived.
        created_at:
          type: string
          description: ISO 8601 time it was added.
      required:
        - id
        - kind
        - value
        - status
        - verification_address
        - verification_code
        - expires_at
        - code_expires_at
        - verified_at
        - verified_via
        - verified_by
        - last_rejection
        - created_at
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.