# Pay Run routes: get, list

URL: /code/api/pay-run/records · Id: `page:code/api/pay-run/records`

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

Reference for [Pay Run](/business/nouns/pay-run), one group of [Pay Run routes](/code/api/pay-run).

### PayRun.get
Returns one Pay Run by id. [Verb page](/business/nouns/pay-run/get?interface=api).

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `payRun` | [Pay Run](/business/nouns/pay-run) | Yes | The Pay Run. |

**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/pay-runs/payrun_hqqWu5rAyZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "PayRun",
  "$id": "https://api.sb/leaseline.app/pay-runs/payrun_hqqWu5rAyZ",
  "payRun": {
    "$id": "https://api.sb/leaseline.app/pay-runs/payrun_hqqWu5rAyZ",
    "$type": "PayRun",
    "company": "company_28zYNZEno0",
    "periodStart": "2026-10-22",
    "periodEnd": "2026-10-22",
    "payDate": "2026-10-22"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/pay-runs/payrun_hqqWu5rAyZ",
    "up": "https://api.sb/leaseline.app/pay-runs"
  },
  "actions": {
    "approve": "https://api.sb/leaseline.app/pay-runs/payrun_hqqWu5rAyZ/approve",
    "pay": "https://api.sb/leaseline.app/pay-runs/payrun_hqqWu5rAyZ/pay",
    "void": "https://api.sb/leaseline.app/pay-runs/payrun_hqqWu5rAyZ/void"
  }
}
```

### PayRun.list
Returns Pay Runs, newest first, one page at a time. [Verb page](/business/nouns/pay-run/list?interface=api).

```text
GET /{namespace}/pay-runs
```

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 |
| --- | --- | --- | --- |
| `payRuns` | list of [Pay Run](/business/nouns/pay-run) | Yes | One page of Pay Runs. |

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "PayRun",
  "payRuns": [
    {
      "$id": "https://api.sb/leaseline.app/pay-runs/payrun_hqqWu5rAyZ",
      "$type": "PayRun",
      "company": "company_28zYNZEno0",
      "periodStart": "2026-10-22",
      "periodEnd": "2026-10-22",
      "payDate": "2026-10-22"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "payrun_hqqWu5rAyZ"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/pay-runs?limit=20",
    "next": "https://api.sb/leaseline.app/pay-runs?after=payrun_hqqWu5rAyZ"
  }
}
```