API Reference

Grovs REST API for programmatic link generation and management

The Grovs REST API lets you create and manage links from your server-side applications. Use it to generate dynamic links programmatically and retrieve link metadata without the dashboard.

Base URL

https://sdk.sqd.link/api/v1/sdk

Authentication

All requests require two headers for authentication:

PROJECT-KEYstringrequired

Your SDK project key. Found in Dashboard → Developer → API Key.

ENVIRONMENTstringrequired

Target environment. Use production or development.

Endpoints

POST/generate_link

Create a new link with custom metadata, platform-specific redirects, and tracking parameters.

GET/link/:link_path

Retrieve the full details of an existing link using its unique path.

Errors

The API uses standard HTTP status codes. Treat the status code as the source of truth when handling failures:

Status	Meaning
`200`	Success. The response body contains the requested data.
`400`	Bad request. The body is malformed JSON, or a field has the wrong shape — a common cause is passing `data` or `tags` as raw JSON instead of stringified JSON (see Generate a Link).
`401`	Unauthorized. The `PROJECT-KEY` header is missing or doesn't match a project. Copy the key exactly from Dashboard → Developer → API Key, and check the `ENVIRONMENT` header is set to `production` or `development`.
`404`	Not found. Typically a `GET /link/:link_path` request where the path doesn't match an existing link in the given environment.
`5xx`	Server error on the Grovs side. Retry with backoff; if it persists, contact [email protected].

A link created in one environment isn't visible in the other — if a request unexpectedly returns 404, check that the ENVIRONMENT header matches the environment the link was created in.

Quick Start

Generate your first link with a single cURL command:

Bash

curl -X POST https://sdk.sqd.link/api/v1/sdk/generate_link \
  -H "PROJECT-KEY: YOUR_PROJECT_KEY" \
  -H "ENVIRONMENT: production" \
  -H "Content-Type: application/json" \
  -d '{"title": "My First Link", "data": "{\"screen\": \"home\"}"}'

Postman Collection

Import the Grovs Postman Collection to explore and test all endpoints interactively.

Edit this page on GitHubLast updated 2026-07-29