Retrieves the item list.
curl --request GET \
--url https://api.example.com/api/items \
--header 'Authorization: <authorization>' \
--header 'organization-id: <organization-id>'import requests
url = "https://api.example.com/api/items"
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};
fetch('https://api.example.com/api/items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"organization-id: <organization-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/items"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/items")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
response = http.request(request)
puts response.read_body{
"pagination": {
"total": 100,
"page": 1,
"pageSize": 10
},
"data": [
{
"id": 1,
"name": "Ergonomic Office Chair Model X-2000",
"type": "inventory",
"typeFormatted": "Inventory Item",
"sellable": true,
"purchasable": true,
"currencyCode": "USD",
"active": true,
"createdAt": "2024-03-20T10:00:00Z",
"updatedAt": "2024-03-20T10:00:00Z",
"code": "CHAIR-X2000",
"sellPrice": 399.99,
"sellPriceFormatted": "$399.99",
"costPrice": 299.99,
"costPriceFormatted": "$299.99",
"costAccountId": 1001,
"costAccount": {},
"inventoryAccountId": 3001,
"inventoryAccount": {},
"sellAccountId": 2001,
"sellAccount": {},
"categoryId": 5,
"category": {},
"sellDescription": "Premium ergonomic office chair with adjustable height and lumbar support",
"purchaseDescription": "Ergonomic office chair - Model X-2000 with standard features",
"quantityOnHand": 50,
"note": "Available in black, gray, and navy colors. 5-year warranty included.",
"sellTaxRateId": 1,
"sellTaxRate": {},
"purchaseTaxRateId": 1,
"purchaseTaxRate": {},
"itemWarehouses": "<array>"
}
]
}Items
Retrieves the item list.
GET
/
api
/
items
Retrieves the item list.
curl --request GET \
--url https://api.example.com/api/items \
--header 'Authorization: <authorization>' \
--header 'organization-id: <organization-id>'import requests
url = "https://api.example.com/api/items"
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};
fetch('https://api.example.com/api/items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"organization-id: <organization-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/items"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/items")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
response = http.request(request)
puts response.read_body{
"pagination": {
"total": 100,
"page": 1,
"pageSize": 10
},
"data": [
{
"id": 1,
"name": "Ergonomic Office Chair Model X-2000",
"type": "inventory",
"typeFormatted": "Inventory Item",
"sellable": true,
"purchasable": true,
"currencyCode": "USD",
"active": true,
"createdAt": "2024-03-20T10:00:00Z",
"updatedAt": "2024-03-20T10:00:00Z",
"code": "CHAIR-X2000",
"sellPrice": 399.99,
"sellPriceFormatted": "$399.99",
"costPrice": 299.99,
"costPriceFormatted": "$299.99",
"costAccountId": 1001,
"costAccount": {},
"inventoryAccountId": 3001,
"inventoryAccount": {},
"sellAccountId": 2001,
"sellAccount": {},
"categoryId": 5,
"category": {},
"sellDescription": "Premium ergonomic office chair with adjustable height and lumbar support",
"purchaseDescription": "Ergonomic office chair - Model X-2000 with standard features",
"quantityOnHand": 50,
"note": "Available in black, gray, and navy colors. 5-year warranty included.",
"sellTaxRateId": 1,
"sellTaxRate": {},
"purchaseTaxRateId": 1,
"purchaseTaxRate": {},
"itemWarehouses": "<array>"
}
]
}Headers
Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Query Parameters
Filter for inactive items
Number of items per page
Page number for pagination
View slug for filtering
Search keyword
Stringified filter roles
Sort order direction
Available options:
DESC, ASC Column sort direction
Array of filter roles
Custom view ID for filtering
⌘I