v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Fetcher

Create a data extraction job

Creates and queues a data extraction job, or returns the existing job for an idempotent duplicate request.

post/v1/fetcher

Request body

Example request

{
  "dataRequest": {
    "filters": {
      "ledger": {
        "transactions": {
          "status": {
            "eq": [
              "approved"
            ]
          }
        }
      }
    },
    "mappedFields": {
      "ledger": {
        "transactions": [
          "id",
          "amount"
        ]
      }
    }
  },
  "metadata": {
    "correlationId": "settlement-2026-07-13",
    "source": "payments"
  }
}

Response

Duplicate request; the existing job is returned.

createdAtstring date-time required

UTC timestamp when the job was created.

jobIdstring required

Unique identifier of the extraction job.

messagestring required

Outcome of the create request.

statusstring required

Current processing status of the job.

Example response

{
  "createdAt": "2026-07-13T12:00:00Z",
  "jobId": "01980a89-21f0-7d7e-a109-564b5c6f53ac",
  "message": "Job created and queued for processing",
  "status": "pending"
}