List records | Runtype Documentation

{
  "data": [
    {
      "createdAt": "2024-06-10T09:15:00Z",
      "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a1d9e",
      "messages": [
        {
          "type": "info",
          "content": "Record created successfully"
        }
      ],
      "metadata": {
        "priority": "high",
        "category": "task"
      },
      "name": "Project Kickoff",
      "organizationId": "org_987654321",
      "productSurfaceId": "prod_surface_12345",
      "schemaValid": true,
      "type": "task",
      "updatedAt": "2024-06-12T16:45:00Z",
      "userId": "user_123456789",
      "availableFields": [
        "title",
        "description",
        "status"
      ],
      "metadataLabels": {
        "priority": "Priority Level",
        "category": "Task Category"
      },
      "metadataSchema": {
        "keys": [
          "priority",
          "category",
          "dueDate"
        ]
      }
    }
  ],
  "pagination": {
    "currentOffset": 0,
    "hasMore": true,
    "hasPrev": false,
    "limit": 10,
    "nextCursor": "cursor_abcdef123456",
    "prevCursor": null,
    "currentPage": 1,
    "totalCount": 25,
    "totalPages": 3
  },
  "filtersApplied": {}
}

Get all records for the authenticated user with advanced filtering and cursor pagination.

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

limitstringOptional

cursorstringOptional

directionstringOptional

includeCountstringOptional

typestringOptional

searchstringOptional

namestringOptional

distinctstringOptional

includeFieldsstringOptional

product_surface_idstringOptional

metadata_keysstringOptional

metadata_keys_allstringOptional

min_fieldsstringOptional

max_fieldsstringOptional

metadata_typesstringOptional

has_large_fieldsstringOptional

min_size_kbstringOptional

max_size_kbstringOptional

recordFilterstringOptional

Response

Paginated list of records

datalist of objects

paginationobject

filtersAppliedmap from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/records \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"