Skip to main content

List Integrations

Retrieve all API integrations (keys) associated with your brand.

Request

GET /api/v1/integrations

Headers

HeaderValueRequired
AuthorizationBearer {client_token}Yes

Query Parameters

ParameterTypeDescription
provider_namestringFilter by provider (e.g., openrouter)
health_statusstringFilter by healthy, degraded, or unhealthy
is_activebooleanFilter active (true) or inactive (false) keys
limitintegerResults per page (default: 50, max: 100)
offsetintegerPagination offset

Example Requests

Get All Integrations

curl "https://spideriq.ai/api/v1/integrations" \
-H "Authorization: Bearer $CLIENT_TOKEN"

Filter by Provider

curl "https://spideriq.ai/api/v1/integrations?provider_name=openrouter" \
-H "Authorization: Bearer $CLIENT_TOKEN"

Filter by Health Status

curl "https://spideriq.ai/api/v1/integrations?health_status=unhealthy" \
-H "Authorization: Bearer $CLIENT_TOKEN"

Response

Success (200 OK)

{
"success": true,
"integrations": [
{
"id": 42,
"provider_name": "openrouter",
"provider_label": "OpenRouter",
"key_label": "Production OpenRouter",
"is_active": true,
"is_primary": true,
"priority": 10,
"daily_limit": 10000,
"daily_count": 1247,
"minute_limit": 100,
"minute_count": 3,
"health_status": "healthy",
"consecutive_failures": 0,
"last_used_at": "2026-02-26T14:58:00Z",
"spend_limit_amount": 500.00,
"spend_limit_period": "monthly",
"spend_limit_action": "warn",
"spend_limit_exceeded": false,
"cached_balance": 47.83,
"cached_usage_today": 2.34,
"cached_usage_month": 89.47,
"cached_currency": "USD",
"billing_synced_at": "2026-02-26T12:00:00Z",
"key_preview": {
"api_key": "sk-o...123"
},
"created_at": "2026-01-15T10:00:00Z",
"updated_at": "2026-02-26T14:58:00Z"
},
{
"id": 43,
"provider_name": "groq",
"provider_label": "Groq",
"key_label": "Groq Free Tier",
"is_active": true,
"is_primary": false,
"priority": 0,
"daily_limit": null,
"daily_count": 523,
"minute_limit": null,
"minute_count": 0,
"health_status": "healthy",
"consecutive_failures": 0,
"last_used_at": "2026-02-26T14:30:00Z",
"cached_balance": null,
"cached_usage_today": null,
"cached_usage_month": null,
"key_preview": {
"api_key": "gsk...xyz"
},
"created_at": "2026-02-01T09:00:00Z",
"updated_at": "2026-02-26T14:30:00Z"
}
],
"total": 2,
"limit": 50,
"offset": 0
}

Response Fields

FieldDescription
idUnique integration ID
provider_nameProvider identifier
provider_labelHuman-readable provider name
key_labelYour custom label
is_activeWhether key is enabled
is_primaryPrimary keys are selected first
prioritySelection priority (10 for primary, 0 for secondary)
daily_limitMax requests per day (null = unlimited)
daily_countRequests used today
minute_limitMax requests per minute (null = unlimited)
minute_countRequests in current minute
health_statushealthy, degraded, or unhealthy
consecutive_failuresNumber of failures in a row
last_used_atLast time this key was used
cached_balanceBalance from last billing sync
cached_usage_todayToday's spend from billing sync
cached_usage_monthThis month's spend from billing sync
billing_synced_atLast billing sync timestamp
key_previewMasked credential preview