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 Members API

Operations for managing community members, their profiles, point balances, and tier status.

Harbor Members 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 Members. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 7 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.

5 operations 3 paths 7 schemas 2 GET1 PATCH2 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 Members 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 5

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

Members 5

Operations for managing community members, their profiles, point balances, and tier status.

GET
/communities/{communityId}/members
Harbor List community members
listMembers 5 params → 200401404
POST
/communities/{communityId}/members
Harbor Create a community member
createMember 1 param body → 201400401409
GET
/communities/{communityId}/members/{memberId}
Harbor Get a community member
getMember 2 params → 200401404
PATCH
/communities/{communityId}/members/{memberId}
Harbor Update a community member
updateMember 2 params body → 200400401404
POST
/communities/{communityId}/members/{memberId}/points
Harbor Award points to a member
awardPoints 2 params body → 200400401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Member (12 properties), CreateMemberRequest (5 properties), Tier (4 properties), UpdateMemberRequest (4 properties). Each schema is shown below with its type and property counts.

CreateMemberRequest
object
Request body for registering a new community member.
5 properties 1 required
Member
object
A community member representing a superfan registered on the Harbor platform.
12 properties
AwardPointsRequest
object
Request body for awarding points to a community member.
3 properties 2 required
PointsBalance
object
Updated points balance after a transaction.
4 properties
MemberList
object
Paginated list of community members.
4 properties
UpdateMemberRequest
object
Request body for updating a community member's profile.
4 properties
Tier
object
Loyalty tier a member has achieved.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harbor-members-api-openapi.yml Raw ↑

Other APIs Harbor publishes across the network.

Harbor Challenges API
Harbor Communities API
Harbor Leaderboards API
Harbor Redemptions API
Harbor Rewards API