Retrieve Migration

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

Retrieve the details of a specific payroll migration by its ID.

Authentication

Requires an API key with migrations:read scope. Pass via the X-API-Key header.

Path Parameters

Parameter	Type	Description
`id`	string (UUID)	The unique identifier of the migration.

Response

Status: 200 OK

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "name": "Q1 2026 ADP to Gusto Migration",
  "source_provider": "adp",
  "target_provider": "gusto",
  "status": "pending",
  "organization": "org_abc123",
  "created_at": "2026-03-16T12:00:00Z",
  "updated_at": "2026-03-16T12:00:00Z"
}

Response Fields

Field	Type	Description
`id`	string (UUID)	Unique identifier for the migration.
`name`	string	Descriptive name of the migration.
`source_provider`	string	Identifier of the source payroll provider.
`target_provider`	string	Identifier of the target payroll provider.
`status`	string	Current status of the migration.
`organization`	string	Organization the migration belongs to.
`created_at`	string (ISO 8601)	Timestamp when the migration was created.
`updated_at`	string (ISO 8601)	Timestamp when the migration was last updated.

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/ \
  -H "X-API-Key: YOUR_API_KEY"

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

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

List Migrations Update Migration