# API

The GOAT API, endpoint by endpoint.

The full API reference is not published yet. Until it is, the guides document each call a reader needs, with its request, its answer, and its errors:

| Task | Calls | Page |
|---|---|---|
| Get a viewer token | `POST /v5/tokens/embed` | [Viewer tokens](../embed/viewer-tokens.md) |
| Register and manage tenants | `/v5/admin/tenants`, `/v5/admin/tenants/register`, `/v5/admin/tenants/sync` | [Tenants and access](../embed/tenants-and-access.md) |
| Grant or deny access to a dashboard | `/v5/admin/grants` | [Grant access to dashboards](../embed/grants.md) |
| Change install settings | `GET` and `PATCH /v5/admin/settings` | [Install settings](settings.md) |
| Send rows from your application | `POST /v5/dataload/datasets/{id}/ingest` | [Push data from your application](../build-dashboards/push-api.md) |

## How calls are authenticated

| Calls | Send |
|---|---|
| `POST /v5/tokens/embed` and the push API | An API key, in the `X-Api-Key` header. See [API keys](../run-goat/api-keys.md). |
| `/v5/admin/...` | A person's own sign-in token, as `Authorization: Bearer`. An admin's or an author's, as each page says. The app does not yet give a way to get that token, and these docs do not yet cover it. |
| What the embedded dashboard calls | The viewer token, as `Authorization: Bearer`. The embed script sends it for you. |

Every address starts with your install's address, such as `https://analytics.example.com`. Errors answer with a JSON body holding a `code` and a `message`; see [Errors](errors.md).
