Skip to main content
GET
/
sources
curl -X GET "https://YOUR_BASE_URL/sources?page=1&size=20&sort_by=name&sort_order=asc" \
  -H "Authorization: Bearer <api-key>" \
  -H "Workspace-Id: <workspace-id>"

{
  "message": "",
  "meta": {},
  "data": {
    "items": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "production-snowflake",
        "type": "snowflake",
        "status": "active",
        "is_interactive": true,
        "dataset_count": 42,
        "validation_count": 128,
        "failed_validation_count": 3,
        "column_count": 560,
        "sensitive_column_count": 12,
        "last_scanned_at": "2025-01-15T10:30:00Z",
        "database_version": "8.23.0",
        "workspace_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    ],
    "page": 1,
    "size": 20,
    "total": 1,
    "pages": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.datachecks.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorization
string
required
Bearer token. Format: Bearer <api-key>
​
Workspace-Id
string
required
Your workspace UUID.
​
filter
string
Search string to filter data sources by name.
​
page
integer
default:"1"
Page number for pagination.
​
size
integer
default:"50"
Number of results per page.
​
sort_by
string
default:"last_scanned"
Field to sort by. Options: last_scanned, name, type.
​
sort_order
string
default:"desc"
Sort direction. Options: asc, desc.
​
interactive
boolean
Filter by interactive status. Omit to return all.
​
is_settings_page
boolean
default:"false"
Returns additional fields used by the settings view.

​
Response

​
data
object
Paginated response object.
​
message
string
Status message.
​
meta
object
Additional metadata.
curl -X GET "https://YOUR_BASE_URL/sources?page=1&size=20&sort_by=name&sort_order=asc" \
  -H "Authorization: Bearer <api-key>" \
  -H "Workspace-Id: <workspace-id>"

{
  "message": "",
  "meta": {},
  "data": {
    "items": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "production-snowflake",
        "type": "snowflake",
        "status": "active",
        "is_interactive": true,
        "dataset_count": 42,
        "validation_count": 128,
        "failed_validation_count": 3,
        "column_count": 560,
        "sensitive_column_count": 12,
        "last_scanned_at": "2025-01-15T10:30:00Z",
        "database_version": "8.23.0",
        "workspace_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    ],
    "page": 1,
    "size": 20,
    "total": 1,
    "pages": 1
  }
}