GET
/
store
/
currencies
cURL
curl '{backend_url}/store/currencies' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "currencies": [
    {
      "code": "usd",
      "symbol": "<string>",
      "symbol_native": "<string>",
      "name": "<string>",
      "decimal_digits": 123,
      "rounding": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "estimate_count": 123
}

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
q
string

Search term to filter the currency's searchable properties.

​
code

Filter by a currency code.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

OK

The paginated list of currencies.

​
limit
number
required

The maximum number of items returned.

​
offset
number
required

The number of items skipped before retrieving the returned items.

​
count
number
required

The total count of items.

​
currencies
object[]
required

The list of currencies.

​
estimate_count
number

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.