---
title: "Your Fantasy City Simulator settlements"
method: GET
path: "/me/settlements"
tags: ["Your own data"]
---

# Your Fantasy City Simulator settlements

`GET /me/settlements`

## Request

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

Every settlement the account is a member of, with its role.

## Response `200`

Settlements.

- object
  - `success` true
  - `data` object[]
    - `id` integer
    - `name` string
    - `role` string: `owner`, `gamemaster`, `player`, `observer`…
    - `status` string
    - `can_edit` boolean
    - `last_activity_at` string, nullable
    - `url` string
  - `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

---

[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)