Get Model | Polytomic Docs

curl https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "configuration": {
      "table": "public.contacts"
    },
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "enricher": {
      "configuration": {},
      "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "fields": [
        {
          "name": "phone_number"
        }
      ],
      "mappings": {}
    },
    "fields": [
      {
        "created_at": "2024-01-15T09:30:00Z",
        "created_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        },
        "description": "Unique identifier",
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "label": "ID",
        "name": "id",
        "remote_type": "string",
        "type": "string",
        "unique": true,
        "updated_at": "2024-01-15T09:30:00Z",
        "user_added": false
      }
    ],
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "identifier": "id",
    "labels": [
      {}
    ],
    "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"
        }
      }
    ],
    "tracking_columns": [
      "string"
    ],
    "type": "postgresql",
    "updated_at": "2024-01-15T09:30:00Z",
    "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",
    "status": "created",
    "type": "createmodel"
  }
}

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

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Query parameters

asyncbooleanOptional

Response

dataobject

jobobject

Errors

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors