Get started
Your first API request
Use a project API key to read your links, then build from a working request.
1. Choose a project key
Create or select an API key in your LinkScale dashboard with access to the project you want to use. For this example, the key needs the links.read permission.
Keep your key on your server or in an environment variable. Do not include it in public frontend code.
2. Read your links
Set LINKSCALE_API_KEY in your environment, then run this read-only request:
Terminal
curl --fail-with-body \
'https://dashboard.linkscale.to/api/v1/links' \
--header "Authorization: Bearer $LINKSCALE_API_KEY"
The API returns a JSON response. Use the list links reference for response fields, filters, and pagination.
3. Handle errors explicitly
Check the HTTP status before reading a response as successful data. Review the endpoint's documented error responses and the permissions assigned to your key.