List campaign conversation messages

GET /campaigns/{id}/chat/messages

List campaign conversation messages

cURL

curl --request GET \
  --url https://api.pineyard.ai/campaigns/{id}/chat/messages \
  --header 'Authorization: Bearer <token>'

200

{
  "messages": [
    {
      "id": "<string>",
      "role": "<string>",
      "content": "<string>",
      "createdAt": "<string>"
    }
  ],
  "messageCount": 123,
  "remainingMessages": 123
}

Required scope: intel.view

Requires a plan that includes business intelligence (ai tier). Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

messages · object[] · required

Show child attributes

messageCount · number · required

remainingMessages · number · required