Get a conversation transcript

GET

/conversations/{leadId}/messages

curl --request GET \
  --url 'https://app.whatsetter.com/api/v1/conversations/example/messages?limit=25' \
  --header 'Authorization: Bearer <token>'

• Production

All messages exchanged with one lead, newest first. leadId is the lead’s id from /leads or /conversations. Requires scope conversations:read.

Authorizations

• bearerAuth

Parameters

Path Parameters

leadId

required

string

Query Parameters

limit

integer

default: 25 >= 1 <= 100

cursor

string

Opaque cursor from the previous page’s pagination.next_cursor.

Responses

200

Page of messages

Media typeapplication/json

object

data

Array<object>

object

id

string

direction

string

Allowed values: inbound outbound

text

string | null

type

Internal interaction type (e.g. USER_MESSAGE, LEAD_WELCOME)

string | null

has_media

boolean

sent_at

string | null format: date-time

pagination

object

has_more

boolean

next_cursor

string | null

Example

{
  "data": [
    {
      "direction": "inbound"
    }
  ]
}

401

Missing, unknown or revoked API key

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Resource not found in this workspace

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}