Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Check service health

GET
/health
curl --request GET \
  --url https://api.pitch2sale.com/health

Unauthenticated. Reports MongoDB and Redis connectivity and whether background workers run; answers 503 when a dependency is down.

Responses

Section titled “Responses”

200

Section titled “200”

All dependencies connected

Media typeapplication/json
object
status
required
string
Allowed values: healthy degraded
checks
required
object
key
additional properties
string
workers_enabled
required
boolean
uptime
required
number
Example
{
  "status": "healthy"
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

503

Section titled “503”

A dependency is down

Media typeapplication/json
object
status
required
string
Allowed values: healthy degraded
checks
required
object
key
additional properties
string
workers_enabled
required
boolean
uptime
required
number
Example
{
  "status": "healthy"
}