---
title: "Get list of area types for given population type"
method: GET
path: "/population-types/{population-type}/area-types"
---

# Get list of area types for given population type

`GET /population-types/{population-type}/area-types`

## Request

- Base URL: `/v1` (relative, and the document’s source URL is not known)
- URL: `/v1/population-types/{population-type}/area-types`
- Auth: none declared

## Path parameters

- `population-type` string, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

area types returned successfully

- GetAreaTypesResponse: The response body containing all available area-types for a given population-type
  - `count` integer: The number of area-types returned
  - `items` AreaType[]: An array of area-types
    - `id` string
    - `label` string
    - `description` string
    - `hierarchy_order` integer
    - `total_count` integer
  - `limit` integer: The number of area-types requested
  - `offset` integer: The first row of area-types for to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter
  - `total_count` integer: The total number of area-types

## Other responses

- `401`: The token provided is unauthorised to carry out this operation
- `404`: Dataset not found
- `500`: Failed to process the request due to an internal error
- `502`: Failed to process the request due to an error in a downstream server

---

[API](https://skmtc.dev/office-of-national-statistics/apis/population-types-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/population-types-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/population-types-api/revisions/f50432209eff?raw)