Skip to content
aimrack

Integration Transfer Run

The integration transfer run resource.

Base/integrationTransferRun
GET/integrationTransferRun

List integration transfer runs

Retrieve a paginated list of integration transfer runs. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/integrationTransferRun
curl --request GET \
  --url '<your-host>/integrationTransferRun?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "integration": "string",
    "source": "string",
    "destination": "string",
    "status": "string",
    "stages": "string",
    "createdBy": "string"
  }
]
GET/integrationTransferRun

Retrieve a integration transfer run

Fetch a single integration transfer run by filtering on `id`.

Query parameters

idstring

Match on the integration transfer run's `id`, e.g. `eq.{id}`.

GET/integrationTransferRun
curl --request GET \
  --url '<your-host>/integrationTransferRun?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "integration": "string",
  "source": "string",
  "destination": "string",
  "status": "string",
  "stages": "string",
  "createdBy": "string"
}
POST/integrationTransferRun

Create a integration transfer run

Create a new integration transfer run.

Body parameters

integrationstringrequired

References integration.id

sourcestringrequired
destinationstringrequired
statustransferRunStatusrequired
stagesobjectrequired
planobject
pausedUntiltimestamp
completedAttimestamp
POST/integrationTransferRun
curl --request POST \
  --url <your-host>/integrationTransferRun \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"integration":"string","source":"string","destination":"string","status":"string","stages":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "integration": "string",
  "source": "string",
  "destination": "string",
  "status": "string",
  "stages": "string",
  "createdBy": "string"
}
PATCH/integrationTransferRun

Update a integration transfer run

Update an existing integration transfer run, matched on `id`.

Body parameters

integrationstringrequired

References integration.id

sourcestringrequired
destinationstringrequired
statustransferRunStatusrequired
stagesobjectrequired
planobject
pausedUntiltimestamp
completedAttimestamp
PATCH/integrationTransferRun
curl --request PATCH \
  --url '<your-host>/integrationTransferRun?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"integration":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "integration": "string",
  "source": "string",
  "destination": "string",
  "status": "string",
  "stages": "string",
  "createdBy": "string"
}
DELETE/integrationTransferRun

Delete a integration transfer run

Delete a integration transfer run, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the integration transfer run to delete, e.g. `eq.{id}`.

DELETE/integrationTransferRun
curl --request DELETE \
  --url '<your-host>/integrationTransferRun?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content