Everything an app may see about a connection. Deliberately without the provider's scope list and without an expiry: an app cannot know what a provider's scope names mean, so capability questions are asked and answered instead. The credential appears in no projection anywhere.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-public-connection-schema.json",
"title": "PublicConnection",
"description": "Everything an app may see about a connection. Deliberately without the provider's scope list and without an expiry: an app cannot know what a provider's scope names mean, so capability questions are asked and answered instead. The credential appears in no projection anywhere.\n",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/aimeat-io-connections-api-openapi.yml#/components/schemas/PublicConnection",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"provider": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"personal",
"shared"
]
},
"accountLabel": {
"type": "string",
"description": "Fetched from the provider at connect time, never supplied by a caller."
},
"status": {
"type": "string",
"enum": [
"active",
"needs_reauth",
"revoked"
],
"description": "needs_reauth is a user-visible state rather than an error; scheduled work parks on it instead of retrying.\n"
}
}
}
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.