Skip to content

List items

View .md
GET

Items in one scope of a collection, by key in lexicographic order. Narrow with prefix — key your documents so a prefix is meaningful (order:2026-08:...) and this becomes a range scan rather than a filter.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • collectionstringrequired

    Collection name.

Query parameters

  • scopestring

    Which scope to address: contact:<contactId>, conversation:<conversationId>, or omitted for the project scope.

    Note the asymmetry with POST /v1/memory and POST /v1/memory/search, which take the scope in the request BODY as scope plus contactId/conversationId. Every other Memory endpoint takes it here.

  • prefixstring

    Only keys starting with this string.

    Limitsmax length 255
  • limitinteger
    Default50
    Limitsmax 100
  • cursorstring

Responses

200Items in the scope.
  • itemsobject[]required
    6 properties
    • keystringrequired
    • valueany

      The stored JSON. Any JSON value.

    • revintegerrequired

      Revision, incremented on every write. Pass it as If-Match on a later write to make that write conditional.

    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
    • expiresAtstring<date-time>
  • nextCursorstringnullable
400Invalid scope or query parameters.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404`collection_not_found`: no collection with that name. A collection exists once it is created or written to.
  • codestringrequired
  • messagestringrequired
  • detailsobject