# Read the board

The board's columns, a page of its rows, and `write` — exactly what `POST /v1/ingest/rows` takes on this board. Scope `read`.

## Endpoint

`GET /v1/ingest/board`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| limit | query | integer | No |

- **limit:** Rows per page.
| cursor | query | string | No |

- **cursor:** The `nextCursor` from the previous page. Opaque.
| rows | query | boolean | No |

- **rows:** `false` answers the shape and the write guide only.

## Responses

### 200

The board.

Content type: `application/json`.

```json
{
  "data": {
    "object": "string",
    "columns": [
      {
        "id": "",
        "label": "string",
        "kind": "string",
        "askedFirst": true,
        "writable": true,
        "why": "string",
        "format": "string",
        "options": [
          {
            "value": "string",
            "label": "string"
          }
        ],
        "members": [
          {
            "id": "",
            "name": "string",
            "email": "string"
          }
        ],
        "example": "string"
      }
    ],
    "rows": [
      {
        "id": "",
        "position": 1,
        "source": "string",
        "cells": {},
        "createdBy": "string"
      }
    ],
    "write": {
      "method": "string",
      "path": "string",
      "columns": [
        {
          "id": "",
          "label": "string",
          "kind": "string",
          "askedFirst": true,
          "writable": true,
          "why": "string",
          "format": "string",
          "options": [
            {
              "value": "string",
              "label": "string"
            }
          ],
          "members": [
            {
              "id": "",
              "name": "string",
              "email": "string"
            }
          ],
          "example": "string"
        }
      ],
      "example": {
        "cells": {},
        "external_id": ""
      }
    },
    "total": 1,
    "nextCursor": "string"
  }
}
```

### 401

No key, or an unknown or revoked one.

Content type: `application/json`.

```json
{
  "error": {
    "message": "string",
    "errors": [
      {
        "index": 1,
        "message": "string"
      }
    ]
  }
}
```

### 403

The key was not given `read`.

Content type: `application/json`.

```json
{
  "error": {
    "message": "string",
    "errors": [
      {
        "index": 1,
        "message": "string"
      }
    ]
  }
}
```

### 429

Over 120 requests a minute; wait `Retry-After` seconds.

Content type: `application/json`.

```json
{
  "error": {
    "message": "string",
    "errors": [
      {
        "index": 1,
        "message": "string"
      }
    ]
  }
}
```
