Skip to main content
OAuth Apps allow third-party applications to access the Essal API on behalf of users. Users grant permission to specific scopes, and your app receives short-lived access tokens scoped to exactly what was requested.

Registering an OAuth App

  1. Go to Settings → Developer → OAuth Apps
  2. Click Register New App
  3. Enter your app name, homepage URL, and redirect URIs
  4. Copy the client_id and client_secret
Or register via API:

Authorization Flow (PKCE)

Token Lifetimes

Refreshing Tokens

Refresh tokens are rotated on each use. Store the new refresh token from every token response. Using an old refresh token will invalidate the entire session.

Revoking Access

Users can revoke your app’s access at any time from Settings → Connected Apps. Your app will receive a 401 on the next API request when access has been revoked.