How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitly QR Codes API

Create dynamic and static QR Codes, customize their render, fetch the image, upgrade a code to a Bitlink, and read scan metrics by browser, city, country and device OS. 16 operation(s), extracted verbatim from the OpenAPI Bitly publishes at https://dev.bitly.com/v4/v4.json.

Bitly QR Codes API is one of 11 APIs that Bitly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include QR Codes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 16 operations across 13 paths, and defines 64 schemas. It is described by OpenAPI 3.0.0, at version 4.0.0.

Requests are made against a single base URL, https://api-ssl.bitly.com/v4.

16 operations 13 paths 64 schemas 1 DELETE9 GET3 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.0
Base URL
https://api-ssl.bitly.com/v4
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Bitly QR Codes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 16

Across 13 paths, the API surfaces 16 operations — 1 DELETE, 9 GET, 3 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

QR Codes 16

QR codes can be created and customized with different dot patterns, corner shapes, colors, and more. They can contain bitlinks, links to microsites, or several kinds of static dat…

POST
/qr-codes
Create a QR Code
createQRCodePublic body → 201400402403404429410500
POST
/qr-codes/static
Generate a static QR Code image
createStaticQRCodePublic 2 params body → 200400403406422429500
GET
/qr-codes/{qrcode_id}/image
Retrieve a QR Code image
getQRCodeImagePublic 3 params → 200400403404410500
PATCH
/qr-codes/{qrcode_id}
Update a QR Code
updateQRCodePublic 1 param body → 200400403404410500
GET
/qr-codes/{qrcode_id}
Retrieve a QR Code
getQRCodeByIdPublic 1 param → 200400403404410500
DELETE
/qr-codes/{qrcode_id}
Delete a QR Code
deleteQRCode 1 param → 200400403404410429500
GET
/groups/{group_guid}/qr-codes
Retrieve QR Codes by Group
listQRMinimal 16 params → 200403429500
PATCH
/groups/{group_guid}/qr-codes
Bulk update QR codes
updateQRCodesByGroup 1 param body → 200400403404410422429500
GET
/qr-codes/{qrcode_id}/scans
Get Scans for a QR Code
getScanMetricsForQRCode 4 params → 200400403404410500503
GET
/qr-codes/{qrcode_id}/scans/summary
Get Scans Summary for a QR Code
getScanMetricsSummaryForQRCode 4 params → 200400403404410500503
GET
/qr-codes/{qrcode_id}/scans/countries
Get Scans for a QR Code by Country
getScanMetricsForQRCodeByCountries 5 params → 200400403404410500503
GET
/qr-codes/{qrcode_id}/scans/cities
Get Metrics for a QR Code by City
getScanMetricsForQRCodeByCities 5 params → 200400402403404410500503
GET
/qr-codes/{qrcode_id}/scans/device_os
Get Scans for a QR Code by Device OS
getScanMetricsForQRCodeByDevicesOS 5 params → 200400402403404410500503
GET
/qr-codes/{qrcode_id}/scans/browsers
Get Scans for a QR Code by Browser
getScanMetricsForQRCodeByBrowser 5 params → 200400402403404410500503
PUT
/qr-codes/{qrcode_id}/to-bitlink
Upgrade a QR Code to a bitlink
upgradeQRCodeToBitlink 1 param → 200400403404429500
PATCH
/qr-codes/{qrcode_id}/redirect
Redirect a QR Code
redirectQRCodeDestination 1 param body → 200400402403404410422429

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are BitlinkUpdate (17 properties), QRCodeMinimal (16 properties), QRCodeDetails (15 properties), QRCodeCustomizationsPublic (11 properties). Each schema is shown below with its type and property counts.

