Skip to content

by Startups.Studio

Candidate.get

GET /{namespace}/candidates/{id}

Returns one Candidate by id.

Noun: Candidate
Mode: read

You, to your agent

Show me the candidate Rosa Ibarra.

curl https://api.sb/patentpad.com/candidates/candidate_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const candidate = await $.Candidate.get({ id: 'candidate_1' })

npx startup-builder do Candidate.get --json '{"id":"candidate_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Candidate.get({ id: 'candidate_1' })"
  }
}

Get returns one Candidate by id. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Candidate.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Outputs

Output	Type	Required	Description
`candidate`	Candidate	required	The Candidate.

Effects

Reads only: it emits no Event and changes nothing.
Read: try, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Candidate.get

When it waits

Never: a read runs at once.

Candidate.delete

Previous Page

Candidate.list

Next Page