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

# List Automation runs

> List runs of the workspace's v2 Automations, newest first, filtered by status, Template, or date range and paged by cursor. Journey (v3) runs are listed by `GET /journeys/runs` instead — the two surfaces never return each other's runs. Runs are retained for 95 days.



## OpenAPI

````yaml /openapi-specs/openapi.documented.yml get /automations/runs
openapi: 3.0.1
info:
  title: Courier
  description: The Courier REST API for sending and managing notifications across channels.
  version: 0.0.1
servers:
  - url: https://api.courier.com
    description: Production
security: []
tags:
  - name: Send
    description: >-
      Send a message to one or more recipients — users, lists, audiences, or
      tenants — across every channel you have configured.
  - name: Templates
    description: >-
      Create, update, version, publish, and localize notification templates and
      their content.
  - name: Brands
    description: >-
      Manage the logos, colors, and layout that give the templates you send a
      consistent look.
  - name: Routing Strategies
    description: >-
      Define reusable channel routing and failover strategies, and see which
      templates use them.
  - name: Journeys
    description: >-
      Build, version, publish, invoke, and cancel multi-step notification
      workflows, along with the templates scoped to them.
  - name: Broadcasts
    description: >-
      Create a one-off send to a list or audience, author its content, then send
      it immediately or schedule it for later.
  - name: User Profiles
    description: >-
      Store the contact information Courier delivers to for each user — email,
      phone number, push tokens, and any custom data you send to.
  - name: Tenants
    description: >-
      Manage tenants — the organizations, teams, or accounts your users belong
      to — along with their users and default preferences.
  - name: Audiences
    description: >-
      Define filter-based groups whose membership Courier recalculates as user
      profiles change.
  - name: Lists
    description: >-
      Manage static groups of users that you subscribe explicitly, and send to
      them by list id or list pattern.
  - name: Providers
    description: >-
      Configure the channel providers Courier delivers through, and browse the
      provider types it supports.
  - name: Preference Topics
    description: >-
      Manage the workspace catalog of subscription topics, the sections that
      group them, and publishing the preference page.
  - name: User Preferences
    description: >-
      Read and write a single user's notification preferences, per topic and per
      channel.
  - name: Messages
    description: >-
      Look up the messages Courier has accepted, inspect their delivery history
      and rendered output, and cancel, resend, or archive them.
  - name: Device Tokens
    description: >-
      Register and manage the APNS and FCM device tokens Courier delivers push
      notifications to.
  - name: Tenant Memberships
    description: >-
      Associate a user with one or more tenants, and read or remove those
      associations.
  - name: Tenant Templates
    description: >-
      Manage the templates and template versions scoped to a single tenant,
      including the ones authored in the embedded designer.
  - name: Automations
    description: >-
      Invoke a stored automation template or an ad hoc automation defined in the
      request.
  - name: Digests
    description: >-
      Inspect what has accumulated in a digest schedule and release a digest
      ahead of its next scheduled delivery.
  - name: Translations
    description: >-
      Store and retrieve the translation strings Courier uses to render
      localized template content.
  - name: Track Events
    description: >-
      Record an inbound event that triggers the journeys and automations mapped
      to it.
  - name: Audit Events
    description: >-
      Read the audit trail of configuration and access changes in your
      workspace.
  - name: Authentication
    description: >-
      Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences,
      and the embedded designer — can call Courier as a single user. Server-side
      requests authenticate with your workspace API key instead.
