Get a checklist · Cueston Docs

GET/checklists/{id}Needscontent.view

The checklist's working draft — every field — and what each environment serves.

Authorization

secretKey

headerAuthorizationBearer <sk_…>

A secret API key from Settings → API keys. It acts with its creator's role.

Path Parameters

id*integer

The checklist's id.

Range1 <= value

Response Body

application/json

response

checklist*

A checklist with its working draft. What visitors see is the version in publication.

Shell

curl -X GET 'https://app.cueston.com/api/checklists/1'

Example ResponseSchema

JSON

{
  "checklist": {
    "id": 42,
    "name": "Onboarding tour",
    "urlPattern": "https://app.acme.com/*",
    "isActive": true,
    "title": "Welcome to Acme",
    "description": "string",
    "items": [
      {
        "id": 42,
        "title": "Welcome to Acme",
        "description": "string",
        "action": {
          "type": "none"
        },
        "completion": {
          "type": "manual"
        },
        "translations": {
          "property1": {
            "title": "Welcome to Acme",
            "description": "string"
          },
          "property2": {
            "title": "Welcome to Acme",
            "description": "string"
          }
        }
      }
    ],
    "launcher": {},
    "completionMessage": "string",
    "styling": {},
    "audienceRules": {
      "enabled": false,
      "matchType": "all",
      "rules": [
        {
          "id": "string",
          "attribute": "string",
          "operator": "equals",
          "value": "string",
          "key": "string"
        }
      ]
    },
    "priority": 0,
    "frequencyType": "always",
    "createdAt": "2026-10-26T09:30:00Z",
    "updatedAt": "2026-10-26T09:30:00Z",
    "publication": {
      "production": {
        "versionId": 7,
        "version": 3,
        "publishedAt": "2026-10-26T09:30:00Z"
      },
      "staging": {
        "versionId": 7,
        "version": 3,
        "publishedAt": "2026-10-26T09:30:00Z"
      }
    },
    "hasUnpublishedChanges": true
  }
}{
  "checklist": {
    "id": 42,
    "name": "Onboarding tour",
    "urlPattern": "https://app.acme.com/*",
    "isActive": true,
    "title": "Welcome to Acme",
    "description": "string",
    "items": [
      {
        "id": 42,
        "title": "Welcome to Acme",
        "description": "string",
        "action": {
          "type": "none"
        },
        "completion": {
          "type": "manual"
        },
        "translations": {
          "property1": {
            "title": "Welcome to Acme",
            "description": "string"
          },
          "property2": {
            "title": "Welcome to Acme",
            "description": "string"
          }
        }
      }
    ],
    "launcher": {},
    "completionMessage": "string",
    "styling": {},
    "audienceRules": {
      "enabled": false,
      "matchType": "all",
      "rules": [
        {
          "id": "string",
          "attribute": "string",
          "operator": "equals",
          "value": "string",
          "key": "string"
        }
      ]
    },
    "priority": 0,
    "frequencyType": "always",
    "createdAt": "2026-10-26T09:30:00Z",
    "updatedAt": "2026-10-26T09:30:00Z",
    "publication": {
      "production": {
        "versionId": 7,
        "version": 3,
        "publishedAt": "2026-10-26T09:30:00Z"
      },
      "staging": {
        "versionId": 7,
        "version": 3,
        "publishedAt": "2026-10-26T09:30:00Z"
      }
    },
    "hasUnpublishedChanges": true
  }
}