Getting Started

Choose the path that matches who you are. Beyond Pricing supports two audiences: partners integrating many Beyond users on a secure backend, and personal users automating their own account.

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

Choose Your Path

For Partners

Use this path if you are a company or large customer integrating many Beyond users on a backend you control — white-label products, multi-tenant 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
• The For Partners page covers the full end-to-end flow, from token setup to listing activation

For Personal Users

Use this path if you are an existing Beyond user automating tasks on your own listings with a CLI, script, or agent.

• App mode: personal
• Authentication: a personal access token (PAT) created from the Beyond dashboard
• Bound to one Beyond login; no client secret to manage
• The For Personal Users page covers the full end-to-end flow, from PAT creation to automation

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/
Swagger UI	/api/v1/docs/
ReDoc	/api/v1/redoc/