Businesses
List, retrieve, create, and edit business clients.
Business clients represent companies, corporations, or other legal entities. Each business is also a Client with clientType: "business".
List businesses
GET /businessesQuery parameters
| Parameter | Type | Description |
|---|---|---|
search | string | Filter by legal name, operating name, or business registration number |
limit | number | Max results (default 50, max 100) |
offset | number | Pagination offset |
Example
curl "https://api.untangly.com/businesses?search=acme" \
-H "Authorization: Bearer untangly_<key>"Response
{
"businesses": [
{
"id": "b1234567-...",
"clientId": "c9876543-...",
"legalName": "Acme Corp",
"countries": ["CA"],
"operatedAs": "Acme",
"businessRegistrationNumber": "123456789",
"taxId": null,
"phone": "+1-555-0100",
"email": "info@acme.com",
"ownershipType": "private",
"industryType": "service",
"incorporationDate": "2010-06-15",
"createdAt": "2026-01-10T08:00:00.000Z",
"updatedAt": "2026-01-10T08:00:00.000Z"
}
],
"total": 1
}Get business details
GET /businesses/{id}Add a business
POST /businessesRequest body
{
"legalName": "New Corp Inc.",
"countries": ["CA"],
"operatedAs": "NewCo",
"businessRegistrationNumber": "987654321",
"phone": "+1-416-555-0100",
"email": "contact@newco.com",
"ownershipType": "private",
"industryType": "retail",
"incorporationDate": "2020-01-01"
}| Field | Type | Required | Description |
|---|---|---|---|
legalName | string | ✅ | Registered legal name |
countries | string[] | ✅ | ISO 3166-1 alpha-2 codes, e.g. ["CA", "US"]; the first is the primary |
operatedAs | string | — | Trade / operating name |
businessRegistrationNumber | string | — | Saved to the business registration field of the first listed country that has one, e.g. Business Number (CA), EIN (US), Company Number (GB) |
taxId | string | — | Only for countries with a tax ID field (US) |
phone | string | — | |
email | string | — | Must be a valid email |
ownershipType | "private" | "public" | "non_profit" | "other" | — | |
industryType | "retail" | "manufacturing" | "service" | "other" | — | |
incorporationDate | string | — | ISO date YYYY-MM-DD |
Edit a business
PATCH /businesses/{id}Send only the fields you want to change. All fields are optional.
Example
curl -X PATCH "https://api.untangly.com/businesses/b1234567-..." \
-H "Authorization: Bearer untangly_<key>" \
-H "Content-Type: application/json" \
-d '{"phone":"+1-416-555-9999","email":"new@acme.com"}'Country-specific numbers
businessRegistrationNumber and taxId are stored in the firm's contact fields for the business's countries. A value is checked against that field's format, and a number already used by another business in the firm returns 409. Sending a number for which none of the business's countries has a field returns 400. Sensitive values are always returned masked (e.g. •••••2544).