Library

List incentive packs

get/library/incentive-packs

Request

Base URL: https://next-api.saturation.io/v1
URL: https://next-api.saturation.io/v1/library/incentive-packs
Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

withCountboolean

Include the total number of matching items. Defaults to false.

expandIncentivePackExpand[]

Comma list of related data to inline on a workspace-source incentive pack. Unknown key returns 400 expand_invalid.

qstring

Search incentive packs by name.

categorystring

Only incentive packs in this category.

jurisdictionstring

Only incentive packs for this jurisdiction.

deprecatedboolean

Filter by whether the incentive pack is deprecated.

Response

A page of incentive packs.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching items; present only when withCount=true was requested.

truncatedboolean

Whether some matching items were omitted from the response.

Example response

{
  "data": [
    {
      "id": "txn_8f2a1c9e",
      "programs": [
        {
          "id": "txn_8f2a1c9e",
          "currentVersion": {
            "id": "txn_8f2a1c9e"
          }
        }
      ]
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.