Retrieve CardRelation List

Request

Query Params

sort

string

optional

field(s) for sorting the dataset, see sorting for more info

Example:

updated_at:desc,id

limit

integer

optional

maximum number of records given, see pagination for more info

>= 1

Default:

100

Example:

50

offset

integer

optional

the number of records to be skipped, see pagination for more info

>= 0

Default:

0

Example:

0

filter

string

optional

used to filter the dataset, see filtering for more info

Example:

created_at:gt:2020-09-26,and,(id:not:starts_with:0000,or,id:contains:FFFF)

show

string

optional

limit the response to show only specific properties, see show & hide for more info

Example:

id,updated_at

hide

string

optional

hide properties from the response, see show & hide for more info

Example:

created_at,updated_at

archived

boolean

optional

per default archived objects are not returned, use this parameter to include archived objects.

combine with filter parameter to return only archived results ?archived&filter=archived_at:not:eq:null

Default:

false

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Request 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/card_relation' \
--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 (CardRelation) {7}]

required

Items

id

string <uuid>

read-onlyoptional

Unique identifier

type

enum<string>

optional

Allowed values:

relatedclonedblocksdepends

Default:

enum<string>

read-onlyoptional

Allowed values:

validwarningerror

Default:

valid

related_card_id

string <uuid>

required

card_id

string <uuid>

required

Unique identifier of the Card

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",
      "type": "related",
      "status": "valid",
      "related_card_id": "fc92fd7b-29ab-4b78-9412-15e37b262a18",
      "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304",
      "created_at": "2024-04-11T10:22:15Z",
      "updated_at": "2024-04-11T10:22:15Z"
    }
  ]
}

🟠401401

🟠404Not Found

🟠401Not Logged In