Getting Started

Choose the path that matches the kind of client you are building. Beyond Pricing supports distinct OAuth2 profiles for server integrations and personal automation clients, plus optional personal access tokens for the same personal profile.

Start with Authentication for diagrams and guidance on partner versus personal mechanisms (client credentials, device authorization, and PATs).

Choose Your Client Profile

Server Integrations

Use this path for confidential backend services, partner platforms, cron jobs, and other server-to-server integrations.

• Client type: confidential
• Default grant: client credentials
• Optional narrowing: user-scoped tokens via user_id, optionally further scoped with credential_id

CLI And Headless Clients

Use this path for single-user automation tools such as CLIs, scripts, and local agents.

• App mode: personal
• Client type: public
• Grant: device authorization (interactive sign-in and refresh tokens), or a personal access token from Beyond for non-interactive automation
• Best for: one Beyond user automating their own account

Common Prerequisites

Before you begin, you need:

1. Beyond-provisioned OAuth2 credentials or an application created by your operator.
2. The correct base URL for your environment.
3. An HTTP client capable of making REST API calls.

For help provisioning credentials, contact api-support@beyondpricing.com.

Common Endpoints

Component	URL
API Endpoints	/api/v1/*
Token Endpoint	/o/token/
Device Authorization Endpoint	/o/device-authorization/
Swagger UI	/api/v1/docs/
ReDoc	/api/v1/redoc/