Getting Started

API Access Tokens

You will first need an API access token (a.k.a. "API key") to start communicating with the API.

🔐 Remember that API access tokens are generated per team. Thus, an access token offers access to all the data associated with workspaces belonging to that team.

⚠️ The API access tokens can be seen by all team admins.

It's important to store the access tokens in a secure way and not share them with third parties. If you really have to share them, make sure they are not exposed publicly and are shared in a secure (e.g. as a One Time Secret).

Get your API key

From your main dashboard, head over to your team settings by clicking Teams List > Your Team > Team Settings:

In your Team settings, go to Developer Portal and click Add new platform application:

Fill out the information needed for your platform application and click Create platform application:

You can create multiple platform applications. You might want to have different client applications for different use cases. For example, one of your platform applications could periodically poll the API's Contacts List endpoint to run some automations on recent contacts. At the same time, you could have a second platform application to connect to your customers' ClickFunnels accounts via OAuth to provide your services to them. We won't be looking into OAuth in this quick Getting Started intro. Instead, we are setting you up to communicate directly with your ClickFunnels account data via the API Access Token.

So now, from the platform application detail page, you can now copy the API Access Token:

Make your first requests

You can have multiple access tokens per platform application. For example, you might want to give different keys to different developers.

Now you can fire out your first request using the API access token as a Bearer token in an Authorization header:

$ curl 'https://localteam.myclickfunnels.test/api/v2/teams' \
--header 'Authorization: Bearer VZeIl6IkzMQCdfSBQdvjSb7-KLllCKrE390QMKcmC6M'
[
    {
        "id": 3,
        "name": "Richard Steinmetz's Team",
# more team information output...

• It usually makes the most sense to query the Workspaces List endpoint next to pick up the workspace ID you want to work with because the Create and List endpoints require a workspace ID:

$ curl 'https://localteam.myclickfunnels.test/api/v2/teams/3/workspaces' \
--header 'Authorization: Bearer VZeIl6IkzMQCdfSBQdvjSb7-KLllCKrE390QMKcmC6M'
[
    {
        "id": 42,
        "team_id": 3,
        "name": "Hammer Workspace",
# more workspace information and potentially other workspaces...

• Once you have the Workspaces ID, you can proceed with exploring your data, like hitting the Contacts List endpoint:

$ curl 'https://localteam.myclickfunnels.test/api/v2/workspaces/42/contacts' \
--header 'Authorization: Bearer VZeIl6IkzMQCdfSBQdvjSb7-KLllCKrE390QMKcmC6M'
[
    {
        "id": 33,
        "email": "[email protected]",
# more contacts information output...

Now you are all set! 🎉

And remember to keep your Access Tokens secure at all times. 🔐

Still questions or doubts? You can share your use case and ask a question over at the Discussion Forum.