Organizations
Organizations group contacts by company. They support auto-enrichment with public company data.
The organization object
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier |
name | string | null | Company name |
organizationalDomain | string | Email domain (e.g. acme.com) |
country | string | null | Auto-enriched country |
industry | string | null | Auto-enriched industry |
employeeCount | string | null | Auto-enriched employee count |
yearlyRevenue | string | null | Auto-enriched revenue |
logoUrl | string | null | Auto-enriched logo URL |
contactCount | integer | Number of linked contacts |
ticketCount | integer | Number of tickets from linked contacts |
createdAt | string | Creation time (ISO 8601 UTC) |
List organizations
GET /helpdesk/api/organizations
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
search | string | no | Search by name or domain |
sort_by | string | no | name, organizational_domain, created_at, contact_count |
sort_order | string | no | asc or desc |
page | integer | no | Page number |
limit | integer | no | Results per page (default: 15, max: 100) |
Create an organization
POST /helpdesk/api/organizations
Requires agent role or above.
Request body
{
"name": "Acme Corp",
"organizationalDomain": "acme.com"
}
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | Company name (max 128 characters) |
organizationalDomain | string | yes | Email domain (max 128 characters) |
Auto-enrichment triggers asynchronously after creation.
Update an organization
PATCH /helpdesk/api/organizations/:organizationId
Requires agent role or above.
Enrich an organization
POST /helpdesk/api/organizations/:organizationId/enrich
Manually triggers synchronous enrichment with public company data.
Delete an organization
DELETE /helpdesk/api/organizations/:organizationId
Requires agent role or above. Contacts linked to the organization have their organizationId set to null.