System

API Health Check

Check the health status of our API layer and verify your authentication

get/health

Request

  • Base URL: https://api.pitchghost.com
  • URL: https://api.pitchghost.com/health
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Response

API is healthy and authentication is valid

status'ok' required
companyIdstring required

The company ID associated with the API key

Example response

{
  "companyId": "company_123456"
}

Changes

No recorded changes to this operation across all 1 revision of this API.