This guide shows you how to create, manage, and monitor your API keys.

What Are API Keys?

API keys allow external tools and services to securely connect to your Pinpoint account. Each key acts as a unique password that authenticates the connection and controls what data the integration can access.

Common integrations include workflow automation tools like Zapier, interview intelligence platforms like Metaview, and custom reporting solutions.

Getting Started

Accessing API Settings

Click Settings in the left sidebar
Select API & Webhooks
Make sure the Pinpoint API toggle is switched on (you'll see it in the top-right corner)

You'll see three tabs: API Keys, API Logs, and Webhooks.

Creating a New API Key

Go to the API Keys tab
Click + CREATE NEW
Enter a name for your key—use something descriptive like "Zapier" or "Reporting Dashboard" so you can easily identify it later
Set permissions for each data category:
- None – No access
- Read – Can view data
- Write and Delete – Can view, create, update, and remove data
Click CREATE API KEY

Tip: Only grant the permissions your integration actually needs. If you're unsure, start with Read-only access—you can always add more later.

Quick option: Click ASSIGN ALL to grant full access to everything. Use this sparingly and only when you're certain the integration requires complete access.

Managing Your API Keys

Viewing Your Keys

The API Keys tab shows all your active keys with:

Column	What It Shows
Key name	The name you gave it
Last used	When it was last used
Key value	Hidden by default (shown as •••••••••••)

Copying Your API Key

Click the copy icon to copy the key to your clipboard
Click the eye icon to reveal the full key temporarily

Keep it secret: Treat your API key like a password. Don't share it via email or messaging apps—use a secure method if you need to share it with a colleague.

Viewing Permissions

Click VIEW PERMISSIONS next to any key to see exactly what access it has.

Editing a Key

Click the •• menu next to the key
Select Edit
Update the name or permissions
Save your changes

Changes take effect immediately, so make sure any connected integrations will still work with the new permissions.

Deleting a Key

Click the •• menu next to the key
Select Delete
Confirm when prompted

Warning: Deleting a key is permanent and happens immediately. Any integration using that key will stop working straight away.

Monitoring API Activity

Viewing API Logs

Click the API Logs tab to see a record of all API requests made to your account.

Each log entry shows:

Field	Description
Path	Which part of the API was accessed
Created At	Date and time of the request
Method	Type of request (GET, POST, PUT, DELETE)
Response	Whether it succeeded (200) or failed (400, 401, etc.)
API Key	Which key was used
IP Address	Where the request came from
Duration	How long it took

Filtering Your Logs

Search by path: Type in the search box to find specific endpoints
Filter by method: Use the "All Methods" dropdown to show only GET, POST, PUT, or DELETE requests

Understanding Response Codes

Code	What It Means
200	Success
201	Successfully created
400	Something was wrong with the request
401	The API key is invalid or missing
403	The API key doesn't have permission for this action
404	The requested item wasn't found
429	Too many requests—slow down
500	Something went wrong on our end

Troubleshooting

My Integration Stopped Working

Check the API Keys tab to make sure the key still exists
Click VIEW PERMISSIONS to verify it has the right access
Look at API Logs for any error codes

I'm Seeing 401 Errors

The API key isn't being recognized. Double-check that:

The key is copied correctly (no extra spaces)
The key hasn't been deleted
The Pinpoint API toggle is switched on

I'm Seeing 403 Errors

The key doesn't have permission for what it's trying to do. Edit the key and add the necessary permissions.

Requests Are Slow

Check the Duration column in your API Logs. If you're seeing times over 2 seconds regularly, your integration might be requesting too much data at once. Consider using filters or pagination.