Unlock Protocol Ticket API
The Ticket API from Unlock Protocol — 9 operation(s) for ticket.
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/unlock-protocol-ticket-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: Unlock Locksmith Applications Ticket API
version: '2'
description: Locksmith provides backend functionality for enabling ticketing, metadata storage, and notification hooks.
license:
name: MIT
servers:
- url: https://locksmith.unlock-protocol.com
description: Production Server
- url: https://staging-locksmith.unlock-protocol.com
description: Staging Server
tags:
- name: Ticket
paths:
/v2/api/ticket/{network}/{lockAddress}/{keyId}/sign:
get:
operationId: signTicket
security:
- User:
- keyOwner
description: Generate signature to prove validity of token.
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
200:
description: Returns signature and payload.
content:
application/json:
schema:
type: object
properties:
payload:
type: string
signature:
type: string
403:
$ref: '#/components/responses/403.NotAuthenticatedOrAuthorized'
404:
$ref: '#/components/responses/404.NotFound'
500:
$ref: '#/components/responses/500.InternalError'
tags:
- Ticket
/v2/api/ticket/{network}/lock/{lockAddress}/key/{keyId}/check:
put:
operationId: checkTicket
deprecated: true
security:
- User:
- Verifier
description: Mark a lock ticket as checked in.
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
202:
description: Ticket is checked in.
content:
application/json:
schema:
$ref: '#/components/schemas/GenericSuccess'
403:
$ref: '#/components/responses/403.NotAuthenticatedOrAuthorized'
404:
$ref: '#/components/responses/404.NotFound'
409:
$ref: '#/components/responses/409.Conflict'
500:
$ref: '#/components/responses/500.InternalError'
tags:
- Ticket
/v2/api/ticket/{slug}/{network}/lock/{lockAddress}/key/{keyId}/check:
put:
operationId: checkEventTicket
security:
- User:
- Verifier
description: Mark an event ticket as checked in.
parameters:
- $ref: '#/components/parameters/Slug'
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
202:
description: Ticket is checked in.
content:
application/json:
schema:
$ref: '#/components/schemas/GenericSuccess'
403:
$ref: '#/components/responses/403.NotAuthenticatedOrAuthorized'
404:
$ref: '#/components/responses/404.NotFound'
409:
$ref: '#/components/responses/409.Conflict'
500:
$ref: '#/components/responses/500.InternalError'
tags:
- Ticket
/v2/api/ticket/{slug}/{network}/lock/{lockAddress}/key/{keyId}:
get:
operationId: getEventTicket
security:
- User: []
description: get a ticket for a key by event.
parameters:
- $ref: '#/components/parameters/Slug'
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
200:
description: Successfully retrieved the ticket.
content:
application/json:
schema:
required:
- name
- lockAddress
- keyId
- manager
- publicLockVersion
- userMetadata
- isVerifier
- attributes
- image
- description
- owner
- expiration
type: object
properties:
keyId:
type: string
name:
type: string
owner:
type: string
manager:
type: string
lockAddress:
type: string
image:
type: string
description:
type: string
checkedInAt:
type: number
userMetadata:
type: object
additionalProperties: true
expiration:
type: string
attributes:
type: array
items:
type: object
required:
- value
properties:
trait_type:
type: string
value:
type: string
display_type:
type: string
publicLockVersion:
type: string
isVerifier:
description: Whether the user who requested the ticket can verify the ticket.
type: boolean
401:
$ref: '#/components/responses/401.NotAuthenticated'
tags:
- Ticket
/v2/api/ticket/{network}/{lockAddress}/{keyId}/email:
post:
operationId: emailTicket
security:
- User:
- LockManager
description: Send QR code by email.
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
200:
description: Email sent.
content:
application/json:
schema:
type: object
properties:
sent:
type: boolean
default: true
403:
$ref: '#/components/responses/403.NotAuthenticatedOrAuthorized'
404:
$ref: '#/components/responses/404.NotFound'
500:
$ref: '#/components/responses/500.InternalError'
tags:
- Ticket
/v2/api/ticket/{network}/{lockAddress}/{keyId}/qr:
get:
operationId: ticketQRCode
security:
- User:
- user
- lockManager
description: Get QR code for the key.
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
200:
description: QR code image.
content:
image/gif:
schema: {}
403:
$ref: '#/components/responses/403.NotAuthenticatedOrAuthorized'
404:
$ref: '#/components/responses/404.NotFound'
500:
$ref: '#/components/responses/500.InternalError'
tags:
- Ticket
/v2/api/ticket/{network}/{lockAddress}/{keyId}/verification:
get:
operationId: ticketVerificationUrl
security:
- User:
- user
- lockManager
description: Get the verification URL for the key.
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
200:
description: JSON object containing the verification url
content:
application/json:
schema:
type: object
properties:
verificationUrl:
type: string
403:
$ref: '#/components/responses/403.NotAuthenticatedOrAuthorized'
404:
$ref: '#/components/responses/404.NotFound'
500:
$ref: '#/components/responses/500.InternalError'
tags:
- Ticket
/v2/api/ticket/{network}/lock/{lockAddress}/key/{keyId}/generate:
get:
operationId: generateTicket
security:
- User: []
description: Generate a ticket for a key.
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
200:
description: Successfully generated the ticket.
401:
$ref: '#/components/responses/401.NotAuthenticated'
tags:
- Ticket
/v2/api/ticket/{network}/lock/{lockAddress}/key/{keyId}:
get:
operationId: getTicket
security:
- User: []
description: get a ticket for a key by lock.
parameters:
- $ref: '#/components/parameters/Network'
- $ref: '#/components/parameters/LockAddress'
- $ref: '#/components/parameters/KeyId'
responses:
200:
description: Successfully retrieved the ticket.
content:
application/json:
schema:
required:
- name
- lockAddress
- keyId
- manager
- publicLockVersion
- userMetadata
- isVerifier
- attributes
- image
- description
- owner
- expiration
type: object
properties:
keyId:
type: string
name:
type: string
owner:
type: string
manager:
type: string
lockAddress:
type: string
image:
type: string
description:
type: string
checkedInAt:
type: number
userMetadata:
type: object
additionalProperties: true
expiration:
type: string
attributes:
type: array
items:
type: object
required:
- value
properties:
trait_type:
type: string
value:
type: string
display_type:
type: string
publicLockVersion:
type: string
isVerifier:
description: Whether the user who requested the ticket can verify the ticket.
type: boolean
401:
$ref: '#/components/responses/401.NotAuthenticated'
tags:
- Ticket
components:
responses:
404.NotFound:
description: The item you are making request for does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/GenericNotFound'
409.Conflict:
description: There is a conflict. The resource already exist.
content:
application/json:
schema:
$ref: '#/components/schemas/GenericServerError'
403.NotAuthenticatedOrAuthorized:
description: User is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/NotAuthenticated'
500.InternalError:
description: Unable to fullfil request due to internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/GenericServerError'
401.NotAuthenticated:
description: User is not authenticated.
content:
application:
schema:
$ref: '#/components/schemas/GenericServerError'
schemas:
NotAuthenticated:
type: object
properties:
message:
type: string
default: You are not authorized or authenticated to perform this action.
GenericSuccess:
type: object
properties:
message:
type: string
default: Successfully fulfilled the request.
GenericServerError:
type: object
properties:
message:
type: string
default: There was an error in fullfiling the request.
GenericNotFound:
type: object
properties:
message:
type: string
default: resource not found
parameters:
LockAddress:
in: path
name: lockAddress
required: true
description: Lock address.
schema:
type: string
Slug:
in: path
name: slug
required: true
description: Slug
schema:
type: string
Network:
in: path
name: network
required: true
description: Network id.
schema:
type: integer
KeyId:
in: path
name: keyId
required: true
description: Key Id.
schema:
type: string
securitySchemes:
User:
type: http
scheme: bearer
bearerFormat: JWT
Application:
type: apiKey
name: api-key
in: query