- General
- Endpoints
Retrieve Item List
GET
/item
Item
Request
Query Params
filter
string
optional
sort
string
optional
show
string
optional
hide
string
optional
with
string
optional
Header Params
x-api-key
string
required
Default:
{{api_key}}
x-api-env
string
required
Default:
{{api_env}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.vplan.com/v1/item?limit=100&offset=0&filter=&sort=&show=&hide=&with=' \
--header 'x-api-key;' \
--header 'x-api-env;'
Responses
🟢200Ok
application/json
Body
count
integer <uint64>
optional
>= 0
Default:
1
limit
integer <uint64>
optional
>= 0<= 1000
Default:
100
offset
integer <uint64>
optional
>= 0
Default:
0
data
array[object (Item) {10}]
optional
id
string <uuid>
read-onlyoptional
description
string
optional
<= 150 characters
code
string
optional
<= 50 characters
external_ref
string | null
read-onlyoptional
Example:
fb1033a2ed70
stockmanagement
boolean
optional
unit
string | null
optional
note
string | null
optional
location
string | null
optional
created_at
string <date-time>
read-onlyoptional
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Example:
2024-04-11T10:22:15Z
Example
{
"count": 1,
"limit": 100,
"offset": 0,
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"description": "string",
"code": "string",
"external_ref": "fb1033a2ed70",
"stockmanagement": true,
"unit": "string",
"note": "string",
"location": "string",
"created_at": "2024-04-11T10:22:15Z",
"updated_at": "2024-04-11T10:22:15Z"
}
]
}
🟠401Not Logged In