Get Ingest Job

Status and progress of a bulk ingest job

GET /v2/ingest-jobs/{job_id}

Get Ingest Job

JavaScript

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v2/ingest-jobs/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "status": "<string>",
  "entity_type": "<string>",
  "operation": "<string>",
  "source": "<string>",
  "counts": {
    "submitted": 123,
    "succeeded": 123,
    "failed": 123
  },
  "chunks_total": 123,
  "chunks_done": 123,
  "created_at": {},
  "finished_at": {},
  "links": {}
}

← Create Wastes (v2)

Read the status, counters and progress of a job created by a bulk endpoint such as POST /v2/wastes. This is the endpoint to poll while the records are being calculated.

Beta. Part of the bulk ingest API, currently in beta. The contract may still change before general availability.

Request

Headers

x-api-key · string · required

Your API key for authentication

Example: sk_live_1234567890abcdef

x-organization-id · string · required

UUID of the organization that created the job, or of one of its parent organizations.

Example: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

job_id · uuid · required

The job id, as returned in the bulk response body and in its Location header.

Example: 2d4b90c1-7c1e-4b6f-9a55-3f2b8e61d0aa

Response

id · uuid

Job id.

status · string

Available values: processing, completed, completed_with_errors.

• processing: the job is running: records are being calculated (or deleted, in a delete job).
• completed: every record succeeded.
• completed_with_errors: every chunk ran and at least one record failed (counts.failed > 0).

failed is reserved and no job ends in it today. A job whose chunks_done stops moving stays processing: see A job that does not finish.

entity_type · string

What the job creates, e.g. wastes.

operation · string

Available values: create, delete (Delete Wastes).

source · string

How the job was submitted: api_bulk with an API key (an integration), app by a person signed in to Dcycle (the app’s forms, or tools that act on their session). Only api_bulk jobs send the ingest_job.finished webhook. file_upload and import_wizard are reserved.

counts · object

Show fields

submitted · integer

Records (or ids, in a delete job) in the request.

succeeded · integer

Records already processed: calculated in a create job, deleted in a delete job.

failed · integer

Records that could not be processed. In a create job the record exists but has no emissions; in a delete job the waste was already gone. The job’s items say which ones.

chunks_total · integer

Number of calculation chunks.

chunks_done · integer

Chunks already calculated. chunks_done / chunks_total is the progress.

created_at · datetime

When the job was created (UTC).

finished_at · datetime | null

When the job finished (UTC), null while it is processing.

links · object

self: this job. items: its per-record outcomes.

Example

cURL

curl "https://api.dcycle.io/v2/ingest-jobs/2d4b90c1-7c1e-4b6f-9a55-3f2b8e61d0aa" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

Successful Response

{
  "id": "2d4b90c1-7c1e-4b6f-9a55-3f2b8e61d0aa",
  "status": "completed_with_errors",
  "entity_type": "wastes",
  "operation": "create",
  "source": "api_bulk",
  "counts": { "submitted": 250, "succeeded": 247, "failed": 3 },
  "chunks_total": 3,
  "chunks_done": 3,
  "created_at": "2026-09-29T10:15:02.184Z",
  "finished_at": "2026-09-29T10:16:41.902Z",
  "links": {
    "self": "/v2/ingest-jobs/2d4b90c1-7c1e-4b6f-9a55-3f2b8e61d0aa",
    "items": "/v2/ingest-jobs/2d4b90c1-7c1e-4b6f-9a55-3f2b8e61d0aa/items"
  }
}

Poll every 5 to 10 seconds and stop when status is no longer processing. chunks_done / chunks_total tells you how far along the job is.

Rather not poll? Register a webhook endpoint for ingest_job.finished: Dcycle sends you this same object, signed, as soon as the job finishes.

A job that does not finish

chunks_done normally moves within minutes. If it has not changed for 30 minutes, the job is stuck: Dcycle does not retry it on its own yet, and its ingest_job.finished webhook will not arrive. Contact support with the job id. Do not resend a create batch with a new Idempotency-Key: its records are already stored, so you would duplicate them.

Common Errors

401 Unauthorized

Missing or invalid API key.

404 Not Found

The job does not exist, or it belongs to an organization outside the one in x-organization-id. Both cases return the same response.

{
  "type": "https://code.dcycle.io/api-reference/errors#NOT_FOUND",
  "title": "Not Found",
  "status": 404,
  "code": "NOT_FOUND",
  "detail": "IngestJobModel with id='2d4b90c1-7c1e-4b6f-9a55-3f2b8e61d0aa' not found",
  "request_id": "b2248a31-0f1b-4a7d-83ce-b29bd5977b4c"
}

Related Endpoints

List Ingest Job Items

Per-record outcomes of the job

Create Wastes (v2)

Create up to 5,000 wastes in one request