Skip to content

Developers

Authentication

Authenticate requests to the Parcel API with a workspace API key.

The Parcel API uses bearer authentication. Every request must include a valid workspace API key in the Authorization header.

Authorization header
Authorization: Bearer pcl_your_api_key

Replace pcl_your_api_key with a key from your workspace. A request without a valid key receives an HTTP 401 Unauthorized response.

For example, to list projects:

Example request
curl https://api.parcelengineering.com/api/v1/projects?workspace_id=YOUR_WORKSPACE_ID \
-H "Authorization: Bearer pcl_your_api_key"

Create an API key

API keys are created and managed by workspace owners and admins, under Settings → API Keys. Each key is scoped to a single workspace and currently grants read-only access to the API.

The full key is shown only once, when you create it. Copy it then and store it somewhere safe. It can’t be retrieved again later; if you lose it, create a new key instead.

Keep your key secure

Treat an API key like a password:

  • Never commit it to source control or expose it in client-side code.
  • Store it in a secret manager or an environment variable.

If a key is ever exposed, revoke it under Settings → API Keys and create a new one. Revocation takes effect immediately. The next request made with that key receives a 401.