API ReferenceEntityBulk

Download Bulk Entities (Sync)

Get a URL to download a bulk entity as a CSV/JSON file.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

formatenumOptional
Format of the file to download. Defaults to CSV.
Allowed values:
paymentMethodsbooleanOptional
If true, will include entity payment methods as part of the response
isCustomerbooleanOptional
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.
foreignIdstringOptional
ID used to identify this entity in your system
statusenumOptional
isPayeebooleanOptional
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.
isPayorbooleanOptional
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.
namestringOptionalDeprecated
Use search instead. Deprecated. Filter entities by name. Partial matches are supported.
searchstringOptional
Find entities by name, email, or emailTo. Partial matches are supported.
metadataobjectOptional

Filter entities by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

returnMetadatastringOptional

Return simple key/value metadata for the specified keys for the entities. For more complex metadata, use the Metadata API.

limitintegerOptional
Number of entities to return. Limit can range between 1 and 100, and the default is 10.
startingAfterstringOptional
The ID of the entity to start after. If not provided, the first page of entities will be returned.

Response

This endpoint returns an object.
urlstring
mimeTypestring

Errors