v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Models

List Models

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.

get/api/models

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