Companies

Required name. Upsert by domain.

Official Aivyro contentAligned with the current public contract

POST/api/v1/companies

name is required on create and cannot PATCH to empty. domain e.g. analytical.example. Lookup by domain (miss is data: []). q searches name/domain.

HTTP	Path	Scope
GET	`/api/v1/companies`	`rest.crm.companies.read`
POST	`/api/v1/companies`	`rest.crm.companies.write`
POST	`/api/v1/companies/upsert`	`rest.crm.companies.write`
GET	`/api/v1/companies/{id}`	`rest.crm.companies.read`
PATCH	`/api/v1/companies/{id}`	`rest.crm.companies.write`

Query

Parameter	Type	Notes
domain	string	Lookup. Miss is data: [].
q	string	Searches name and domain.
limit / cursor	number / string	Cursor page. limit 1–100.

Fields

Field	Type	Notes
id	UUID	Immutable.
name	string	Required on create. Cannot PATCH to empty.
domain	string \| null	e.g. analytical.example. "" stores null.
owner_id	UUID \| null	Same id as GET /members.
tag_ids	UUID[]	Full replace. [] clears.
created_at / updated_at	datetime	ISO-8601 UTC.

POST /api/v1/companies

curl -sS -X POST "$AIVYRO_API_BASE/api/v1/companies" \
  -H "Authorization: Bearer $AIVYRO_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"Analytical Engines","domain":"analytical.example"}'