Entity reference · v1

accounts

ACCT-NNNNNNtable accountssoft delete

Organisations we deal with (customers, prospects, partners, internal) with lifecycle, health, ARR, churn risk.

Endpoints

GET/api/v1/accountsList accounts

POST/api/v1/accountsCreate accounts

GET/api/v1/accounts/{id}Read one

PATCH/api/v1/accounts/{id}Update

DELETE/api/v1/accounts/{id}Soft-delete (?hard=true to skip trash)

POST/api/v1/accounts/{id}/restoreRestore from trash

GET/api/v1/accounts/{id}/links/feedbackList linked feedback

POST/api/v1/accounts/{id}/links/feedbackAdd link

DELETE/api/v1/accounts/{id}/links/feedback/{targetId}Unlink

GET/api/v1/accounts/{id}/links/meetingsList linked meetings

POST/api/v1/accounts/{id}/links/meetingsAdd link

DELETE/api/v1/accounts/{id}/links/meetings/{targetId}Unlink

Writable fields

* required on create. PATCH treats every field as optional.

Field	Type	Constraints	Notes
name*	string
relationship	string	`customer \| prospect \| partner \| internal`	What this account is: customer, prospect, partner or internal. Defaults to customer.
status	string	`active \| poc \| lapsed \| churned`	Where the relationship stands: active, poc, lapsed or churned. Defaults to active.
segment	string	`enterprise \| mid-market \| smb \| startup \| internal`	Customer segment, lowercase. 'Mid-Market' and friends were legal before migration 00081 and are still accepted, stored lowercased.
arr	float	≥ 0
health_score	integer	≥ 0 · ≤ 100
churn_risk	string	`low \| medium \| high \| critical`
users_count	integer	≥ 0
primary_contact	string		The primary contact's name. It mirrors the account's primary contact (contacts with is_primary): writing it renames that person, or adds them when the account has none.
primary_contact_email	string		The primary contact's email. Writing an address makes the account's contact with that address its primary contact, adding the person when there is none.
plan	string	`enterprise \| growth \| starter`
tags	string[]
last_activity	timestamp
is_draft	boolean
metadata	json

Listing & filtering

Pagination: ?limit=50&offset=0 · max limit 200
Default sort: ?sort=arr&order=desc
Sortable fields: created_at · updated_at · name · arr · health_score · id_number
Search (?q=): name, primary_contact
Filters: ?relationship= ?status= ?segment= ?churn_risk= ?plan= ?is_draft= , repeat any filter to OR multiple values
Trash: hidden by default; pass ?include_deleted=true
Expand: ?expand=feedback,meetings

Examples

curlbash

curl 'https://productos.ca/api/v1/accounts?limit=10' \
  -H "Authorization: Bearer $TOKEN"

Try it out

Paste a token and hit a real endpoint. The request goes from your browser straight to /api/v1/accounts. The token is held in this page only for the request and is never stored.

Try it out

API token

Issue tokens in Settings → API tokens. Token never leaves this page.

GET/api/v1/accounts?limit=3