characters

List Characters

List characters in a world with pagination and filtering.

  • world_id: Required world ID
  • search: Search by character name
  • character_type: Filter by type (PC, NPC, etc.)
  • approved_only: Show only approved characters
  • sort: 'name' for case-insensitive alphabetical order by character name; omitted keeps newest-first
get/v1/characters

Request

  • Base URL: https://api.myarchivist.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.myarchivist.ai/v1/characters
  • Auth: HTTP bearer

Query parameters

campaign_idstring required

Campaign ID to filter characters

searchstring nullable

Search characters by name

character_typestring nullable

Filter by character type (PC, NPC, etc.)

approved_onlyboolean

Show only approved characters

with_linksboolean

Return descriptions with [[wikilinks]] intact

fieldsstring nullable

Use 'card' for lightweight list items

sortstring nullable

Sort order. 'name' sorts case-insensitively by character name at the database level, applied before pagination. Omitted keeps the default (newest first).

pageinteger
sizeinteger

Headers

x-api-keystring nullable

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.