Retrieve Card List

Retrieve the Card List for this collection

NOTE

If collection with id does not exist, it will return an empty list of cards NOT a 404 response.

Request

Path Params

collection_id

string

required

Query Params

include

array[string]

optional

object(s) included in the dataset, see eager loading for more info.

Possible options are:

time_tracking_total

resource_type_count - count of linked resources by resource type

resource_type_time - sum of linked activities by resource type

Allowed values:

time_tracking_totalresource_type_countresource_type_time

with

array[string]

optional

object(s) included in the dataset, see eager loading for more info.

Possible options are:

activities

collection

labels

resources - assigned to the card

stage

statuses

time - total time of the linked activities

time_tracking

relations

Allowed values:

activitiescollectionlabelsresourcesstagestatustimetime_trackingrelations

enrich_custom_fields

boolean

optional

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 (Card) {27}]

required

Items

string <uuid>

read-onlyoptional

Unique identifier

name

string

optional

Name specific for a Card

NOTE

Collection has a name global for all cards, however a Card can have a specific name different from the rest.

Update the Collection name to update it for every Card.

Example:

Painting Order 10199

description

string

optional

Description specific for a Card

NOTE

Collection has a description global for all cards, however a Card can have a specific description different from the rest.

Update the Collection description to update it for every Card.

Example:

Painting 3x Chair Lissabon Red

start_date

string <date> | null

optional

Default:

2020-01-02

start_time

string <time> | null

optional

Default:

15:00

end_date

string <date> | null

optional

Default:

2020-01-02

end_time

string <time> | null

optional

Default:

15:00

rank

string

read-onlyoptional

Alphanumeric representation of the position

Default:

aaa

position

integer

read-onlyoptional

Position of the card in a day

days_diff

integer

read-onlyoptional

days_active

integer

read-onlyoptional

locked

boolean

read-onlyoptional

time_tracking_running

boolean

read-onlyoptional

custom_fields

array[object (CustomField) {13}]

required

date

string <date> | null

deprecated

Default:

2020-01-02

start

string <date> | null

deprecated

Default:

2020-01-02

end

string <date> | null

deprecated

Default:

2020-01-02

time

integer

deprecated

Duration of the card in minutes

Example:

120

card_recurring_id

string <uuid> | null

optional

parent_card_id

string <uuid> | null

optional

collection_id

string <uuid>

required

Unique identifier of the Collection

status_id

string <uuid>

required

Unique identifier of the Status

stage_id

string <uuid>

required

Unique identifier of the Stage

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

completed_at

string <date-time> | null

optional

created_at

string <date-time>

read-onlyrequired

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyrequired

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": "Painting Order 10199",
      "description": "Painting 3x Chair Lissabon Red",
      "start_date": "2020-01-02",
      "start_time": "15:00",
      "end_date": "2020-01-02",
      "end_time": "15:00",
      "rank": "aaa",
      "position": 0,
      "days_diff": 0,
      "days_active": 0,
      "locked": true,
      "time_tracking_running": true,
      "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"
        }
      ],
      "date": "2020-01-02",
      "start": "2020-01-02",
      "end": "2020-01-02",
      "time": 120,
      "card_recurring_id": "106de719-5cc0-4af9-bc80-777744f7e20c",
      "parent_card_id": "37909c19-1675-4aa9-a5ad-e2a7cefd2529",
      "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
      "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
      "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
      "external_ref": "fb1033a2ed70",
      "completed_at": "2019-08-24T14:15:22Z",
      "created_at": "2024-04-11T10:22:15Z",
      "updated_at": "2024-04-11T10:22:15Z"
    }
  ]
}

🟠401Not Logged In