List User Messages

get

https://apiv2.{domain}.ai/api/v2/core/user-messages

Search user messages using specific filter parameters and get all attributes of entities

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

Specifies the offset value to start for the page

limit

integer

Specifies the number of entries to be returned for the page

queryLimit

string

Limit on the total number of search results, defaults to 100

userId

string

Filter on user id of the message

profileId

string

Filter on profile id of the candidate

positionId

string

Filter on position id associated with the message

conversationId

string

Filter on conversation id of the message

emailTo

string

Filter on email address to which email message was addressed

emailFrom

string

Filter on email address from which email message was sent

userCampaignId

string

Filter on campaign id of the user message

templateId

string

Filter on template id of the user message

createdAt

string

Filter on create timestamp of user message

replyTime

string

Filter on reply time of user message

include

string

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

exclude

string

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.

keyList

string

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

Authorization

string

required

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

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK