GET
/
components
curl --request GET \
  --url https://api.serial.io/components \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "component_type": "SN",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "last_edited_at": "2023-11-07T05:31:56Z",
    "last_edited_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pn_metadata_dataset_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Query Parameters

​
name
string

Get component by its name (Case & space sensitive, must match exactly to return the component)

​
is_active
boolean

Get all active components if true, all inactive components if false

​
component_type
string

Get components by its type (SN or LOT)

Response

200
application/json

OK

The response is of type object[].

GET
/
components
curl --request GET \
  --url https://api.serial.io/components \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "component_type": "SN",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "last_edited_at": "2023-11-07T05:31:56Z",
    "last_edited_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pn_metadata_dataset_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Query Parameters

​
name
string

Get component by its name (Case & space sensitive, must match exactly to return the component)

​
is_active
boolean

Get all active components if true, all inactive components if false

​
component_type
string

Get components by its type (SN or LOT)

Response

200
application/json

OK

The response is of type object[].