Scannable Docs

List items

Returns the items in your inventory, oldest created_at first, or soonest due first with sort=next_inspection_at. An API key reads your whole organisation, whatever folder permissions say. Find an item with serial_number, nfc_tag or q (text in the serial number, name, product or SKU). Add include=data_fields,inspection_frequencies to get what the single item carries without a call per item. Narrow the list with folder_id (which includes the folders inside it), label_id, assigned_to, status, product_id, sku_id, next_inspection_before, next_inspection_after and expires_before. Archived items are left out unless you send archived=true. Pass each response’s next_cursor as cursor to fetch the next page, until it is null.

GET
/v1/items

Authorization

ApiKey
headerAuthorizationBearer <token>

Your organisation's API key. Send it as Authorization: Bearer <key>. Create one in the Scannable admin under Settings → API keys.

Query Parameters

limit?integer

Page size (1–100). Defaults to 20.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor of the previous page. Leave it out for the first page. A cursor only works with the filters it was issued for.

serial_number?string

Only the item with this serial number, ignoring case. A serial number is unique only within a product, so more than one item can match.

q?string

Only the items whose serial number, batch number, name, product name, SKU name, part number or PO number contains this text, ignoring case, or whose NFC tag is this text.

nfc_tag?string

Only the item linked to this NFC tag, by the tag’s id as scanned in either byte order, ignoring case.

folder_id?string

Only the items held in any of these folders or a folder inside one. A folder of another organisation matches nothing. Separate several with commas.

label_id?string

Only the items with any of these labels. A label of another organisation matches nothing. Separate several with commas.

assigned_to?string

Only the items assigned to any of these members. A member of another organisation matches nothing. Separate several with commas.

status?string

Only the items with any of these safety statuses. Separate several with commas, such as not_safe_failed,not_safe_overdue.

product_id?string

Only the items of any of these products. Separate several with commas.

sku_id?string

Only the items of any of these SKUs. Separate several with commas.

next_inspection_before?string

Only the items whose next inspection is due before this time (ISO 8601). Items with no inspection due are left out.

next_inspection_after?string

Only the items whose next inspection is due at or after this time (ISO 8601). Items with no inspection due are left out.

expires_before?string

Only the items that expire before this time (ISO 8601). Items with no expiry are left out.

include?string

Adds to each item what the single item carries: data_fields, inspection_frequencies, or both, comma-separated. Saves retrieving each item on its own.

sort?string

The order of the list. created_at (the default) lists the oldest items first. next_inspection_at lists the items due soonest first, overdue ones included, and those with no next inspection last.

Default"created_at"
Value in"created_at""next_inspection_at"
archived?boolean

Send true for the items you have archived. Omit it or send false for the rest.

Response Body

A page of your items.

application/json
  1. response
data*array<>
total*integer

The total number of results that match the filters.

Range-9007199254740991 <= value <= 9007199254740991
limit*integer

The page size applied to this response.

Range-9007199254740991 <= value <= 9007199254740991
next_cursor*|

Pass as cursor to fetch the next page. Null on the last page.

Example Request
curl -X GET 'https://api.scannable.io/v1/items'
Example response
{  "data": [    {      "id": "item_gdwadfjn13zb7o5",      "serial_id": "serial_gdwadfjn13zb7o5",      "serial_number": "21H0042871",      "name": "Harness 12",      "status": "safe_passed",      "product": {        "id": "prod_hqycu1g6t1yyt16",        "name": "AVAO BOD FAST",        "manufacturer": "Petzl"      },      "sku": {        "id": "sku_wnpil4kqbhgv5o5",        "part_number": "C071CA01",        "name": "AVAO BOD FAST, size 1"      },      "folder": {        "id": "folder_0oiuplyrd7v1tw7",        "name": "Rope Access Kit"      },      "assigned_to": {        "id": "member_tsyqfxifv1te4qf",        "name": "Mere Walker"      },      "labels": [        {          "id": "label_14nvy9743mll6el",          "name": "Rescue kit"        }      ],      "manufactured_at": "2026-03-04T14:05:00.000Z",      "first_used_at": "2026-03-04T14:05:00.000Z",      "expires_at": "2026-03-04T14:05:00.000Z",      "last_inspection": {        "id": "insp_7igae9yjg93sht5",        "status": "failed",        "type": "thorough",        "inspected_at": "2026-03-04T14:05:00.000Z",        "notes": "Webbing abraded behind the rear D-ring."      },      "next_inspection_at": "2026-03-04T14:05:00.000Z",      "archived": false,      "created_at": "2026-03-04T14:05:00.000Z",      "data_fields": [        {          "id": "data_cztnsj2mtmvfb82",          "name": "Asset tag",          "type": "text",          "value": "AT-0042",          "unit": "m",          "visibility": "internal"        }      ],      "inspection_frequencies": [        {          "frequency_id": "freq_fu760equhw69jld",          "name": "6-monthly thorough",          "due_at": "2026-03-04T14:05:00.000Z",          "starts_at": "2026-03-04T14:05:00.000Z"        }      ]    }  ],  "total": 42,  "limit": 20,  "next_cursor": "eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9"}