Skip to main content
Each request to the Perquery API must include an API key. The API uses the key to find your organization and to check what the key can read.

​
Send the API key

Put the key in the Authorization header. Write the word ApiKey, one space, and then the key:

​
Key format

A key has three parts with an underscore between them: pq_<prefix>_<secret>. Send the full key, with all three parts.

​
Create a key

1

Open the API Keys page

In the Perquery app, open API Keys.
2

Create the key

Click Create key. Enter a Name. If necessary, set a date in Expires (optional). Click Create.
3

Copy the key

Click Copy. Store the key in a safe place. Then click Done.
For all the details, read API keys.

​
What a key can read

  • A key is read-only. It accepts only GET requests.
  • A key acts as the team member who created it. It reads only the data that the roles of this member allow at the time of the request.
  • When the roles of the creator change, the access of the key changes too.
  • When your organization does not have the API access add-on, all keys of the organization stop. The API answers 403 with missing-entitlement.

​
When the API refuses a key

For all errors, read Errors and limits.

​
Keep your keys safe

A key gives access to the data of your organization. Do not put a key in browser code, in a mobile app or in a public repository.
  • Keep the key in an environment variable or in a secret store, as in the examples above.
  • Give each integration its own key with a clear Name. You can then revoke one key and keep the others.
  • Set an expiry date for a key that you need only for a limited time.
  • When a key is lost or shared by mistake, revoke it on the API Keys page at once. Then create a new key.