Skip to main content
GET
/
api
/
core
/
data_sync
/
{use_case_id}
/
config
/
{sync_id}
Get sync settings by ID
curl --request GET \
  --url https://api.example.com/api/core/data_sync/{use_case_id}/config/{sync_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "knowledge_source_id": "<string>",
  "deleted": false,
  "type": "confluence",
  "sync_status": "Not yet synced",
  "synced_issues_count": 0,
  "last_successful_sync": "2023-11-07T05:31:56Z",
  "credential_id": "<string>",
  "oauth_credential_id": "<string>",
  "user_id": "<string>",
  "most_recent_sync_job_id": "<string>",
  "available_keywords": [
    "<string>"
  ],
  "cql_query": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Path Parameters

​
sync_id
string
required
​
use_case_id
string
required

Response

Successful Response

​
id
string
required
​
knowledge_source_id
string
required
​
deleted
boolean
default:false
​
type
enum<string>
default:confluence
Available options:
confluence
Allowed value: "confluence"
​
sync_status
enum<string>
default:Not yet synced
Available options:
Not yet synced,
Syncing,
Synced,
Failed,
Sync status not available
​
synced_issues_count
integer
default:0
​
last_successful_sync
string<date-time> | null
​
credential_id
string | null
​
oauth_credential_id
string | null
​
user_id
string | null
​
most_recent_sync_job_id
string | null
​
available_keywords
string[] | null
​
cql_query
string | null