vPlan
  1. Collection
vPlan
  • General
    • Structure
    • Synchronize Data
    • Pagination
    • Sorting
    • Filtering
    • Show & Hide
    • Eager Loading
    • Deep Insertion
    • Deprecated
    • External Reference
    • Rate Limits
    • Authentication
      • Authentication
        • Get authorization
        • Token Exchange
      • Me
        • Retrieve information about current authentication
    • Errors
      • Empty values in created object
      • Memory Exhausted
      • Report an issue
      • Service Unavailable
      • Retrieve Api Messages
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • View
          • Create New BoardView
        • Retrieve Board List
        • Create New Board
        • Retrieve Single Board
        • Update Single Board
        • Remove Single Board
      • Stage
        • Retrieve Stage List
        • Create New Stage
        • Retrieve Single Stage
        • Update Single Stage
        • Remove Single Stage
      • Activity
        • Retrieve Activity List
        • Create New Activity
        • Retrieve Single Activity
        • Update Single Activity
        • Remove Single Activity
      • Resource
        • Schedule
        • Schedule Deviation
          • Retrieve Deviation List
          • Create New Schedule Deviation
          • Retrieve Single Schedule Deviation
          • Update Single Schedule Deviation
          • Remove Single Schedule Deviation
        • Retrieve Resource List
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Schedule
        • Retrieve Schedule List
        • Retrieve Schedule Year
        • Retrieve Schedule Month
        • Schedule Retrieve Day
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Invite User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Update Single Collection
        • Move Collection to Board
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
        • All Cards List
      • Attachment
        • Retrieve Attachment List
        • Upload New Attachment
        • Add New Attachment Link
        • Retrieve Single Attachment
        • Remove Single Attachment
      • Comment
        • Retrieve Comment List
        • Create New Comment
        • Retrieve Single Comment
        • Update Single Comment
        • Remove Single Comment
      • Checklist
        • Collection
          • Retrieve Collection Checklist List
            GET
          • Create New Collection Checklist
            POST
          • Retrieve Single Collection Checklist
            GET
          • Update Single Collection Checklist
            PUT
          • Remove Single Collection Checklist
            DELETE
        • Card
          • Retrieve Card Checklist List
          • Create New Card Checklist
          • Retrieve Single Card Checklist
          • Update Single Card Checklist
          • Remove Single Card Checklist
      • Time Tracking
        • Retrieve TimeTracking List
        • Create New TimeTracking
        • Retrieve Single TimeTracking
        • Update Single TimeTracking
        • Remove Single TimeTracking
        • Export TimeTracking
      • Relations between cards
        • Retrieve CardRelation List
        • Create New CardRelation
        • Retrieve Single CardRelation
        • Remove Single CardRelation
    • Order Data
      • Address
      • Order
        • Retrieve Order List
        • Create New Order
        • Retrieve Single Order
        • Update Single Order
        • Remove Single Order
      • Row
        • Retrieve OrderRow List
        • Create New OrderRow
        • Retrieve Single OrderRow
        • Update Single OrderRow
        • Remove Single OrderRow
      • Item
        • Retrieve Item List
        • Create New Item
        • Retrieve Single Item
        • Update Single Item
        • Remove Single Item
      • Project
        • Retrieve Project List
        • Create New Project
        • Retrieve Single Project
        • Update Single Project
        • Remove Single Project
      • Relation
        • Retrieve Relation List
        • Create New Relation
        • Retrieve Single Relation
        • Update Single Relation
        • Remove Single Relation
      • Warehouse
        • Retrieve Warehouse List
        • Create New Warehouse
        • Retrieve Single Warehouse
        • Update Single Warehouse
        • Remove Single Warehouse
    • Webhook
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
    • Payload send to webhook url
      • Normal Object
      • Nested Object
      • Nested Object with Pivot
  1. Collection

Retrieve Single Collection Checklist

GET
/collection/{collection_id}/checklist/{checklist_id}
Retrieve a single Checklist from this collection

Request

Path Params
collection_id
string 
required
Example:
{{$string.uuid}}
checklist_id
string 
required
Example:
{{$string.uuid}}
Query Params
show
string 
optional
Show only specific properties from the response. More info show & hide
hide
string 
optional
Hide properties from the response. More info show & hide
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/{{$string.uuid}}?show=&hide=' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok
application/json
Body
id
string <uuid>
read-onlyoptional
Unique identifier
name
string 
optional
editable
boolean 
optional
position
integer 
optional
items
array [object {7}] 
optional
id
string <uuid>
optional
checklist_id
string <uuid>
optional
description
string 
optional
position
integer 
optional
checked
boolean 
optional
created_at
string <date-time>
optional
updated_at
string <date-time>
optional
collection_id
string <uuid>
required
Unique identifier of the Collection
card_id
string <uuid>
required
Unique identifier of the Card
board_checklist_id
string <uuid> | null 
optional
external_ref
string  | null 
read-onlyoptional
Third-party reference of the object, for informational purposes only
Example:
fb1033a2ed70
created_at
string <date-time>
read-onlyoptional
Date and time of creation
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Date and time of last update
Example:
2024-04-11T10:22:15Z
Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "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",
    "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304",
    "board_checklist_id": "62e3aad7-3992-4982-83ef-b063128dc2d5",
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z"
}
🟠404Not Found
🟠401Not Logged In
Modified at 2025-05-26 13:17:47
Previous
Create New Collection Checklist
Next
Update Single Collection Checklist
Built with