API ReferenceModels

Get Model

Returns a single model by ID, including its source fields, identity, and filters.

The response includes the model’s source fields, identity column, and any configured filters. To preview the data a model would return without saving changes, use GET /api/models/{id}/sample.

Authentication

AuthorizationBasic

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

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Query parameters

asyncbooleanOptional

Response

OK
dataobject
jobobject

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error