URL Shorteners — entry 002 of 14

Bitly

Verified Jul 2026

Bitly is one of the oldest and most widely used link-management platforms, shortening URLs to bit.ly links and tracking clicks, geography, referrers, and campaigns. Its v4 REST API authenticates with an OAuth 2.0 access token and covers link creation, custom back-halves, QR codes, and analytics, returning JSON. A limited free tier exists, with paid Core and Enterprise plans unlocking higher volumes, branded domains, and deeper metrics.

url-shortenerlink-managementanalyticsoauthqr-codes

Visit dev.bitly.com ↗More URL Shorteners

AuthenticationOAuthRequires an OAuth flow; expect app registration.

HTTPSSupportedTraffic is encrypted in transit.

CORSEnabledCallable directly from browser JavaScript.

PricingFreemiumA usable free tier exists, with paid plans for more volume.

FormatsJSONResponses can be requested as JSON.

GreatAPIs Score

Score74out of 100

Authentication8/25OAuth flow required

Pricing17/20Freemium tier available

Docs20/20Machine-readable spec file bundled

Formats9/15Single response format

Freshness20/20Verified within 6 months

Embed this badge

<a href="https://greatapis.com/api/bitly/"><img src="https://greatapis.com/badge/bitly.svg" alt="Scored 74 on greatapis.com"></a>

Auth quickstart

Register an app / run the OAuth flow to obtain a bearer token.
Send it as an Authorization headerAuthorization: Bearer <token>

Stored keyNo key stored

Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.

Endpoints

Servers

https://api-ssl.bitly.com/v4

Auth

bearerAuth

Groups28

Groups are subdivisions within organizations. Every user will be in at least one group, and every shortened link will be in one group. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

GET/groupsRetrieve Groups

Responses

Status	Description	Schema
`200`	SUCCESS	`Groups`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}Retrieve a Group

Responses

Status	Description	Schema
`200`	SUCCESS	`Group`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/groups/{group_guid}Update a Group

Request body

