Get Smart Source

GET /api/v1/smart-sources/{smart_source_id}

Get Smart Source

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/smart-sources/{smart_source_id} \
  --header 'X-API-Key: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_data_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "source_type": "api",
  "is_active": true,
  "external_id_field": "<string>",
  "api": {
    "api_url": "<string>",
    "http_method": "GET",
    "request_headers": {},
    "request_body_template": {},
    "auth_type": "none",
    "auth_credential": "<string>",
    "auth_header_name": "",
    "response_data_path": "",
    "next_page_path": "",
    "field_mappings": [
      {
        "source_field": "<string>",
        "target_column": "<string>",
        "transform": "<string>"
      }
    ]
  },
  "s3": {
    "s3_bucket": "<string>",
    "s3_prefix": "",
    "s3_region": "eu-central-1",
    "s3_access_key": "<string>",
    "s3_secret_key": "<string>",
    "s3_file_pattern": "*",
    "extraction_prompt_override": ""
  },
  "sharepoint": {
    "sharepoint_tenant_id": "",
    "sharepoint_client_id": "",
    "sharepoint_client_secret": "<string>",
    "sharepoint_site_id": "",
    "sharepoint_drive_id": "",
    "sharepoint_folder_id": "",
    "sharepoint_folder_drive_id": "",
    "sharepoint_folder_path": "",
    "sharepoint_file_pattern": "*",
    "extraction_prompt_override": ""
  },
  "schedule": {
    "auto_sync_enabled": false,
    "schedule_type": "minutes",
    "schedule_minutes": 123,
    "schedule_time": "<string>",
    "schedule_days": [
      123
    ],
    "schedule_timezone": "UTC"
  },
  "sync_status": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "last_auto_sync_at": "2023-11-07T05:31:56Z",
  "next_sync_at": "2023-11-07T05:31:56Z",
  "last_error": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

smart_source_id · string<uuid> · required

Response

200 - application/json

OK

id · string<uuid> · required

custom_data_source_id · string<uuid> · required

name · string · required

description · string · required

source_type · enum<string> · required

Available options: api, s3, sharepoint

is_active · boolean · required

external_id_field · string · required

api · APIConfigSchema · object | null · required

Show child attributes

s3 · S3ConfigSchema · object | null · required

Show child attributes

sharepoint · SharePointConfigSchema · object | null · required

Show child attributes

schedule · ScheduleSchema · object · required

Show child attributes

sync_status · string | null · required

last_synced_at · string<date-time> | null · required

last_auto_sync_at · string<date-time> | null · required

next_sync_at · string<date-time> | null · required

last_error · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required