# List currencies

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/setting/currency
```

- API version: v1
- Operation ID: `v1_public_currency_index`
- Section: Team settings › [Currencies](https://developer.yoprint.com/reference/currencies.md)
- Web page: https://developer.yoprint.com/reference/currencies/v1-currency-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns the team's currencies in one list. Deleted currencies are left out.

YoPrint works in one currency per team: the default currency. Its `symbol` appears on PDFs, emails and formatted amounts (such as `formatted_calc_total`), and its `iso` code is sent to integrations such as QuickBooks and Shopify. A new sales order records the default currency when it is created, and YoPrint doesn't convert between currencies.

The team's first currency is its default. No operation changes the default: `default` in a request is ignored.

## Permission

Any team member can call it. Reading needs no extra permission.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/currency' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `default` (boolean, required): Whether it is the team's currency.
    - `id` (string, required)
    - `iso` (string, required): The three-letter ISO 4217 code, in capitals.
    - `name` (string, required)
    - `symbol` (string, required)
    - `trashed` (boolean, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "default": true,
      "id": "Y3WvW4mbyTw1sO",
      "iso": "USD",
      "name": "US Dollar",
      "symbol": "$",
      "trashed": false
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Notes

- The currency with `default: true` is the one YoPrint uses.

## Related

- [Update a currency without checks](https://developer.yoprint.com/reference/currencies/v1-currency-update-patch.md): `PATCH /v1/api/store/{team_slug}/setting/currency/{hash_id}`
