Organisations API

External integration

Organisations represent legal entities — companies, trusts, funds, and other non-individual entities — that your firm tracks. Organisations support CRUD operations plus the same v2 filtering model used by other entity endpoints.

Read endpoints

Endpoint	Purpose
`GET /api/organisations`	Paginated list for the current tenant.
`GET /api/organisations/{organisationUuid}`	Get one organisation by UUID.
`GET /api/organisations/search?searchTerm=`	Search by legal name, company name, or identification ID.
`GET /api/organisations/{organisationUuid}/households`	List households linked to this organisation.

List and search endpoints accept includeCustomFields=true when you need the expanded response with custom field values.

Create and update

POST/api/organisations

{
  "legalCompanyName": "Acme Advisory LLC",
  "companyName": "Acme Advisory",
  "industry": "FINANCIAL_AND_INSURANCE_ACTIVITIES",
  "identificationType": "US_EIN",
  "identificationId": "12-3456789",
  "createdByTenantStaffUuid": "TS019C06688AA57248B9EA5325DBDFC48E",
  "preferredPhoneNumber": {
    "countryCode": "+1",
    "number": "5557771234"
  },
  "administratorContactUuids": [],
  "associatedContactUuids": []
}

Required on create	Notes
`legalCompanyName`	Full legal registered name.
`industry`	Must be a valid `Industry` value. See enum reference.
`identificationType`	Must be a valid `OrganisationIdentificationType` value. See enum reference.
`identificationId`	The actual ID (tax number, registration number, etc.). Tenant-scoped duplicate checks apply.
`createdByTenantStaffUuid`	UUID of the staff member creating this record.

PUT/api/organisations/{organisationUuid} accepts optional replacements for phone numbers, addresses, administrators, and associated contacts.

{
  "companyName": "Acme Advisory Group",
  "isActive": true,
  "lockerId": "LOCKER-1001",
  "administratorContactUuids": ["C019B9D0FD0E5772F9E8ED189895D40C4"]
}

DELETE/api/organisations/{organisationUuid} returns 204 No Content on success.

V2 filtering

Endpoint	Purpose
`POST /api/v2/organisations`	Complex filtering, sorting, and pagination.
`POST /api/v2/organisations/filter-values`	Distinct values for a field, optionally applied against base filters.

{
  "filters": [
    { "field": "isActive", "operator": "equals", "value": "true" }
  ],
  "page": 0,
  "size": 20,
  "sort": ["legalCompanyName,asc"]
}

Enum reference

industry

Sector classification for the organisation. Use the exact enum key in API requests.

MANUFACTURING EDUCATION PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_ACTIVITIES ADMINISTRATIVE_AND_SUPPORT_SERVICE_ACTIVITIES ELECTRICITY_GAS_STEAM_AND_AIR_CONDITIONING_SUPPLY ARTS_ENTERTAINMENT_AND_RECREATION ACCOMMODATION_AND_FOOD_SERVICE_ACTIVITIES AGRICULTURE_FORESTRY_AND_FISHING INFORMATION_AND_COMMUNICATION OTHER_SERVICE_ACTIVITIES WATER_SUPPLY_SEWERAGE_WASTE_MANAGEMENT_AND_REMEDIATION_ACTIVITIES WHOLESALE_AND_RETAIL_TRADE_REPAIR_OF_MOTOR_VEHICLES_AND_MOTORCYCLES ACTIVITIES_OF_HOUSEHOLDS_AS_EMPLOYERS PUBLIC_ADMINISTRATION_AND_DEFENSE ACTIVITIES_OF_EXTRATERRITORIAL_ORGANIZATIONS_AND_BODIES HUMAN_HEALTH_AND_SOCIAL_WORK_ACTIVITIES FINANCIAL_AND_INSURANCE_ACTIVITIES TRANSPORTATION_AND_STORAGE REAL_ESTATE_ACTIVITIES MINING_AND_QUARRYING CONSTRUCTION

For display purposes, use GET /api/industries to retrieve the list of industries with both their API key and human-readable display name. See Dynamic configuration lookups for all lookup endpoints.

identificationType

The type of identification document or number used to uniquely identify the organisation.

CHILE_RUT US_EIN UK_COMPANY_NUMBER OTHER

Dynamic fields

The industry list with display names can be retrieved from the API at runtime for use in UI dropdowns or validation.

Field	Lookup endpoint
`industry` (with display names)	`GET /api/industries`
`country fields`	`GET /api/core/geo/v1/countries`
`phone country codes`	`GET /api/core/geo/v1/phone-codes`