---
title: "List automations"
method: GET
path: "/api/public/organizations/{orgId}/automations"
tags: ["Automations"]
---

# List automations

`GET /api/public/organizations/{orgId}/automations`

## Request

- Base URL: `https://charts.basedash.com`
- URL: `https://charts.basedash.com/api/public/organizations/{orgId}/automations`
- Auth: HTTP bearer

Lists automations for an organization. Requires admin access to the organization. Results are paginated and ordered by creation date (newest first).

## Path parameters

- `orgId` string, required: Organization ID

## Query parameters

- `limit` integer: Maximum number of items to return (1-100, default 50)
- `cursor` string: Cursor for pagination (ID of the last item from previous page)
- `includeArchived` boolean, nullable: Whether archived automations should be included

## Response `200`

Automations retrieved successfully

- PublicAutomationListResponse
  - `data` PublicAutomation[], required
    - `id` string, required: Automation ID
    - `organizationId` string, required: Organization ID
    - `name` string, required: Automation name
    - `icon` string, required: Automation icon name
    - `color` string, required: Automation icon color
    - `instructions` string, required: Automation instructions
    - `active` boolean, required: Whether the automation is enabled
    - `archivedAt` string, date-time, nullable, required: Archive timestamp, if archived
    - `trigger` PublicAutomationTrigger, required
      - `type` 'MANUAL' | 'SCHEDULE' | 'DATA_CHANGE', required: Automation trigger type
      - `frequency` 'DAILY' | 'WEEKDAYS' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY', required: Schedule frequency for scheduled automations
      - `preferredHour` integer, required: Preferred UTC hour for scheduled runs
      - `preferredDayOfWeek` integer, nullable, required: Preferred day of week for weekly schedules, where 0 is Sunday
      - `preferredDayOfMonth` integer, nullable, required: Preferred day of month for monthly schedules
      - `databaseConnectionId` string, nullable, required: Data source ID for data change triggers
      - `sqlQuery` string, required: SQL query for data change triggers
    - `notifications` PublicAutomationNotifications, required
      - `slackChannel` string, nullable, required: Slack channel for automation notifications
      - `emailRecipients` string, required: Comma-separated email recipients for automation notifications
    - `createdByMemberId` string, required: Member ID that created the automation
    - `createdAt` string, date-time, required: Creation timestamp
    - `updatedAt` string, date-time, required: Last update timestamp
  - `pagination` PaginationMeta, required
    - `nextCursor` string, nullable, required: Cursor for the next page (null if no more pages)
    - `hasMore` boolean, required: Whether there are more items after this page

## Other responses

- `401`: Unauthorized - Missing or invalid API key
- `404`: Not found - Organization not found or no admin access
- `429`: Rate limit exceeded - Too many requests
- `500`: Internal server error

---

[API](https://skmtc.dev/basedash/apis/basedash-public-api.md) - [All operations](https://skmtc.dev/basedash/apis/basedash-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/basedash/apis/basedash-public-api/revisions/efb9d40bc6f7?raw)