List Tax Providers

GET

/admin/tax-providers

Retrieve a list of tax providers installed in the Medusa application through Tax Module Providers. The tax providers can be filtered by fields such as id. The tax providers can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "estimate_count": 0,
    "tax_providers": [
        {
            "id": "tp_taxjar_taxjar",
            "is_enabled": true
        }
    ]
}

Request

Authorization

Query Params

fields

string

fields

optional

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

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

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 -.

optional

One of

array[string]

Filter by a tax provider's ID.

is_enabled

boolean

is_enabled

optional

Filter by whether the tax provider is enabled.

$and

array [object]

$and

optional

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

$or

array [object]

$or

optional

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

Responses

🟢200OK

application/json

Body

The list of tax providers.

limit

number

limit

required

The maximum number of items retrieved.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items available.

estimate_count

number

estimate_count

optional

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

tax_providers

array[object (AdminTaxProvider) {2}]

required

The list of tax providers.

string

required

The tax provider's ID.

Example:

tp_taxjar_taxjar

is_enabled

boolean

is_enabled

required

Whether the tax provider is enabled in the Medusa application.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

List Regions

Manage the Rules of a Shipping Option