List Migration Tasks

GET

api

migration-tasks

curl --request GET \
  --url https://worker.anon.com/api/v1/migration-tasks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://worker.anon.com/api/v1/migration-tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://worker.anon.com/api/v1/migration-tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://worker.anon.com/api/v1/migration-tasks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://worker.anon.com/api/v1/migration-tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "object": "migration_task",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "migration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "PENDING",
    "data_category": "EMPLOYEE",
    "data_type": "Location",
    "completed_at": "2023-11-07T05:31:56Z"
  }
]

{
  "type": "api_error",
  "message": "<string>"
}

{
  "type": "api_error",
  "message": "<string>"
}

{
  "type": "api_error",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Query Parameters

migration_id

string<uuid>

required

Migration ID to list tasks for

Response

Success

object

enum<string>

required

Available options:

migration_task

string<uuid>

required

Unique identifier for the migration task

created

string<date-time>

required

Timestamp when the migration task was created

updated

string<date-time>

required

Timestamp when the migration task was last updated

migration_id

string<uuid>

required

Unique identifier for the migration

status

enum<string>

required

Current status of the migration task

Available options:

PENDING,

IN_PROGRESS,

COMPLETE,

FAILED,

AWAITING_USER_INPUT,

NO_DATA

data_category

enum<string>

required

Category of the data being migrated

Available options:

EMPLOYEE,

COMPENSATION,

DEDUCTION_SETUP,

COMPANY,

TAX,

TRAVEL

data_type

enum<string>

required

Type of the data being migrated

Available options:

Location,

EntityType,

StateTax,

EmployeeRoster,

EmployeeDetails,

Deductions,

ContractorPayments,

TimeOffBalances,

PayrollJournal,

FederalTax,

DirectDeposit,

ContractorRoster,

PTOData,

Signatory,

SilverEntityType,

SilverLocation,

SilverFederalTax,

SilverItemDetails,

SilverSignatory,

SilverEmployeeRoster,

SilverEmployeeDetails,

BookingsReport,

TransactionReport,

EmployeeW2Previews,

EmployeeDirectDeposit,

FederalTaxSetup,

StateTaxSetup,

addServiceAccount,

ItemCatalogue,

GiftCardsData,

ItemDetails,

GoldItemDetails,

GoldEmployeeData,

GoldEntityType

completed_at

string<date-time> | null

required

Timestamp when the migration task was completed

List Migration Tasks

curl --request GET \
  --url https://worker.anon.com/api/v1/migration-tasks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://worker.anon.com/api/v1/migration-tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://worker.anon.com/api/v1/migration-tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://worker.anon.com/api/v1/migration-tasks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://worker.anon.com/api/v1/migration-tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "object": "migration_task",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "migration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "PENDING",
    "data_category": "EMPLOYEE",
    "data_type": "Location",
    "completed_at": "2023-11-07T05:31:56Z"
  }
]

{
  "type": "api_error",
  "message": "<string>"
}

{
  "type": "api_error",
  "message": "<string>"
}

{
  "type": "api_error",
  "message": "<string>"
}

Getting Started

Modal Integration

Core Resources

API Reference

Reference

Authorizations

Query Parameters

Response