Middle-earth API

Retrieve a member

GET/members/{member_id}

Retrieves a single member, including their race-specific traits.

Request

Path parameters

  • member_id string Required

    The member's identifier, such as mem_frodo.

Example request

cURL
curl -X GET 'https://api.middle-earth.example/v3/members/<member_id>'

Response

The member.

Body

  • id string Required

    Unique identifier.

  • name string Required

    Display name.

  • race string <Race> Required

    The race of a member.

    Allowed valueshobbitelfdwarfmanwizard

  • status string Required

    Changes automatically as the fellowship travels. Use Update a quest to change a quest instead.

    Allowed valuesactivewoundedfallenabandoned

  • skills array of strings

    Free-form skill tags, for example stealth, swordsmanship or riddles. Used when matching members to quests.

  • home object <Region>

    A place in Middle-earth. Regions nest, so the Shire can sit inside Eriador.

  • traits oneOf

    Traits specific to the member's race.

  • created_at string date-time

    When the record was created.

Example response

application/json

Json
{
  "id": "string",
  "name": "string",
  "race": "hobbit",
  "status": "active",
  "skills": [
    "string"
  ],
  "home": {
    "name": "string",
    "settlement": "string",
    "parent": null
  },
  "traits": {
    "kind": "hobbit",
    "second_breakfasts": 0,
    "pipe_weed_brand": "string"
  },
  "created_at": "2024-01-01T00:00:00Z"
}