SPsparkvault
sparks

List the account's Sparks

Changed on

A page of the account's Sparks, newest first, without their payloads. A Spark an app holds is listed only to that app. Page with cursor until has_more is false.

get/sparks

Request

Query parameters

status'active' | 'ash'

Only Sparks stored in this state. expired and deleted are worked out per Spark when the list answers and are never stored, so neither filters: an unread Spark past its TTL is stored active, and one its owner deleted is stored ash.

kindlingstring

Only the Sparks of this kindling (kdl_…).

limitinteger

A page-size hint: a value above 500 reads as 500, and a missing, zero, negative or non-numeric one as 100.

cursorstring

The next_cursor a previous page returned, with the same status and kindling. Opaque, and sealed to the query that issued it.

Response

A page of Sparks.

Changes

  • a9a10e328ba5Revision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter kindling

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter status

    • info

      added the non-success response with the status

    • info

      added the success response with the status