Companies
Add a company
POST /v1/company
Request
| Field | Type | Description |
|---|---|---|
| name* | string | |
| contactTypes* | string[] | Merchant, Broker, Funder, Investor, Procedssor, or Other. |
| dba | string | |
| phones | Phone[] | |
| emails | Email[] | |
| addresses | Address[] | |
| industry | string | number | |
| website | string | Max 100 characters. |
| ein | string | |
| submissionEmail | string | Funder companies only. Single email or comma-separated list. |
| defaultReceivableCommission | string | number | Funder companies only. |
| note | string |
company = client.companies.add(name="Acme Inc", dba="Acme", contact_types=["Merchant"])Example response
{ "success": true, "id": "9mslw6gq9lew3", "url": "https://example.com/workspace/contact/company/9mslw6gq9lew3" }Get a company
GET /v1/company/{id}
company = client.companies.get("9mslw6gq9lew3")Note
The response shape for this endpoint isn't formally documented by the API, so both SDKs return an untyped object (dict in Python, a plain object type in TypeScript). For Funder companies, submissionEmail and defaultReceivableCommission are returned as top-level fields.
Update a company
PATCH /v1/company/{id}
Accepts the same fields as Add a company, all optional -- only the fields you pass are updated.
client.companies.update("9mslw6gq9lew3", website="https://acme.example.com")