---
title: "Get User Message"
method: GET
path: "/api/v2/core/user-messages/{userMessageId}"
tags: ["User Message"]
---

# Get User Message

`GET /api/v2/core/user-messages/{userMessageId}`

Given a user message id, it returns all attributes of the user message

## Path parameters

- `userMessageId` string, required

## Query parameters

- `include` string
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- UserMessageSchema
  - `createdAt` integer, nullable — Creation timestamp for the user message
  - `plannedEventId` integer, nullable — Decrypted Event ID
  - `parentMessageId` string, nullable — Parent message id of the user message
  - `emailTo` string, nullable — Recipient of the user message with type email
  - `profileId` string, nullable — Profile Id associated with the user message
  - `failureReason` string, nullable — Reason of failure of the user message
  - `messageTo` string, nullable — Recipient of the user message
  - `company` string, nullable — Company name associated with user message
  - `userId` string, nullable — User who initiated sending this user message
  - `userCampaignId` integer, nullable — User Campaign Id associated with the user message
  - `conversationId` string, nullable — Conversation Id associated with the user message
  - `workflowRecipeId` integer, nullable — Workflow recipe id associated with user message
  - `conversationType` string, nullable — Conversation Type associated with the user message e.g. email, sms
  - `emailBcc` string, nullable — Email blind carbon copy addresses in comma separated format
  - `templateId` integer, nullable — Template Id associated with the user message
  - `readTime` integer, nullable — Read timestamp for the user message
  - `replyTime` integer, nullable — Reply timestamp for the user message
  - `id` string, nullable — Object id of the user message
  - `emailCc` string, nullable — Email carbon copy addresses in comma separated format
  - `failureTime` integer, nullable — Time of failure of the user message
  - `plannedEvent` PlannedEventSchema
    - `createdAt` integer, nullable — Timestamp when this event was created
    - `isCancelled` boolean, nullable
    - `eventSpeakers` string[], nullable — List of speakers
    - `activeRegistrations` string, nullable — active registrations
    - `registerButton` RegisterButton
      - `textColor` string, nullable — text color for registration button
      - `backgroundColor` string, nullable — background color of registration button
      - `text` string, nullable — Text of registration button
    - `eventTeamDataJson` object, nullable — Event team data
    - `eventBucket` string, nullable — Bucket of the event
    - `address` string, nullable — Address of venue
    - `eventCustomFieldsJson` object, nullable — Event custom fields
    - `eventType` string, nullable
    - `institution` string, nullable — Institution related to event
    - `selectedTimezone` string, nullable — Selected time zome
    - `name` string, nullable — Name of the event
    - `homePageBanner` HomePageBanner
      - `useImage` boolean, nullable — boolean value for using image
      - `image` string, nullable — image of home page banner
      - `title` string, nullable — title for home page
    - `eventLocationType` string, nullable
    - `id` string, nullable — id
    - `parentId` string, nullable — Parent id of the event
    - `venue` string, nullable — Venue of the event
    - `endTimestamp` integer, nullable — Ending timestamp of event
    - `isPublished` boolean, nullable
    - `eventLandingPage` string, nullable — Event landing page
    - `status` string, nullable
    - `createdBy` string, nullable — User id which created this event
    - `eventCategory` string, nullable — Category of the event
    - `startTimestamp` integer, nullable — Starting time stamp of event
    - `when` string, nullable — When tag of the event
    - `description` string, nullable — Description of event
  - `emailContent` string, nullable — Email file content of the message. This is an email content with Internet Message Format specification (RFC 5322)
  - `deliveryTime` integer, nullable — Delivery timestamp for the user message
  - `messageFrom` string, nullable — Sender of the user message
  - `status` string, nullable — Status of the user message
  - `subject` string, nullable — Subject of the user message with type email
  - `emailReplyTo` string, nullable — Reply-To as set in the email envelope of the user message with type email
  - `readCount` integer, nullable — Read count for the user message
  - `emailFrom` string, nullable — Sent-on-behalf-of if different from user_id of the user message with type email
  - `messageContent` UserMessageContent
    - `attachments` MessageAttachment[], nullable — List of attachments of the user message
      - `contentType` string, nullable — Mime type of the attachment
      - `fileName` string, nullable — File name of the attachment
      - `content` string, nullable — Content of the attachment
      - `isBased64Encoded` boolean, nullable — Flag to indicate if the content is base64 encoded
    - `body` string, nullable — Message body of the user message
  - `clickTime` integer, nullable — Click timestamp for the user message
  - `clickCount` integer, nullable — Click count for the user message
  - `positionId` integer, nullable — Position Id associated with the user message

---

[API](https://skmtc.dev/eightfold/apis/api-server-v2-service-service.md) · [All operations](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/eightfold/api-server-v2-service-service/revisions/0fb26f4e41bf/schema)