Get Model

GET

1 import { PolytomicClient } from "polytomic";
2 
3 const client = new PolytomicClient({ token: "YOUR_TOKEN", version: "YOUR_VERSION" });
4 await client.models.get("248df4b7-aa70-47b8-a036-33ac447e668d");

Play

1 {
2   "data": {
3     "configuration": {
4       "table": "public.contacts"
5     },
6     "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7     "created_at": "2024-01-15T09:30:00Z",
8     "created_by": {
9       "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
10       "name": "name",
11       "type": "type"
12     },
13     "enricher": {
14       "configuration": {
15         "key": "value"
16       },
17       "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
18       "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
19       "fields": [
20         {
21           "description": "Unique identifier",
22           "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
23           "label": "ID",
24           "name": "phone_number",
25           "remote_type": "string",
26           "type": "string",
27           "unique": true,
28           "user_added": false
29         }
30       ],
31       "mappings": {
32         "key": "value"
33       }
34     },
35     "fields": [
36       {
37         "description": "Unique identifier",
38         "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
39         "label": "ID",
40         "name": "id",
41         "remote_type": "string",
42         "type": "string",
43         "unique": true,
44         "user_added": false
45       }
46     ],
47     "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
48     "identifier": "id",
49     "labels": [
50       {
51         "key": "value"
52       }
53     ],
54     "name": "Contacts",
55     "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
56     "policies": [
57       "248df4b7-aa70-47b8-a036-33ac447e668d"
58     ],
59     "relations": [
60       {
61         "from": "id"
62       }
63     ],
64     "tracking_columns": [
65       "tracking_columns"
66     ],
67     "type": "postgresql",
68     "updated_at": "2024-01-15T09:30:00Z",
69     "updated_by": {
70       "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
71       "name": "name",
72       "type": "type"
73     },
74     "version": 1
75   },
76   "job": {
77     "error": "error message",
78     "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
79     "result": {
80       "key": "value"
81     },
82     "status": "created",
83     "type": "createmodel"
84   }
85 }

Path parameters

idstringRequired

Query parameters

asyncbooleanOptional

Response

dataobjectOptional

jobobjectOptional

Get Model

Path parameters

Headers

Query parameters

Response

Errors