For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
  • Getting started
    • Introduction
    • Obtaining API keys
    • Quickstart
    • Native clients
    • Concepts
    • Embedding authentication
    • Versioning
    • Idempotent requests
    • Events
  • Configuring your connections
    • CDC streaming from databases
  • Code examples
    • Bulk sync (ELT) from HubSpot to PostgreSQL
    • Bulk sync (ELT) from Salesforce to S3
    • Bulk sync (ELT) from Salesforce to Snowflake
    • Model sync (Reverse ETL) from MongoDB to Salesforce
  • API Reference
      • POSTEnrichment Fields
      • POSTPreview Model
      • GETList Models
      • POSTCreate Model
      • GETGet Model
      • DELDelete Model
      • PATCHUpdate Model
      • GETSample Records
Logo
Log inBook a demo
API ReferenceModels

List Models

GET
https://app.polytomic.com/api/models
GET
/api/models
$curl https://app.polytomic.com/api/models \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -u "<username>:<password>"
1{
2  "data": [
3    {
4      "configuration": {
5        "table": "public.contacts"
6      },
7      "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
8      "created_at": "2024-01-15T09:30:00Z",
9      "created_by": {
10        "id": "12345678-1234-1234-1234-123456789012",
11        "name": "John Doe",
12        "type": "user"
13      },
14      "enricher": {
15        "configuration": {},
16        "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
17        "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
18        "fields": [
19          {
20            "name": "phone_number"
21          }
22        ],
23        "mappings": {}
24      },
25      "fields": [
26        {
27          "created_at": "2024-01-15T09:30:00Z",
28          "created_by": {
29            "id": "12345678-1234-1234-1234-123456789012",
30            "name": "John Doe",
31            "type": "user"
32          },
33          "description": "Unique identifier",
34          "example": null,
35          "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
36          "label": "ID",
37          "name": "id",
38          "remote_type": "string",
39          "type": "string",
40          "unique": true,
41          "updated_at": "2024-01-15T09:30:00Z",
42          "user_added": false
43        }
44      ],
45      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
46      "identifier": "id",
47      "labels": [
48        {}
49      ],
50      "name": "Contacts",
51      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
52      "policies": [
53        "248df4b7-aa70-47b8-a036-33ac447e668d"
54      ],
55      "relations": [
56        {
57          "from": "id",
58          "to": {
59            "field": "user_id",
60            "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
61          }
62        }
63      ],
64      "tracking_columns": [
65        "string"
66      ],
67      "type": "postgresql",
68      "updated_at": "2024-01-15T09:30:00Z",
69      "updated_by": {
70        "id": "12345678-1234-1234-1234-123456789012",
71        "name": "John Doe",
72        "type": "user"
73      },
74      "version": 1
75    }
76  ]
77}
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.
Was this page helpful?
Previous

Create Model

Next

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)

OR
AuthorizationBearer
This is the Polytomic API key

Headers

X-Polytomic-VersionstringRequired

Response

OK
datalist of objects or null

Errors

401
Unauthorized Error
404
Not Found Error