Flat API

REST discovered

Details

URL: https://api.flat.io/v2
Spec: https://flat.io/developers/docs/openapi.yaml
Spec (json): https://api.apis.guru/v2/specs/flat.io/2.13.0/openapi.json
Docs: https://flat.io/developers/docs/api/reference

Authentication

Flat personal access token bearer discovered Get token ↗

Authorization: Bearer <credential>

Create an app in My apps. In the left menu, open Flat API > Personal Tokens, choose a token name and scopes, and generate a token. Use it as Authorization: Bearer <token>.

Flat OAuth2 client credentials (client ID and client secret) oauth2 discovered Set up OAuth ↗

If your app will be used by other Flat accounts, request OAuth2 credentials from Flat via the OAuth2 credentials request form. Flat provides a key/secret pair (client_id and client_secret). Redirect users to https://flat.io/auth/oauth, then exchange the returned code at https://api.flat.io/oauth/access_token for an access token. The resulting access token is used as Authorization: Bearer <token>.