API reference · Automations
List automations
GET
https://api.pidgely.com/automationsThe organization's automations, oldest first, each with its steps and the counters of the last 30 days. Filter by store with store_id.
The organization's automations (of one store with store_id), oldest first, with the counters of the last 30 days. Needs a plan with automations (Scale or custom; 403 plan_required otherwise).
Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
store_id |
string | No | UUID. |
Request
This endpoint is not in the SDKs yet; call it over HTTP.
curl -X GET 'https://api.pidgely.com/automations?store_id=0199e0f2-1a2b-7c3d-9e4f-5a6b7c8d9e01' \
-H "Authorization: Bearer $PIDGELY_API_KEY"Response
200 OK
{
"data": [
{
"object": "automation",
"id": "0199e3d1-4a5b-7c6d-8e9f-0a1b2c3d4e51",
"store_id": null,
"preset": "trial_ending",
"name": "Teste grátis acabando",
"trigger": "contact_date",
"status": "active",
"status_reason": "",
"trigger_options": {
"property": "trial_ends_at",
"offset_seconds": -259200,
"send_hour": 9,
"yearly": false
},
"filter": {
"segment_id": null,
"properties": []
},
"goal": {
"event_name": "subscription_started",
"value_property": "amount"
},
"exit_events": [],
"settings": {
"quiet_hours": {
"enabled": true,
"start": 22,
"end": 8,
"timezone": "America/Sao_Paulo"
},
"frequency_cap": true,
"attribution_days": 7,
"from": "Fexxo <oi@fexxo.com.br>",
"currency": "BRL"
},
"steps": [
{
"id": "0199e3d1-4a5c-7a01-8b02-3c4d5e6f7a11",
"position": 0,
"kind": "email",
"wait_seconds": 0,
"template_id": "0199e3d1-4a50-7b11-9c12-4d5e6f7a8b21",
"template_name": "Teste grátis acabando · 1",
"template_subject": "Seu teste grátis termina em 3 dias",
"subject": "",
"from": "",
"coupon_code": "",
"event_name": "",
"on_event": "",
"on_timeout": ""
},
{
"id": "0199e3d1-4a5c-7a02-8b03-3c4d5e6f7a12",
"position": 1,
"kind": "wait",
"wait_seconds": 172800,
"template_id": null,
"template_name": "",
"template_subject": "",
"subject": "",
"from": "",
"coupon_code": "",
"event_name": "",
"on_event": "",
"on_timeout": ""
},
{
"id": "0199e3d1-4a5c-7a03-8b04-3c4d5e6f7a13",
"position": 2,
"kind": "email",
"wait_seconds": 0,
"template_id": "0199e3d1-4a50-7b12-9c13-4d5e6f7a8b22",
"template_name": "Teste grátis acabando · 2",
"template_subject": "Último dia do seu teste grátis",
"subject": "",
"from": "",
"coupon_code": "",
"event_name": "",
"on_event": "",
"on_timeout": ""
}
],
"currency": "BRL",
"last_30_days": {
"enrolled": 412,
"active": 57,
"sent": 374,
"skipped": 2,
"opened": 198,
"clicked": 73,
"exited_goal": 34,
"exited_other": 7,
"conversions": 34,
"revenue": 811190
},
"activated_at": "2026-10-12 16:44:41.000000+00",
"created_at": "2026-10-12 16:44:41.000000+00",
"updated_at": "2026-10-12 16:44:41.000000+00"
},
{
"object": "automation",
"id": "0199e1a0-2b4c-7d6e-8f01-2a3b4c5d6e7f",
"store_id": "0199e0f2-1a2b-7c3d-9e4f-5a6b7c8d9e01",
"preset": "cart_abandoned",
"name": "Carrinho abandonado",
"trigger": "cart_abandoned",
"status": "active",
"status_reason": "",
"trigger_options": {
"methods": []
},
"filter": {
"segment_id": null,
"properties": []
},
"goal": {
"event_name": "",
"value_property": ""
},
"exit_events": [],
"settings": {
"quiet_hours": {
"enabled": true,
"start": 22,
"end": 8
},
"frequency_cap": true,
"attribution_days": 7,
"from": "",
"currency": ""
},
"steps": [
{
"id": "0199e1a0-2b4d-7a11-8b22-3c4d5e6f7a81",
"position": 0,
"kind": "wait",
"wait_seconds": 3600,
"template_id": null,
"template_name": "",
"template_subject": "",
"subject": "",
"from": "",
"coupon_code": "",
"event_name": "",
"on_event": "",
"on_timeout": ""
},
{
"id": "0199e1a0-2b4d-7a12-8b23-3c4d5e6f7a82",
"position": 1,
"kind": "email",
"wait_seconds": 0,
"template_id": "0199e1a0-2b40-7b01-9c02-4d5e6f7a8b91",
"template_name": "Aurora Moda · Carrinho abandonado · 1",
"template_subject": "Você esqueceu algo no carrinho",
"subject": "",
"from": "",
"coupon_code": "",
"event_name": "",
"on_event": "",
"on_timeout": ""
},
{
"id": "0199e1a0-2b4d-7a13-8b24-3c4d5e6f7a83",
"position": 2,
"kind": "wait",
"wait_seconds": 82800,
"template_id": null,
"template_name": "",
"template_subject": "",
"subject": "",
"from": "",
"coupon_code": "",
"event_name": "",
"on_event": "",
"on_timeout": ""
},
{
"id": "0199e1a0-2b4d-7a14-8b25-3c4d5e6f7a84",
"position": 3,
"kind": "email",
"wait_seconds": 0,
"template_id": "0199e1a0-2b40-7b02-9c03-4d5e6f7a8b92",
"template_name": "Aurora Moda · Carrinho abandonado · 2",
"template_subject": "Seu carrinho continua salvo",
"subject": "",
"from": "",
"coupon_code": "",
"event_name": "",
"on_event": "",
"on_timeout": ""
}
],
"currency": "BRL",
"last_30_days": {
"enrolled": 412,
"active": 57,
"sent": 374,
"skipped": 2,
"opened": 198,
"clicked": 73,
"exited_goal": 34,
"exited_other": 7,
"conversions": 34,
"revenue": 811190
},
"activated_at": "2026-10-12 16:44:41.000000+00",
"created_at": "2026-10-12 16:44:41.000000+00",
"updated_at": "2026-10-12 16:44:41.000000+00"
}
]
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
data |
object[] | Yes | Items of this page. |
data[].object |
string | Yes | Object type. One of automation. |
data[].id |
string | Yes | Unique id (UUID). UUID. |
data[].store_id |
string | null | Yes | Store of a store automation; null for an organization automation (SaaS and apps). UUID. |
data[].preset |
string | Yes | Preset it was created from (onboarding, trial_ending, dunning, reengagement, saas_checkout, cart_abandoned, payment_pending, post_purchase, winback), or lifecycle_onboarding, lifecycle_first_send, lifecycle_upgrade and lifecycle_reengagement for the lifecycle automations of the platform organization (provisioned by the bootstrap). |
data[].name |
string | Yes | Display name. |
data[].trigger |
string | Yes | One of cart_abandoned, payment_pending, post_purchase, winback, event, contact_added, contact_date, inactivity. |
data[].status |
string | Yes | Current status. One of draft, active, paused. |
data[].status_reason |
string | Yes | Why it is paused: plan = the organization's plan no longer includes automations. One of ``, manual, plan, store. |
data[].trigger_options |
object | Yes | methods (payment_pending: pix, boleto), delivery_fallback_days (post_purchase: an order paid this many days ago without a delivery event counts as delivered, 1-60), inactive_days (winback: days since the last paid order, 14-730; inactivity: days without the event, 1-365), event_name (event, inactivity), segment_id and sources (contact_added), property, offset_seconds, send_hour and yearly (contact_date). |
data[].trigger_options.methods |
string[] | No | — |
data[].trigger_options.delivery_fallback_days |
integer | No | — |
data[].trigger_options.inactive_days |
integer | No | winback: 14-730; inactivity: 1-365. |
data[].trigger_options.event_name |
string | No | event: the event that enrolls; inactivity: the event whose absence counts (empty = any event). |
data[].trigger_options.segment_id |
string | null | No | contact_added: only contacts added to this segment (null = every new contact). UUID. |
data[].trigger_options.sources |
string[] | No | contact_added: sources of new contacts that count (empty = any). |
data[].trigger_options.property |
string | No | contact_date: contact property holding the date (YYYY-MM-DD or RFC 3339). |
data[].trigger_options.offset_seconds |
integer | No | contact_date: signed offset from the date (-259200 = 3 days before). |
data[].trigger_options.send_hour |
integer | No | contact_date: hour of the day for dates without a time, in the automation's time zone (default 9). Between 0 and 23. |
data[].trigger_options.yearly |
boolean | No | contact_date: every year on the date (birthdays). |
data[].filter |
object | Yes | Entry filter. Only contacts in segment_id (when set) whose properties match every condition enter. |
data[].filter.segment_id |
string | null | Yes | Segment the broadcast is sent to. UUID. |
data[].filter.properties |
object[] | Yes | Custom properties: up to 100 keys matching ^[A-Za-z_][A-Za-z0-9_]{0,49}$, values string (up to 2,000 characters), number, boolean, or null to delete. |
data[].filter.properties[].key |
string | Yes | — |
data[].filter.properties[].op |
string | Yes | One of eq, neq, exists, not_exists. |
data[].filter.properties[].value |
string | No | Compared as text (numbers and booleans as written in JSON). |
data[].goal |
object | Yes | The event that ends the enrollment as a success (exit reason goal). It counts as a conversion when an e-mail of the automation went out within the attribution window; value_property (major units, e.g. 49.90) is summed as revenue. |
data[].goal.event_name |
string | Yes | Empty = no goal event (store automations use their orders and payments). |
data[].goal.value_property |
string | Yes | — |
data[].exit_events |
string[] | Yes | — |
data[].settings |
object | Yes | Optional behaviours. Quiet hours hold e-mails between start and end o'clock in the store's time zone (from its currency; timezone overrides it) and send them at end. The frequency cap allows one automation e-mail per address per 24 hours across every automation of the organization (later ones wait). Orders placed up to attribution_days after an automation e-mail count as recovered revenue. |
data[].settings.quiet_hours |
object | Yes | — |
data[].settings.quiet_hours.enabled |
boolean | Yes | — |
data[].settings.quiet_hours.start |
integer | Yes | Between 0 and 23. |
data[].settings.quiet_hours.end |
integer | Yes | Between 0 and 23. |
data[].settings.quiet_hours.timezone |
string | No | IANA time zone; empty = the store's (organization automations default to America/Sao_Paulo). |
data[].settings.frequency_cap |
boolean | Yes | — |
data[].settings.attribution_days |
integer | Yes | Between 1 and 30. |
data[].settings.from |
string | No | Default sender of an organization automation's e-mails (a step's sender wins; empty = the template's). |
data[].settings.currency |
string | No | ISO 4217 currency of an organization automation's revenue (default BRL). |
data[].steps |
object[] | Yes | — |
data[].steps[].id |
string | Yes | Unique id (UUID). UUID. |
data[].steps[].position |
integer | Yes | — |
data[].steps[].kind |
string | Yes | One of wait, email, wait_event. |
data[].steps[].wait_seconds |
integer | Yes | wait: duration. |
data[].steps[].template_id |
string | null | Yes | email: builder template (edit it in the template builder). UUID. |
data[].steps[].template_name |
string | Yes | — |
data[].steps[].template_subject |
string | Yes | The template's subject in the store's language. |
data[].steps[].subject |
string | Yes | Subject override; empty = the template's (per language). |
data[].steps[].from |
string | Yes | Sender; empty = the store's sender address. |
data[].steps[].coupon_code |
string | Yes | {{{COUPON_CODE}}}; empty = blocks mentioning the coupon are left out. |
data[].steps[].event_name |
string | Yes | wait_event: the event waited for (up to wait_seconds). |
data[].steps[].on_event |
string | Yes | wait_event: go on (continue) or end the enrollment (exit, reason event_received) when the event happens. One of ``, continue, exit. |
data[].steps[].on_timeout |
string | Yes | wait_event: go on or end the enrollment (reason timeout) when the wait runs out. One of ``, continue, exit. |
data[].currency |
string | Yes | — |
data[].last_30_days |
object | Yes | Counters over a period: customers enrolled, live (active: active or held now), e-mails sent and skipped, unique opens and clicks (tracked domains), exits by goal (an order, a payment) and for other reasons, conversions and recovered revenue (minor units of the store currency). |
data[].last_30_days.enrolled |
integer | Yes | — |
data[].last_30_days.active |
integer | Yes | — |
data[].last_30_days.sent |
integer | Yes | — |
data[].last_30_days.skipped |
integer | Yes | — |
data[].last_30_days.opened |
integer | Yes | — |
data[].last_30_days.clicked |
integer | Yes | — |
data[].last_30_days.exited_goal |
integer | Yes | — |
data[].last_30_days.exited_other |
integer | Yes | — |
data[].last_30_days.conversions |
integer | Yes | — |
data[].last_30_days.revenue |
integer | Yes | Format: int64. |
data[].activated_at |
string | null | Yes | Format: date-time. |
data[].created_at |
string | Yes | Creation time, YYYY-MM-DD HH:MM:SS.ffffff+00 (UTC). Format: date-time. |
data[].updated_at |
string | Yes | Format: date-time. |
Errors
Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.
| Status | Name | When |
|---|---|---|
| 401 | missing_api_key, restricted_api_key |
No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access. |
| 403 | invalid_api_key, validation_error |
The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account). |
| 422 | validation_error |
A field is missing or invalid; message names it. |
| 429 | rate_limit_exceeded |
Too many requests per second. Wait for Retry-After seconds. |
| 403 | plan_required |
The organization is below the Scale plan (field is automations). |