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

Kard users > Rewards API

The users > Rewards API from Kard — 2 operation(s) for users > rewards.

Kard users > Rewards API is one of 16 APIs that Kard publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include users > Rewards. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://rewards-api.getkard.com, https://test-rewards-api.getkard.com.

2 operations 2 paths 8 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://rewards-api.getkard.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kard users > Rewards API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

Paths & Operations 2

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

users > Rewards 2
GET
/v2/issuers/{organizationId}/users/{userId}/offers
Get Offers By User
offers 13 params → 200400401404500
GET
/v2/issuers/{organizationId}/users/{userId}/locations
Get Locations By User
locations 17 params → 200400401404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are type_commons:ErrorObject (5 properties), type_commons:ErrorSource (3 properties), type_commons:ErrorResponse (1 property). Each schema is shown below with its type and property counts.

type_commons:ErrorSource
object
3 properties
type_commons:PurchaseChannel
string
Purchase channel of offer
type_commons:OrganizationId
string
Your issuer organization ID, provided by Kard
type_commons:ErrorObject
object
5 properties 3 required
type_commons:CategoryOption
string
Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
type_commons:UserId
string
The ID of the user as defined on the issuers system
type_commons:State
string
type_commons:ErrorResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kard-users-rewards-api-openapi.yml Raw ↑

Other APIs Kard publishes across the network.

Kard attributions API
Kard Files API
Kard notifications > Notifications API
Kard notifications > Subscriptions API
Kard Organizations API
Kard Organizations > Children API
Kard Organizations > ContentStrategies API
Kard Organizations > Placements API
Kard Ping API
Kard rewards API
Kard transactions API
Kard users API