Data model

Conversations

Lightweight communication log: a single call / sms / video / in-person check-in. Logging one bumps the parent contact's last_contacted_at via the bump_last_contacted hook, so the stay-in-touch dashboard updates automatically.

Model name: conversation

Endpoints: 5

Max page size: 200

Fields

Per-field validation rules. Values that violate any constraint are rejected with 400 before they reach the database.

Field	Type	Constraints
channel	`enum`	enum`call \| sms \| whatsapp \| email \| in_person \| video \| voice \| letter \| other`
content	`string`	max length`8000`
summary	`string`	max length`400`
parent_id	`string`	max length`64`ref →`contact`owned
sentiment	`enum`	enum`positive \| neutral \| negative`
occurred_at	`string`	max length`32`
duration_minutes	`number`	-

Mutability

Which fields can you send, and when? Anything without a marker is server-managed - sending it isn't an error, it's silently ignored.

Create-only - read from POST body.Patchable - read from PATCH body.Server-managed - ignored on the body.

Field	Type	Create	Patch
channel	enum
content	string
summary	string
parent_id	string
sentiment	enum
occurred_at	string
duration_minutes	number

Fields marked create-only but not patchable are immutable after creation. Server-managed fields include id, timestamps, ownership, and status.

Filtering & sorting

Combinable on list endpoints. Repeating a filter key produces an IN clause; prefixing a sort key with - reverses direction. Example: ?status=open&status=blocked&sort=-created_at.

Filter keys

parent_iddata__parent_id

channeldata__channel

sentimentdata__sentiment

statusstatus

is_archivedis_archived

owned_byowned_by

Sort keys

created_atcreated_at

occurred_atdata__occurred_at

Default: occurred_at

Endpoints

Each endpoint below lists its HTTP method, path, and the PAT scope it needs. Code samples cover curl, JavaScript, TypeScript, Python, Rust, Java, and WebSocket.

GET/xapi2/data/conversationconversation:list

List objects

Returns a paginated list of objects you can read. Default page size is 20; pass ?limit= to change (capped per type). Use ?after=<id> for keyset pagination on created_at-sorted lists, or ?offset= for offset paging.

curl -H "Authorization: Bearer pat_…" \
     "https://friendship-tracker.com/xapi2/data/conversation?limit=20"

GET/xapi2/data/conversation/{id}conversation:read

Read one

Returns the object by id. 404 if it does not exist or you cannot read it (the two cases are intentionally conflated).

curl -H "Authorization: Bearer pat_…" \
     https://friendship-tracker.com/xapi2/data/conversation/OBJECT_ID

POST/xapi2/data/conversationconversation:create

Create

Creates a new object. Body is a flat JSON dict of field values. Server-side fields (id, timestamps, ownership) are filled automatically; only fields listed below as creatable are read from the body.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X POST https://friendship-tracker.com/xapi2/data/conversation \
     -d '{"name": "…"}'

PATCH/xapi2/data/conversation/{id}conversation:update

Update

Partial update. Only fields included in the body are touched; everything else is preserved. Same allow-list as create, minus the fields that are immutable post-create.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X PATCH https://friendship-tracker.com/xapi2/data/conversation/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/conversation/{id}conversation:delete

Delete

Removes the object. It vanishes from every default list immediately and stops being returned by read / list.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://friendship-tracker.com/xapi2/data/conversation/OBJECT_ID

Use in CLI

The same endpoints are also exposed via the Friendship Tracker CLI. For scripts, CI, and bulk imports it's usually the faster path.

friendshipcli conversation list --limit 5
friendshipcli conversation get <id>
friendshipcli conversation create --parent-id "Hello"
friendshipcli conversation upsert --unique parent_id --csv items.csv
friendshipcli conversation schema   # fields & limits

Full command reference, profiles, CSV import, auto-retry, NDJSON streaming → /docs/cli