Get Component Instances
curl --request GET \
--url https://api.serial.io/components/instances \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.serial.io/components/instances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.serial.io/components/instances', 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.serial.io/components/instances",
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: Bearer <token>"
],
]);
$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.serial.io/components/instances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.serial.io/components/instances")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.serial.io/components/instances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"identifier": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"status": "WIP",
"last_updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"part_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_archived": true,
"work_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latitude": 123,
"longitude": 123
}
]Component Instances
Get Component Instances
Gets all component instances matching query parameters
GET
/
components
/
instances
Get Component Instances
curl --request GET \
--url https://api.serial.io/components/instances \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.serial.io/components/instances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.serial.io/components/instances', 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.serial.io/components/instances",
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: Bearer <token>"
],
]);
$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.serial.io/components/instances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.serial.io/components/instances")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.serial.io/components/instances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"identifier": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"status": "WIP",
"last_updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"part_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_archived": true,
"work_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latitude": 123,
"longitude": 123
}
]Authorizations
API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>
Query Parameters
Component's Serial backend id
User facing name of the component (must match exactly, is case senstitive)
Component's Type (either SN or LOT)
Component's Status (WIP, PLANNED, DEFECTIVE, COMPLETE)
Components associated to particular work order
Components associated with a specific part number
Show children for returned component instances
Show parents for returned component instances
Response
200 - application/json
OK
Available options:
WIP, PLANNED, DEFECTIVE, COMPLETE 
