HollrAI APIConversations

List conversations for a specific campaign

View as Markdown

Uses POST (not GET) because campaignId is passed in the request body rather than as a path/query param.

Authentication

hollr-api-keystring

API key issued for your account. Every request is logged and rate-limited against this key.

Query parameters

pageintegerOptionalDefaults to 1
limitintegerOptionalDefaults to 50
statusstringOptional
Filter by conversation status.
directionenumOptional
Allowed values:
tagstringOptional
startDatedatetimeOptional
endDatedatetimeOptional
sortBystringOptionalDefaults to createdAt
sortOrderenumOptionalDefaults to desc
Allowed values:

Request

This endpoint expects an object.
campaignIdstringRequiredformat: "uuid"

Response

Campaign conversations retrieved.
statusstringOptional
messagestringOptional
datalist of objectsOptional
campaignIdstringOptionalformat: "uuid"
paginationobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error