Hang ProgramMembershipPuzzles API
The ProgramMembershipPuzzles API from Hang — 3 operation(s) for programmembershippuzzles.
The ProgramMembershipPuzzles API from Hang — 3 operation(s) for programmembershippuzzles.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/hang-programmembershippuzzles-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Hang Partner API (params in:formData) Activities Program Membership Puzzles API
description: '
<p>The Partner API allows you to request various resources that can power your loyalty program.</p>
© Hang 2023'
version: 2023.09.07
x-copyright: '© Hang 2023'
servers:
- url: /partner-api
security:
- ApiKeyAuth: []
tags:
- name: ProgramMembershipPuzzles
paths:
/v2/program-memberships/{program_membership_id}/puzzles:
get:
tags:
- ProgramMembershipPuzzles
operationId: get_v2_program-memberships_program_membership_id_puzzles
summary: Endpoint to retrieve puzzles for a program membership
parameters:
- name: program_membership_id
in: path
required: true
description: ID of the program membership to retrieve puzzles for
schema:
type: string
- name: started
in: query
description: A filter. Set true to only return puzzles where the program membership has made progress. Set false to only return puzzles where the program membership has not made progress. If left blank, all puzzles are returned.
schema:
type: boolean
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
puzzle:
type: object
properties:
id:
type: string
description: Unique identifier for the Puzzle object.
program_id:
type: number
description: Unique identifier for the Loyalty Program object.
name:
type: string
description: Name/title of the Puzzle object.
description:
type: string
description: Description of the Puzzle object.
earn_instructions:
type: string
description: Instructions for earning the puzzle.
image_url:
type: string
description: URL of the combined Puzzle image.
rewards:
type: array
items:
type: string
description: Array of Reward objects.
additionalProperties: false
required:
- id
- program_id
- name
- description
- earn_instructions
- image_url
- rewards
additionalProperties: false
required:
- puzzle
description: ''
/v2/program-memberships/{program_membership_id}/puzzles/{puzzle_id}:
get:
tags:
- ProgramMembershipPuzzles
operationId: get_v2_program-memberships_program_membership_id_puzzles_puzzle_id
summary: Endpoint to retrieve a single puzzle belonging to a program membership
parameters:
- name: puzzle_id
in: path
required: true
description: ID of the puzzle to retrieve
schema:
type: string
- name: program_membership_id
in: path
required: true
description: ID of the program membership to retrieve puzzle for
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
puzzle:
type: object
properties:
id:
type: string
description: Unique identifier for the Puzzle object.
program_id:
type: number
description: Unique identifier for the Loyalty Program object.
name:
type: string
description: Name/title of the Puzzle object.
description:
type: string
description: Description of the Puzzle object.
earn_instructions:
type: string
description: Instructions for earning the puzzle.
image_url:
type: string
description: URL of the combined Puzzle image.
rewards:
type: array
items:
type: string
description: Array of Reward objects.
additionalProperties: false
required:
- id
- program_id
- name
- description
- earn_instructions
- image_url
- rewards
additionalProperties: false
required:
- puzzle
description: ''
/v2/program-memberships/{program_membership_id}/puzzles/{puzzle_id}/complete:
post:
tags:
- ProgramMembershipPuzzles
operationId: post_v2_program-memberships_program_membership_id_puzzles_puzzle_id_complete
summary: Endpoint to redeem a completed puzzle belonging to a program membership
parameters:
- name: puzzle_id
in: path
required: true
description: ID of the puzzle to redeem
schema:
type: string
- name: program_membership_id
in: path
required: true
description: ID of the program membership to redeem the puzzle for
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
puzzle:
type: object
properties:
id:
type: string
description: Unique identifier for the Puzzle object.
program_id:
type: number
description: Unique identifier for the Loyalty Program object.
name:
type: string
description: Name/title of the Puzzle object.
description:
type: string
description: Description of the Puzzle object.
earn_instructions:
type: string
description: Instructions for earning the puzzle.
image_url:
type: string
description: URL of the combined Puzzle image.
rewards:
type: array
items:
type: string
description: Array of Reward objects.
additionalProperties: false
required:
- id
- program_id
- name
- description
- earn_instructions
- image_url
- rewards
additionalProperties: false
required:
- puzzle
'401':
description: The program membership is not authorized to redeem the puzzle with given puzzle_id.
'422':
description: The puzzle is not redeemable because it is not complete or the puzzle_id given is not correct.
description: ''
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key