Authentication

curl --request GET \
  --url https://api.flatpeak.com/login \
  --header 'Authorization: Basic <encoded-value>'

{
  "bearer_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50X2lkIjoiYWNjXzQwODQzYzgwNThlMzRiM2E5OGZkMGY1Yjc1MmE2OTFiIiwibGl2ZV9tb2RlIjpmYWxzZSwiaXNzIjoiRmxhdFBlYWtBUEkiLCJzdWIiOiJhY2NfNDA4NDNjODA1OGUzNGIzYTk4ZmQwZjViNzUyYTY5MWIiLCJleHAiOjE2NjYwOTg4NjgsIm5iZiI6MTY2NjAxMjQ2OCwiaWF0IjoxNjY2MDEyNDY4fQ.GVfkaouHm4nBoj5gSaAaEBaoS9tPNhALgrMu0-TIrWQ",
  "expires_in": 3600,
  "live_mode": true
}

Authentication

Flatpeak API uses bearer authentication to authorise access to endpoints. To create a bearer, use this endpoint with basic auth.

Field	Value
`username`	Your Flatpeak Account ID
`password`	Any of your Flatpeak API Keys

Account ID and API Keys can be found in the Dashboard.

GET

Authentication

curl --request GET \
  --url https://api.flatpeak.com/login \
  --header 'Authorization: Basic <encoded-value>'

{
  "bearer_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50X2lkIjoiYWNjXzQwODQzYzgwNThlMzRiM2E5OGZkMGY1Yjc1MmE2OTFiIiwibGl2ZV9tb2RlIjpmYWxzZSwiaXNzIjoiRmxhdFBlYWtBUEkiLCJzdWIiOiJhY2NfNDA4NDNjODA1OGUzNGIzYTk4ZmQwZjViNzUyYTY5MWIiLCJleHAiOjE2NjYwOTg4NjgsIm5iZiI6MTY2NjAxMjQ2OCwiaWF0IjoxNjY2MDEyNDY4fQ.GVfkaouHm4nBoj5gSaAaEBaoS9tPNhALgrMu0-TIrWQ",
  "expires_in": 3600,
  "live_mode": true
}

Authorizations

Authorization

string

header

required

Pass your account_id as username and secret_key as password via basic auth.

Response

bearer_token

string

required

The bearer security token.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50X2lkIjoiYWNjXzQwODQzYzgwNThlMzRiM2E5OGZkMGY1Yjc1MmE2OTFiIiwibGl2ZV9tb2RlIjpmYWxzZSwiaXNzIjoiRmxhdFBlYWtBUEkiLCJzdWIiOiJhY2NfNDA4NDNjODA1OGUzNGIzYTk4ZmQwZjViNzUyYTY5MWIiLCJleHAiOjE2NjYwOTg4NjgsIm5iZiI6MTY2NjAxMjQ2OCwiaWF0IjoxNjY2MDEyNDY4fQ.GVfkaouHm4nBoj5gSaAaEBaoS9tPNhALgrMu0-TIrWQ"

expires_in

integer

required

Expiration time in seconds.

Example:

3600

live_mode

boolean

required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example:

true

Introduction List all events

⌘I