Sign in
Library

List project incentives

get/projects/{projectId}/library/incentives

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/projects/{projectId}/library/incentives
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Project ID or slug.

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.

expandProjectIncentiveExpand[]

Comma list of related data to inline on a project incentive (depth ≤ 2). Unknown key returns 400 expand_invalid.

isAppliedboolean

Filter by whether the incentive is applied to the project.

jurisdictionstring

Only project incentives for this jurisdiction.

Response

A page of project incentives.

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",
      "sourceId": "txn_8f2a1c9e",
      "sourceIncentiveVersionId": "txn_8f2a1c9e",
      "source": {
        "id": "txn_8f2a1c9e",
        "currentVersion": {
          "id": "txn_8f2a1c9e"
        }
      }
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

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