API ReferenceSchemas

Get Schema Records

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.

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-VersionstringRequired

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