Skip to main content
The ego API is HTTP and JSON. Every request reads through ego, scoped to the connections your key can see. The endpoint pages in this section are generated from the OpenAPI specification, so the parameters and responses shown there match the spec exactly.
The API is in preview. The base URL and endpoints describe the shape we’re building toward and aren’t live yet.

Base URL

All endpoints are relative to:

Authentication

Authenticate with an API key, passed as a bearer token on every request:
Keys are secrets. Keep them out of source control and client-side code. A request with a missing or invalid key returns 401.

Scopes

A token carries the scopes you grant on the consent screen. Each endpoint requires its native scope; a request without it returns 403.

Responses

Successful responses are JSON. List endpoints return their results under a data array. Errors return a JSON object with a human-readable error message: