> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deck.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List triggers

> Returns a paginated list of triggers in your organization.



## OpenAPI

````yaml /api-reference/v2.json get /triggers
openapi: 3.1.1
info:
  title: Deck API
  version: 2.0.0
servers:
  - url: https://api.deck.co/v2
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Agents
    description: >-
      Agents are the AI workers that execute tasks against sources. Create and
      manage the agents in your organization.
  - name: Components
    description: >-
      Embeddable UI components. Create short-lived session tokens for the Auth
      Component.
  - name: Platform
    description: Organization-wide platform settings, such as the static IP range.
  - name: Credentials
    description: >-
      Credentials store the login details an agent uses at a source. Values are
      tokenized at rest and never returned in plaintext.
  - name: Event Destinations
    description: >-
      Where Deck delivers events: webhooks, SQS, Kinesis, S3, and more. Manage
      destinations and inspect delivery attempts.
  - name: Events
    description: >-
      Immutable records of things that happened in your organization, such as a
      task run completing or a credential being verified.
  - name: Sessions
    description: >-
      Sessions are agent sandbox lifetimes. A session is created for each task
      run (or explicitly) and counts toward your concurrency limit.
  - name: Sources
    description: >-
      Sources are the websites and portals agents work against. Register,
      inspect, reset, and delete them.
  - name: Storage
    description: >-
      Files produced by task runs: downloaded documents, exports, and extraction
      results.
  - name: Task Runs
    description: >-
      A task run is one execution of a task. Inspect status and output, retrieve
      files and screenshots, cancel runs, and answer interaction requests.
  - name: Tasks
    description: >-
      Tasks define reusable units of work for an agent: a goal, an input schema,
      and an output schema. Run them against sources with credentials.
  - name: Test
    description: Connectivity check for your API key.
  - name: Triggers
    description: Triggers run tasks automatically on a schedule or in response to events.
  - name: Workflows
  - name: Workflow Runs
paths:
  /triggers:
    get:
      tags:
        - Triggers
      summary: List triggers
      description: Returns a paginated list of triggers in your organization.
      operationId: listTriggers
      parameters:
        - name: limit
          in: query
          description: Maximum number of items to return (1-100, default 20)
          schema:
            pattern: ^-?(?:0|[1-9]\d*)$
            type:
              - integer
              - string
            format: int32
            minimum: 1
            maximum: 100
            default: 20
            example: 20
        - name: cursor
          in: query
          schema:
            type: string
          description: Cursor from a previous response for pagination.
        - name: status
          in: query
          schema:
            type: string
          description: 'Filter by status: `active` or `inactive`.'
        - name: task_id
          in: query
          schema:
            type: string
          description: Filter to triggers that run this task. Prefixed with `task_`.
        - name: workflow_id
          in: query
          schema:
            type: string
          description: Filter to triggers that run this workflow. Prefixed with `wflo_`.
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PaginatedResponseOfListTriggerData'
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponseOfListTriggerData'
            text/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponseOfListTriggerData'
        '400':
          description: Bad request — validation error or malformed input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not found — the requested resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            Conflict — the request is valid but cannot be completed in the
            current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            Unprocessable content — the request body is understood but contains
            invalid values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: >-
            Too many requests — the organization-wide API rate limit was
            exceeded (`rate_limit_exceeded`). Retry with exponential backoff.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PaginatedResponseOfListTriggerData:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ListTriggerData'
          description: Array of resource objects for the current page.
        has_more:
          type: boolean
          description: '`true` if there are more results beyond this page.'
        next_cursor:
          type:
            - 'null'
            - string
          description: >-
            Opaque cursor string to pass as the `cursor` query parameter on the
            next request. `null` when there are no more pages.
        request_id:
          type:
            - 'null'
            - string
          description: Unique identifier for the API request.
      required:
        - data
        - has_more
    ValidationErrorResponse:
      required:
        - errors
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
          description: RFC 9110 problem type URI.
        title:
          type:
            - 'null'
            - string
          description: Short summary of the validation failure.
        status:
          type:
            - 'null'
            - integer
          description: HTTP status code.
          format: int32
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Validation errors grouped by field name.
        traceId:
          type:
            - 'null'
            - string
          description: Request trace identifier.
      description: Validation error returned for malformed requests (HTTP 400).
    ErrorResponse:
      required:
        - errors
        - request_id
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/TaskRunError'
          description: One or more errors that describe what went wrong.
        request_id:
          type: string
          description: Unique identifier for this request, useful for tracing.
      description: Standard error response.
    ListTriggerData:
      required:
        - id
        - object
        - name
        - description
        - status
        - condition
        - task_id
        - workflow_id
        - credential_ids
        - credential_filter
        - input
        - steps
        - skip_if
        - concurrency_max
        - created_at
        - updated_at
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the trigger, prefixed with `trg_`.
          pattern: ^trg_
          example: trg_AbC123xYz456
        object:
          type: string
          description: Always `trigger`.
        name:
          type: string
          description: Display name for the trigger.
        description:
          type:
            - 'null'
            - string
          description: Description of the trigger's purpose.
        status:
          type: string
          description: >-
            `active` or `inactive`. Inactive triggers keep their configuration
            and fire nothing.
        condition:
          $ref: '#/components/schemas/TriggerCondition'
        task_id:
          type:
            - 'null'
            - string
          description: >-
            The task this trigger runs. Prefixed with `task_`. `null` when the
            trigger targets a workflow.
        workflow_id:
          type:
            - 'null'
            - string
          description: >-
            The workflow this trigger runs. Prefixed with `wflo_`. `null` when
            the trigger targets a task.
        credential_ids:
          type:
            - 'null'
            - array
          items:
            type: string
          description: >-
            Explicit credentials the trigger targets. `null` when the trigger
            uses `credential_filter`.
        credential_filter:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/TriggerCredentialFilter'
          description: >-
            Credential scope the trigger fans out across. `null` when the
            trigger uses `credential_ids`.
        input:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/JsonElement'
          description: >-
            Input passed to every run this trigger creates, matching the task's
            `input_schema`. `null` for a workflow target.
        steps:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/RunWorkflowStep'
          description: Per-step config for a workflow target. `null` for a task target.
        skip_if:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/TriggerSkipIf'
          description: Skip condition evaluated per credential before a run is created.
        concurrency_max:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
          description: >-
            Maximum simultaneous runs from this trigger. `null` means no
            per-trigger cap.
        created_at:
          type: string
          format: date-time
          description: ISO 8601 timestamp of when the resource was created.
          example: '2026-08-24T12:00:00Z'
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 timestamp of when the resource was last updated.
          example: '2026-08-24T12:00:00Z'
      description: >-
        A trigger object. Triggers create task runs on a schedule across a set
        of credentials.
    TaskRunError:
      required:
        - type
        - code
        - message
      type: object
      properties:
        type:
          type: string
          description: >-
            Error category (e.g. `source`, `auth`, `task`, `rate_limit`).
            Determines the class of failure.
        code:
          type: string
          description: Machine-readable error code. Use this for programmatic handling.
        message:
          type: string
          description: >-
            Human-readable explanation. Do not rely on this for logic — it may
            change.
        field:
          type:
            - 'null'
            - string
          description: The input field that caused the error, when applicable.
      description: Error details for a failed task run. Same structure as API-level errors.
    TriggerCondition:
      required:
        - type
        - cron
        - timezone
      type: object
      properties:
        type:
          type: string
          description: The condition type. Always `schedule`.
        cron:
          type: string
          description: >-
            Standard 5-field cron expression: minute, hour, day of month, month,
            day of week.
        timezone:
          type: string
          description: >-
            IANA timezone name the schedule is evaluated in (e.g.
            `America/New_York`). Day boundaries and DST shifts follow local
            time.
      description: 'When the trigger fires: a cron expression evaluated in a timezone.'
    TriggerCredentialFilter:
      required:
        - source_ids
        - status
      type: object
      properties:
        source_ids:
          type: array
          items:
            type: string
          description: >-
            Match credentials on any of these sources. IDs prefixed with `src_`.
            Pass `["*"]` to match every source in the organization; the wildcard
            must be the only entry.
        status:
          type: array
          items:
            type: string
          description: >-
            Allowlist of credential statuses to fan out to, typically
            `unverified` and `verified`. There is no default, and an empty list
            is rejected. `invalid` / `deleted` credentials never match.
      description: A scope of credentials, resolved each time the trigger fires.
    JsonElement:
      description: Arbitrary JSON value.
    RunWorkflowStep:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          example: check_price
          description: >-
            The step to override, matching a step `name` in the workflow
            definition. For a `for_each`, the override applies to the inner step
            on every item.
        credential_id:
          type:
            - 'null'
            - string
          description: >-
            Credential for this step's task run. Mutually exclusive with
            `source_id`.
        source_id:
          type:
            - 'null'
            - string
          description: >-
            Source for this step's task run (public sources only). Mutually
            exclusive with `credential_id`.
        input:
          type:
            - 'null'
            - object
          additionalProperties: true
          description: >-
            Shallow-merged onto the definition's `input`: top-level keys here
            win, keys absent fall back to the definition. Nested objects replace
            entirely.
      description: >-
        Run-time values for one step. `session_id` is not accepted; every step
        of a run executes in one session.
    TriggerSkipIf:
      required:
        - last_run
      type: object
      properties:
        last_run:
          $ref: '#/components/schemas/TriggerSkipLastRun'
      description: >-
        Skip condition evaluated per credential before a run is created. When
        met, the credential is skipped for that fire and no run is created.
    TriggerSkipLastRun:
      required:
        - result
        - within_seconds
      type: object
      properties:
        result:
          type: string
          description: 'Task run result to match: `success`, `failure`, or `unknown`.'
        within_seconds:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int64
          description: Time window in seconds, measured back from the fire time.
      description: >-
        Skips a credential when its most recent completed run of the trigger's
        task finished with `result` within `within_seconds`.
  securitySchemes:
    BearerAuth:
      type: http
      description: Secret key (sk_live_...)
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.