---
title: "List records"
method: GET
path: "/api/records/"
tags: ["records"]
---

# List records

`GET /api/records/`

## Request

- Base URL: `https://docs.blindinsight.io` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.blindinsight.io/api/records/`
- Auth: one of:
  - API key in cookie `sessionid`
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/blindinsight/apis/blind-insight-rest-api/docs/api/records/get.ts> (a function with typed inputs; its response is checked against the schema)

List records for the given schema ID. Takes optional pagination parameters
`limit` and `offset`, as well as an optional query filter `q`.

The response will be a list of record objects.

**On the command line:**

```bash
blind records list --schema "<schema-id>"
```

## Query parameters

- `limit` integer
- `offset` integer
- `q` string[]
- `schema` string

## Response `200`

- Record[]
  - `id` string, required
  - `url` string, uri, required
  - `schema` string, uri, required
  - `data` object: The data that this record represents.

---

[API](https://skmtc.dev/blindinsight/apis/blind-insight-rest-api.md) - [All operations](https://skmtc.dev/blindinsight/apis/blind-insight-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/blindinsight/apis/blind-insight-rest-api/revisions/0ac902401cea?raw)