API introduction

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:

curl https://tierity.com/api/organizations \
  -H "Authorization: Bearer pk_..."

See Authentication 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:

{ "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

API Documentation

Core Endpoints

Overview

Base URL

Authentication

Requests and responses

Errors

Endpoints

Organizations

Findings and SLAs

​Overview

​Base URL

​Authentication

​Requests and responses

​Errors

​Endpoints

Organizations

Findings and SLAs

Overview

Base URL

Authentication

Requests and responses

Errors

Endpoints