List canon region rows
Canon module
GET/canon/regionscanonRegions.list
A cost region. Only ratified multipliers answer; others refuse. Returns a cursor page of canon region rows the caller may see. The default order is `region_code` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of CanonRegion
| Field | Type | Required | Description |
|---|---|---|---|
| region_code | RegionCode | Yes | Cost region code from `xpms.dim_region`.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)+$ |
| name | string | Yes | Region name.Constraints: length 1 to 200 |
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| currency_code | string | Yes | Currency of the region.Constraints: pattern ^[A-Z]{3}$ |
| note | string | null | Yes | Note from the Bible.Constraints: length 1 to 20000 |
{
"data": [
{
"region_code": "NA-SE-MIA",
"name": "Miami and South Florida",
"jurisdiction_id": "US-FL",
"currency_code": "USD",
"note": "Basis region."
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/canon/regions" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.canonRegions.listAll()) {
console.log(row);
}for row in xos.canon_regions.list_all():
print(row)xos canon-regions list --all