# Problem routes: create, get, list

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

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

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

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

```text
POST /{namespace}/problems
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `statement` | `text` | Yes | The struggle, in the words of the ICP. |
| `costPerPeriod` | `json` | No | What the Problem costs the ICP per period: hours times wage, or the spend on what they hire today. |
| `address` | `json` | No | The opportunity map cell it sits on: an occupation, a task it performs, and an industry. |
| `moment` | `text` | No | The moment the job starts, with the observable trigger that marks it. |
| `progress` | `text` | No | The progress the ICP wants, from the state before to the state after. |
| `hiredToday` | `json` | No | What the ICP hires for the job today, by kind and cost: software, a Service, their own hands, or nothing. |

**Returns**

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

**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/problems \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"statement":"Tracks lease renewals for small property managers."}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "problem": {
    "$id": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
    "$type": "Problem",
    "statement": "Tracks lease renewals for small property managers."
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Problem.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Problem.get
Returns one Problem by id. [Verb page](/business/nouns/problem/get?interface=api).

```text
GET /{namespace}/problems/{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 Problem. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

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

**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/problems/problem_UzvXXfKsJB \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Problem",
  "$id": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
  "problem": {
    "$id": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
    "$type": "Problem",
    "statement": "Tracks lease renewals for small property managers."
  },
  "links": {
    "self": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
    "up": "https://api.sb/leaseline.app/problems"
  },
  "actions": {
    "notify": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB/notify",
    "vote": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB/vote"
  }
}
```

### Problem.list
Returns Problems, newest first, one page at a time. [Verb page](/business/nouns/problem/list?interface=api).

```text
GET /{namespace}/problems
```

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 |
| --- | --- | --- | --- |
| `problems` | list of [Problem](/business/nouns/problem) | Yes | One page of Problems. |

**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/problems?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Problem",
  "problems": [
    {
      "$id": "https://api.sb/leaseline.app/problems/problem_UzvXXfKsJB",
      "$type": "Problem",
      "statement": "Tracks lease renewals for small property managers."
    }
  ],
  "meta": {
    "limit": 20,
    "after": "problem_UzvXXfKsJB"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/problems?limit=20",
    "next": "https://api.sb/leaseline.app/problems?after=problem_UzvXXfKsJB"
  }
}
```