---
updatedAt: 2026-06-22T13:11:51.000Z
agentTools:
  projectIndex: https://integrations.luscii.com/llms.txt
---

# List instrument items

Returns a paginated list of items for instruments. All versions of an instrument are listed. Items for instruments created by the organisation and by Luscii are both listed.

Accessible by `HC_ADMIN` and `HC_VIEW_ALL`.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Public API reference",
    "description": "Full list of available endpoints.",
    "version": "1.0"
  },
  "paths": {
    "/v1/instrument-items": {
      "get": {
        "tags": [
          "Instruments"
        ],
        "summary": "List instrument items",
        "description": "Returns a paginated list of items for instruments. All versions of an instrument are listed. Items for instruments created by the organisation and by Luscii are both listed.",
        "operationId": "da517e84e34a98becb375caac076cd35",
        "parameters": [
          {
            "$ref": "#/components/parameters/PaginationCursor"
          },
          {
            "$ref": "#/components/parameters/PaginationPageSize"
          }
        ],
        "responses": {
          "200": {
            "description": "Success response if everything works",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "meta",
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "description": "Paginated items data",
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/InstrumentItemTransformer"
                      },
                      "additionalProperties": false
                    },
                    "meta": {
                      "$ref": "#/components/schemas/PaginationData"
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/Unprocessable"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "FhirObservationCoding": {
        "properties": {
          "code": {
            "type": "string",
            "example": "8310-5"
          },
          "system": {
            "type": "string",
            "example": "http://example.org"
          },
          "display": {
            "type": "string",
            "example": "Body temperature"
          }
        },
        "type": "object"
      },
      "PaginationData": {
        "properties": {
          "perPage": {
            "description": "Number of results per page",
            "type": "integer",
            "default": 50
          },
          "nextCursor": {
            "description": "Pagination cursor to be used to fetch next results",
            "type": [
              "string",
              "null"
            ],
            "example": "eyJBbGVyd..."
          },
          "nextPageUrl": {
            "description": "Url to be used to fetch next results",
            "type": [
              "string",
              "null"
            ],
            "example": "https://next.page/?cursor=eyJBbGVyd..."
          },
          "prevCursor": {
            "description": "Pagination cursor to be used to fetch previous results",
            "type": [
              "string",
              "null"
            ],
            "example": "eyJBbGVyd..."
          },
          "prevPageUrl": {
            "description": "Url to be used to fetch previous results",
            "type": [
              "string",
              "null"
            ],
            "example": "https://next.page/?cursor=eyJBbGVyd..."
          }
        },
        "type": "object"
      },
      "uuidSchema": {
        "type": "string",
        "format": "uuid",
        "example": "9890ed24-405d-4688-abcd-b7f829d75939"
      },
      "isoDateTimeSchema": {
        "description": "Date-time formatted to ISO8601. See https://www.rfc-editor.org/rfc/rfc3339#section-5.6",
        "type": "string",
        "format": "date-time",
        "example": "2024-09-17T15:45:00+02:00"
      },
      "InstrumentItemTransformer": {
        "description": "Details of the item.",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/uuidSchema",
            "description": "The unique identifier of the item."
          },
          "version": {
            "$ref": "#/components/schemas/uuidSchema",
            "description": "The version of the item."
          },
          "type": {
            "description": "The type of the moment.",
            "type": "string",
            "example": "numeric",
            "enum": [
              "multiple-choice-single-select",
              "multiple-choice-multi-select",
              "numeric",
              "text",
              "file-picker",
              "external",
              "result"
            ]
          },
          "coding": {
            "description": "The FHIR observation coding, if any.",
            "oneOf": [
              {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/FhirObservationCoding"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "$ref": "#/components/schemas/isoDateTimeSchema",
            "description": "Date and time when the item was created."
          },
          "updatedAt": {
            "$ref": "#/components/schemas/isoDateTimeSchema",
            "description": "Date and time when the item was last updated."
          }
        },
        "type": "object"
      }
    },
    "responses": {
      "Unprocessable": {
        "description": "Unprocessable entity, i.e. Validation error",
        "x-statusCode": "422"
      }
    },
    "parameters": {
      "PaginationCursor": {
        "name": "cursor",
        "in": "query",
        "description": "Cursor to paginate the results",
        "schema": {
          "type": "string"
        }
      },
      "PaginationPageSize": {
        "name": "perPage",
        "in": "query",
        "description": "Number of items per page",
        "schema": {
          "type": "integer",
          "default": 50,
          "maximum": 200,
          "minimum": 1
        }
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "description": "Bearer token. Just enter the token itself without 'Bearer' keyword",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "tags": [
    {
      "name": "Instruments",
      "description": "Instruments related endpoints"
    }
  ],
  "externalDocs": {
    "description": "General Public API Documentation",
    "url": "https://integrations.luscii.com/docs/public-api"
  },
  "servers": [
    {
      "url": "https://vitalsapi.luscii.com/"
    }
  ],
  "x-readme": {}
}
```