BizKitHub
DocsAPI ReferenceService/api/service/scheduler/peek
postServiceService

/api/service/scheduler/peek

Read-only peek into the scheduler queue. Runs the same SELECT used by /claim but without the UPDATE, so the runner can validate end-to-end queue access (auth + DB + query) from its health check without consuming jobs.

servicepostApiServiceSchedulerPeek

Parameters

JSON body

Request body

application/json
apiKeystringRequired
sampleSizenumberOptional
Range: 025

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /api/service/scheduler/peek

post
curl -X POST "https://api.bizkithub.com/api/service/scheduler/peek" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "apiKey": "example_apiKey",
  "sampleSize": 0
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key