List automation journeys

GET

Retrieve a list of automation journeys that have occurred within a specific automation.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

automationIdstringRequiredformat: "^(aut_[0-9a-fA-F\-]+)$"

The prefixed ID of the automation object

Response

datalist of objects

limitinteger

The limit placed on the results. If no limit was specified in the request, this defaults to 10.

pageinteger

The page number the results are from. If no page was specified in the request, this defaults to page 1.

total_resultsinteger

The total number of results from all pages.

total_pagesinteger

The total number of pages.

Errors

GET

1 curl https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/automations/aut_00000000-0000-0000-0000-000000000000/journeys \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "aj_00000000-0000-0000-0000-000000000000",
5       "automation_id": "aut_00000000-0000-0000-0000-000000000000",
6       "status": "initiated",
7       "subscription_id": "sub_00000000-0000-0000-0000-000000000000",
8       "email": "[email protected]",
9       "started_at": 1714857600,
10       "completed_at": 1714861200
11     },
12     {
13       "id": "aj_00000000-0000-0000-0000-000000000000",
14       "automation_id": "aut_00000000-0000-0000-0000-000000000000",
15       "status": "initiated",
16       "subscription_id": "sub_00000000-0000-0000-0000-000000000000",
17       "email": "[email protected]",
18       "started_at": 1714857600,
19       "completed_at": 1714861200
20     }
21   ],
22   "limit": 10,
23   "page": 1,
24   "total_results": 2,
25   "total_pages": 1
26 }

Built with

1	curl https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/automations/aut_00000000-0000-0000-0000-000000000000/journeys \
2	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"id": "aj_00000000-0000-0000-0000-000000000000",
5	"automation_id": "aut_00000000-0000-0000-0000-000000000000",
6	"status": "initiated",
7	"subscription_id": "sub_00000000-0000-0000-0000-000000000000",
8	"email": "[email protected]",
9	"started_at": 1714857600,
10	"completed_at": 1714861200
11	},
12	{
13	"id": "aj_00000000-0000-0000-0000-000000000000",
14	"automation_id": "aut_00000000-0000-0000-0000-000000000000",
15	"status": "initiated",
16	"subscription_id": "sub_00000000-0000-0000-0000-000000000000",
17	"email": "[email protected]",
18	"started_at": 1714857600,
19	"completed_at": 1714861200
20	}
21	],
22	"limit": 10,
23	"page": 1,
24	"total_results": 2,
25	"total_pages": 1
26	}