Skip to content

Batched payload for the portal Integrations page

GET
/integrations/overview
curl --request GET \
--url https://example.com/api/integrations/overview \
--header 'Authorization: Bearer <token>'

Aggregates integrations, webhook setup metadata, webhook status cache, API keys, extended MCP health, and user preferences into a single response. Replaces six individual portal round-trips; individual endpoints remain for granular refetch after mutations.

Batched integrations overview payload

Media type application/json
object
integrations
required
Array<object>
object
setupInfo
required
object
status
required
object
keys
required
Array<object>
object
health
required
object | null
preferences
required
object

Not authenticated

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number
reconnect

True if re-linking GitHub may fix the issue

boolean

Failed to load integrations