Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ziplink.click/llms.txt

Use this file to discover all available pages before exploring further.

The Ziplink API provides developers with a robust and scalable interface for creating and managing all resources that you may find in on the UI. Whether you’re integrating Ziplink into your existing systems, automating workflows, or building custom applications, our API is designed to offer flexibility, efficiency, and powerful analytics. Usin the API, you can creat and manage short links, generate and customize QR codes, retrieve analytics data, and much more.

​
Getting Started

To get started with the Ziplink API, you’ll need to obtain an API key. You can do this by signing up for a free account on our website. After signing up, you need to call the auth token endpoint with your email and password to obtain an access token and refresh token. This process will change in the future when dedicated API keys are introduced. With the access token, you can make authenticated requests to the API endpoints. For example, to create a new short link, you can send a POST request to the /links endpoint with the following JSON payload:
Create a new short link
{
  "url": "https://example.com",
  "title": "Example Link"
}
The API will respond with a JSON object containing the details of the newly created short link. For more information on the response format, refer to the create new link endpoint’s documentation .

​
Examples

You will find detailed example request parameters (arguments) and sample responses for each API endpoint, helping you understand how to interact with the API and what to expect from the output. If any of the examples are unclear, ask round the community.