Control access with Public API Keys

The Instapage Public API lets you connect your account to other tools and pull data such as workspace details, team member information, analytics, and leads. You can also manage pages, collections, and assets. To use it, you need an API key and the developer documentation.

What’s new

• Multiple API keys. Previously, one personal token gave an integration full access to all your workspaces. Now you can create separate keys, one for each tool, team, or contractor. You can revoke a key without affecting the others.

• Limited access. For each key, you choose which workspaces it can reach and the highest role it can use.

• Expiration dates. Keys can expire after a set time or never.

• New location. Developer settings now have their own section: Developers & API → API Keys. They’re no longer in Account settings.

Create an API key

1. Go to API Keys in your Dashboard or My Account Admin → Developers & API → API Keys and click CREATE API KEY.

2. In Key name, enter a unique name between 3 and 36 characters.

3. In Allowed workspace(s), choose what the key can access:

   • All workspaces (default): all your current workspaces, plus any you create or join later.

   • Specific workspaces: use the search field to find workspaces, or click Select all to pick every workspace on the list right now. Workspaces other people share with you appear under Shared with me.

4. In Maximum permitted role, choose Inherited, Manager, Editor, or Viewer.

5. In Expiration, choose 7 days, 30 days, 90 days, Never, or Custom…. For Custom…, click the date field, pick a day, and click APPLY.

6. Click CREATE.

7. The API key generated window shows your key. Click COPY, save the key somewhere secure, then click CLOSE.

Edit an API key

1. On the API Keys list, click the key name. You can also open the ⋮ menu and choose Edit API key.

2. Change the name or the allowed workspaces.

3. Save your changes.

Revoke an API key

1. Open the ⋮ menu next to the key and choose Revoke API key.

2. Type revoke in the confirmation window and click Revoke.

3. The key stops working right away, and the list marks it as Revoked.

How keys, workspaces and roles work together

• Workspaces column. Shows what each key can access. Not restricted means all workspaces. Keys limited to selected workspaces show something like Limited to: Marketing or Limited to 3 workspaces.

• Maximum role. A key never gets a higher role than you have in a workspace. For example, if a key’s maximum role is Manager but you’re an Editor in a workspace, the key acts as an Editor there. Inherited means the key uses your own role in each workspace.

• All workspaces vs Select all. All workspaces includes workspaces you create or join later. Select all includes only the workspaces that exist now. To give such a key access to a new workspace later, edit the key and add it.

• Expiry date column. A warning icon marks keys that are about to expire.

If you used the personal API token

Your existing personal token keeps working as before, so your integrations won’t break. It keeps the same access: all workspaces and no expiration date.

• The API Keys list shows it as Legacy personal token, with Not restricted access and Never expires.

• You can no longer view or copy the token in the app because the Personal API Token card has been removed from Account settings.

• If you don’t have the token saved outside Instapage, create a new API key and use it in place of the old token in your integration.

Documentation

To learn how to send requests with your key, click the API DOCUMENTATION link at the top of the API Keys page, or go to devdocs.instapage.com. The documentation covers:

• authorization: https://devdocs.instapage.com/#authorization 

• available endpoints and data

• code examples in shell, JavaScript, and TypeScript

• error codes

Rate limits

• 200 requests per minute. If you go over this limit, you get a 429 Too Many Requests response.

• Daily call limit based on your plan. The account owner can check it in the Subscription section.

What you can do with the API

• Generate and manage pages in bulk with Collections

• Audit team member usage by workspace

• List pages in a workspace

• Publish and unpublish pages

• Get analytics for workspaces and pages

• Manage lead notification recipients across multiple pages

• List and upload images in workspace image folders

To keep in mind

• You see the key only once. After you close the API key generated window, you can’t view or copy the key again. If you lose it, revoke it and create a new one.

• The expiration date is fixed. When a key is about to expire, create a new one and update your integration.

• Revoking can’t be undone.

• All workspaces is the default and includes future workspaces. If an integration needs only some workspaces, select them before you click CREATE.

• Plan and role restrictions apply. API actions follow the same rules as your role and subscription. For example, users on a free plan can’t download pages through the API.

Tips

• Give each key a clear name that says what it’s for, such as the tool or the contractor. You can reuse the name of a revoked key.

• Give each key only the workspaces it needs and the lowest role that works for the integration.

• Use a separate key for each integration. That way, you can revoke one without breaking the others.