For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • POSTUpsert Schema Fields
      • DELDelete Schema Field
      • PATCHPatch Schema Field
      • PUTSet Primary Keys
      • DELReset Primary Keys
      • POSTRefresh Connection Schema
      • GETGet Schema Status
      • GETGet Schema
      • GETGet Schema Records
Logo
Log inBook a demo
API ReferenceSchemas

Get Schema Records

GET
https://app.polytomic.com/api/connections/:id/schemas/:schema_id/records
GET
/api/connections/:id/schemas/:schema_id/records
$curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/public.users/records \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "id": 1024,
5      "username": "jdoe",
6      "email": "jdoe@example.com",
7      "created_at": "2023-11-15T09:27:00Z",
8      "is_active": true,
9      "last_login": "2024-06-10T14:45:00Z",
10      "profile": {
11        "first_name": "John",
12        "last_name": "Doe",
13        "birthdate": "1985-04-12"
14      }
15    }
16  ]
17}
Returns a sample of records from a schema on a connection. The sample is intended for previewing the shape and values of data before committing to a sync configuration, not for full data export. > 🚧 The sample is not guaranteed to be representative of the full dataset. > Row selection is implementation-defined and may differ across connection > types. > 📘 If the schema's field definitions are stale, refresh them first with > [`POST /api/connections/{id}/schemas/refresh`](../../../../../../api-reference/schemas/refresh) to ensure > the sample aligns with the current schema structure.
Was this page helpful?
Previous

Get Events

Next

Returns a sample of records from a schema on a connection.

The sample is intended for previewing the shape and values of data before committing to a sync configuration, not for full data export.

🚧 The sample is not guaranteed to be representative of the full dataset. Row selection is implementation-defined and may differ across connection types.

📘 If the schema’s field definitions are stale, refresh them first with POST /api/connections/{id}/schemas/refresh to ensure the sample aligns with the current schema structure.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the connection.
schema_idstringRequired
Identifier of the schema within the connection.

Headers

X-Polytomic-VersionstringOptional

Response

OK
datalist of maps from strings to any or null

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error