Skip to main content
GET
Required token scopes: View notes of all chats Filters match the note’s original author, not its last editor. When you set several filters, a note must match all of them. Array parameters use brackets: send authorSources[]=bot&authorSources[]=api. A plain authorSources=bot is rejected with 400. total counts every note that matches the filters, not only the notes on this page. More pages exist while skip + the number of returned notes is less than total.

Authorizations

Authorization
string
header
required

API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.

Path Parameters

chatId
string
required

The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the contact's phone number

Query Parameters

skip
string

How many notes to skip. Defaults to 0

Pattern: ^\d+$
limit
string

Maximum notes to return (1-1000). Defaults to 100

Pattern: ^\d+$
authorSources[]
enum<string>[]

Return notes whose original author comes from any of these sources: user (an agent in the inbox), bot, scenario, api (any API token), unknown. Repeat the parameter for several sources. Duplicate values return 400

Minimum array length: 1
Available options:
user,
bot,
scenario,
api,
unknown
authorUid
string

Return notes written by the agent with this user ID (the author.actor.uid of that agent's notes)

Minimum string length: 1
authorCustomName
string

Return notes whose author customName is exactly this value

Minimum string length: 1

Response

A page of notes, newest first

notes
object[]
required

Notes on this page, newest first

total
integer
required

Number of notes in the chat that match the filters, across all pages