Skip to main content
GET
/
accounting
/
queue
/
status
Get Accounting Queue Status
curl --request GET \
  --url https://api.royalti.io/accounting/queue/status \
  --header 'Authorization: Bearer <token>'
{
  "jobId": "job-uuid-123",
  "state": "active",
  "progress": 45.5,
  "data": {
    "triggeredBy": "manual",
    "timestamp": "2023-11-07T05:31:56Z",
    "userCount": 100
  },
  "timestamps": {
    "created": 123,
    "processed": 123,
    "finished": 123
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Get Accounting Queue Status Check the status of accounting recalculation jobs. Can query a specific job by ID or get overall queue status. Method: GET Query Parameters:
ParameterTypeDescription
jobIdstringSpecific job ID to check (optional)
Without jobId: Returns queue overview and recent jobs With jobId: Returns detailed status for that specific job

​
Code Examples

const response = await fetch('https://api.royalti.io/accounting/queue/status', {
  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}"

Query Parameters

​
jobId
string

Specific job ID to check status for

Response

Queue status retrieved successfully

​
jobId
string
Example:

"job-uuid-123"

​
state
enum<string>
Available options:
waiting,
active,
completed,
failed,
delayed
Example:

"active"

​
progress
number<float>

Progress percentage (0-100)

Example:

45.5

​
data
object
​
timestamps
object