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
      • 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 "X-Polytomic-Version: X-Polytomic-Version" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>"
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-04-20T16:45:00Z",
10      "profile_complete": false
11    }
12  ]
13}
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

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

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

Headers

X-Polytomic-VersionstringRequired

Response

OK
datalist of maps from strings to any or null

Errors

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