---
title: "Introduction"
description: "The Notifiable API. SDK routes use a public key. Server routes use an API key."
canonical: https://docs.notifiable.sh/api
source: https://docs.notifiable.sh/api/index.md
---

# Introduction

The Notifiable API is a versioned JSON API. SDK routes use a public key. Server routes use an API key. Every response uses one success or error envelope.

The public API is the Server group. Those routes start at `/api/v1/public`. Send `Authorization: Bearer` with a workspace server API key. The same key can act on every app in the workspace. A route that names an app uses that app id. `environment` is `development` or `production`. The key can manage product data. It cannot bill, invite members, transfer or delete the workspace, read Apple or provider secrets, or mint another key.

A success response has `request_id`, `status` (`success`), `code`, `message`, `timestamp`, and `data`. An error response has the same fields except `data`, and an `error` object with `type` and `details`.

## Server

- [Workspace](/api/workspace) — the workspace this server API key belongs to.
- [Apps](/api/apps) — apps in the workspace.
- [Subscribers](/api/subscribers) — people and devices in one app and environment.
- [Segments](/api/segments) — audiences for one app and environment.
- [Notifications](/api/notifications) — compose, send, schedule, and read notifications.
- [Event log](/api/event-log) — events recorded for one app and environment.
- [Webhooks](/api/webhooks) — endpoints Notifiable calls for one app and environment.
- [Workflows](/api/workflows) — draft and published workflows.
- [Automations](/api/automations) — saved automations that send when an event matches.
- [Analytics](/api/analytics) — delivery counts for one app and environment.
- [Deep links](/api/deep-links) — routes the SDK stores for notification taps.
