---
title: "Download Bulk Entities (Sync)"
method: GET
path: "/entities/download"
tags: ["entity > bulk"]
---

# Download Bulk Entities (Sync)

`GET /entities/download`

## Request

- Base URL: `https://api.mercoa.com`
- URL: `https://api.mercoa.com/entities/download`
- Auth: HTTP bearer

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

## Query parameters

- `format` 'CSV' | 'JSON'
- `paymentMethods` boolean
- `isCustomer` boolean
- `foreignId` string
- `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed'
- `isPayee` boolean
- `isPayor` boolean
- `name` string
- `search` string
- `metadata` InvoiceTypesMetadataFilter
  - `key` string, required
  - `value` union, required
    - string
    - string[]
- `returnMetadata` string
- `limit` integer
- `startingAfter` string

## Response `200`

Response with status 200

- CommonsBulkDownloadResponse
  - `url` string, required
  - `mimeType` string, required

## Other responses

- `400`: Error response with status 400
- `401`: Error response with status 401
- `403`: Error response with status 403
- `404`: Error response with status 404
- `409`: Error response with status 409
- `500`: Error response with status 500
- `501`: Error response with status 501

---

[API](https://skmtc.dev/mercoa/apis/mercoa-2.md) - [All operations](https://skmtc.dev/mercoa/apis/mercoa-2/llms.txt) - [OpenAPI document](https://skmtc.dev/mercoa/apis/mercoa-2/revisions/00a8e403ae18?raw)