How to access the Linkie API

Step-by-step guide on how to access the Linkie API

The Linkie API is a free, public API for building with Linkie data and connecting Linkie to your own tools, workflows, or services.

Open your Linkie profile settings

Click your Linkie avatar at the top-right corner of the playground. A dropdown menu will appear. From there, click the **Account Settings **icon.

Go to API Keys

Once you are in settings, click API Keys.

This is where you can create and manage the API keys connected to your Linkie profile.

Generate an API key

Click Generate new key.

Add a short name that describes where you will use the key.

The name is up to you, but we recommend using something easy to recognize and understand later, especially if you create multiple API keys.

In the same window, choose the permission scopes for the API key. These permissions control what the key can access or change:

Linkie profiles: choose None, Read Only, or Read & Write.
Analytics: choose None or Read Only.
Automated posts: choose None, Read Only, or Read & Write.

Choose Read Only when the tool only needs to view information. Choose Read & Write only when the tool needs to create, update, or manage content for you.

For better security, give each API key only the permissions it needs. You can create separate API keys for different tools or workflows.

Copy and store your API key

Copy the API key and save it somewhere secure, such as your password or secret manager.

Keep your API key private and never expose it in frontend code. Anyone with access to it will be able to authenticate API requests for your Linkie profile.

Open the API documentation

Once your API key has been generated and stored, open the Linkie API docs to view the available endpoints, request formats, authentication details, and response examples.

Things to note

Basic RESTful API knowledge and an API client are required to work with the API.
Permission scopes control what each API key can access or change.
You can view the API documentation at linkie.bio/docs.
Store your API key securely and never commit it to public or private repositories. Keep it in an environment variable, a .env file, a secrets manager, or a password manager.
You can create separate API keys for different tools or workflows if you want to manage access more easily.
If you no longer use an API key, revoke it from your Linkie settings.

Updated on: 10/06/2026

Was this article helpful?

Thank you!