API ReferenceValidationsList Validations

List Validations

GET /api/v1/payroll-migrations/{migration_id}/validations/

Returns a paginated list of validations for a payroll migration.

Authentication

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

Path Parameters

ParameterTypeDescription
migration_idstring (UUID)The ID of the payroll migration.

Response

Status: 200 OK

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "migration_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "source_run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "target_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "status": "completed",
      "created_at": "2026-03-16T12:00:00Z"
    }
  ]
}

Response Fields

FieldTypeDescription
countintegerTotal number of validations.
nextstring or nullURL for the next page of results.
previousstring or nullURL for the previous page of results.
resultsarrayList of validation objects.

Validation Object

FieldTypeDescription
idstring (UUID)Unique identifier for the validation.
migration_idstring (UUID)The migration this validation belongs to.
source_run_idstring (UUID)The source run used for comparison.
target_run_idstring (UUID)The target run used for comparison.
statusstringValidation status: pending, processing, completed, or failed.
created_atstring (ISO 8601)Timestamp when the validation was created.

Errors

StatusDescription
401Missing or invalid API key.
403API key does not have validations:read scope.
404Migration not found.

Code Examples

curl https://api.parsifyhq.com/api/v1/payroll-migrations/d4e5f6a7-b8c9-0123-defa-234567890123/validations/ \
  -H "X-API-Key: YOUR_API_KEY"