Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hang

Hang Quests API

The Quests API from Hang — 9 operation(s) for quests.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hang Quests API is one of 18 APIs that Hang publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Quests. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 10 operations across 9 paths. It is described by OpenAPI 2.0, at version 2023.09.07.

Requests are made against the base URL https://loyalty.hang.xyz/partner-api.

10 operations 9 paths 0 schemas 1 DELETE3 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023.09.07
Base URL
https://loyalty.hang.xyz/partner-api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hang Quests API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Quests 10
GET
/v2/program-memberships/{program_membership_id}/quests/opt-ins
Endpoint to retrieve all optIns for a program membership
get_v2_program-memberships_program_membership_id_quests_opt-ins 1 param → 200
GET
/v2/admin/quests
Get all quests for program.
get_v2_admin_quests 2 params → 200
POST
/v2/program-memberships/{program_membership_id}/quests/{quest_id}/opt-in
Opt a user into a quest.
post_v2_program-memberships_program_membership_id_quests_quest_id_opt-in 2 params → 200
POST
/opt-ins/{opt_in_id}/claim-quest-prize
Claim the prize(s) associated with a Quest.
post_opt-ins_opt_in_id_claim-quest-prize 1 param → 200
POST
/opt-ins/{opt_in_id}/claim-activity-prize
Claim the prize(s) associated with an Activity.
post_opt-ins_opt_in_id_claim-activity-prize 2 params → 200
POST
/v2/admin/quests/{quest_id}/quest-requirements
Create a new quest requirement.
post_v2_admin_quests_quest_id_quest-requirements 14 params → 200
GET
/v2/admin/quests/{quest_id}
Get quest by Id.
get_v2_admin_quests_quest_id 1 param → 200
PATCH
/v2/admin/quests/{quest_id}
Updates the quest with the provided fields.
patch_v2_admin_quests_quest_id 22 params → 200
PATCH
/v2/admin/quest-requirements/{quest_requirement_id}
Update a quest requirement.
patch_v2_admin_quest-requirements_quest_requirement_id 16 params → 200
DELETE
/v2/program-memberships/{program_membership_id}/opt-ins/{opt_in_id}
ONLY WORKS IN DEV/STAGING: Clear the Quest Status of a given Opt-In ID.
delete_v2_program-memberships_program_membership_id_opt-ins_opt_in_id 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hang-quests-api-openapi.yml Raw ↑

Other APIs Hang publishes across the network.

Hang Activities API
AE Profile APIs.io
Hang Loot Box Reward Choices API
AE Profile APIs.io
Hang Loot box reward probabilities API
AE Profile APIs.io
Hang Loot Boxes API
AE Profile APIs.io
Hang Member Actions API
AE Profile APIs.io
Hang Memberships API
AE Profile APIs.io
Hang Program memberships API
AE Profile APIs.io
Hang Program Tiers API
AE Profile APIs.io
Hang ProgramMembershipPuzzles API
AE Profile APIs.io
Hang Programs API
AE Profile APIs.io
Hang Puzzles API
AE Profile APIs.io
Hang Redemptions API
AE Profile APIs.io
#Quests
← Back to H APIs
API Details
ID
hang:hang-quests-api
Base URL
https://loyalty.hang.xyz/partner-api
Docs
https://docs.hang.com/hang-platform
Provider
Hang
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network