List tracked aggregates
Lists rows from the aggregate registry (newest-updated first) with an optional type filter and q id-substring search. Requires dual admin auth (X-Admin-API-Key + JWT with an allowed email domain).
curl -X GET "https://api.spkey.co/admin/aggregates?type=example_string&q=example_string&limit=42&offset=null" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.spkey.co/admin/aggregates?type=example_string&q=example_string&limit=42&offset=null"
headers = {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.spkey.co/admin/aggregates?type=example_string&q=example_string&limit=42&offset=null", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.spkey.co/admin/aggregates?type=example_string&q=example_string&limit=42&offset=null", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/admin/aggregates?type=example_string&q=example_string&limit=42&offset=null')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-API-Key'] = 'YOUR_API_KEY'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"total": 3.14,
"limit": 3.14,
"offset": 3.14,
"knownTypes": [
{
"type": "example_string",
"label": "example_string",
"binding": "example_string"
}
],
"aggregates": [
{
"aggregateType": "example_string",
"aggregateId": "example_string",
"doId": "null",
"orgId": "null",
"createdAt": "example_string",
"updatedAt": "example_string"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
GET
/admin/aggregates
GET
Base URLstring
Target server for requests. Edit to use your own host.
⚠️Authentication configuration error - security schemes not found
query
typestring
Filter by aggregate type or slug.
query
qstring
Case-insensitive substring match on aggregate id.
query
limitinteger
Min: 1 • Max: 200
query
offsetintegernull
Min: 0
Request Preview
Response
Response will appear here after sending the request
Query Parameters
typestring
Filter by aggregate type or slug.
qstring
Case-insensitive substring match on aggregate id.
Responses
totalnumber
Requiredlimitnumber
Requiredoffsetnumber
RequiredknownTypesarray
Requiredaggregatesarray
RequiredWas this page helpful?