Authentication

To access any endpoint in the Pipeback API, you need to authenticate your requests using a bearer token. This guide explains how to use bearer token authentication with our API.

Creating API Tokens

You can create and manage your API tokens in Pipeback Settings » API.

Token Features

Custom Names: Give each token a descriptive name to identify its purpose
Optional Expiration: Set tokens to expire after a specific period (1 day, 1 week, 1 month, 1 year, 3 years, 5 years, or never)
Status Tracking: Monitor which tokens are active or expired
Last Used: See when each token was last used
Revocation: Revoke tokens at any time to immediately invalidate access

Important: Your API token will only be displayed once when you create it. Make sure to copy and store it securely. You won't be able to view it again.

Bearer Token Authentication

To authenticate your requests to the Pipeback API, you need to include two required headers in every request:

Authorization: Your API token (Bearer token)
x-workspace-id: Your workspace ID

You can find both your API tokens and workspace ID in Settings » API.

Required Headers

Name
Authorization
Type
string
Required
*
Description
Your API token in the format Bearer YOUR_API_TOKEN
Name
x-workspace-id
Type
string
Required
*
Description
Your workspace ID (UUID format). This identifies which workspace the request should be executed against.

Example Request

Example request with required headers

curl https://api.pipeback.com/app/contacts \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Important: Both headers are required for all API requests. Requests missing either header will receive a 401 Unauthorized or 403 Forbidden response.