Skip to main content
GET
/
api
/
public
/
organizations
/
{orgId}
/
data-sources
List data sources
curl --request GET \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/data-sources \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "dialect": "POSTGRES",
      "databaseName": "<string>",
      "username": "<string>",
      "host": "<string>",
      "port": 123,
      "sslEnabled": true,
      "sslCustomCertificatesEnabled": true,
      "sshEnabled": true,
      "sshHost": "<string>",
      "sshPort": 123,
      "sshUsername": "<string>",
      "bigQueryProjectId": "<string>",
      "spannerInstanceId": "<string>",
      "snowflakeAccountId": "<string>",
      "snowflakeWarehouse": "<string>",
      "snowflakeRole": "<string>",
      "lastSuccessfulSyncAt": "2023-11-07T05:31:56Z",
      "lastSyncStatus": "PENDING",
      "lastSyncAttemptAt": "2023-11-07T05:31:56Z",
      "hasCompletedFirstSync": true,
      "syncErrorMessage": "<string>",
      "lastHealthyAt": "2023-11-07T05:31:56Z",
      "lastHealthStatus": "HEALTHY",
      "lastHealthCheckAttemptAt": "2023-11-07T05:31:56Z",
      "isDemo": true,
      "isBasedashWarehouse": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

Query Parameters

limit
integer
default:50

Maximum number of items to return (1-100, default 50)

Required range: 1 <= x <= 100
cursor
string

Cursor for pagination (ID of the last item from previous page)

Response

Data sources retrieved successfully

data
object[]
required
pagination
object
required