Countries

List countries

Lists all active countries available as reference data.

Countries are global reference entries used for ISO code lookups, rent regulation resolution and address normalization.

Usage Example

curl -X GET https://api.faireplace.com/api/countries \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "code": "FR",
    "name": "France",
    "is_active": true,
    "created_at": "2026-01-15T09:00:00",
    "updated_at": "2026-01-15T09:00:00"
  }
]
get/countries

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/countries
  • Auth: HTTP bearer

Response

List of active countries.

idstring uuid required

Unique country identifier.

codestring required

ISO country code (typically ISO 3166-1 alpha-2, e.g. FR, BE, DE).

namestring required

Human-readable country name.

is_activeboolean required

Whether the country is active.

The GET /countries list endpoint returns only active countries.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time required

Last update timestamp (ISO 8601).

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "code": "FR",
    "name": "France",
    "is_active": true,
    "created_at": "2026-01-15T09:00:00",
    "updated_at": "2026-01-15T09:00:00"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.