Introduction

API endpoint

The API is available at the following base endpoint:

https://api.signupgate.com/v1/

Bearer token

All endpoints require a valid bearer token to be included in the Authorization header of the request.
See how you can obtain a bearer token in the get started guide.

Example request

curl --request GET \
 --url https://api.signupgate.com/v1/status \
 --header 'accept: application/json' \
 --header 'Authorization: Bearer [YOUR_API_KEY]'

Response format

All responses are in JSON format.
The response will include a success field and a data field with the response data.

Example response

{
  "success": true,
  "data": {
    ...
  }
}

If the request fails, the success field will be false and the response will include a message field with the error message.

Example response

{
  "success": false,
  "message": "Error message related to the request"
}