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

# Get a Message

> Fetch a message's current status by its Oliver `id` or by the `reference_id` you supplied.



## OpenAPI

````yaml GET /services/core/open_api/v1/messages/{id}
openapi: 3.1.0
info:
  title: Oliver Partner API
  description: API for partners to interact with Oliver
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://partner-api.getoliver.com
security:
  - bearerAuth: []
paths:
  /services/core/open_api/v1/messages/{id}:
    get:
      summary: Get a message
      description: >-
        Fetch a message's current status by its Oliver `id` or by the
        `reference_id` you supplied.
      parameters:
        - name: X-Client-Id
          in: header
          description: The location id of the practice
          required: true
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: The Oliver message id, or your `reference_id`.
          schema:
            type: string
      responses:
        '200':
          description: The message
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/Message'
                  message:
                    type: string
                    nullable: true
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
components:
  schemas:
    Message:
      type: object
      properties:
        id:
          type: string
          description: Oliver's id for the message.
        reference_id:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - sent
            - delivered
            - read
            - failed
            - suppressed
        status_reason:
          type: string
          nullable: true
          description: >-
            Why a message is `suppressed` (`opted_out`, `blocked_number`) or
            `failed`.
        channel_requested:
          type: string
          enum:
            - auto
            - rcs
            - sms
        channel_used:
          type: string
          enum:
            - rcs
            - sms
          nullable: true
          description: >-
            How the client got it. For `auto`, null until the carrier reports
            it; read it from `GET` or the status webhook.
        client_id:
          type: string
          nullable: true
        error_code:
          type: string
          nullable: true
          description: Carrier error code when `failed`.
        error_message:
          type: string
          nullable: true
        sent_at:
          type: string
          format: date-time
          nullable: true
        delivered_at:
          type: string
          format: date-time
          nullable: true
        read_at:
          type: string
          format: date-time
          nullable: true
        failed_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
    GeneralError:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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