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

# Get a received message

> Returns the metadata, the state of the parsed content and the webhook deliveries of a received message. Contains no content. Requires the permission "Read received messages".



## OpenAPI

````yaml /api-reference/openapi.yaml get /receiving/messages/{id}
openapi: 3.1.0
info:
  title: Talario API
  version: '1.0'
  description: REST API for received messages and webhook deliveries.
servers:
  - url: https://talario.eu/api/v1
security:
  - apiKey: []
tags:
  - name: Received messages
  - name: Webhook deliveries
paths:
  /receiving/messages/{id}:
    get:
      tags:
        - Received messages
      summary: Get a received message
      description: >-
        Returns the metadata, the state of the parsed content and the webhook
        deliveries of a received message. Contains no content. Requires the
        permission "Read received messages".
      operationId: getReceivedMessage
      parameters:
        - $ref: '#/components/parameters/MessageId'
      responses:
        '200':
          description: The received message.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/ReceivedMessage'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    MessageId:
      name: id
      in: path
      required: true
      description: Talario's ID of the received message.
      schema:
        type: string
        format: uuid
  schemas:
    ReceivedMessage:
      type: object
      required:
        - id
        - domain
        - received_at
        - envelope_from
        - storage_status
        - content_status
        - recipients
      properties:
        id:
          type: string
          format: uuid
        domain:
          type: string
        received_at:
          type: string
          format: date-time
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
        envelope_from:
          type: string
        message_id:
          type:
            - string
            - 'null'
          description: The `Message-ID` header, chosen by the sender.
        storage_status:
          type: string
          enum:
            - pending
            - stored
            - failed
        size_bytes:
          type:
            - integer
            - 'null'
        sha256:
          type:
            - string
            - 'null'
        content_status:
          type: string
          enum:
            - pending
            - ready
            - failed
          description: State of the parsed content.
        parse_status:
          type:
            - string
            - 'null'
          enum:
            - parsed
            - failed
            - null
          description: Result of parsing once `content_status` is `ready`.
        recipients:
          type: array
          items:
            type: object
            required:
              - recipient
              - last_event
              - deliveries
            properties:
              recipient:
                type: string
              last_event:
                $ref: '#/components/schemas/LastEvent'
              deliveries:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookDelivery'
    LastEvent:
      type: object
      description: Latest storage or webhook event for the recipient.
      required:
        - type
        - occurred_at
        - http_status
        - error_code
      properties:
        type:
          type: string
          enum:
            - received
            - inbound_stored
            - inbound_storage_failed
            - webhook_attempted
            - webhook_succeeded
            - webhook_failed
            - webhook_cancelled
        occurred_at:
          type: string
          format: date-time
        http_status:
          type:
            - integer
            - 'null'
          description: HTTP status of the latest webhook attempt.
        error_code:
          type:
            - string
            - 'null'
          description: Machine-readable reason of a failure.
    WebhookDelivery:
      type: object
      required:
        - delivery_id
        - endpoint_id
        - payload_version
        - status
        - attempts
      properties:
        delivery_id:
          type: string
          format: uuid
        endpoint_id:
          type:
            - string
            - 'null'
          description: '`null` if the endpoint was deleted.'
        payload_version:
          type: integer
          enum:
            - 1
            - 2
        status:
          type: string
          enum:
            - pending
            - succeeded
            - failed
            - cancelled
        attempts:
          type: integer
        last_attempt_at:
          type:
            - string
            - 'null'
          format: date-time
        last_http_status:
          type:
            - integer
            - 'null'
        last_error_code:
          type:
            - string
            - 'null'
        next_attempt_at:
          type:
            - string
            - 'null'
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: message_expired
            message:
              type: string
            fields:
              type: object
              description: Invalid fields with their messages; only for `invalid_payload`.
              additionalProperties:
                type: array
                items:
                  type: string
  responses:
    Unauthenticated:
      description: '`unauthenticated`: the API key is missing, invalid or revoked.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        `forbidden`: the API key lacks the permission, or the project is
        suspended.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: >-
        `not_found`: the resource does not exist or is outside the scope of the
        API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: '`too_many_requests`: a rate limit was exceeded.'
      headers:
        Retry-After:
          description: Seconds to wait before the next request.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: API key of your project, starting with `tlr_api_`.

````

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