---
title: "Get a message"
method: GET
path: "/conversations/v3/custom-channels/{channelId}/messages/{messageId}"
tags: ["Messages"]
---

# Get a message

`GET /conversations/v3/custom-channels/{channelId}/messages/{messageId}`

## Request

- Base URL: `https://api.hubapi.com`
- URL: `https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/messages/{messageId}`
- Auth: OAuth 2
  - Authorization code: `https://app.hubspot.com/oauth/authorize`
  - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `conversations.custom_channels.read`

Get the details for a specific message sent over a custom channel

## Path parameters

- `channelId` integer, required
- `messageId` string, required

## Response `200`

successful operation

- PublicConversationsMessage
  - `archived` boolean, required
  - `attachments` union[], required
    - union
      - PublicFile
        - `fileId` string, required
        - `fileUsageType` 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING', required
        - `name` string
        - `type` 'FILE', required
        - `url` string
      - PublicLocation
        - `address` string
        - `latitude` number, required
        - `longitude` number, required
        - `name` string
        - `type` 'LOCATION', required
        - `url` string
      - PublicContact
        - `contactProfile` ContactProfile, required
          - `addresses` ContactAddress[], required
            - `city` string
            - `country` string
            - `countryCode` string
            - `state` string
            - `street` string
            - `type` 'HOME' | 'WORK'
            - `zip` string
          - `emails` ContactEmail[], required
            - `email` string, required
            - `type` 'HOME' | 'WORK'
          - `name` ContactName
            - `firstName` string
            - `lastName` string
            - `middleName` string
            - `prefix` string
            - `suffix` string
          - `org` ContactOrg
            - `company` string
            - `department` string
            - `title` string
          - `phones` ContactPhone[], required
            - `phone` string, required
            - `type` 'CELL' | 'HOME' | 'MAIN' | 'WORK'
          - `urls` ContactUrl[], required
            - `type` 'HOME' | 'WORK'
            - `url` string, required
        - `type` 'CONTACT', required
      - PublicUnsupportedContent
        - `type` 'UNSUPPORTED_CONTENT', required
      - PublicMessageHeader
        - `fileId` integer
        - `text` string
        - `type` 'MESSAGE_HEADER', required
      - PublicQuickReplies
        - `allowMultiSelect` boolean, required
        - `allowUserInput` boolean, required
        - `quickReplies` QuickReply[], required
          - `label` string
          - `value` string, required
          - `valueType` 'TEXT' | 'URL', required
        - `type` 'QUICK_REPLIES', required
      - PublicWhatsAppTemplateMetadata
        - `contentId` integer
        - `crmObjectIds` object, required
        - `mappedTemplateId` integer
        - `parameters` object, required
        - `rootMicId` integer
        - `type` 'WHATSAPP_TEMPLATE_METADATA', required
      - PublicSocialMetadataAttachment
        - `socialMetadata` SocialMetadata, required
          - `description` string
          - `id` string
          - `mediaTitle` string
          - `mediaType` 'ARTICLE' | 'AUDIO' | 'CAROUSEL' | 'DOCUMENT' | 'GIF' | 'LINK' | 'NONE' | 'PHOTO' | 'POLL' | 'STORY' | 'VIDEO', required
          - `mediaUrl` string
          - `mediaUrlString` string
          - `thumbnailUrl` string
        - `type` 'SOCIAL_MEDIA_METADATA', required
  - `channelAccountId` string, required
  - `channelId` string, required
  - `client` PublicClient, required
    - `clientType` 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN', required
    - `integrationAppId` integer
  - `conversationsThreadId` string, required
  - `createdAt` string, date-time, required
  - `createdBy` string, required
  - `direction` 'INCOMING' | 'OUTGOING', required
  - `id` string, required
  - `inReplyToId` string
  - `recipients` PublicRecipient[], required
    - `actorId` string
    - `deliveryIdentifier` PublicDeliveryIdentifier, required
      - `type` 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE', required
      - `value` string, required
    - `name` string
    - `recipientField` string
  - `richText` string
  - `senders` PublicSender[], required
    - `actorId` string
    - `deliveryIdentifier` PublicDeliveryIdentifier
      - `type` 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE', required
      - `value` string, required
    - `name` string
    - `senderField` string
  - `status` PublicMessageStatus
    - `failureDetails` PublicMessageFailureDetails
      - `errorMessage` string
      - `errorMessageTokens` object, required
    - `statusType` 'FAILED' | 'READ' | 'RECEIVED' | 'SENT', required
  - `subject` string
  - `text` string, required
  - `truncationStatus` 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY', required
  - `type` 'MESSAGE', required
  - `updatedAt` string, date-time

## Other responses

- `default`: An error occurred.

## Changes

- **2026-07-13** (v3) `5cdcacfbfd17`: 1 info
  - endpoint added
- **2026-07-13** (v3) `00e6adb0221a`: 1 breaking
  - api path removed without deprecation
- **2026-05-22** (v3) `1555463e652b`: 2 info
  - the security scope `conversations.custom_channels.read` was added to the endpoint's security scheme `oauth2`
  - the security scope `channel-integration-read` was removed from the endpoint's security scheme `oauth2`
- **2026-04-09** (v3) `6e5d9e1a7c16`: 3 info
  - the endpoint scheme security `private_apps` was removed from the API
  - the security scope `channel-integration-read` was added to the endpoint's security scheme `oauth2`
  - the security scope `conversations.custom_channels.read` was removed from the endpoint's security scheme `oauth2`
- **2026-03-25** (v3) `ef056bda2974`: 2 info
  - api tag `Messages` added
  - api tag `Basic` removed

[Operation history](https://skmtc.dev/hubspot/apis/conversations-custom-channels/changes/conversations/v3/custom-channels/:channelId/messages/:messageId/get.md)

---

[API](https://skmtc.dev/hubspot/apis/conversations-custom-channels.md) - [All operations](https://skmtc.dev/hubspot/apis/conversations-custom-channels/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/conversations-custom-channels/revisions/b6d4942824fa?raw)
