v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBModels
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.
get/api/models/{id}
Path parameters
idstring uuid required
Example:248df4b7-aa70-47b8-a036-33ac447e668d
Query parameters
asyncboolean
Headers
X-Polytomic-Versionstring
Response
OK
Example response
{
"data": {
"configuration": {
"table": "public.contacts"
},
"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"created_by": {
"id": "12345678-1234-1234-1234-123456789012",
"name": "John Doe",
"type": "user"
},
"enricher": {
"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"fields": [
{
"name": "phone_number"
}
]
},
"fields": [
{
"created_by": {
"id": "12345678-1234-1234-1234-123456789012",
"name": "John Doe",
"type": "user"
},
"description": "Unique identifier",
"example": 123,
"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"label": "ID",
"name": "id",
"remote_type": "string",
"type": "string",
"unique": true
}
],
"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"identifier": "id",
"name": "Contacts",
"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"policies": [
"248df4b7-aa70-47b8-a036-33ac447e668d"
],
"relations": [
{
"from": "id",
"to": {
"field": "user_id",
"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
}
}
],
"type": "postgresql",
"updated_by": {
"id": "12345678-1234-1234-1234-123456789012",
"name": "John Doe",
"type": "user"
},
"version": 1
},
"job": {
"error": "error message",
"job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"type": "createmodel"
}
}