Get Bulk Sync Schemas

GET

https://app.polytomic.com/api/bulk/syncs/:id/schemas

GET

/api/bulk/syncs/:id/schemas

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

Try it

1 {
2   "data": [
3     {
4       "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
5       "disable_data_cutoff": false,
6       "enabled": true,
7       "fields": [
8         {
9           "enabled": true,
10           "id": "email",
11           "obfuscated": false,
12           "output_name": "email",
13           "user_output_name": "my_email"
14         }
15       ],
16       "filters": [
17         {
18           "function": "Equality",
19           "field_id": "field1"
20         }
21       ],
22       "id": "Contact",
23       "output_name": "contact",
24       "partition_key": "email",
25       "tracking_field": "updated_at",
26       "user_output_name": "my_contact"
27     }
28   ]
29 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

filtersmap from strings to optional stringsOptional

Response

datalist of objects or null

Get Bulk Sync Schemas

Authentication

Path parameters

Headers

Query parameters

Response

Errors