API Overview
Introduction
The LinkSense REST API gives you programmatic access to all resources in your account — projects, dynamic links, iOS apps, and Android apps. Every action available in the dashboard can also be performed through the API, making it straightforward to integrate LinkSense into your CI/CD pipelines, internal tooling, or backend services.
Requests are authenticated using API keys scoped to your account. All responses are JSON, with the single exception of the QR-code endpoint, which returns an image.
API access itself is available on every plan — generate a key and start making requests. Individual capabilities are plan-gated and answer 403 FORBIDDEN_PLAN: short links and deferred deep linking require Pro. Your plan’s project and link quotas apply to API writes exactly as they do in the dashboard.
Base URL
All API requests are made to the following base URL. Append the endpoint path to this URL for each request.
Authentication
Authenticate every request by including your API key as a Bearer token in the Authorization header. API keys begin with ls_live_.
Authorization: Bearer ls_live_your_api_key_hereGenerate and manage your API keys from Dashboard › Settings › API Keys. Treat your keys like passwords — never commit them to source control or expose them in client-side code.
Rate Limits
The API enforces a limit of 60 requests per minute per API key. If you exceed this limit, the API returns a 429 Too Many Requests response. Each response includes the following headers so you can track your usage:
| Field | Type | Required | Description |
|---|---|---|---|
X-RateLimit-Limit | number | No | Maximum number of requests allowed per window. |
X-RateLimit-Remaining | number | No | Number of requests remaining in the current window. |
X-RateLimit-Reset | number | No | Timestamp in milliseconds since the Unix epoch at which the current window resets. |
Retry-After | number | No | Seconds to wait before retrying. Sent only on 429 responses. |
Response Format
All successful responses wrap the result in a data envelope. Error responses use an error envelope with a machine-readable code and a human-readable message.
{ "data": { "id": "abc123", "name": "My Project", "subdomain": "my-project", "created_at": "2024-01-01T00:00:00Z" }}{ "error": { "code": "NOT_FOUND", "message": "The requested resource does not exist." }}Failures that have more to say carry a details field: validation errors list the offending fields, and plan gates report which plan is required.
{ "error": { "code": "INVALID_INPUT", "message": "Validation failed", "details": [ { "code": "too_big", "path": ["social_title"], "message": "Social title must be 200 characters or less" } ] }}Error Codes
The API uses consistent error codes across all endpoints. Use the code field in error responses to handle specific failure cases in your integration.
| Field | Type | Required | Description |
|---|---|---|---|
INVALID_INPUT | 400 | No | Request body or query parameter validation failed. |
FORBIDDEN_FIELD | 400 | No | The request included a field that is not allowed. |
UNAUTHORIZED | 401 | No | API key is missing, invalid, or has been revoked. |
AUTH_REQUIRED | 401 | No | Authentication is required for this request. |
ACCESS_DENIED | 403 | No | The resource belongs to another account, or access was otherwise denied. |
FORBIDDEN_PLAN |
The Type column above shows the HTTP status code returned for each error. Always check the HTTP status first, then use the code field for precise error handling.
Quick Example
Here is a minimal example that lists your projects using cURL. Replace the API key with your own from the dashboard.
curl -H "Authorization: Bearer ls_live_abc123..." \ https://linksense.net/api/v1/projectsReady to explore all available endpoints? Continue to the API Endpoints reference.