Docs Blog Sign in

Organizations

Organizations group contacts by company. They support auto-enrichment with public company data.

The organization object

AttributeTypeDescription
idstringUnique identifier
namestring | nullCompany name
organizationalDomainstringEmail domain (e.g. acme.com)
countrystring | nullAuto-enriched country
industrystring | nullAuto-enriched industry
employeeCountstring | nullAuto-enriched employee count
yearlyRevenuestring | nullAuto-enriched revenue
logoUrlstring | nullAuto-enriched logo URL
contactCountintegerNumber of linked contacts
ticketCountintegerNumber of tickets from linked contacts
createdAtstringCreation time (ISO 8601 UTC)

List organizations

GET /helpdesk/api/organizations

Query parameters

ParameterTypeRequiredDescription
searchstringnoSearch by name or domain
sort_bystringnoname, organizational_domain, created_at, contact_count
sort_orderstringnoasc or desc
pageintegernoPage number
limitintegernoResults 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"
}
FieldTypeRequiredDescription
namestringnoCompany name (max 128 characters)
organizationalDomainstringyesEmail 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.