Countries

Country reference data (ISO codes, lookups).

List countries

GET

https://api.faireplace.com/api

/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

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

Response:


Code
[
  {
    "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"
  }
]

List countries › Responses

List of active countries.

Country[]

List of country reference entries.

A country reference entry. Countries are global reference data used across the platform (e.g. to resolve rent regulation rules, address normalization, and ISO code lookups). Field names match the JSON payload exactly (no renaming).

Country

id

string · uuid · required

Unique country identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

code

string · required

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

Example: FR

name

string · required

Human-readable country name.

Example: France

is_active

boolean · required

Whether the country is active.

The GET /countries list endpoint returns only active countries.

Example: true

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2026-01-15T09:00:00

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2026-01-15T09:00:00

Get a country by ID

GET

https://api.faireplace.com/api

/countries/{id}

Retrieves a single country by its UUID.

Code
curl -X GET https://api.faireplace.com/api/countries/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"

Get a country by ID › path Parameters

id

string · uuid · required

Get a country by ID › Responses

The country.

Country

id

string · uuid · required

Unique country identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

code

string · required

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

Example: FR

name

string · required

Human-readable country name.

Example: France

is_active

boolean · required

Whether the country is active.

The GET /countries list endpoint returns only active countries.

Example: true

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2026-01-15T09:00:00

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2026-01-15T09:00:00

Get a country by ISO code

GET

https://api.faireplace.com/api

/countries/code/{code}

Retrieves a single country by its ISO code (e.g. FR).

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

Get a country by ISO code › path Parameters

code

string · required

ISO country code (e.g. FR, BE, DE).

Get a country by ISO code › Responses

The country.

Country

id

string · uuid · required

Unique country identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

code

string · required

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

Example: FR

name

string · required

Human-readable country name.

Example: France

is_active

boolean · required

Whether the country is active.

The GET /countries list endpoint returns only active countries.

Example: true

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2026-01-15T09:00:00

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2026-01-15T09:00:00

Mandates Coupons