List Runs
GET /api/v1/payroll-migrations/{migration_id}/runs/
Retrieve a paginated list of all runs belonging to a specific migration.
Authentication
Requires an API key with migrations:read scope. Pass via the X-API-Key header.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
migration_id | string (UUID) | The unique identifier of the parent migration. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number for pagination. Defaults to 1. |
page_size | integer | No | Number of results per page. Defaults to 20. |
Response
Status: 200 OK
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "d4e5f6a7-b8c9-0123-def0-123456789abc",
"migration": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"run_type": "source",
"document_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "completed",
"created_at": "2026-03-16T12:00:00Z",
"updated_at": "2026-03-16T12:05:00Z"
},
{
"id": "e5f6a7b8-c9d0-1234-ef01-23456789abcd",
"migration": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"run_type": "target",
"document_id": "f6a7b8c9-d0e1-2345-f012-3456789abcde",
"status": "pending",
"created_at": "2026-03-16T13:00:00Z",
"updated_at": "2026-03-16T13:00:00Z"
}
]
}Errors
| Status | Description |
|---|---|
401 | Missing or invalid API key. |
403 | API key does not have migrations:read scope. |
404 | Migration not found. |
Code Examples
curl https://api.parsifyhq.com/api/v1/payroll-migrations/b2c3d4e5-f6a7-8901-bcde-f12345678901/runs/ \
-H "X-API-Key: YOUR_API_KEY"