Skip to main content
POST
Search scorecards

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
offset
integer | null
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

Required range: 1 <= x <= 100
person_id
string<uuid>

Return only scorecards for this person UUID.

job_id
string<uuid>

Return only scorecards scoped to this job UUID.

candidate_id
string<uuid>

Return only scorecards for this candidate UUID.

template_id
string<uuid>

Return only scorecards created from this template UUID.

created_by_ids
string<uuid>[]

Filter by creator team member UUIDs. Get IDs from GET /v1/team-members.

is_starred
boolean

Filter by starred status.

sort_by
enum<string>
default:created_at

Column to sort by. One of: created_at (default), updated_at, overall_rating.

Available options:
created_at,
updated_at,
overall_rating
sort_order
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc

Response

Scorecards found

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required