List Migrations

GET /api/v1/payroll-migrations/

Retrieve a paginated list of all payroll migrations belonging to your organization.

Authentication

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

Request

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number for pagination. Defaults to 1.
page_sizeintegerNoNumber of results per page. Defaults to 20.

Response

Status: 200 OK

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "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"
    },
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "Paylocity to ADP Migration",
      "source_provider": "paylocity",
      "target_provider": "adp",
      "status": "in_progress",
      "organization": "org_abc123",
      "created_at": "2026-03-10T09:30:00Z",
      "updated_at": "2026-03-15T14:00:00Z"
    }
  ]
}

Errors

StatusDescription
401Missing or invalid API key.
403API key does not have migrations:read scope.

Code Examples

curl https://api.parsifyhq.com/api/v1/payroll-migrations/ \
  -H "X-API-Key: YOUR_API_KEY"