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
        • 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
        • 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
        • 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
          GET
        • Create New Collection
          POST
        • Retrieve Single Collection
          GET
        • Remove Single Collection
          DELETE
        • Move Collection to Backlog
          PUT
        • Update Single Collection
          PUT
        • Move Collection to Board
          POST
      • 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
          • Create New Collection Checklist
          • Retrieve Single Collection Checklist
          • Update Single Collection Checklist
          • Remove Single Collection Checklist
        • 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 Collection List

GET
/collection
Collection
Retrieve the Collection List

Request

Query Params
with
string 
optional
object(s) included in the dataset, see eager loading for more info.
Possible options are:
activities
attachments
cards
checklists
comments
followers
labels
Order
limit
integer 
optional
Number of maximum records given. More info pagination
Default:
100
offset
integer 
optional
Number of records to be skipped. More info pagination
Default:
0
filter
string 
optional
Filter the dataset. More info filtering
sort
string 
optional
Sorting the dataset. More info sorting
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 --request GET 'https://api.vplan.com/v1/collection?limit=100&offset=0&filter=&sort=&show=&hide=' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok
application/json
Body
count
integer <uint64>
optional
Total amount of items
>= 0
Default:
1
limit
integer <uint64>
optional
Max amount of items fetched
>= 0<= 1000
Default:
100
offset
integer <uint64>
optional
Offset so items may be paginated
>= 0
Default:
0
data
array[object (Collection) {21}] 
required
Items
id
string <uuid>
read-onlyoptional
Unique identifier
name
string 
optional
Example:
Order 10199
description
string  | null 
optional
Example:
3x Chair Lissabon
start
string <date> | null 
read-onlyoptional
Earliest date from its Cards
Example:
2020-01-02
end
string <date> | null 
read-onlyoptional
Latest date from its Cards
Example:
2020-08-13
due_date
string <date> | null 
optional
Example:
2020-01-02
meta
object  | null 
read-onlyoptional
Hashmap with additional information for the collection, received via Order
Example:
{"bar":"foo","baz":"quux"}
position
integer  | null 
read-onlyoptional
Position in the backlog, if collection is planned the postion will be null
Example:
13
source_type
enum<string> 
read-onlyoptional
States if the collection is created directly (custom), by cloning a collection or via an Order
Allowed values:
customorderclone
Default:
custom
status
enum<string> 
optional
Status of the collection
planned
collection is planned, and has cards visible on a board
not_planned
collection is on backlog
ignored
collection is in the archive
WARNING
On update the status can only be changed from ignored to not_planned or from not_planned to ignored.
For other actions please look at:
Move Collection to Backlog
Move Collection to Board
Allowed values:
plannednot_plannedignored
Example:
not_planned
progress
enum<string> 
read-onlyoptional
progress of the cards within the collection
open - all cards are on the first status
partial - not all cards are on the first or last status
done - all cards are on the last status
Allowed values:
openpartialdone
Example:
open
warnings
array[string]
read-onlyoptional
Example:
[]
custom_fields
array[object (CustomField) {13}] 
required
board_id
string <uuid>
required
Unique identifier of the Board
cover_image_url
string <uri> | null 
optional
cover_image_signature
string  | null 
read-onlyoptional
cover_image_bytes
integer 
read-onlyoptional
>= 0
cover_color_hex
string  | null 
optional
Examples:
#FFF#8d46e0
Match pattern:
^#([A-Fa-f0-9]{3}){1,2}$
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
{
  "count": 1,
  "limit": 100,
  "offset": 0,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Order 10199",
      "description": "3x Chair Lissabon",
      "start": "2020-01-02",
      "end": "2020-08-13",
      "due_date": "2020-01-02",
      "meta": {
        "bar": "foo",
        "baz": "quux"
      },
      "position": 13,
      "source_type": "custom",
      "status": "planned",
      "progress": "open",
      "warnings": [],
      "custom_fields": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "Weight",
          "type": "text",
          "scope": "collection",
          "priority": 0,
          "value": "string",
          "drawing_id": "19ba6f6f-3365-4d74-bdc5-b3df4072c0ab",
          "components": {
            "latitude": 52.3156048,
            "longitude": 6.496432,
            "country": "Netherlands",
            "city": "Rijssen",
            "postal_code": "7462TB",
            "street1": "Hogepad 83",
            "street2": "Second floor"
          },
          "list": [
            {
              "name": "string",
              "value": "string",
              "color": "transparent"
            }
          ],
          "selected": {
            "name": "string",
            "value": "string",
            "color": ""
          },
          "options": {
            "unit": "kg",
            "align": "left",
            "decimals": 2
          },
          "created_at": "2024-04-11T10:22:15Z",
          "updated_at": "2024-04-11T10:22:15Z"
        }
      ],
      "board_id": "75e8c400-2dbc-43a3-9af4-ff9e6c099385",
      "cover_image_url": "http://example.com",
      "cover_image_signature": "string",
      "cover_image_bytes": 0,
      "cover_color_hex": "#FFF",
      "external_ref": "fb1033a2ed70",
      "created_at": "2024-04-11T10:22:15Z",
      "updated_at": "2024-04-11T10:22:15Z"
    }
  ]
}
🟠401Not Logged In
Modified at 2024-10-04 09:04:55
Previous
Delete Custom Field By Name
Next
Create New Collection
Built with