Scannable Docs
Get started

Quickstart

Create an API key, check it, and read your first items from the equipment owner API.

Make your first call to the equipment owner API in about five minutes. You need to be an admin of your Scannable organisation, and a terminal with curl.

The API lives at https://api.scannable.io. Every path starts with the version, /v1. It is read only for now: it reads your members, teams, folders, items and inspections, and changes nothing.

Create an API key

Only organisation admins can create API keys. The key acts for your organisation, not for you, and can read every folder and item its scopes cover.

In the Scannable web app, open Settings → API keys. Select Create API key. If you don't see Create API key, contact Scannable support to turn on API access for your organisation.

  1. Name the key after the system that will use it, such as Asset register sync.
  2. Under the scopes, tick Read for each resource your integration needs. For this quickstart, tick Read for Items.
  3. Create the key and copy it. Scannable shows it once.

A key with no scopes can't call the equipment owner API. Every request returns 403.

Store the key as an environment variable so it stays out of your code:

export SCANNABLE_API_KEY="paste-your-key-here"

Check the key

Get the authenticated identity returns the organisation the key acts for and the scopes it grants.

Request
curl https://api.scannable.io/v1/auth/me \
  -H "Authorization: Bearer $SCANNABLE_API_KEY"
Response
{
  "organisation_id": "org_8r4lvh6r3knlg1w",
  "type": "equipment_owner",
  "member_id": "member_tsyqfxifv1te4qf",
  "name": "Southern Alps Rope Access",
  "created_at": "2024-05-13T08:00:00.000Z",
  "auth_method": "api_key",
  "user": null,
  "roles": [],
  "scopes": ["items:read"]
}

Check that type is equipment_owner and that scopes lists every scope you ticked. A 401 means the key is wrong, expired or revoked.

List your items

List items returns the equipment in your inventory, 20 at a time.

Request
curl "https://api.scannable.io/v1/items?limit=1" \
  -H "Authorization: Bearer $SCANNABLE_API_KEY"
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": "2021-08-01T00:00:00.000Z",
      "first_used_at": "2022-01-10T00:00:00.000Z",
      "expires_at": "2031-08-01T00:00:00.000Z",
      "last_inspection": {
        "id": "insp_7igae9yjg93sht5",
        "status": "passed",
        "type": "thorough",
        "inspected_at": "2026-09-02T09:30:00.000Z",
        "notes": null
      },
      "next_inspection_at": "2027-03-02T09:30:00.000Z",
      "archived": false,
      "created_at": "2022-01-10T08:12:00.000Z"
    }
  ],
  "total": 412,
  "limit": 1,
  "next_cursor": "eyJjcmVhdGVkQXQiOiIyMDIyLTAxLTEwVDA4OjEyOjAwLjAwMFoifQ"
}

A 403 with code: "forbidden_scope" means the key lacks items:read. Create a new key with that scope ticked.

Next steps

On this page