Find entities
mercoa_find_entitiesRead-only
Find/search entities (buyers, vendors, payors, payees). Use to look up counterparties by name/email/foreignId or list all. GET /entity.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max entities to return (1-100, default 10). | |
| search | No | Search by name, email, emailTo, entity ID, or foreign ID (partial matches). | |
| status | No | Entity status filter (e.g. verified, pending). | |
| isPayee | No | Filter entities marked as payees. | |
| isPayor | No | Filter entities marked as payors. | |
| foreignId | No | Your system's ID(s) for the entity. | |
| isCustomer | No | If true, only entities with a direct relationship to your organization. | |
| startingAfter | No | Entity ID cursor for pagination. | |
| paymentMethods | No | If true, include payment methods in the response. | |
| returnMetadata | No | Metadata key(s) to include in the response. |