Get Countries
API operation: Open the endpoint in Scalar
Use GET /countries to list countries for the current project. The operation is Country.findAll.
This list can be available without operation-level authentication. It supports pagination, ordering, filtering, and the params relationships cities, metafields, and metadata. When params is omitted, those expansions may be included by default; request only what the client needs.
Legacy SDK example
const response = await ordering.countries().get()
The SDK helper shown here may differ by version.
OpenAPI reference
Operation: GET /countries
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
params | string | No | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields. |
orderBy | string | No | Field to sort by, with - prefixed for descending order. Multiple fields can be chained with commas. |
where | string | No | JSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension. |
page | integer | No | Page number, starting at 1. Applies only to lists that return a pagination block. |
page_size | integer | No | Number of items per page. |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized (ProjectAccessErrorResponse) |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |