---
title: "The inhabitants of a settlement"
method: GET
path: "/me/settlements/{id}/inhabitants"
tags: ["Your own data"]
---

# The inhabitants of a settlement

`GET /me/settlements/{id}/inhabitants`

## Request

- Base URL: `https://michaelghelfistudios.com/api/v1`
- URL: `https://michaelghelfistudios.com/api/v1/me/settlements/{id}/inhabitants`
- Auth: HTTP bearer

Each with species, job, a rendered description and journal in the requested language; the GM-only `secret` travels for gamemasters.

## Path parameters

- `id` integer, required

## Query parameters

- `lang` 'en' | 'fr' | 'all'

## Response `200`

Inhabitants.

- object
  - `success` true
  - `data` object[]
    - `id` integer
    - `name` string
    - `gender` string
    - `age` integer
    - `is_pc` boolean
    - `species` string
    - `job` string, nullable
    - `description` string
    - `history` string, nullable
    - `secret` string, nullable: Gamemasters only.
    - `journal` string[]
    - `portrait_url` string, nullable
  - `meta` object
    - `version` 'v1'
    - `lang` string
    - `key` object
      - `id` integer
      - `scopes` string[]
    - `license` object
      - `name` string
      - `url` string
      - `attribution` string
  - `links` object
    - `self` string
    - `docs` string

## Other responses

- `404`: Unknown item.

---

[API](https://skmtc.dev/michaelghelfistudios/apis/mgs-toolbox-public-api.md) · [All operations](https://skmtc.dev/michaelghelfistudios/apis/mgs-toolbox-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/michaelghelfistudios/apis/mgs-toolbox-public-api/revisions/20d2b0932478?raw)