# Candidate routes: create, get, list

URL: /code/api/candidate/records · Id: `page:code/api/candidate/records`

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

Reference for [Candidate](/business/nouns/candidate), one group of [Candidate routes](/code/api/candidate).

### Candidate.create
Creates a Candidate. [Verb page](/business/nouns/candidate/create?interface=api).

```text
POST /{namespace}/candidates
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `opening` | [Opening](/business/nouns/opening) | Yes | The Opening the Person is considered for. |
| `person` | [Person](/business/nouns/person) | Yes | The Person, whose record crosses Startups only with Consent. |
| `source` | `string` | Yes | One of `pool`, `prospecting`, `listing`, or `referral`. |
| `delta` | `json` | No | The per-Verb difference between the Candidate and the incumbent Agent in the tryout. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `candidate` | [Candidate](/business/nouns/candidate) | Yes | The Candidate. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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](/business/nouns/candidate/get?interface=api).

```text
GET /{namespace}/candidates/{id}
```

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

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `candidate` | [Candidate](/business/nouns/candidate) | Yes | The Candidate. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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](/business/nouns/candidate/list?interface=api).

```text
GET /{namespace}/candidates
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `candidates` | list of [Candidate](/business/nouns/candidate) | Yes | One page of Candidates. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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"
  }
}
```