Retrieve Collection List

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: ********************

or

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.vplan.com/v1/collection?with=' \
--header 'x-api-key: <api-key>' \
--header 'x-api-env: <api-key>'

Responses

🟢200Ok

application/json

Body

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": 0,
            "source_type": "custom",
            "status": "planned",
            "progress": "open",
            "warnings": [],
            "custom_fields": [
                {
                    "board_id": "75e8c400-2dbc-43a3-9af4-ff9e6c099385",
                    "value": {
                        "description": "string",
                        "color": "transparent"
                    },
                    "options": {
                        "values": [
                            {
                                "description": "string",
                                "color": "transparent"
                            }
                        ],
                        "default": "string"
                    }
                }
            ],
            "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