List API Keys
curl --request GET \
--url https://{brand_domain}/api/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'X-Super-Admin-Email: <x-super-admin-email>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{brand_domain}/api/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Super-Admin-Email: <x-super-admin-email>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{brand_domain}/api/v1/api-keys"
headers = {
"X-Super-Admin-Email": "<x-super-admin-email>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Super-Admin-Email': '<x-super-admin-email>',
Authorization: 'Bearer <token>'
}
};
fetch('https://{brand_domain}/api/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{brand_domain}/api/v1/api-keys"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Super-Admin-Email", "<x-super-admin-email>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{brand_domain}/api/v1/api-keys")
.header("X-Super-Admin-Email", "<x-super-admin-email>")
.header("Authorization", "Bearer <token>")
.asString();const url = 'https://{brand_domain}/api/v1/api-keys';
const options = {
method: 'GET',
headers: {
'X-Super-Admin-Email': '<x-super-admin-email>',
Authorization: 'Bearer <token>'
}
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"data": [
{
"id": 4,
"name": "POS-System-Integration",
"prefix": "op_live_5gH2",
"status": "active",
"last_used": "2026-06-23T14:18:22Z",
"expires_at": null,
"created_at": "2026-06-21T09:00:00Z"
}
]
}{
"success": false,
"error": "Payment not found",
"errors": [
{
"code": "PAYMENT_NOT_FOUND",
"message": "Payment not found",
"field": null
}
],
"request_id": "8f5a2e9b0c7d4e5f"
}{
"success": false,
"error": "Payment not found",
"errors": [
{
"code": "PAYMENT_NOT_FOUND",
"message": "Payment not found",
"field": null
}
],
"request_id": "8f5a2e9b0c7d4e5f"
}{
"success": false,
"error": "Payment not found",
"errors": [
{
"code": "PAYMENT_NOT_FOUND",
"message": "Payment not found",
"field": null
}
],
"request_id": "8f5a2e9b0c7d4e5f"
}API Reference
List API Keys
Lists metadata for all API keys created for the brand. Full key secrets are hashed and never returned in list metadata for security.
Requires special admin authorization: API key must possess write and admin scopes, and the X-Super-Admin-Email header
must identify an active superadmin user.
GET
https://{brand_domain}/api/v1
/
api-keys
List API Keys
curl --request GET \
--url https://{brand_domain}/api/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'X-Super-Admin-Email: <x-super-admin-email>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{brand_domain}/api/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Super-Admin-Email: <x-super-admin-email>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{brand_domain}/api/v1/api-keys"
headers = {
"X-Super-Admin-Email": "<x-super-admin-email>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Super-Admin-Email': '<x-super-admin-email>',
Authorization: 'Bearer <token>'
}
};
fetch('https://{brand_domain}/api/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{brand_domain}/api/v1/api-keys"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Super-Admin-Email", "<x-super-admin-email>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{brand_domain}/api/v1/api-keys")
.header("X-Super-Admin-Email", "<x-super-admin-email>")
.header("Authorization", "Bearer <token>")
.asString();const url = 'https://{brand_domain}/api/v1/api-keys';
const options = {
method: 'GET',
headers: {
'X-Super-Admin-Email': '<x-super-admin-email>',
Authorization: 'Bearer <token>'
}
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"data": [
{
"id": 4,
"name": "POS-System-Integration",
"prefix": "op_live_5gH2",
"status": "active",
"last_used": "2026-06-23T14:18:22Z",
"expires_at": null,
"created_at": "2026-06-21T09:00:00Z"
}
]
}{
"success": false,
"error": "Payment not found",
"errors": [
{
"code": "PAYMENT_NOT_FOUND",
"message": "Payment not found",
"field": null
}
],
"request_id": "8f5a2e9b0c7d4e5f"
}{
"success": false,
"error": "Payment not found",
"errors": [
{
"code": "PAYMENT_NOT_FOUND",
"message": "Payment not found",
"field": null
}
],
"request_id": "8f5a2e9b0c7d4e5f"
}{
"success": false,
"error": "Payment not found",
"errors": [
{
"code": "PAYMENT_NOT_FOUND",
"message": "Payment not found",
"field": null
}
],
"request_id": "8f5a2e9b0c7d4e5f"
}Last modified on July 12, 2026
Related topics
Laravel SDK - Fluent Payment Integration for PHP AppsAPI KeysNode.js SDK - TypeScript-First Payment IntegrationGenerate API KeyRevoke API KeyWas this page helpful?