April 22, 2026

Filter Organizations by External ID

A GET request to /v3/Organizations now supports filtering by ExternalId. The ExternalId value is the identifier from an integrated external system - for example, the Client ID from XPM, the Contact ID from Xero, or the Intuit Customer ID from QuickBooks Online.

For example:

GET /v3/Organizations?$filter=ExternalId eq '123987456'

This returns only Organizations whose external ID matches the provided value. The ExternalId filter can also be combined with other filters using the and operator.

{
  "@odata.context": "https://api.karbonhq.com/v3/$metadata#Organizations/KarbonService.OrganizationSummaryDTO",
  "@odata.count": 1,
  "value": [
    {
      "@odata.type": "#KarbonService.OrganizationSummaryDTO",
      "OrganizationKey": "2Nw8tnxwQCVf",
      "FullName": "Sample Company",
      "PhoneNumber": null,
      "Website": null,
      "EmailAddress": "info@samplecompany.com",
      "ContactType": "Client",
      "LastModifiedDateTime": "2026-04-20T10:15:30Z",
      "Tags": []
    }
  ]
}

The following External IDs are supported:

Note: External IDs are not guaranteed to be unique across connected systems. If multiple integrations are enabled in Karbon, this filter may return multiple results.