Sign in
Library

Get an incentive pack

get/library/incentive-packs/{packId}

Request

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

Path parameters

packIdstring required

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

Example:txn_8f2a1c9e

Query parameters

expandIncentivePackExpand[]

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

Response

The incentive pack.

idstring required

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

slugstring required
namestring required
descriptionstring nullable
categorystring nullable
jurisdictionstring required

Country, state, or province where the incentive applies.

visibility'public' | 'private' | 'shared' required

Who can access the pack. Public packs are available to every workspace; private packs belong to one workspace.

isOwnedboolean required
deprecatedboolean required
enabledboolean required
enabledAtstring date-time nullable

Example response

{
  "id": "txn_8f2a1c9e",
  "programs": [
    {
      "id": "txn_8f2a1c9e",
      "currentVersion": {
        "id": "txn_8f2a1c9e"
      }
    }
  ]
}

Changes

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