Retrieve Run

GET /api/v1/payroll-migrations/{migration_id}/runs/{id}/

Retrieve the details of a specific run within a 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.
`id`	string (UUID)	The unique identifier of the run.

Response

Status: 200 OK

{
  "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"
}

Response Fields

Field	Type	Description
`id`	string (UUID)	Unique identifier for the run.
`migration`	string (UUID)	ID of the parent migration.
`run_type`	string	Either `"source"` or `"target"`.
`document_id`	string (UUID)	ID of the associated document.
`status`	string	Current status of the run.
`created_at`	string (ISO 8601)	Timestamp when the run was created.
`updated_at`	string (ISO 8601)	Timestamp when the run was last updated.

Errors

Status	Description
`401`	Missing or invalid API key.
`403`	API key does not have `migrations:read` scope.
`404`	Migration or run not found.

Code Examples

curl https://api.parsifyhq.com/api/v1/payroll-migrations/b2c3d4e5-f6a7-8901-bcde-f12345678901/runs/d4e5f6a7-b8c9-0123-def0-123456789abc/ \
  -H "X-API-Key: YOUR_API_KEY"

import requests
 
migration_id = "b2c3d4e5-f6a7-8901-bcde-f12345678901"
run_id = "d4e5f6a7-b8c9-0123-def0-123456789abc"
 
resp = requests.get(
    f"https://api.parsifyhq.com/api/v1/payroll-migrations/{migration_id}/runs/{run_id}/",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
 
print(resp.json())

const migrationId = "b2c3d4e5-f6a7-8901-bcde-f12345678901";
const runId = "d4e5f6a7-b8c9-0123-def0-123456789abc";
 
const resp = await fetch(
  `https://api.parsifyhq.com/api/v1/payroll-migrations/${migrationId}/runs/${runId}/`,
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);
 
const data = await resp.json();

List Runs Update Run