List Matchers
hudu_list_matchersLists integration-to-company matchers in Hudu, revealing unmatched records that need manual resolution. Filter by matched status, company, or integration to manage sync mappings.
Instructions
List matchers in Hudu. A matcher is one row in the mapping table between a connected integration (a PSA or RMM such as Autotask or ConnectWise) and Hudu's companies: it ties one customer record in that external system to one Hudu company, so synced data lands in the right place.
integration_id is required on every call here. It is the number in the address bar when you edit the integration in Hudu's admin UI (…/integrations//edit); the API publishes no endpoint that lists integrations, so it has to come from the user or from a matcher you have already seen (integrator_id on the record).
The reason to call this is almost always matched: false, which returns the records the integration pulled in but could not tie to a Hudu company — the sync backlog someone has to work through. Each unmatched row carries the external name and, where Hudu guessed, a potential_company_id. Resolve them one at a time with hudu_update_matcher.
Returns an object with items plus pagination facts. Note that the Hudu API returns no total count for any collection, so page_was_full is the only honest signal that more records exist — read pagination_note before concluding a list is complete.
Operation class: Read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number. Hudu has no cursor or offset — only pages. | |
| fields | No | Return only these top-level fields on each record. Use it to keep large lists small — e.g. ["id","name","company_id"]. Unknown field names are ignored. | |
| matched | No | false returns only the integration records that have not yet been tied to a Hudu company — the ones needing attention. true returns only the resolved ones. Omit for both. | |
| sync_id | No | The record's id inside the integration, for integrations that number their records. Use `identifier` instead when that system uses string keys. | |
| page_size | No | Records per page (1-100, default 25). Hudu publishes no maximum, so this client clamps at 100; larger values are rejected here rather than silently altered by the server. | |
| company_id | No | Show only matchers already pointing at this Hudu company. | |
| identifier | No | The record's string key inside the integration, for integrations that do not use numeric ids. | |
| integration_id | Yes | Numeric id of the integration whose matchers you want. Required — this endpoint returns nothing useful without it. Find it in the URL when editing the integration in Hudu, or read `integrator_id` off a matcher you already have. | |
| response_format | No | Output shape. 'json' (default) is compact and machine-readable; 'markdown' is easier for a person to read but larger. | json |