Get an API key

Create, name, and safely store an API key to authenticate REST API requests.

Updated October 12, 20262 min read

An API key identifies your account on every REST API request. You create keys in Fiddle and send them in the X-API-Key header.

Create a key

  1. Go to Integrations → Fiddle API.
  2. Click Create API Key.
  3. Give it a descriptive Name (for example, “Shopify sync” or “warehouse script”) so you can tell keys apart later.
  4. Choose the User the key belongs to. Requests made with the key act as this user.
  5. Select Read, Write, or both.
  6. Click Create API Key, then copy the key. Keys start with fdk_.

The full key is shown only once, at creation. Store it in a secure secrets manager or environment variable. If you lose it, revoke the key and create a new one.

Use the key

Send the key in the X-API-Key header on every request:

curl https://fiddle.io/rest/api/v2/users/me \
  -H "X-API-Key: YOUR_API_KEY"

GET /users/me returns the user the key belongs to, so it’s a quick way to check a new key.

Don’t send the key as Authorization: Bearer YOUR_API_KEY. The Authorization header doesn’t accept API keys, so the request won’t authenticate.

Keep keys safe

  • Never commit keys to source control or paste them into client-side code.
  • Use a separate key per integration so you can revoke one without breaking the others.
  • Assign each key to a user whose access fits what the integration needs.
  • Revoke any key that may have leaked: go to Integrations → Fiddle API and click Revoke next to it.

Requests made with a valid API key get a higher rate limit than anonymous requests — see authentication and rate limits.

Next steps

With a key in hand, read authentication and rate limits to understand headers, errors, and quotas.

Was this article helpful?

Related articles

Still need help?

Ask Filo, our built-in AI assistant, for an instant answer — or get in touch with our team and we'll take it from there.