Get all syncs

Beta

GET

https://api-prod.scoutos.com/v2/syncs

GET

/v2/syncs

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.syncs.list()

Try it

200Retrieved

1 {
2   "data": [
3     {
4       "sync_config": {
5         "source_settings": {
6           "source_archetype_id": "string",
7           "sitemap_url": "string",
8           "crawler_settings": {
9             "scraper": {
10               "scraper_type": "http"
11             },
12             "text_extractor": {
13               "text_extractor_type": "readability"
14             },
15             "allow": "string",
16             "deny": "string",
17             "strip": "string",
18             "strip_urls": true,
19             "allowed_domains": "string",
20             "user_agent_header": "string",
21             "max_depth": 20,
22             "max_page_count": 8000,
23             "exclude_before_lastmod_date": "string"
24           },
25           "mode": "merge"
26         },
27         "destination": {
28           "destination_type": "string",
29           "collection_id": "string",
30           "table_id": "string"
31         },
32         "mapping": {
33           "fields": [
34             {}
35           ]
36         },
37         "schedule": {
38           "frequency": "string",
39           "enabled": true
40         }
41       },
42       "sync_id": "string",
43       "last_updated_at": "2024-01-15T09:30:00Z",
44       "created_at": "2024-01-15T09:30:00Z",
45       "created_by": {
46         "type": "user",
47         "details": {
48           "api_key": {}
49         }
50       },
51       "last_updated_by": {
52         "type": "user",
53         "details": {
54           "api_key": {}
55         }
56       },
57       "trigger_id": "string"
58     }
59   ]
60 }

Authentication

AuthorizationBearer

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

Response

Successful Response

datalist of objects