Retrieve Collection List

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:

checklists

followers

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:

filter

string

optional

Filter the dataset. More info filter

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:

x-api-env

string

required

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

count

integer <uint64>

optional

Total amount of items

>= 0

Default:

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:

data

array[object (Collection) {21}]

required

Items

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:

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