Skip to content

Deel: List payroll migration imports for a legal entity

Deel globalPayroll.listPayrollMigrationImports: arguments, response, policy and SDK examples.

← Global payroll operations · Get started

Operation deel.globalpayroll_listpayrollmigrationimports_v2026_09_15

Provider route: GET /gp/legal-entities/{legal_entity_id}/payroll-migration-imports. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["globalPayroll"]["listPayrollMigrationImports"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.globalPayroll.listPayrollMigrationImports(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.global_payroll.list_payroll_migration_imports(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.legal_entity_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 20
Maximum: 50
Minimum: 1
query.cursorstringOptionalMaximum length: 255
Minimum length: 1

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List payroll migration imports for a legal entity — 200 response body

Referenced models: List payroll migration imports for a legal entity — 200 response body

List payroll migration imports for a legal entity — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand List payroll migration imports for a legal entity — 200 response body — data
The legal entity's payroll migration imports and the payroll data Deel already holds.
paginationModelRequired within parentExpand List payroll migration imports for a legal entity — 200 response body — pagination
Pagination metadata for the page of imports returned.

Referenced models: List payroll migration imports for a legal entity — 200 response body — data, List payroll migration imports for a legal entity — 200 response body — pagination

List payroll migration imports for a legal entity — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe legal entity's payroll migration imports and the payroll data Deel already holds.
importsarrayRequired within parentThe legal entity's payroll migration imports, newest first. Empty when it has none.
imports[]ModelEach itemExpand Get a payroll migration import — 200 response body — data
periodModelRequired within parentExpand List payroll migration imports for a legal entity — 200 response body — data period
The period the legal entity's payroll data on the Deel side already covers.

Referenced models: Get a payroll migration import — 200 response body — data, List payroll migration imports for a legal entity — 200 response body — data period

List payroll migration imports for a legal entity — 200 response body — pagination
FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the page of imports returned.
has_morebooleanRequired within parentWhether a further page of imports exists.
limitJSONRequired within parent
limit (anyOf 1)integerAlternativeThe page size that was applied - the requested limit, or its default when none was sent.
Maximum: 50
Minimum: 1
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeThe cursor to pass to fetch the next page, or null when this is the last one.
next_cursor (anyOf 2)nullAlternativeThe cursor to pass to fetch the next page, or null when this is the last one.
Get a payroll migration import — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe payroll migration import.
created_atstringRequired within parentWhen the import was created.
Format: date-time
filesarrayRequired within parentThe files attached to the import.
files[]ModelEach itemExpand Get a payroll migration import — 200 response body — data files item
import_idstringRequired within parentThe unique identifier of the payroll migration import.
Format: uuid
legal_entity_idstringRequired within parentThe legal entity the import belongs to.
Format: uuid
statusModelRequired within parentExpand Get a payroll migration import — 200 response body — data status
The state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app.
submitted_atJSONRequired within parent
submitted_at (anyOf 1)stringAlternativeWhen the import was submitted for review, or null when it is not SUBMITTED.
Format: date-time
submitted_at (anyOf 2)nullAlternativeWhen the import was submitted for review, or null when it is not SUBMITTED.
Format: date-time
typestringRequired within parentWhat kind of ingestion this is. Year-to-date payroll history is the only kind today.
Known values: YTD_HISTORICAL_INGESTION
updated_atstringRequired within parentWhen the import last changed.
Format: date-time

Referenced models: Get a payroll migration import — 200 response body — data files item, Get a payroll migration import — 200 response body — data status

List payroll migration imports for a legal entity — 200 response body — data period
FieldTypePresenceDescription and constraints
$objectRootThe period the legal entity's payroll data on the Deel side already covers.
endJSONRequired within parent
end (anyOf 1)stringAlternativeThe last day the payroll data Deel holds covers, as YYYY-MM-DD.
end (anyOf 2)nullAlternativeThe last day the payroll data Deel holds covers, as YYYY-MM-DD.
startJSONRequired within parent
start (anyOf 1)stringAlternativeThe first day the payroll data Deel holds covers, as YYYY-MM-DD.
start (anyOf 2)nullAlternativeThe first day the payroll data Deel holds covers, as YYYY-MM-DD.
Get a payroll migration import — 200 response body — data files item
FieldTypePresenceDescription and constraints
$objectRoot
file_idstringRequired within parentThe identifier of the file in the Deel file service.
file_nameJSONRequired within parent
file_name (anyOf 1)stringAlternativeThe name displayed for the file in Deel, when one is known.
file_name (anyOf 2)nullAlternativeThe name displayed for the file in Deel, when one is known.
file_sizeJSONRequired within parent
file_size (anyOf 1)JSONAlternative
file_size (anyOf 1) (anyOf 1)integerAlternativeThe size of the file in bytes, when one is known.
Maximum: 10485760
Minimum: 1
file_size (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
file_size (anyOf 2)nullAlternativeThe size of the file in bytes, when one is known.
Maximum: 10485760
Minimum: 1
mime_typeJSONRequired within parent
mime_type (anyOf 1)stringAlternativeThe media type of the file, when one is known.
mime_type (anyOf 2)nullAlternativeThe media type of the file, when one is known.
sourcestringRequired within parentWhich surface the file arrived through: EXTERNAL for this API, INTERNAL for the Deel web app. An import can hold both when a client and a partner have each added files to it.
Known values: INTERNAL, EXTERNAL
uploaded_atstringRequired within parentWhen the file was uploaded to the Deel file service.
Format: date-time
Get a payroll migration import — 200 response body — data status
FieldTypePresenceDescription and constraints
$stringRootThe state of the import. IN_PROGRESS holds files that have not been submitted, and is what attaching files leaves behind - including on an import that had already been submitted, which reopens it. SUBMITTED once handed to Deel for review. DRAFT is an import started with no files yet, which only happens in the Deel web app.
Known values: DRAFT, IN_PROGRESS, SUBMITTED

SDK function policy ID: deel.globalpayroll_listpayrollmigrationimports_v2026_09_15. Catalog operation: globalpayroll_listpayrollmigrationimports_v2026_09_15. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["global-payroll:read"]

Pinned headers: {"X-Version": "2026-09-15"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.