Get a job's counts

GET 
/jobs/:job_id/stats

Returns how many people have applied to a job and where they are: by stage, and by what has been decided. Use it for a dashboard tile or a report.

The counts are totals only. Nothing in them identifies a candidate.

This is the one job read that scans a job's whole application history, so it is kept for up to a minute and shared between callers, and it has its own limit of 30 requests a minute per key. as_of says when the counts were worked out. The response also says it may be kept for 60 seconds (Cache-Control: private, max-age=60), so a client that honours it will not ask more often than that.

The role this key acts as needs the jobs:view permission.

Request

Responses

200

The job's counts.

Response Headers

X-RateLimit-Limit

Requests allowed in the current window for this key.

X-RateLimit-Remaining

Requests left in the current window.

Cache-Control

private, max-age=60. The counts may be kept for a minute.

401

The key is missing, malformed, expired or revoked.

403

The key is valid but may not do this: the role it acts as lacks the permission this call needs (forbidden, with the permission in required), or the workspace's plan has lapsed (billing_past_due: reads still work, adding candidates is paused) or is suspended (account_suspended).

404

There is no job with that ID in your workspace.

429

Too many requests. Wait for Retry-After seconds, then retry.

Response Headers

Retry-After

Seconds to wait before retrying.