Produktly docs
ChecklistsId

Get a checklist

GET
/checklists/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

Use an API key from the Produktly dashboard → Settings → API keys.

In: header

Path Parameters

id*integer
Range0 < value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/checklists/1"
{  "id": 0,  "name": "string",  "active": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "folderId": 0,  "themeId": 0,  "items": [    {      "property1": null,      "property2": null    }  ],  "settings": {    "property1": null,    "property2": null  },  "rules": [    {      "property1": null,      "property2": null    }  ],  "ruleLogicalOperator": "string",  "dashboardUrl": "string",  "note": "string"}

Create a checklist POST

Creates the checklist as a draft. Pass active: true to publish immediately — the checklist must have at least one item and targeting set, otherwise it stays a draft and the response note explains why. The response includes a dashboardUrl for reviewing the checklist in the builder.

Update a checklist PATCH

Only the fields you send are changed. items and targeting replace their stored values wholesale — fetch the checklist first and send the full array back, preserving item ids (completion state is keyed on them). settings are merged. Live checklists can be edited, but an update that would leave one unpublishable (no items or no targeting) returns 400; set active: false first to take it down.