Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APITeamCandidate

Candidate routes: create, get, list

The Candidate Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Candidate, one group of Candidate routes.

Candidate.create

Creates a Candidate. Verb page.

Text
POST /{namespace}/candidates

Body, as JSON: the inputs. Emits Candidate.created.

Inputs

InputTypeRequiredDescription
openingOpeningrequiredThe Opening the Person is considered for.
personPersonrequiredThe Person, whose record crosses Startups only with Consent.
sourcestringrequiredOne of pool, prospecting, listing, or referral.
deltajsonThe per-Verb difference between the Candidate and the incumbent Agent in the tryout.

Returns

OutputTypeRequiredDescription
candidateCandidaterequiredThe Candidate.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/candidates \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"opening":"opening_3rD8qFSOyQ","person":"person_sLqbXbW683","source":"pool"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "candidate": {
    "$id": "https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW",
    "$type": "Candidate",
    "opening": "opening_3rD8qFSOyQ",
    "person": "person_sLqbXbW683",
    "source": "pool",
    "state": "screening"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Candidate.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Candidate.get

Returns one Candidate by id. Verb page.

Text
GET /{namespace}/candidates/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Candidate.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
candidateCandidaterequiredThe Candidate.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Candidate",
  "$id": "https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW",
  "candidate": {
    "$id": "https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW",
    "$type": "Candidate",
    "opening": "opening_3rD8qFSOyQ",
    "person": "person_sLqbXbW683",
    "source": "pool",
    "state": "screening"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW",
    "up": "https://api.sb/leaseline.app/candidates"
  },
  "actions": {
    "screen": "https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW/screen"
  }
}

Candidate.list

Returns Candidates, newest first, one page at a time. Verb page.

Text
GET /{namespace}/candidates

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
candidateslist of CandidaterequiredOne page of Candidates.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/candidates?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Candidate",
  "candidates": [
    {
      "$id": "https://api.sb/leaseline.app/candidates/candidate_CR5hpwMwhW",
      "$type": "Candidate",
      "opening": "opening_3rD8qFSOyQ",
      "person": "person_sLqbXbW683",
      "source": "pool",
      "state": "screening"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "candidate_CR5hpwMwhW"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/candidates?limit=20",
    "next": "https://api.sb/leaseline.app/candidates?after=candidate_CR5hpwMwhW"
  }
}

Candidate

Previous

update, delete

Next