Overview

Once you've sent your migration file via SFTP, you can retrieve a list of all jobs created for your clientId.

Authentication

All requests to the API must include an x-api-key header for authentication. This API key will be provided by a member of the Aero team.

Retrieve List of Jobs

Sandbox - POST https://migration-api.sandbox-sync.aero.inc/v1/clients/client_id/jobs

Production - POST https://migration-api.sync.aero.inc/v1/clients/client_id/jobs

Request Parameters

Parameter	Required?	Type	Description
client_id	Yes	string	Identifier of client provided by Aero team

Request Example

GET https://migration-api.sandbox-sync.aero.inc/v1/clients/{client_id}/jobs
Headers: x-api-key {api_key}

Response Example - Three jobs created in total

{
    "status": "success",
    "statusCode": 200,
    "client_id": "myClientId",
    "jobs": [
        {
            "job_id": "63c9f8ef-7e50-464f-8a23-a319647a2e9d",
            "created_at": "2024-09-03T19:06:25.490972+00:00"
        },
        {
            "job_id": "a43df75e-3f8a-402a-94bb-388d5e8ff99c",
            "created_at": "2024-09-03T19:19:15.434616+00:00"
        },
        {
            "job_id": "b4a09864-2028-4646-b7df-07adf1498db8",
            "created_at": "2024-09-03T19:03:39.118087+00:00"
        }
    ]
}