Authenticate
curl --request POST \
--url https://api.thehyperstack.com/v1/auth \
--header 'Authorization: <authorization>'import requests
url = "https://api.thehyperstack.com/v1/auth"
headers = {"Authorization": "<authorization>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<authorization>'}};
fetch('https://api.thehyperstack.com/v1/auth', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.thehyperstack.com/v1/auth",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.thehyperstack.com/v1/auth"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.thehyperstack.com/v1/auth")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.thehyperstack.com/v1/auth")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Authentication Successful",
"account_name": "Acme Academy",
"account_id": "acme-academy"
}
{
"detail": "Invalid token or organization not found"
}
{
"detail": "Authentication credentials were not provided."
}
API Guide
Authenticate
POST
/
v1
/
auth
Authenticate
curl --request POST \
--url https://api.thehyperstack.com/v1/auth \
--header 'Authorization: <authorization>'import requests
url = "https://api.thehyperstack.com/v1/auth"
headers = {"Authorization": "<authorization>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<authorization>'}};
fetch('https://api.thehyperstack.com/v1/auth', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.thehyperstack.com/v1/auth",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.thehyperstack.com/v1/auth"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.thehyperstack.com/v1/auth")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.thehyperstack.com/v1/auth")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Authentication Successful",
"account_name": "Acme Academy",
"account_id": "acme-academy"
}
{
"detail": "Invalid token or organization not found"
}
{
"detail": "Authentication credentials were not provided."
}
Description
Checks your API key and returns the name of the organization it belongs to. Use it to test a new key.GET works too.
Headers
string
required
Your API key:
Bearer YOUR_API_KEY. Create a key in the Studio under Settings → Developers.Success Response Fields
boolean
true when the key is valid.string
Always
"Authentication Successful".string
The display name of your organization.
string
Your organization’s unique ID (its URL slug).
Responses
{
"success": true,
"message": "Authentication Successful",
"account_name": "Acme Academy",
"account_id": "acme-academy"
}
{
"detail": "Invalid token or organization not found"
}
{
"detail": "Authentication credentials were not provided."
}
curl -X POST "https://api.thehyperstack.com/v1/auth" \
-H "Authorization: Bearer YOUR_API_KEY"
Last modified on October 20, 2026
Was this page helpful?

