Retrieve Collection Checklist List

GET

/collection/{collection_id}/checklist

Retrieve the Checklist List for this collection

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

x-api-env

Example:

x-api-env: ********************

Path Params

Body Params application/json

Example

{
    "count": 1,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "name": "string",
            "editable": true,
            "position": 0,
            "items": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "checklist_id": "4032cca0-5078-4948-a022-e817e3039a01",
                    "description": "string",
                    "position": 0,
                    "checked": true,
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ],
            "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
            "board_checklist_id": "62e3aad7-3992-4982-83ef-b063128dc2d5"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.vplan.com/v1/collection/1e03dd5b-d57d-4577-8ec5-418c7387af61/checklist' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--data-raw '{
    "count": 1,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "name": "string",
            "editable": true,
            "position": 0,
            "items": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "checklist_id": "4032cca0-5078-4948-a022-e817e3039a01",
                    "description": "string",
                    "position": 0,
                    "checked": true,
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ],
            "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
            "board_checklist_id": "62e3aad7-3992-4982-83ef-b063128dc2d5"
        }
    ]
}'

Responses

🟢200Ok

application/json

Body

Example

{
    "count": 1,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "id": "4ae92bb4-f6fb-45ec-9cc3-1d7fd614cd9f",
            "collection_id": "0b3c3130-34ad-4319-aabd-2f4e9bb70f08",
            "card_id": null,
            "board_checklist_id": null,
            "name": "s",
            "editable": true,
            "position": 0,
            "external_ref": null,
            "created_at": "2024-06-10T13:46:05Z",
            "updated_at": "2024-06-10T13:46:05Z",
            "items": [
                {
                    "id": "b9f53a66-4f8a-4cae-b757-f42eef6fac07",
                    "checklist_id": "4ae92bb4-f6fb-45ec-9cc3-1d7fd614cd9f",
                    "description": "a",
                    "position": 0,
                    "checked": false,
                    "created_at": "2024-06-10T13:46:05Z",
                    "updated_at": "2024-06-10T13:46:05Z"
                },
                {
                    "id": "5e738e8d-7cf1-4a71-a258-1b9099336128",
                    "checklist_id": "4ae92bb4-f6fb-45ec-9cc3-1d7fd614cd9f",
                    "description": "b",
                    "position": 1,
                    "checked": false,
                    "created_at": "2024-06-10T13:46:05Z",
                    "updated_at": "2024-06-10T13:46:05Z"
                },
                {
                    "id": "ba62bdf8-b25e-4b2f-befd-342c30562b96",
                    "checklist_id": "4ae92bb4-f6fb-45ec-9cc3-1d7fd614cd9f",
                    "description": "c",
                    "position": 2,
                    "checked": false,
                    "created_at": "2024-06-10T13:46:05Z",
                    "updated_at": "2024-06-10T13:46:05Z"
                },
                {
                    "id": "6476fe57-8d09-46c2-8fa5-d1620759e9c9",
                    "checklist_id": "4ae92bb4-f6fb-45ec-9cc3-1d7fd614cd9f",
                    "description": "d",
                    "position": 3,
                    "checked": false,
                    "created_at": "2024-06-10T13:46:05Z",
                    "updated_at": "2024-06-10T13:46:05Z"
                }
            ]
        }
    ]
}

🟠404Not Found

🟠401Not Logged In

Modified at 2025-07-22 14:20:42

Checklist

Create New Collection Checklist