Skip to main content

How to create API credentials for your BuildPass account

Create your own API client ID and client secret directly from BuildPass settings.

Written by Raxl

BuildPass API access is now self-serve. Admins on eligible plans can create their own API credentials (client ID and client secret) directly from BuildPass settings, without contacting support. This article explains how to create an API client, where to find your credentials, and how to revoke access if needed.

Why use API access

API credentials let you connect BuildPass with your own systems, such as internal dashboards, data warehouses, or custom integrations. Instead of exporting data manually, your systems can authenticate with BuildPass and read data programmatically.

Before you start

  • API access is available on Pro plans and above. If you are on a lower tier and need API access, contact your BuildPass account manager.

  • You must be a BuildPass admin to create API credentials.

Step 1 — Open API Access settings

Go to Settings > More Settings > API Access.

[Screenshot: The More Settings menu with the API Access option highlighted]

Step 2 — Create an API client

Select Create API client. Give the client a name that describes the integration it will be used for, and select the scopes the client should have access to.

[Screenshot: The Create API client dialog showing the integration name field and scope checkboxes]

Step 3 — Copy your credentials

Once created, BuildPass displays your client ID and client secret with copy buttons next to each. Copy both values and store them securely, for example in a password manager.

[Screenshot: The created credentials dialog showing the client ID and client secret with Copy buttons]

Step 4 — Authenticate

Your systems exchange the client ID and client secret for an access token using BuildPass's OAuth token endpoint. Share these details with your developer or integration partner.

Revoking an API client

If a credential is no longer needed or may have been exposed, return to Settings > More Settings > API Access and select Revoke next to the client. Revoked credentials stop working immediately.

Still need help? Reply to this article or contact the support team and we'll help you out.

Did this answer your question?