Skip to main content
GET
Get batch candidates

Authorizations

Authorization
string
header
required

Company-scoped API key. Production keys are prefixed sk_live_, sandbox keys sk_test_, each followed by 22 base62 characters (pattern ^sk_(live|test)_[0-9A-Za-z]{22}$). Generate keys in the TapTalent dashboard under Account Settings → Developers → API Key Management; a key is shown once at generation and old keys are invalidated immediately on regeneration.

Path Parameters

batchId
integer
required

The batch ID returned from the bulk upload endpoint.

Query Parameters

pageNumber
integer
default:1

Page number. 1-indexed — the first page is pageNumber=1.

perPage
enum<integer>
default:10

Items per page. Must be one of: 10, 20, 40, 80, 100.

Available options:
10,
20,
40,
80,
100

Response

Paginated candidates parsed from the batch.

Success envelope for the batch retrieval endpoint.

success
boolean
required

Indicates if the request was successful.

Example:

true

data
object
required