Leverage the powerful OneLink API to generate smart links on-the-fly, capture deep analytics, and master programmatic redirection.
Access full endpoint specifications, parameters, and code payloads.
The OneLink API is a powerful set of tools that allows developers to interact with our redirection engine programmatically. Instead of creating links one by one in the dashboard, you can build systems that generate thousands of links automatically.
Generate links on-the-fly when a new user signs up or a new product is added.
Pull click data directly into your internal BI tools or custom marketing dashboards.
A/B test different fallback URLs and deep link paths at scale.
Monitoring your growth doesn't have to be manual. Use the `GET /links/:slug/stats` endpoint to retrieve real-time data for any of your smart links.
To start using the API, you need two pieces of information: an **API Key** and an **API Secret**. You can find these in your dashboard under **Settings > Developer**.
Your **API Secret** is only shown once. We store only its cryptographic hash. If you lose it, you will need to generate a new key pair. Never share your secret in frontend code or public repositories.
A deep link is a special URL that points to a specific piece of content inside a mobile app, rather than just opening the app's home screen. In OneLink, this is configured using the `deepLinkPath` field.
Standard URL: Like a building's street address (Opens the front door / Home Screen).
Deep Link Path: Like a specific room number (Opens a specific profile or product).
The Protocol
protocol://path?params
OneLink detects the user's device (iOS, Android, etc.) automatically.
It attempts to 'fire' the custom deepLinkPath (URI Scheme) you provided.
If installed, the OS catches the scheme and opens the specific in-app page.
| Application | Example Path | Native Result |
|---|---|---|
instagram://user?username=onelink | Opens specific Profile | |
| Spotify | spotify:album:12345 | Opens specific Album |
| Twitter (X) | twitter://user?screen_name=nasa | Opens specific Profile |
| YouTube | vnd.youtube://watch?v=VIDEO_ID | Opens specific Video |
whatsapp://send?phone=91... | Opens specific Chat |
Search for "[App Name] URI Scheme documentation". Most major apps publish their schemes for external developers.
Many apps use predictable patterns. If the web URL is spotify.com/playlist/X, the deep link is likely spotify:playlist:X.
Check community-maintained lists like Handle.it or URL-Schemes repositories on GitHub.
Before adding it to OneLink, test it directly: Copy the path (e.g., instagram://user?username=nasa) and paste it into your mobile browser's address bar. If the app opens to the right page, the path is correct!
The core of OneLink is the Smart Link. Using the `POST /links` endpoint, you can create links with custom slugs, brand metadata, and platform-specific fallback behavior.
Ready to write code? Access our full technical documentation, including endpoints, parameters, and payloads.
View Technical DocsOur engineers are available for technical integration assistance.
Talk to an EngineerOneLink supports high-concurrency environments with custom rate limits and dedicated infrastructure for enterprise customers.