v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
User Message

List User Messages

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

get/api/v2/core/user-messages

Query parameters

startinteger

Specifies the offset value to start for the page

limitinteger

Specifies the number of entries to be returned for the page

queryLimitstring

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

userIdstring

Filter on user id of the message

profileIdstring

Filter on profile id of the candidate

positionIdstring

Filter on position id associated with the message

conversationIdstring

Filter on conversation id of the message

emailTostring

Filter on email address to which email message was addressed

emailFromstring

Filter on email address from which email message was sent

userCampaignIdstring

Filter on campaign id of the user message

templateIdstring

Filter on template id of the user message

createdAtstring

Filter on create timestamp of user message

replyTimestring

Filter on reply time of user message

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

OK