API Reference
Complete OpenAPI specification for the Links Platform.
Links API Reference
Welcome to the Links API documentation. This reference provides comprehensive details on every endpoint, parameter, and response schema available in the Links Platform.
It is designed for developers who prefer working directly with HTTP requests or need to inspect the raw JSON payloads underlying our SDKs.
Core Concepts
Before making requests, familiarize yourself with these fundamentals.
Authentication
The API uses Bearer Token authentication. Learn how to retrieve your key.
Errors
Standard HTTP status codes and error response formats used across the platform.
Base URLs
Production and Sandbox environment endpoints.
Base URLs
All API requests should be prefixed with one of the following base URLs:
| URL | Description |
|---|---|
https://dev-backend.thelinks.ai/api/v1 | Main backend server. |
API Capabilities
The API exposes a set of RESTful endpoints built around a unified data model, enabling consistent access and management of your financial data across multiple platforms.
Unified Models
Interact with standardized financial data regardless of the underlying source system.
- Unified Customers: Create and retrieve normalized customer profiles.
- Unified Contacts: Manage individual contacts linked to customers.
- Unified Products: Access catalog items and pricing structures.
- Unified Contracts: Track active agreements and terms.
- Unified Invoices: Manage billing cycles, due dates, and amounts.
- Unified Payments: Record and reconcile transactions.
- Unified Opportunities: Handle sales pipeline data.
Ecosystem Integrations
- External Connections: Metadata for third-party integrations (MCP ecosystem).
Open API Specification
This documentation is generated from our OpenAPI 3.0 specification.