Skip to content
AutomatedOn Help Centre

Get started with the Run History API

Updated 22 October 2026 · For developers

The Run History API is a read-only JSON API for your process runs and the records each run handled. It returns the same history you see on a process's History tab, so you can feed it into reports, dashboards or alerts. Every endpoint is a GET under https://{tenantname}.automatedon.io/api/v1, where {tenantname} is your tenant's name, as in the address you use to sign in to AutomatedOn.

Before you start

You need an API key. To get one, contact the AutomatedOn support team, for example by raising a ticket here. Tell us which tenant it's for.

Steps

  1. Keep the key server-side

    Store the key where only your server or script can read it, such as an environment variable or a secrets store. Don't put it in a browser page or a mobile app, where anyone could read it.

  2. Send the key on every request

    Put the key in the X-Api-Key header. Requests without a valid key return 401 Unauthorized.

    GET /api/v1/runs HTTP/1.1
Host: {tenantname}.automatedon.io
X-Api-Key: your-api-key
Accept: application/json

  3. Make your first request

    List the most recent runs across all your processes:

    curl "https://{tenantname}.automatedon.io/api/v1/runs" \
  -H "X-Api-Key: $AO_API_KEY"

    You get back a page of runs, newest first. Responses are JSON with camelCase property names.

  4. Drill into a run

    Take a run's id and ask for its records with GET /runs/{runId}/records. Add include=steps to see what each step and action did for each record.

What happens next

Read Run History API: paging, dates and filters before you build anything that loops over results, and keep to the limit of 60 requests a minute.

What the API can't do

Keys are read-only. They can't start, requeue or dismiss runs, or delete history. Do those in AutomatedOn itself.

Was this guide helpful?