---
title: "GET messages"
method: GET
path: "/v3/administrations/{administration_id}/conversations/{conversation_id}/messages"
tags: ["Conversation messages"]
---

# GET messages

`GET /v3/administrations/{administration_id}/conversations/{conversation_id}/messages`

## Request

- Base URL: `https://api.bookingexperts.com`
- URL: `https://api.bookingexperts.com/v3/administrations/{administration_id}/conversations/{conversation_id}/messages`
- Auth: one of:
  - API key in header `X-API-KEY`
  - OAuth 2
    - Authorization code: `/oauth/authorize`
    - Token URL: `/oauth/token`
- TypeScript: <https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/docs/v3/administrations/:administration_id/conversations/:conversation_id/messages/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns messages of the administration

## Path parameters

- `administration_id` string, required
- `conversation_id` string, required

## Query parameters

- `page[number]` integer
- `page[size]` integer
- `sort` string
- `fields[conversation]` string
- `include` string
- `filter[id]` string
- `filter[rid]` string
- `filter[is_open]` string
- `filter[booking]` string

## Headers

- `Accept-Language` string

## Response `200`

ConversationsMessageCollectionResponse

- object
  - `data` ConversationsMessage[]
    - `id` string: ID
    - `type` string: Type
    - `attributes` object: Attributes
      - `kind` 'outbound' | 'inbound': The direction of the message from the administration's point of view. So, inbound is a message from a guest, outbound is a message to a guest.
      - `delivery_status` 'pending' | 'delivered' | 'read' | 'failed': The delivery status of the message. Possible values are pending, delivered, read, and failed. This is currently not updated for inbound messages.
      - `content` string, required
      - `rid` string, required
      - `failure_reason` string
      - `sent_at` string, date-time
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `relationships` object: Relationships
      - `conversation` object
        - `data` object
          - `id` string: conversation ID
          - `type` string
          - `meta` object
            - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
            - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
      - `attachments` object
        - `data` object[]
          - `id` string: attachments ID
          - `type` string
          - `meta` object
            - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
            - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
    - `meta` object: Metadata
      - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known.
  - `included` union[]
    - union
      - Conversation: Conversations is a collection of messages between administration and guest. They're in the context of a booking.
        - `id` string: ID
        - `type` string: Type
        - `attributes` object: Attributes
          - `rid` string, required: The identifier that is used by the external system to track the message
          - `is_open` boolean: Indicates whether the conversation is open or closed.
        - `relationships` object: Relationships
          - `booking` object
            - `data` object
              - …
        - `meta` object: Metadata
          - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known.
      - ConversationsMessagesAttachment: An attachment associated with a conversation message.
        - `id` string: ID
        - `type` string: Type
        - `attributes` object: Attributes
          - `filename` string: The filename of the attachment
          - `data` string, byte: Base64-encoded image or video data. Supported formats are: jpg, gif, png, webp, mp4 and mov
          - `created_at` string, date-time
          - `updated_at` string, date-time
        - `links` object: Links
          - `attachment_url` string: Link to attachment_url
        - `relationships` object: Relationships
          - `message` object
            - `data` object
              - …
        - `meta` object: Metadata
          - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known.
  - `meta` object
    - `pagination` object
      - `total_records` integer
      - `page` integer
      - `size` integer

## Other responses

- `429`: Error
- `default`: Error

---

[API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)