API

Links

Make short links and QR codes, change where they send people, route them by rules, and make variants per recipient.

A link is a short URL, https://{short host}/{code}, that sends visitors to its destination: a web address, an email (mailto:) or a phone number (tel:). Its kind is qr for a QR code or link for a plain short link. Both work the same way, but visits to a QR code count as scans and visits to a link as clicks. The code never changes, so a destination can change after the code is printed, and each destination is kept in the link's history.

Routing rules send some visitors elsewhere, by device, operating system, country, language or a time window. The first rule that holds decides; when none does, the destination is served. UTM settings add utm_* parameters to web destinations. An archived link, or one past its expiresAt, answers HTTP 410 instead of sending visitors on.

A per-recipient variant is a link with its own code and visit count that follows its parent's destination, rules and UTM settings. Every member with links.read can read every link. Changing one needs links.manage, or links.edit on a link the member made. A CSV batch makes up to 100 links at once, and a batch of QR codes costs credits.

Errors

Besides the errors any endpoint can answer, these endpoints answer:

StatusCodeWhen
400invalidA value the link cannot take: a bad destination, a label or campaign too long, an expiry not in the future, a design that is not the workspace's, a rule with no condition or one that ends before it starts, or a variant given its own destination, rules or a duplicate label.
400invalid_csvThe CSV is malformed, its header is wrong, or it has no rows or more than 100.
400bad_cursorThe cursor was not given by this list.