Approval Workflow2

Async API Status1

ATS Candidate5

ATS Position6

Booking7

Career Navigator2

Careerhub5

Comment9

Course5

Demand7

Email Delivery Feedback3

Employee12

Employee Role2

Entity Changelog1

Entity Profile Application3

Event Candidate Activity3

Events3

Ext AI Interview3

Ext Booking5

Ext Demand7

Ext Demand Org Unit3

Foundational Data4

Hiring Company2

Holiday7

HRIS Employee2

Insights3

JIE6

Join Talent Pool1

Offer6

Org Unit1

Performance Feedback4

Position9

Profile12

Profile Application3

Profile Feedback3

Profile Note4

Profile Tag4

Question2

Succession Plan12

Upskill Plan Assignment8

Upskill Plan Template8

User Calendar Event3

User Campaign3

User Groups8

User Message3

Users6

User Message

Get User Message

Changed on Nov 3, 2026

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

get/api/v2/core/user-messages/{userMessageId}

Request

Base URL
https://apiv2.eightfold.ai
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/core/user-messages/:userMessageId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userMessageIdstring required

Id of user message in Eightfold

Query parameters

includestring

Include additional fields in the response. Possible values are emailContent, messageContent

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

createdAtinteger nullable

Creation timestamp for the user message

plannedEventIdinteger nullable

Decrypted Event ID

parentMessageIdstring nullable

Parent message id of the user message

emailTostring nullable

Recipient of the user message with type email

profileIdstring nullable

Profile Id associated with the user message

failureReasonstring nullable

Reason of failure of the user message

messageTostring nullable

Recipient of the user message

companystring nullable

Company name associated with user message

userIdstring nullable

User who initiated sending this user message

userCampaignIdinteger nullable

User Campaign Id associated with the user message

conversationIdstring nullable

Conversation Id associated with the user message

workflowRecipeIdinteger nullable

Workflow recipe id associated with user message

conversationTypestring nullable

Conversation Type associated with the user message e.g. email, sms

emailBccstring nullable

Email blind carbon copy addresses in comma separated format

templateIdinteger nullable

Template Id associated with the user message

readTimeinteger nullable

Read timestamp for the user message

replyTimeinteger nullable

Reply timestamp for the user message

idstring nullable

Object id of the user message

emailCcstring nullable

Email carbon copy addresses in comma separated format

failureTimeinteger nullable

Time of failure of the user message

emailContentstring nullable

Email file content of the message. This is an email content with Internet Message Format specification (RFC 5322)

deliveryTimeinteger nullable

Delivery timestamp for the user message

messageFromstring nullable

Sender of the user message

statusstring nullable

Status of the user message

subjectstring nullable

Subject of the user message with type email

emailReplyTostring nullable

Reply-To as set in the email envelope of the user message with type email

readCountinteger nullable

Read count for the user message

emailFromstring nullable

Sent-on-behalf-of if different from user_id of the user message with type email

clickTimeinteger nullable

Click timestamp for the user message

clickCountinteger nullable

Click count for the user message

positionIdinteger nullable

Position Id associated with the user message

Changes

Nov 3, 20269a8b3a927e93 Revision changes
- info
  added the optional property ///// to the response with the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response optional property ///// became not read-only for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status

Operation history