Shlink Integrations API
Handle services with which shlink is integrated
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/shlink:shlink-integrations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Shlink Integrations API
version: '3.0'
description: 'Operations tagged Integrations across 3 of this provider''s published API definitions: shlink-openapi-v5.1.4.json, shlink-openapi-v5.1.0.json, shlink-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{scheme}://{host}'
variables:
scheme:
enum:
- https
- http
default: https
host:
default: ''
tags:
- name: Integrations
description: Handle services with which shlink is integrated
paths:
/rest/v{version}/mercure-info:
get:
tags:
- Integrations
summary: Get mercure integration info
description: Returns information to consume updates published by Shlink on a mercure hub. https://mercure.rocks/
operationId: mercureInfo
parameters:
- name: version
in: path
description: The API version to be consumed
required: true
schema:
enum:
- '3'
- '2'
- '1'
type: string
responses:
'200':
description: The mercure integration info
content:
application/json:
schema:
required:
- mercureHubUrl
- jwt
- jwtExpiration
type: object
properties:
mercureHubUrl:
type: string
description: The public URL of the mercure hub that can be used to get real-time updates published by Shlink
jwt:
type: string
description: A JWT with subscribe permissions which is valid with the mercure hub
jwtExpiration:
type: string
description: The date (in ISO-8601 format) in which the JWT will expire
example:
mercureHubUrl: https://example.com/.well-known/mercure
jwt: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJTaGxpbmsiLCJpYXQiOjE1ODY2ODY3MzIsImV4cCI6MTU4Njk0NTkzMiwibWVyY3VyZSI6eyJzdWJzY3JpYmUiOltdfX0.P-519lgU7dFz0bbNlRG1CXyqugGbaHon4kw6fu4QBdQ
jwtExpiration: '2020-04-15T12:18:52+02:00'
'501':
description: This Shlink instance is not integrated with a mercure hub
content:
application/problem+json:
schema:
required:
- type
- title
- detail
- status
type: object
properties:
type:
type: string
description: A machine unique code
title:
type: string
description: A unique title
detail:
type: string
description: A human-friendly error description
status:
type: number
description: HTTP response status code
examples:
API v3 and newer:
value:
title: Mercure integration not configured
type: https://shlink.io/api/error/mercure-not-configured
detail: This Shlink instance is not integrated with a mercure hub.
status: 501
Previous to API v3:
value:
title: Mercure integration not configured
type: MERCURE_NOT_CONFIGURED
detail: This Shlink instance is not integrated with a mercure hub.
status: 501
default:
description: Unexpected error.
content:
application/problem+json:
schema:
required:
- type
- title
- detail
- status
type: object
properties:
type:
type: string
description: A machine unique code
title:
type: string
description: A unique title
detail:
type: string
description: A human-friendly error description
status:
type: number
description: HTTP response status code
security:
- ApiKey: []
servers:
- url: '{scheme}://{host}'
variables:
scheme:
enum:
- https
- http
default: https
host:
default: ''
components:
securitySchemes:
ApiKey:
type: apiKey
description: A valid shlink API key
name: X-Api-Key
in: header
externalDocs:
description: Find more info on how to start using this API here
url: https://shlink.io/documentation/api-docs
x-refined-from:
- shlink-openapi-v5.1.4.json
- shlink-openapi-v5.1.0.json
- shlink-openapi.json