paths:
  /automations/runs:
    get:
      tags:
        - Automations
      summary: List Automation runs
      description: >-
        List runs of the workspace's v2 Automations, newest first, filtered by
        status, Template, or date range and paged by cursor. Journey (v3) runs
        are listed by `GET /journeys/runs` instead — the two surfaces never
        return each other's runs. Runs are retained for 95 days.
      operationId: automations_list_runs
      parameters:
        - name: cursor
          in: query
          description: >-
            A cursor token for pagination. Use the `next_cursor` from the
            previous response to fetch the next page of results. Treat it as
            opaque.
          required: false
          schema:
            type: string
        - name: limit
          in: query
          description: >-
            The number of runs to return per page, between `1` and `50`.
            Defaults to `20`. Values outside the range are clamped, and a
            non-numeric value falls back to `20`.
          required: false
          schema:
            type: string
            pattern: ^\d+$
        - name: status
          in: query
          description: >-
            A comma-separated list of run statuses to filter on, e.g.
            `PROCESSED,ERROR`.
          required: false
          schema:
            type: string
        - name: template_id
          in: query
          description: A comma-separated list of Automation Template ids to filter on.
          required: false
          schema:
            type: string
        - name: start_date
          in: query
          description: >-
            An inclusive lower bound on `created_at`, as an ISO 8601 date or
            timestamp (e.g. `2026-08-18` or `2026-08-18T20:06:36.259Z`). Any
            other format returns `400`.
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          description: >-
            An inclusive upper bound on `created_at`, in the same format as
            `start_date`.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: A page of Automation runs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationRunListResponse'
              examples:
                Example1:
                  value:
                    runs:
                      - run_id: 126c55b2-805a-4b53-9afb-537a3c94708e
                        template_id: 356181e4-e347-4f0a-9adf-bb4a77d42398
                        status: PROCESSED
                        created_at: '2026-08-05T20:06:36.259Z'
                        source:
                          - >-
                            audiences:user:matched/vip-customers/1-6a7397ca-2bba2e2b116fa65d6f6ef05d
                          - invoke/356181e4-e347-4f0a-9adf-bb4a77d42398
                    next_cursor: 1785960234636,2918ef2a-3262-4f48-985b-cbf5c2be32d0
        '400':
          description: Malformed cursor, or a start or end date that is not ISO 8601.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
              examples:
                InvalidCursor:
                  value:
                    message: invalid cursor
                    type: invalid_request_error
                InvalidStartDate:
                  value:
                    message: >-
                      invalid start_date: expected an ISO 8601 date such as
                      2026-08-18 or 2026-08-18T20:06:36.259Z
                    type: invalid_request_error
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Courier from '@trycourier/courier';


            const client = new Courier({
              apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
            });


            const automationRunListResponse = await
            client.automations.runs.list();


            console.log(automationRunListResponse.runs);
        - lang: Python
          source: |-
            import os
            from courier import Courier

            client = Courier(
                api_key=os.environ.get("COURIER_API_KEY"),  # This is the default and can be omitted
            )
            automation_run_list_response = client.automations.runs.list()
            print(automation_run_list_response.runs)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/trycourier/courier-go/v4\"\n\t\"github.com/trycourier/courier-go/v4/option\"\n)\n\nfunc main() {\n\tclient := courier.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tautomationRunListResponse, err := client.Automations.Runs.List(context.TODO(), courier.AutomationRunListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", automationRunListResponse.Runs)\n}\n"
        - lang: Java
          source: |-
            package com.courier.example;

            import com.courier.client.CourierClient;
            import com.courier.client.okhttp.CourierOkHttpClient;
            import com.courier.models.automations.AutomationRunListResponse;
            import com.courier.models.automations.runs.RunListParams;

            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    CourierClient client = CourierOkHttpClient.fromEnv();

                    AutomationRunListResponse automationRunListResponse = client.automations().runs().list();
                }
            }
        - lang: Ruby
          source: |-
            require "courier"

            courier = Courier::Client.new(api_key: "My API Key")

            automation_run_list_response = courier.automations.runs.list

            puts(automation_run_list_response)
        - lang: PHP
          source: >-
            <?php


            require_once dirname(__DIR__) . '/vendor/autoload.php';


            use Courier\Client;

            use Courier\Core\Exceptions\APIException;


            $client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API
            Key');


            try {
              $automationRunListResponse = $client->automations->runs->list(
                cursor: 'cursor',
                endDate: 'end_date',
                limit: '321669910225',
                startDate: 'start_date',
                status: 'status',
                templateID: 'template_id',
              );

              var_dump($automationRunListResponse);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: C#
          source: >-
            using System;

            using TryCourier;

            using TryCourier.Models.Automations.Runs;


            CourierClient client = new();


            RunListParams parameters = new();


            var automationRunListResponse = await
            client.Automations.Runs.List(parameters);


            Console.WriteLine(automationRunListResponse);
        - lang: CLI
          source: |-
            courier automations:runs list \
              --api-key 'My API Key'
components:
  schemas:
    AutomationRunListResponse:
      title: AutomationRunListResponse
      description: A page of Automation runs.
      type: object
      properties:
        runs:
          type: array
          items:
            $ref: '#/components/schemas/AutomationRunListItem'
        next_cursor:
          type: string
          description: >-
            Pass back as `cursor` to fetch the next page. Absent on the last
            page.
      required:
        - runs
      additionalProperties: false
    BadRequest:
      title: BadRequest
      type: object
      properties:
        type:
          type: string
          enum:
            - invalid_request_error
      required:
        - type
      allOf:
        - $ref: '#/components/schemas/BaseError'
    AutomationRunListItem:
      title: AutomationRunListItem
      description: An Automation run as it appears in a list response.
      type: object
      properties:
        run_id:
          type: string
          description: A unique identifier representing the run.
        template_id:
          type: string
          description: The id of the Automation Template this run belongs to.
        status:
          type: string
          description: >-
            The state of the run: `PROCESSING`, `PROCESSED`, `WAITING`,
            `CANCELED`, `ERROR`, `THROTTLED`, or `NOT PROCESSED`. Not an enum —
            new values have been added before.
        created_at:
          type: string
          description: When the run started, as an ISO 8601 timestamp.
        source:
          type: array
          items:
            type: string
          description: >-
            Internal provenance strings describing what started the run, e.g.
            `invoke/<template_id>` or `segment/page/Pricing Page`. Diagnostic
            only — the format is unstable and should not be parsed.
      required:
        - run_id
        - source
      additionalProperties: false
    BaseError:
      title: BaseError
      type: object
      properties:
        message:
          type: string
          description: A message describing the error that occurred.
      required:
        - message
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````