Skip to main content

API Root Endpoint

GET /api/v1

Description​

This endpoint is typically used to check the status or health of the API service. It might return basic information about the API such as the current version, status, or available resources. It's a common practice to use this endpoint for monitoring and validating API connectivity.

Example Request:

curl -G "http://[base_url]/api/v1" \
     -H "Authorization: Bearer [access_token]"

Responses:

  • 200 OK: Successfully reached the API. The response might include basic API details or a simple message indicating the API is operational.

Example Response:

{
  "status": "OK",
  "message": "API is running.",
  "version": "1.0"
}

Error Responses:

  • 404 Not Found: The endpoint does not exist or is not available.
  • 503 Service Unavailable: The API is down or temporarily unavailable.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1 \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!