Skip to main content
POST
Search recruit students

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Body

application/json

Search recruit students. The companyId is injected from the OAuth grant and must not be sent by the client. OAuth anti-enumeration ceilings apply: batchSize is clamped to 25 and page (and the cursor's nextTypesensePage) may not exceed 10.

batchSize
integer
default:21

Results per batch. Schema allows up to 50, but the OAuth path clamps any value above 25 down to 25.

Required range: 1 <= x <= 25
page
integer
default:1

Page number. Over OAuth, values above 10 are rejected with 400.

Required range: 1 <= x <= 10
lastDoc
object

Pagination cursor echoed from a previous response. Over OAuth, nextTypesensePage is capped at 10.

jobId
string | null

Filter by job id.

searchTerm
string
default:""

Search term for candidate names/profiles.

Maximum string length: 120
sort
enum<string>
default:recommended

Result ordering. recommended ranks previously-paid creators first, then most recently active, and ranks by text relevance when a searchTerm is present. The metric sorts also RESTRICT the pool to creators that carry the metric, because the large majority of the index has no value for it: views (lifetime views on posts delivered through SideShift), earned (lifetime SideShift payouts), and followers (follower count, only present for influencer-enriched creators). A metric sort takes precedence over text relevance.

Available options:
recommended,
views,
earned,
followers
filters
object

Advanced candidate-search filters. All fields optional; mirrors the platform recruit search filter set.

Response

Paginated recruit-candidate search results.

data
object
required