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

# Retrieve an email



## OpenAPI

````yaml openapi-core.json GET /v1/emails/{id}
openapi: 3.1.0
info:
  title: Yorlet Core API
  description: Core platform APIs including buildings, customers, units, and tasks.
  version: 1.0.0
servers:
  - url: https://api.yorlet.com
    description: Production
  - url: https://api.yorlet.io
    description: Sandbox
security: []
paths:
  /v1/emails/{id}:
    get:
      tags:
        - Emails
      summary: Retrieve an email
      operationId: messages_retrieve
      parameters:
        - schema:
            type: string
            description: The id identifier.
          required: true
          description: The id identifier.
          name: id
          in: path
      responses:
        '200':
          description: Returns the message object if a valid identifier was provided.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier for the object.
                  created:
                    type: number
                    description: >-
                      Time at which the object was created. Measured in seconds
                      since the Unix epoch.
                  account:
                    type: string
                    description: >-
                      The account that the object belongs to. Only returned if
                      the request is made with a valid Yorlet-Context header.
                  deleted:
                    type: boolean
                    default: false
                    description: Only returned if the object has been deleted.
                  object:
                    type: string
                    enum:
                      - message
                  actor:
                    type:
                      - object
                      - 'null'
                    properties:
                      type:
                        type: string
                        enum:
                          - user
                          - agent
                          - api_key
                          - system
                        description: The kind of principal that performed the action.
                      user:
                        anyOf:
                          - type: string
                          - type: object
                            properties:
                              id:
                                type: string
                                description: Unique identifier for the object.
                              created:
                                type: number
                                description: >-
                                  Time at which the object was created. Measured
                                  in seconds since the Unix epoch.
                              account:
                                type: string
                                description: >-
                                  The account that the object belongs to. Only
                                  returned if the request is made with a valid
                                  Yorlet-Context header.
                              deleted:
                                type: boolean
                                default: false
                                description: Only returned if the object has been deleted.
                              object:
                                type: string
                                enum:
                                  - user
                              email:
                                type: string
                              name:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                              - created
                              - object
                              - email
                              - name
                          - type: 'null'
                        description: >-
                          Present when `type` is `user`. The user id, or the
                          user object when expanded with `actor.user`.
                      key:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Present when `type` is `agent` or `api_key`. The id of
                          the key that performed the action.
                    description: >-
                      The principal that sent this message. Set for outbound
                      messages; `null` for inbound messages and for messages
                      recorded before actor attribution existed.
                    required:
                      - type
                  body:
                    type: string
                    description: Plain-text body, common to all channels.
                  channel:
                    type: string
                    enum:
                      - email
                    description: >-
                      The communication channel for this thread. `email` today;
                      additional channels may be added later.
                  direction:
                    type: string
                    enum:
                      - inbound
                      - outbound
                    description: >-
                      Whether the message was sent by the account or received
                      from a counterparty.
                  email:
                    type: object
                    properties:
                      attachments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The attachment id, when available.
                            filename:
                              type:
                                - string
                                - 'null'
                              description: The attachment filename.
                            content_type:
                              type:
                                - string
                                - 'null'
                              description: The MIME type of the attachment.
                        description: Attachments on the email, metadata only.
                      cc:
                        type: array
                        items:
                          type: string
                        description: CC recipients.
                      email_record_id:
                        type:
                          - string
                          - 'null'
                        description: The `email_records` id for outbound sends.
                      from:
                        type: string
                        description: The From address.
                      html:
                        type:
                          - string
                          - 'null'
                        description: HTML body, when available.
                      in_reply_to:
                        type:
                          - string
                          - 'null'
                        description: The Message-ID this email replies to.
                      message_id:
                        type:
                          - string
                          - 'null'
                        description: The RFC Message-ID.
                      subject:
                        type:
                          - string
                          - 'null'
                        description: The email subject.
                      to:
                        type: array
                        items:
                          type: string
                        description: To recipients.
                    description: Email-specific fields. Present when `channel` is `email`.
                    required:
                      - attachments
                      - cc
                      - email_record_id
                      - from
                      - html
                      - in_reply_to
                      - message_id
                      - subject
                      - to
                  thread:
                    type: string
                    description: The thread this message belongs to.
                required:
                  - id
                  - created
                  - object
                  - actor
                  - body
                  - channel
                  - direction
                  - thread
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API Key authentication. Use "Bearer YOUR_API_KEY".

````

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