Skip to main content
POST
Get all records

Description

Returns all of a user’s memory records, identified by their userReferenceId and the associated botId.

Endpoint

Body parameters

You must send socketId, or userReferenceId together with botId. One of the two forms is required.
string
The user’s external reference identifier.
string
Identifier of the channel associated with the memory.
string
Socket identifier of the user (the flow_token of WhatsApp Flows). Alternative to userReferenceId + botId; it cannot be combined with them. An unknown socketId, or one of another company, answers 404.

Authentication

Every request must include the x-api-key header with an API key that has the memory:read scope.

Request example

cURL

Responses

Response example

Authorizations

x-api-key
string
header
required

API key del proyecto de Jelou

Body

application/json
userReferenceId
string
required

External reference identifier of the user. Use together with botId. Cannot be combined with socketId.

botId
string
required

Identifier of the bot associated with the memory. Use together with userReferenceId. Cannot be combined with socketId.

socketId
string

Socket identifier of the user (the flow_token of WhatsApp Flows). Alternative to userReferenceId + botId. An unknown socketId, or one of another company, answers 404.

Response

Records retrieved successfully.

status
string
Example:

"success"

message
string
Example:

"Records retrieved successfully"

data
object

Map of key to stored value.