Skip to main content
GET
/
file
/
processing
/
{jobId}
Get royalty processing job status
curl --request GET \
  --url https://api.royalti.io/file/processing/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "job_abc123xyz",
  "name": "royalty-text-processing",
  "status": "active",
  "progress": 45,
  "processedOn": "2024-01-15T10:30:00Z",
  "finishedOn": null,
  "failedReason": null,
  "data": {
    "fileName": "spotify_2024-01.csv",
    "royaltySource": "spotify",
    "accountingPeriod": "2024-01-01",
    "rowsProcessed": 45000,
    "rowsTotal": 100000
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Get royalty processing job status Monitor the status and progress of a royalty file processing job. Provides real-time updates on processing progress, errors, and completion status.

​
Code Examples

const response = await fetch('https://api.royalti.io/file/processing/example-id', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

​
jobId
string
required

The processing job ID returned from file confirmation

Response

Success - Returns job details

​
id
string

Job ID

​
name
string

Job name/type

​
status
enum<string>

Current job status

Available options:
waiting,
active,
completed,
failed
​
progress
number

Processing progress (0-100)

Required range: 0 <= x <= 100
​
processedOn
string<date-time> | null

Timestamp when job started processing

​
finishedOn
string<date-time> | null

Timestamp when job finished

​
failedReason
string | null

Error message if job failed

​
data
object

Job-specific data and metadata