List Models | Polytomic Docs

curl https://app.polytomic.com/api/models \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>"

{
  "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
    }
  ]
}

Lists all models in the caller’s organization.

Results are ordered by updated_at descending, with id used as a tiebreaker. If more results are available, the response includes pagination.next_page_token. Pass that token back unchanged to continue from the last item you received.

The token is opaque. Do not construct or edit it yourself.

The limit is capped at 50. Values above that cap are reduced to 50, and non-positive values fall back to the same default.

Lists all models in the caller's organization. Results are ordered by `updated_at` descending, with `id` used as a tiebreaker. If more results are available, the response includes `pagination.next_page_token`. Pass that token back unchanged to continue from the last item you received. The token is opaque. Do not construct or edit it yourself. The `limit` is capped at 50. Values above that cap are reduced to 50, and non-positive values fall back to the same default.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Response

datalist of objects or null

Errors

401

Unauthorized Error

404

Not Found Error

Authentication

Headers

Response

Errors