Skip to content

Jobs

The Jobs API allows you to retrieve the status of asynchronous operations in the Blockgraph platform.

The Job Object

A Job object has the following structure:

{
  "id": "string",
  "status": "PENDING",
  "segmentId": "string"
}
Field Type Description
id string Unique identifier for the job
status string Current status of the job
segmentId string ID of the associated segment (if applicable)

Possible Status Values

  • PENDING - waiting to start processing
  • READY - ready to start processing
  • RUNNING - job is running
  • CANCELLED - job is cancelled
  • PENDING_APPROVAL - job is pending approval from another participant
  • REJECTED - job is rejected
  • FAILED - job failed
  • PARTIAL_SUCCESS - job failed, format validation passed
  • SUCCESS - job is successfully completed

Retrieve a Job

Retrieves the status of a job by its ID.

Endpoint

GET /api/jobs/{jobId}

Headers

  • Accept: application/vnd.blockgraph.v1+json
  • Authorization: Bearer {access-token}

Path Parameters

Name Type Required Description
jobId string true The ID of the job to retrieve

Example Request

curl -X GET "https://api.{participant id}.blockgraph.app/api/jobs/$jobId" \
  -H "Accept: application/vnd.blockgraph.v1+json" \
  -H "Authorization: Bearer $access_token"

Response

200 OK

Returns the job object if found.

{
  "id": "job_123",
  "status": "RUNNING",
  "segmentId": "segment_456"
}

404 Not Found

Returned when the job with the specified ID is not found.

400 Bad Request

Returned when the request is invalid.

500 Internal Server Error

Returned when an unexpected error occurs on the server.