Library

List rate pack items

List current items in an available rate pack.

get/library/rate-packs/{packId}/items

Request

Base URL: https://next-api.saturation.io/v1
URL: https://next-api.saturation.io/v1/library/rate-packs/{packId}/items
Auth: HTTP bearer

Path parameters

packIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

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.

qstring

Search item titles and aliases.

groupstring

Only rate pack items in this group.

agreementstring

Only rate pack items for this agreement.

localstring

Only rate pack items for this local.

unitstring

Filter by unit.

Response

A page of pack items.

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",
      "rate": {
        "amount": 152900,
        "currency": "USD"
      },
      "version": {
        "id": "txn_8f2a1c9e"
      }
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

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