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

Harbor Redemptions API

Operations for managing reward redemption requests from members.

Harbor Redemptions API is one of 6 APIs that Harbor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Redemptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.harbor.gg/v1.

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Server
https://api.harbor.gg/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Harbor Redemptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token obtained via OAuth 2.0 client credentials flow. Contact Harbor to obtain API credentials.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Redemptions 2

Operations for managing reward redemption requests from members.

GET
/communities/{communityId}/redemptions
Harbor List redemptions
listRedemptions 4 params → 200401
POST
/communities/{communityId}/redemptions
Harbor Create a redemption request
createRedemption 1 param body → 201400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Redemption (10 properties), Reward (10 properties), RedemptionList (4 properties), CreateRedemptionRequest (3 properties). Each schema is shown below with its type and property counts.

RedemptionList
object
Paginated list of redemptions.
4 properties
CreateRedemptionRequest
object
Request body for creating a reward redemption.
3 properties 2 required
Reward
object
A reward available for redemption in the community catalog.
10 properties
Redemption
object
A reward redemption request from a community member.
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harbor-redemptions-api-openapi.yml Raw ↑

Other APIs Harbor publishes across the network.

Harbor Challenges API
Harbor Communities API
Harbor Leaderboards API
Harbor Members API
Harbor Rewards API