Retrieve Relation List

Request

Query Params

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.vplan.com/v1/relation?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 (Relation) {12}]

optional

Items

id

string <uuid>

read-onlyoptional

Unique identifier

name

string

optional

<= 100 characters

description

string | null

optional

<= 150 characters

type

string | null

optional

<= 255 characters

note

string | null

optional

<= 65535 characters

phone

string | null

optional

<= 25 characters

fax

string | null

optional

<= 25 characters

email

string <email> | null

optional

<= 254 characters

website

string <uri> | null

optional

<= 512 characters

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": "string",
      "description": "string",
      "type": "string",
      "note": "string",
      "phone": "string",
      "fax": "string",
      "email": "user@example.com",
      "website": "http://example.com",
      "external_ref": "fb1033a2ed70",
      "created_at": "2024-04-11T10:22:15Z",
      "updated_at": "2024-04-11T10:22:15Z"
    }
  ]
}

🟠401Not Logged In