Skip to main content

​
Endpoints

MethodPathPurpose
GET/companiesList, paginated
POST/companiesCreate
GET/companies/:idFetch one
PATCH/companies/:idUpdate
DELETE/companies/:idDelete
No /search endpoint in v1 (deferred to v1.1).

​
Fields

FieldTypeNotes
iduuid
namestringRequired
domainstring | nullIndexed (case-insensitive)
custom_attributesobjectValidated by the schema engine
created_at, updated_atdatetime

​
Create

curl -X POST $SALTY_API/companies \
  -H "Authorization: Bearer $SALTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme Corp","domain":"acme.com","custom_attributes":{"tier":"enterprise","arr":250000}}'

​
Validation errors

name is required: 
{
  "error": {
    "type": "invalid_request",
    "code": "validation_failed",
    "message": "Required",
    "param": "name"
  }
}