Retrieve Resource List

Request

Query Params

with

string

optional

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

Possible options are:

activities - activities the resource is able to perform

cards

group - resource groups it belongs to

schedules

schedule_deviations

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 filtering

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

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

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/resource?limit=100&offset=0&filter=&sort=&show=&hide=&archived=' \
--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 (Resource) {14}]

optional

Items

id

string <uuid>

read-onlyoptional

Unique identifier

name

string

optional

type

enum<string>

optional

Allowed values:

machinecellemployee

Default:

resource

description

string

optional

start_date

string <date>

optional

end_date

string <date> | null

optional

avatar

string <uri> | null

optional

workdays

object (ResourceWorkdays)

optional

Days of the week that are considered workdays

integration_schedule

boolean

optional

If false, vPlan manages the schedules via workdays. When true, integration manages the schedules

color_hex

string

optional

Color hex is used to signify the Resource, only used if the avatar is null

Match pattern:

^#([0-9a-f]{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

archived_at

string <date-time> | null

read-onlyoptional

Date and time that the object is archived

Example:

2021-07-06T11:24:35Z

Example

{
  "count": 1,
  "limit": 100,
  "offset": 0,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "type": "resource",
      "description": "string",
      "start_date": "2019-08-24",
      "end_date": "2019-08-24",
      "avatar": "http://example.com",
      "workdays": {
        "1": 0,
        "2": 0,
        "3": 0,
        "4": 0,
        "5": 0,
        "6": 0,
        "7": 0
      },
      "integration_schedule": true,
      "color_hex": "string",
      "external_ref": "fb1033a2ed70",
      "created_at": "2024-04-11T10:22:15Z",
      "updated_at": "2024-04-11T10:22:15Z",
      "archived_at": "2021-07-06T11:24:35Z"
    }
  ]
}

🟠404Not Found

🟠401Not Logged In