items

List Items

get/v1/items

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/items
  • Auth: HTTP bearer

Query parameters

campaign_idstring required

Campaign ID to filter items

searchstring nullable

Search items by name

approved_onlyboolean

Show only approved items

with_linksboolean

Return descriptions with [[wikilinks]] intact

sortstring nullable

Sort order. 'name' sorts case-insensitively by item 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.