---
updatedAt: 2026-08-26T15:21:01.000Z
---

Fetch the complete documentation index at: https://developers.flipdish.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

# Getting Started with Flipdish API

Set up your Flipdish App, get an access token, and make your first API call.

## Create your Flipdish App

> 📘 What is a Flipdish App
>
> We use the term "Flipdish App" for any integration, module or application built on top of the Flipdish API.\
> Some code samples may use the term "client" instead of "Flipdish App"

To interact with the Flipdish API you will need a Flipdish account. You can create one for free at <https://portal.flipdish.com/signup>

Click on your avatar and then on **Developer tools**.

![1288](https://files.readme.io/729ad3d-dt.png "dt.png")

Click on **OAuth apps** and then on the red **Add New** button.

![1027](https://files.readme.io/04f2d61-2.png "2.png")

Give your app a name and press **Create**

![1650](https://files.readme.io/f1f5f4d-3.png "3.png")

## Get your credentials

Your Flipdish App has a **Client ID** and a **Secret Key**. You need both to request an access token.

![2235](https://files.readme.io/8aa5135-12.png "12.png")

> 📘 Secret key is hidden by default
>
> Use the **REVEAL SECRET KEY** button in the Developer Portal to view your key. Keep it in a safe place and never expose it to customers or third parties.

## Get an access token

### Via the Developer Portal

You can generate a token directly from the Developer Portal for testing.

![2017](https://files.readme.io/b03f49f-1.png "1.png")

Click the **Request token** button to generate a token.

![1705](https://files.readme.io/01083d6-11.png "11.png")

### Via the API (client credentials flow)

For production integrations, request tokens programmatically using your Client ID and Secret Key:

```curl
curl --request POST \
  --url https://api.flipdish.co/identity/connect/token \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'client_id=<your_client_id>' \
  --data-urlencode 'client_secret=<your_secret_key>' \
  --data-urlencode 'scope=api'
```
```python
import requests

response = requests.post(
    "https://api.flipdish.co/identity/connect/token",
    data={
        "grant_type": "client_credentials",
        "client_id": "<your_client_id>",
        "client_secret": "<your_secret_key>",
        "scope": "api",
    },
)
access_token = response.json()["access_token"]
```
```javascript
const response = await fetch("https://api.flipdish.co/identity/connect/token", {
  method: "POST",
  headers: { "Content-Type": "application/x-www-form-urlencoded" },
  body: new URLSearchParams({
    grant_type: "client_credentials",
    client_id: "<your_client_id>",
    client_secret: "<your_secret_key>",
    scope: "api",
  }),
});
const { access_token } = await response.json();
```

> 📘 Token types
>
> **Secret Key**: used only by you and Flipdish to obtain access tokens. Never expose it to customers or third parties.
>
> **Access Token** (Bearer Token): used in the `Authorization` header for every API call. Tokens expire — re-request one using your credentials when needed.

## Make an API call

Include your access token in the `Authorization` header on every request:

```curl
curl --request GET \
  --url https://api.flipdish.co/orgManagement/orgs \
  --header 'Authorization: Bearer <access_token>'
```

> ❗️ Always use HTTPS
>
> Calls made over plain HTTP will fail. API requests without authentication will also fail.

> 📘 User-Agent Required
>
> Set a descriptive `User-Agent` header on all requests (e.g., `YourCompany/YourProduct v1.0`). See [User Agents](https://developers.flipdish.com/docs/user-agents) for details.

> 📘 Rate limits apply
>
> API requests are rate limited. See [Rate Limits](https://developers.flipdish.com/docs/rate-limits) for current limits and how to handle a `429` response.

## What's next

Explore the [API Overview](https://developers.flipdish.com/docs/api-overview) to see which API resources are available and common integration scenarios.