API Reference

postmortem.so provides a REST API for integrating with your existing tools and workflows.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer pm_your_api_key

Find your API key in the dashboard at Settings → API Access.

Free plan: read-only access. Pro and Team: full read/write access.

Base URL

https://postmortem.so/api/v1

Endpoints

GET /projects

List all your projects.

Response

[
  {
    "id": "abc123",
    "name": "My API",
    "slug": "my-api",
    "baseUrl": "https://api.example.com"
  }
]

GET /projects/:id/status

Get current status, endpoint health, and active incidents for a project.

GET /projects/:id/incidents

List incidents for a project.

Query parameters

• limit — default: 10, max: 50

POST /projects/:id/incidents (Pro and Team)

Create a new incident.

Body

{
  "title": "API returning 500 errors",
  "description": "Optional description"
}

PATCH /incidents/:id (Pro and Team)

Resolve an incident.

Body

{
  "status": "resolved"
}

Rate limits

API requests are subject to daily rate limits based on your plan. If you exceed the limit, you'll receive a 429 response with a message indicating when the limit resets.

Status page JSON API

Each public status page also has a JSON endpoint:

GET /api/status/:slug

This returns the current system status, endpoint health, and active incidents. It's public and doesn't require authentication. Responses are cached for 60 seconds.