Skip to main content
GET
/
api
/
public
/
organizations
/
{orgId}
/
automations
/
{id}
Get an automation
curl --request GET \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/automations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "icon": "<string>",
    "color": "<string>",
    "instructions": "<string>",
    "active": true,
    "archivedAt": "2023-11-07T05:31:56Z",
    "trigger": {
      "preferredHour": 11,
      "preferredDayOfWeek": 3,
      "preferredDayOfMonth": 16,
      "databaseConnectionId": "<string>",
      "sqlQuery": "<string>"
    },
    "notifications": {
      "slackChannel": "<string>",
      "emailRecipients": "<string>"
    },
    "createdByMemberId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://basedash.com/docs/llms.txt

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
orgId
string
required

Organization ID

​
id
string
required

Automation ID

Response

Automation retrieved successfully

​
data
object
required