Skip to main content

Your First Request

Let’s get started with a simple health check request to ensure that the API is accessible and functioning correctly.

Base URL

EnvironmentURL
Productionhttps://server.overflow.co
Staginghttps://server.stage.overflow.co

Test with a Health Check

Use this curl command to perform a health check and verify your API credentials.
Health Check Request
curl -X GET \
 'https://server.stage.overflow.co/api/v3/health' \
 -H 'x-client-id: <CLIENT_ID>' \
 -H 'x-api-key: <API_KEY>'

OpenAPI Specification

Versioning

The current version of the API is v3, which is reflected in the base path: /api/v3.