Links › Get a link’s QR code style

Links

Get a link’s QR code style

GET/api/{ORG}/links/{link}/qrPermalink

Answers the QrCode.

Permission
Links · view
Plan
Plans that include the API: Pricing
Retry
Safe: a read changes nothing

Example request

bash
curl "https://console.brevily.com/api/NORTHWIND/links/01JC6Y8QH2M4ZK7T9VRW3XNB5D/qr" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

json
{  "styled": false,  "fg": "example",  "bg": "example",  "shape": "example",  "margin": 1,  "logo": false,  "logoSize": "SMALL",  "logoAvailable": false}

Made-up values.

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters
linkstringrequired—

QrCode

Answer fields
NameTypeDescriptionAllowed values
styledbooleanA style is saved; false for the plain code.—
fgstringThe code’s colour, #rrggbb.—
bgstringThe ground’s colour, #rrggbb; null when transparent.or null
shapestringThe module shape.—
marginintegerThe quiet zone, in modules.—
logobooleanThe organisation’s logo sits in the middle.—
logoSizestringHow big the logo is drawn when logo is true: LARGE (the default) is as big as still scans reliably at the code’s size; MEDIUM and SMALL are smaller shares of it.SMALL, MEDIUM, LARGE
logoAvailablebooleanThe organisation has a logo uploaded (Settings › General › Logo in QR codes). logo may be true without one: the code is then drawn whole until one is uploaded.—
Errors
Status Code When
400 VALIDATION_FAILED A field, a parameter or the body is wrong; details.fields says which.
401 UNAUTHENTICATED No key, a key that does not match, or one expired or revoked.
403 ACCESS_DENIED The key lacks Links · view, or the organisation’s plan does not include it.
404 NOT_FOUND No organisation with that code for this key, or no such record in it.
429 RATE_LIMITED Too many calls: wait Retry-After seconds.

Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.