Skip to content
Docs
Open appStart free

Create and manage API keys

On this page

An API key lets your own code read your Ghosts and Finds or act on them. Keys belong to your company, not to one person. The API reference lists what the API can do.

Owners and admins manage keys, and your company needs an active plan.

Create a key

  1. Open Settings then API and click Create on the API Keys card.
  2. Give it a Key name that says where it is used, like “Payroll CRM sync”.
  3. Turn on Read-only if the key only needs to read data.
  4. Click Create API Key, then copy the key and store it somewhere safe.

Warning

PitchGhost shows the full key only once. If you lose it, delete the key and create a new one.

A read-only key can read data but cannot change anything. You choose this when you create the key and cannot change it later.

Rename or delete a key

Open the menu on the key’s row and choose Rename or Delete. Deleting a key revokes it at once, so anything using it stops working. This cannot be undone.

Let a key act with a social account

A key can take actions on a social platform only through a linked account it has permission to use. The person who linked the account grants that.

  1. Open the account’s platform under Settings then Integrations.
  2. Click the access button next to the account to open Account access.
  3. On the API tab, pick the keys that may use it.

An account shared with everyone in the company can be used by every API key.

Last updated

Was this helpful?

Related articles

Still need help? Open the app and choose Help, then Chat now.