Hang Programs API

The Programs API from Hang — 2 operation(s) for programs.

Operations 2

GET /programs/tiers Fetch all tiers and corresponding benefits for the program linked to the API key used in the request. #
GET /v2/admin/program Endpoint to return program information using the current JWT. #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hang-programs-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

hang-programs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Hang Partner API (params in:formData) Activities Programs API
  description: '

    <p>The Partner API allows you to request various resources that can power your loyalty program.</p>

    &copy Hang 2023'
  version: 2023.09.07
  x-copyright: '&copy Hang 2023'
servers:
- url: /partner-api
security:
- ApiKeyAuth: []
tags:
- name: Programs
paths:
  /programs/tiers:
    get:
      tags:
      - Programs
      operationId: get_programs_tiers
      summary: Fetch all tiers and corresponding benefits for the program linked to the API key used in the request.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  tiers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the program tier object.
                        order:
                          type: number
                          description: The order in which the tier should be displayed.
                        tier_metric_minimum_threshold:
                          type: number
                          description: The minimum amount of points, or any tier metric (e.g. xp, points, stars, etc), the user must reach before being able to unlock the tier.
                        display_name:
                          type: string
                          description: The name of the tier.
                        marketing_benefit_text:
                          type: string
                          description: The marketing benefit text of the tier.
                        image_url:
                          type: string
                          description: The image associated to the tier.
                        benefits:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Unique identifier for the tier benefit object.
                            order:
                              type: string
                              description: The order in which the tier benefit should be displayed.
                            text:
                              type: string
                              description: The text of the tier benefit.
                            short_text:
                              type: string
                              description: The short text of the tier benefit.
                          additionalProperties: false
                          required:
                          - id
                          - order
                          - text
                          - short_text
                      additionalProperties: false
                      required:
                      - id
                      - order
                      - tier_metric_minimum_threshold
                      - display_name
                      - marketing_benefit_text
                      - image_url
                      - benefits
                additionalProperties: false
                required:
                - tiers
        '500':
          description: Something unexpected happened while trying to retrive the tier benefits.
      description: Tiers represent a status level that a user can achieve based on their activity within a loyalty program. Each tier has a minimum threshold that a user must reach before being able to unlock the tier.
  /v2/admin/program:
    get:
      tags:
      - Programs
      operationId: get_v2_admin_program
      summary: Endpoint to return program information using the current JWT.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  program:
                    type: object
                    properties:
                      should_use_progression_v2:
                        type: boolean
                        description: Boolean flag indicating if the program is using v2 progression.
                    additionalProperties: false
                    required:
                    - should_use_progression_v2
                additionalProperties: false
                required:
                - program
      description: ''
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key