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.

API access is available on the Pro plan. Requests are authenticated using API keys scoped to your account. All responses are JSON.

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_here

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:

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."
  }
}

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.

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/projects

Ready to explore all available endpoints? Continue to the API Endpoints reference.