application/json — GroupUpdate (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`Group`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/citiesGet Click Metrics for a Group by City

Responses

Status	Description	Schema
`200`	SUCCESS	`CityMetrics`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/clicksGet clicks by group

Responses

Status	Description	Schema
`200`	SUCCESS	`GroupClicks`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/codes/scans/citiesGet Scan Metrics for a Group by City

Responses

Status	Description	Schema
`200`	SUCCESS	`CityMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/codes/scans/countriesGet Scan Metrics for a Group by Country

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/codes/scans/over_timeGet Scan Metrics for a Group Over Time

Responses

Status	Description	Schema
`200`	SUCCESS	`GroupClicks`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/codes/scans/topGet Top Performing QR Codes for a Group

Parameters

Name	In	Required	Type
`decoupled`	query	no	boolean

Responses

Status	Description	Schema
`200`	SUCCESS	—
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/countriesGet Click Metrics for a Group by Country

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/devicesGet Click Metrics for a Group by Device Type

Responses

Status	Description	Schema
`200`	SUCCESS	`DeviceMetrics`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/engagements/over_timeGet Group Metrics Over Time

Responses

Status	Description	Schema
`200`	SUCCESS	`GroupClicks`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/engagements/topGet Group Top Performing Links by Engagement

Responses

Status	Description	Schema
`200`	SUCCESS	`SortedLinks`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

POST/groups/{group_guid}/exportsCreate an inline CSV export for a group

Request body

application/json — GroupExportRequestBody (required)

Responses

Status	Description	Schema
`200`	OK	`GroupExportResponse`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/feature_usageGet limit usage for a group

Responses

Status	Description	Schema
`200`	SUCCESS	`GroupFeatureUsage`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`

GET/groups/{group_guid}/historical_usageGet historical usage for a group

Responses

Status	Description	Schema
`200`	SUCCESS	`GroupHistoricalUsage`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`

GET/groups/{group_guid}/links/clicks/citiesGet Group Link Clicks by City

Responses

Status	Description	Schema
`200`	SUCCESS	`CityMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/links/clicks/countriesGet Group Link Clicks by Country

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/links/clicks/devicesGet Group Link Clicks by Device

Responses

Status	Description	Schema
`200`	SUCCESS	—
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/links/clicks/over_timeGet Group Link Clicks Over Time

Responses

Status	Description	Schema
`200`	SUCCESS	`GroupClicks`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/links/clicks/referrersGet Group Link Clicks by Referrer

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/links/clicks/topGet Group Top Performing Links by Click

Responses

Status	Description	Schema
`200`	SUCCESS	`SortedLinks`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/preferencesRetrieve Group Preferences

Responses

Status	Description	Schema
`200`	SUCCESS	`GroupPreferences`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/groups/{group_guid}/preferencesUpdate Group Preferences

Request body

application/json — GroupPreferences (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`GroupPreferences`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/referrersGet Click Metrics for a Group by Referrer

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/referring_networksGet Click Metrics for a Group by Referring Networks

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/shorten_countsRetrieve Group Shorten Counts

Responses

Status	Description	Schema
`200`	SUCCESS	`Metrics`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/tagsRetrieve Tags by Group

Responses

Status	Description	Schema
`200`	SUCCESS	`Tags`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

Organizations5

Organizations are equivalent to a Bitly account. Every plan limit, group, and user is tied to an organization.

GET/organizationsRetrieve Organizations

Parameters

Name	In	Required	Type
`include_all`	query	no	boolean

Responses

Status	Description	Schema
`200`	SUCCESS	`Organizations`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/organizations/{organization_guid}Retrieve an Organization

Responses

Status	Description	Schema
`200`	SUCCESS	`Organization`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/organizations/{organization_guid}/plan_limitsGet Plan Limits

Responses

Status	Description	Schema
`200`	SUCCESS	`PlanLimits`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/organizations/{organization_guid}/shorten_countsGet Shorten Counts for an Organization

Responses

Status	Description	Schema
`200`	SUCCESS	`Metrics`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/organizations/{organization_guid}/shorten_counts_by_groupGet Shorten Counts for an Organization by Group

Responses

Status	Description	Schema
`200`	SUCCESS	`Metrics`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

User3

Some subscription plans allow multiple users. Only one user is used for authenticating a call, and these operations apply only to the authenticated user.

GET/userRetrieve a User

Responses

Status	Description	Schema
`200`	SUCCESS	`User`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/userUpdate a User

Request body

application/json — UserUpdate (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`User`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/user/platform_limitsGet Platform Limits

Responses

Status	Description	Schema
`200`	SUCCESS	`PlatformLimits`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

BSDs1

Branded short domains (BSDs) are the custom domains used to brand your links. A BSD can be added to a Bitly organization and may be assigned to one or more groups. They can contain up to 32 characters.

GET/bsdsGet BSDs

Responses

Status	Description	Schema
`200`	SUCCESS	`BSDsResponse`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

Bitlinks21

Bitlinks are shortened links. They could begin with the bit.ly domain or your own custom branded short domain (BSD). **Related Operations:** - [POST /bitlinks](#createFullBitlink) - Create a new bitlink or add a custom keyword to an existing bitlink - [PATCH /bitlinks/{bitlink}](#updateBitlink) - Redirect an existing bitlink

POST/bitlinksCreate a Bitlink

Request body

application/json — FullShorten (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`BitlinkBody`
`201`	CREATED	`BitlinkBody`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`417`	EXPECTATION_FAILED	`ExpectationFailed`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}Retrieve a Bitlink

Responses

Status	Description	Schema
`200`	SUCCESS	`BitlinkBody`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/bitlinks/{bitlink}Update a Bitlink

Request body

application/json — BitlinkUpdateBody (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`BitlinkBody`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`409`	CONFLICT	`Conflict`
`410`	GONE	`Gone`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

DELETE/bitlinks/{bitlink}Delete a Bitlink

Responses

Status	Description	Schema
`200`	SUCCESS	`LinkDeletionResponse`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/citiesGet Metrics for a Bitlink by City

Responses

Status	Description	Schema
`200`	SUCCESS	`CityMetrics`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/clicksGet Clicks for a Bitlink

Responses

Status	Description	Schema
`200`	SUCCESS	`Clicks`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/clicks/summaryGet a Clicks Summary for a Bitlink

Responses

Status	Description	Schema
`200`	SUCCESS	`ClicksSummary`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/countriesGet Metrics for a Bitlink by Country

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/devicesGet Metrics for a Bitlink by Device Type

Responses

Status	Description	Schema
`200`	SUCCESS	`DeviceMetrics`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/engagementsGet Engagement Counts for a Bitlink

Responses

Status	Description	Schema
`200`	SUCCESS	`TotalEngagements`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/engagements/summaryGet an Engagement Count Summary for a Bitlink

Responses

Status	Description	Schema
`200`	SUCCESS	`TotalEngagementsSummary`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/referrer_nameGet Metrics for a Bitlink by Referrer Name

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/referrersGet Metrics for a Bitlink by Referrers

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/referrers_by_domainsGet Metrics for a Bitlink by Referrers by Domain

Responses

Status	Description	Schema
`200`	SUCCESS	`ReferrersByDomains`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/bitlinks/{bitlink}/referring_domainsGet Metrics for a Bitlink by Referring Domains

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

POST/expandExpand a Bitlink

Request body

application/json — ExpandBitlink (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`ExpandedBitlink`
`400`	BAD_REQUEST	`BadRequest`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/bitlinksRetrieve Bitlinks by Group

Responses

Status	Description	Schema
`200`	SUCCESS	`Bitlinks`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/groups/{group_guid}/bitlinksBulk update bitlinks

Request body

application/json — BulkUpdateRequest (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`BulkUpdate`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/bitlinks/{sort}Retrieve Sorted Bitlinks for Group

Responses

Status	Description	Schema
`200`	SUCCESS	`SortedLinks`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/groups/{group_guid}/engagements/sorted/topRetrieve Top Links and Decoupled QR Codes by Engagements

Responses

Status	Description	Schema
`200`	SUCCESS	`TopLinksAndQRCodes`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

POST/shortenShorten a Link

Request body

application/json — Shorten (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`ShortenBitlinkBody`
`201`	CREATED	`ShortenBitlinkBody`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`417`	EXPECTATION_FAILED	`ExpectationFailed`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

Custom Bitlinks5

These endpoints are for updating custom Bitlinks only. Custom Bitlinks have both a BSD and a customized back-half (e.g., yourcompany.com/yourcampaign). If a link begins with the bit.ly domain or ends with an auto-generated random string it is not a custom Bitlink.

POST/custom_bitlinksAdd Custom Bitlink

Request body

application/json — AddCustomBitlink (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`CustomBitlink`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`409`	Conflict	`Error`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/custom_bitlinks/{custom_bitlink}Retrieve Custom Bitlink

Responses

Status	Description	Schema
`200`	SUCCESS	`CustomBitlink`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/custom_bitlinks/{custom_bitlink}Update Custom Bitlink

Request body

application/json — UpdateCustomBitlink (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`CustomBitlink`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/custom_bitlinks/{custom_bitlink}/clicksGet Clicks for a Custom Bitlink's Entire History

Responses

Status	Description	Schema
`200`	SUCCESS	`Clicks`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/custom_bitlinks/{custom_bitlink}/clicks_by_destinationGet Metrics for a Custom Bitlink by Destination

Responses

Status	Description	Schema
`200`	SUCCESS	`ClickMetrics`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

Campaigns8

Bitly Campaigns are used to build and organize links and metrics for marketing campaigns.

GET/campaignsRetrieve Campaigns

Responses

Status	Description	Schema
`200`	SUCCESS	`Campaigns`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`502`	BAD_GATEWAY	`BadGateway`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

POST/campaignsCreate Campaign

Request body

application/json — CampaignModify (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`Campaign`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/campaigns/{campaign_guid}Retrieve a Campaign

Responses

Status	Description	Schema
`200`	SUCCESS	`Campaign`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/campaigns/{campaign_guid}Update Campaign

Request body

application/json — CampaignModify (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`Campaign`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/channelsRetrieve Channels

Responses

Status	Description	Schema
`200`	SUCCESS	`Channels`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

POST/channelsCreate Channel

Request body

application/json — ChannelModify (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`Channel`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/channels/{channel_guid}Get a Channel

Responses

Status	Description	Schema
`200`	SUCCESS	`Channel`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/channels/{channel_guid}Update a Channel

Request body

application/json — ChannelModify (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`Channel`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

Webhooks6

Webhooks are a method of sending information from Bitly to an application outside of Bitly. It's a way to automate actions or updates between two different systems. These endpoints are for configuring your webhooks.

GET/organizations/{organization_guid}/webhooksGet Webhooks

Responses

Status	Description	Schema
`200`	SUCCESS	`Webhooks`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

POST/webhooksCreate Webhook

Request body

application/json — WebhookCreate (required)

Responses

Status	Description	Schema
`201`	CREATED	`Webhook`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/webhooks/{webhook_guid}Retrieve Webhook

Responses

Status	Description	Schema
`200`	SUCCESS	`Webhook`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PATCH/webhooks/{webhook_guid}Update Webhook

Request body

application/json — WebhookUpdate (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`Webhook`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

DELETE/webhooks/{webhook_guid}Delete Webhook

Responses

Status	Description	Schema
`204`	SUCCESS	—
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

POST/webhooks/{webhook_guid}/verifyVerify Webhook

Responses

Status	Description	Schema
`200`	SUCCESS	`Webhook`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

QR Codes16

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 data.

GET/groups/{group_guid}/qr-codesRetrieve QR Codes by Group

Responses

Status	Description	Schema
`200`	SUCCESS	`QRCodesMinimal`
`403`	FORBIDDEN	`Forbidden`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`

PATCH/groups/{group_guid}/qr-codesBulk update QR codes

Request body

application/json — QRCBulkUpdateRequest (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`QRCBulkUpdate`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

POST/qr-codesCreate a QR Code

Request body

application/json — PublicCreateQRCodeRequest (required)

Responses

Status	Description	Schema
`201`	CREATED	`QRCodeMinimal`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`

POST/qr-codes/staticGenerate a static QR Code image

Parameters

Name	In	Required	Type
`Accept`	header	no	string
`format`	query	no	string

Request body

application/json — PublicCreateStaticQRCodeRequest (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`PublicStaticQRCodeResponse`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`406`	NOT_ACCEPTABLE	`BadRequest`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`

GET/qr-codes/{qrcode_id}Retrieve a QR Code

Responses

Status	Description	Schema
`200`	SUCCESS	`QRCodeDetails`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`

PATCH/qr-codes/{qrcode_id}Update a QR Code

Parameters

Name	In	Required	Type
`qrcode_id`	path	yes	string

Request body

application/json — PublicUpdateQRCodeRequest

Responses

Status	Description	Schema
`200`	SUCCESS	`QRCodeMinimal`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`

DELETE/qr-codes/{qrcode_id}Delete a QR Code

Responses

Status	Description	Schema
`200`	SUCCESS	`PublicDeleteQRCodeResponse`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`

GET/qr-codes/{qrcode_id}/imageRetrieve a QR Code image

Parameters

Name	In	Required	Type
`Accept`	header	no	string
`format`	query	no	string

Responses

Status	Description	Schema
`200`	SUCCESS	`PublicQRCodeImageResponse`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`

PATCH/qr-codes/{qrcode_id}/redirectRedirect a QR Code

Parameters

Name	In	Required	Type
`qrcode_id`	path	yes	string

Request body

application/json — RedirectQRCodeRequest (required)

Responses

Status	Description	Schema
`200`	SUCCESS	`QRCodeMinimal`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`422`	UNPROCESSABLE_ENTITY	`UnprocessableEntity`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`

GET/qr-codes/{qrcode_id}/scansGet Scans for a QR Code

Responses

Status	Description	Schema
`200`	SUCCESS	`BitlinkScans`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/qr-codes/{qrcode_id}/scans/browsersGet Scans for a QR Code by Browser

Responses

Status	Description	Schema
`200`	SUCCESS	`ScanMetrics`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/qr-codes/{qrcode_id}/scans/citiesGet Metrics for a QR Code by City

Responses

Status	Description	Schema
`200`	SUCCESS	`CityScanMetrics`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/qr-codes/{qrcode_id}/scans/countriesGet Scans for a QR Code by Country

Responses

Status	Description	Schema
`200`	SUCCESS	`ScanMetrics`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/qr-codes/{qrcode_id}/scans/device_osGet Scans for a QR Code by Device OS

Responses

Status	Description	Schema
`200`	SUCCESS	`ScanMetrics`
`400`	BAD_REQUEST	`BadRequest`
`402`	UPGRADE_REQUIRED	`UpgradeRequired`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

GET/qr-codes/{qrcode_id}/scans/summaryGet Scans Summary for a QR Code

Responses

Status	Description	Schema
`200`	SUCCESS	`BitlinkScansSummary`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`410`	GONE	`Gone`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

PUT/qr-codes/{qrcode_id}/to-bitlinkUpgrade a QR Code to a bitlink

Parameters

Name	In	Required	Type
`qrcode_id`	path	yes	string

Responses

Status	Description	Schema
`200`	SUCCESS	`BitlinkBody`
`400`	BAD_REQUEST	`BadRequest`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`429`	MONTHLY_LIMIT_EXCEEDED	`MonthlyLimitExceeded`
`500`	INTERNAL_ERROR	`InternalError`

apps1

GET/apps/{client_id}Retrieve OAuth App

Responses

Status	Description	Schema
`200`	SUCCESS	`OAuthApp`
`403`	FORBIDDEN	`Forbidden`
`404`	NOT_FOUND	`NotFound`
`500`	INTERNAL_ERROR	`InternalError`
`503`	TEMPORARILY_UNAVAILABLE	`TemporarilyUnavailable`

Try it

Operation

API key

Developer reference

Base URLhttps://api-ssl.bitly.com/v4

Rate limit

Per-hour and per-minute caps reset independently, with the minute cap set to one-tenth of the hourly figure; standard plans default to 1,000 requests/hour (100/min) per endpoint, Enterprise plans 10,000/hour, plus separate monthly transaction limits by plan and a 5-concurrent-connection cap per IP. Exceeding a cap returns HTTP 429 with a RATE_LIMIT_EXCEEDED or MONTHLY_LIMIT_EXCEEDED error.

Key endpoints

POST/shorten
POST/expand
GET/bitlinks/{bitlink}/clicks/summary

GreatAPIs Score

Embed this badge

Auth quickstart

Endpoints

Try it

Developer reference

People comparing Bitly also look at…

Bitly vs 1pt

Bitly vs CleanURI

Bitly vs Kutt

Bitly vs Mgnet.me

Bitly vs Shrtlnk

Bitly vs Rebrandly

RedirHub

TinyURL

UrlBae

Cutt.ly