Skip to main content
GET
/
v1
/
api-keys
Get API keys
curl --request GET \
  --url https://api.waterfall.io/v1/api-keys \
  --header 'x-api-key: <api-key>'
{
  "api_keys": [
    {
      "api_key": "11111111-1111-1111-1111-111111111111",
      "active": true,
      "notes": "master key",
      "master": true,
      "per_interval": 50,
      "interval_seconds": 60
    },
    {
      "api_key": "22222222-2222-2222-2222-222222222222",
      "active": true,
      "notes": "team-a",
      "master": false,
      "per_interval": 30,
      "interval_seconds": 60
    },
    {
      "api_key": "33333333-3333-3333-3333-333333333333",
      "active": false,
      "notes": "team-b (deactivated)",
      "master": false,
      "per_interval": 30,
      "interval_seconds": 60
    }
  ]
}
Requires your master API key in the x-api-key header.

​
What this endpoint does

Returns all API keys on your account — including the master key and all sub-keys — with their current status, notes, and rate-limit settings. Use this to audit which keys are active, check their rate limits, or find the UUID of a key you want to modify.

Authorizations

​
x-api-key
string
header
required

To access the API, provide your API key in x-api-key.

Response

API keys list returned

Response containing the list of API keys for the authenticated account.

​
api_keys
object[] | null
required

Your account API keys

Example:
[
  {
    "api_key": "ad18e456-0dd7-45e1-b094-43a0361aedfa",
    "active": true,
    "notes": "team-a",
    "master": false,
    "per_interval": 30,
    "interval_seconds": 60
  }
]