List Tax Regions
Retrieve a list of tax regions. The tax regions can be filtered by fields such as id
. The tax regions can also be sorted or paginated.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
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.
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
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 -
.
Search term to filter a tax region's searchable properties.
Filter by a tax region ID.
Filter by a country code.
Filter by a ISO 3166-2 province code. Must be lower-case.
"us-ca"
Filter by the ID of a parent tax region to retrieve its child tax regions.
Filter by the ID of the user to retrieve the tax regions they created.
Filter by a tax region's creation date.
Filter by a tax region's update date.
Filter by a tax region's deletion date.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Whether to include deleted records in the result.
Response
OK
The paginated list of tax regions.