Download Bulk Entities (Sync)
Get a URL to download a bulk entity as a CSV/JSON file.
Request
- Base URL: https://api.mercoa.com
- URL: https://api.mercoa.com/entities/download
- Auth: HTTP bearer
Query parameters
Format of the file to download. Defaults to CSV.
If true, will include entity payment methods as part of the response
If true, only entities with a direct relationship to the requesting organization will be returned. If false or not provided, all entities will be returned.
ID used to identify this entity in your system
If true, entities that are marked as payees will be returned. If false or not provided, entities that are marked as payees will not be returned.
If true or not provided, entities that are marked as payors will be returned. If false, entities that are marked as payors will not be returned.
Use search instead. Deprecated. Filter entities by name. Partial matches are supported.
Find entities by name, email, emailTo, entity ID, or foreign ID. Partial matches are supported for name, email, and emailTo. Exact matches are used for entity ID and foreign ID.
Filter entities by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
Return simple key/value metadata for the specified keys for the entities. For more complex metadata, use the Metadata API.
Number of entities to return. Limit can range between 1 and 100, and the default is 10.
The ID of the entity to start after. If not provided, the first page of entities will be returned.
Response
Response with status 200
Changes
No recorded changes to this operation across all 1 revision of this API.