---
title: "List the residencies"
method: GET
path: "/api/v1/residencies"
tags: ["Residencies"]
---

# List the residencies

`GET /api/v1/residencies`

## Request

- Base URL: `https://pcp.example.com`
- URL: `https://pcp.example.com/api/v1/residencies`
- Auth: HTTP bearer

ISO 3166-1 alpha-2 countries.

## Response `200`

OK

- ResidencyListResponse: ResidencyListResponse schema
  - `residencies` object[]
    - `alpha2` string
    - `alpha3` string
    - `common_name` string
    - `eea` boolean
    - `eu` boolean
    - `name` string
    - `numeric` string
    - `region` string, nullable
    - `sub_region` string, nullable

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `401`: Missing, invalid or expired credentials
- `403`: The caller may not do this
- `500`: Internal Server Error _(panics)_
- `default`

---

[API](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1.md) - [All operations](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/revisions/2ac049494a01?raw)