List all countries

Overview

The complete list of countries used across the platform, in the shape expected by a select control. A fixed reference list: cache it client-side rather than fetching it on every screen. Identical response shape to the removed GET /api/v1/utility/countries - only the path and the authentication requirement changed.

Controller: App\Http\Controllers\Api\V1\Public\CountryController::index()
Route name: api.v1.public.countries.index

Authentication

Type: None (public endpoint)
Additional middleware: throttle:public - the dedicated public-area limiter, keyed by IP address since there is never an authenticated user here. See docs/api/README.md §14.

Request

Method: GET
Path: /api/v1/public/countries

No parameters and no body.

Example request

Response `200 OK`

data is an object keyed by uppercase ISO 3166-1 alpha-2 code, not an array. Captured live; truncated to the first 3 of 250 entries.

{
  "success": true,
  "status": "success",
  "message": "OK",
  "data": {
    "AD": {
      "label": "Andorra",
      "value": "AD",
      "description": "Principat d'Andorra"
    },
    "AE": {
      "label": "United Arab Emirates",
      "value": "AE",
      "description": "الإمارات العربية المتحدة"
    },
    "AF": {
      "label": "Afghanistan",
      "value": "AF",
      "description": "جمهوری اسلامی افغانستان"
    }
  }
}

250 entries at capture time. The list is not paginated and is not expected to be: it is a fixed reference set.

Response fields

Field	Type	Nullable	Always present	Description
`data.{CODE}`	`object`	No	Yes	Key is the uppercase ISO 3166-1 alpha-2 code
`data.{CODE}.label`	`string`	No	Yes	English country name
`data.{CODE}.value`	`string`	No	Yes	Same as the key. Send this to `country`/`code` parameters on other public endpoints
`data.{CODE}.description`	`string`	No	Yes	Native official name. Falls back to `label` when unavailable

Errors

`429 Too Many Requests`

Behind the dedicated public limiter (300 requests per minute, keyed by IP). No errors key.

{
  "success": false,
  "status": "error",
  "message": "Too many requests"
}

Notes

label is English regardless of Accept-Language. description is the native official name, not a translation into the caller's language. Neither field is localised to the caller.

One special case is hard-coded: TW is returned as Taiwan, Province of China rather than the name the underlying country package supplies.

Replaces GET /api/v1/utility/countries (removed; see docs/api/_archive/utility/GET_countries.md). The response shape is unchanged.

{ "status": "success", "message": "string", "data": { "property1": { "label": "string", "value": "string", "description": "string" }, "property2": { "label": "string", "value": "string", "description": "string" } } }

List all countries

Overview#

Authentication#

Request#

Example request#

Response 200 OK#

Response fields#

Errors#

429 Too Many Requests#

Notes#

Request

Responses

Overview

Authentication

Request

Example request

Response `200 OK`

Response fields

Errors

`429 Too Many Requests`

Notes