BadRequest
BADREQUEST
BaseScanMetrics
object
4 properties
BitlinkBody
object
BitlinkScans
object
4 properties
BitlinkScansSummary
object
4 properties
BitlinkUpdate
object
17 properties
CityScanMetric
object
5 properties
CityScanMetrics
object
DeeplinkRule
object
10 properties
DeletedLink
object
1 property
DeletedQRCode
object
1 property
DynamicRoutingDeviceEnum
string
Device type values for use in dynamic routing rules (devicematch / deviceexclude)
DynamicRoutingPlatformEnum
string
Platform (OS) values for use in dynamic routing rules (osmatch / osexclude)
DynamicRoutingRule
object
A dynamic routing rule that redirects traffic to a different destination based on user attributes.
9 properties
Error
object
4 properties
FieldError
object
3 properties
Forbidden
FORBIDDEN
GS1Metadata
object
Contains GS1 related metadata
1 property
GS1Value
object
2 properties
Gone
GONE
GradientColor
object
2 properties
HasReferences
object
1 property
InstallPreference
string
InternalError
INTERNALERROR
MobileOS
string
MonthlyLimitExceeded
MONTHLYLIMITEXCEEDED
NotFound
NOTFOUND
OtherScanMetrics
object
2 properties
PublicCreateQRCodeRequest
object
Customization and content values for a QR code created through the public API
10 properties 2 required
PublicCreateStaticQRCodeRequest
object
Request body for generating a static QR code image. Customizations such as gradient, backgroundgradient, frame, text and logo are not supported.
3 properties 2 required
PublicDeleteQRCodeResponse
object
QR Code delete response
2 properties
PublicQRCodeImageResponse
object
Wraps the image data for a QR code.
1 property
PublicStaticQRCodeResponse
object
Response containing a generated static QR code image.
1 property
PublicUpdateQRCodeRequest
object
Customization and content values for a QR code created through the public API
6 properties
QRCBulkUpdate
object
1 property
QRCBulkUpdateRequest
object
5 properties 1 required
QRCodeBranding
object
1 property
QRCodeCorner
object
Represents one corner, both inner and outer, of a QR code, with color and shape values
3 properties
QRCodeCorners
object
An object representing all three corners of the QR code. The corners corresponding to each property are: corner1 = top left, corner2 = top right, and corner3 =…
3 properties
QRCodeCustomizationsPublic
object
Options for customizing a QR Code's appearance
11 properties
QRCodeCustomizationsStaticPublic
object
Appearance options for a static QR code. gradient, backgroundgradient, frame, text, and logo are not supported.
6 properties
QRCodeDestination
object
3 properties
QRCodeDetails
object
15 properties
QRCodeDotPatternType
string
QRCodeFrameRequest
object
3 properties 1 required
QRCodeFrameType
string
QRCodeGradient
object
4 properties
QRCodeLogoPublic
object
1 property
QRCodeMinimal
object
16 properties
QRCodeSpecSettingsPublic
object
The QR code's editable spec settings, which for now is just the error correction
1 property
QRCodeText
object
Contains the center, top, and bottom text to be used in the QR code
3 properties
QRCodeTypeEnum
string
The type of dynamic/static content the QR serves, e.g. Link In Bio page, micro site, bitlink, email, text, Wifi, etc.
QRCodesMinimal
object
QR code paginated list Response
2 properties
QRPagination
object
This object specifies how to query the next set of results.
3 properties
QRScans
object
2 properties
RedirectQRCodeRequest
object
Request to redirect a QRCode
1 property 1 required
ScanMetric
object
2 properties
ScanMetrics
object
SimplifiedError
object
3 properties
TemporarilyUnavailable
TEMPORARILYUNAVAILABLE
Text
object
An object describing text with color
2 properties 1 required
TimeUnit
string
the unit of time queried for (minute, hour, day, week, month)
UnprocessableEntity
UNPROCESSABLEENTITY
UpgradeRequired
UPGRADEREQUIRED

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitly-qr-codes-api-openapi.yml Raw ↑

Other APIs Bitly publishes across the network.

Bitly BSDs API
Bitly Bitlinks API
Bitly Campaigns API
Bitly Custom Bitlinks API
Bitly Groups API
Bitly OAuth Apps API
Bitly Organizations API
Bitly User API
Bitly Webhooks API
Bitly MCP Server
Where this information came from

This is an independent, third-party profile of Bitly QR Codes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.