---
title: Partner
description: Short integration guides for the Blinqx public API.
---

These guides explain authentication, authorization, pagination, and request handling for partners. The OpenAPI contract remains the source of truth for paths, payloads, and responses.

## Surfaces

- **Published OpenAPI JSON** (this site): [/openapi.json](/openapi.json) — the current public paths, payloads, scopes, and responses. Live app equivalent: `GET /api/v1/openapi.json`.
- **Developer docs** (same site): [architecture & OpenAPI map](/developers/public-api) — includes Mermaid diagrams of the contract layers.
- **Codebase wiki source** (repo): [`openwiki/integrations/public-api-and-docs.md`](https://github.com/blinqx-hq/basenet-rebuild-poc/blob/main/openwiki/integrations/public-api-and-docs.md)

Engineers running the staff app locally can also open Scalar at `http://localhost:3000/reference`; this is a development preview, not the partner entry point.

Partner Pages base: https://supreme-adventure-r2rn151.pages.github.io/ · partner home: [/partner](/partner)

## Guides

1. [Getting started with a scoped token](/partner/getting-started-scoped-token)
2. [Scopes and permission filtering](/partner/scopes-and-permission-filtering)
3. [Pagination, filtering, and sorting](/partner/pagination-filtering-sorting)
4. [Idempotency keys](/partner/idempotency-keys)
5. [Rate limits and Retry-After](/partner/rate-limits-and-retry-after)
6. [Webhook subscriptions](/partner/webhooks)
7. [OData](/partner/odata)