> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tierity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API introduction

> Automate Tierity over HTTP: read findings and deadlines, manage members and invitations, and set SLA policies.

## Overview

The Tierity API is the same JSON-over-HTTP API the web app uses. Anything you can see in the app, you can reach with an API key. API access is available on every plan.

## Base URL

```
https://tierity.com/api
```

For a self-hosted instance, use your own domain, for example `https://tierity.example.com/api`.

Most endpoints are scoped to an organization and include its ID:

```
/api/organizations/{orgId}/...
```

Find your organization's ID in the address bar when you're in the app (`/app/org/{orgId}/...`), or call `GET /api/organizations`.

## Authentication

Send an API key as a bearer token:

```bash theme={null}
curl https://tierity.com/api/organizations \
  -H "Authorization: Bearer pk_..."
```

See [Authentication](https://docs.tierity.com/api-reference/authentication.md) for creating and revoking keys.

## Requests and responses

Send request bodies as JSON with `Content-Type: application/json`. Responses are JSON. Field names in responses are mostly `snake_case`; a few older endpoints return `camelCase`. Each endpoint's page shows its shape.

## Errors

Errors use standard HTTP status codes with a JSON body:

```json theme={null}
{ "error": "Organization not found" }
```

| Status | Meaning |
| - | - |
| `400` | The request body or parameters are invalid |
| `401` | The API key is missing, invalid, revoked or expired |
| `402` | A plan limit was reached, such as seats; the body includes a `reason` |
| `403` | The key's owner doesn't have the role this action needs, or the key belongs to a different organization |
| `404` | The resource doesn't exist |
| `422` | The request was understood but can't be applied |
| `500` | Something went wrong on our side |

## Endpoints

> **[Organizations](https://docs.tierity.com/api-reference/endpoints/organizations.md)**
>
> Organization details, members, roles and invitations.

> **[Findings and SLAs](https://docs.tierity.com/api-reference/endpoints/findings.md)**
>
> Findings from every connected tool with their deadlines, and SLA policies.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.