1
Create an API key
In the dashboard, go to Settings → API Keys and create one. Choose the
organization scope so the key can see links your whole team creates.2
Check the key works
Listing links is the cheapest way to confirm the key authenticates:A working key returns a
data object. If you get 401, the key is wrong or revoked; if 403, it is valid but not permitted — check its permissions.3
Create a link
destination_url is the only required field. Leave domain out and your default domain is used; leave back_half out and one is generated.The response carries the link, including the shortlink_url to share and the name you will use to refer to it later.4
Read its analytics
Use the
name from the previous step:A brand-new link has no clicks yet, so expect an empty result. Analytics are near-real-time but not instant.
Creating links programmatically
Where to go next
Custom back halves
Choose the path instead of taking a generated one.
Bulk operations
Create and delete many links in one request.
Branded links
Serve links from your own domain.
Analytics
Read clicks, scans and visitors.