- General
- Endpoints
Retrieve Collection Checklist List
GET
/collection/{collection_id}/checklist
Checklist
Request
Path Params
collection_id
string
required
Example:
{{$string.uuid}}
Query Params
filter
string
optional
sort
string
optional
show
string
optional
hide
string
optional
with
string
optional
Header Params
x-api-key
string
required
Default:
{{api_key}}
x-api-env
string
required
Default:
{{api_env}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.vplan.com/v1/collection/{{$string.uuid}}/checklist?limit=100&offset=0&filter=&sort=&show=&hide=&with=' \
--header 'x-api-key;' \
--header 'x-api-env;'
Responses
🟢200Ok
application/json
Body
count
integer <uint64>
optional
>= 0
Default:
1
limit
integer <uint64>
optional
>= 0<= 1000
Default:
100
offset
integer <uint64>
optional
>= 0
Default:
0
data
array[object (Checklist) {11}]
required
id
string <uuid>
read-onlyoptional
name
string
optional
editable
boolean
optional
position
integer
optional
items
array [object {7}]
optional
collection_id
string <uuid>
required
card_id
string <uuid>
required
board_checklist_id
string <uuid> | null
optional
external_ref
string | null
read-onlyoptional
Example:
fb1033a2ed70
created_at
string <date-time>
read-onlyoptional
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Example:
2024-04-11T10:22:15Z
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