How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 17 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 62 schemas. It is described by OpenAPI 3.2.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 62 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are type_users_rewards_StandardOfferFields (16 properties), type_users_rewards_OfferComponents (9 properties), type_users_rewards_ProgressBar (6 properties), type_users_rewards_LocationAttributes (6 properties). Each schema is shown below with its type and property counts.

type_users_rewards_ProgressBarSegments
object
Segment configuration for the progress bar in different layouts
3 properties 2 required
type_users_rewards_Coordinates
object
2 properties 2 required
type_commons_ResourceType
string
Type of document returned
type_commons_PurchaseChannel
string
Purchase channel of offer
type_users_rewards_LocationRelationships
object
2 properties 2 required
type_users_rewards_CategoryFields
object
1 property 1 required
type_users_rewards_CategoryData
object
2 properties 2 required
type_users_rewards_ProgressBarSegmentSelection
string
Supported selection strategies for highlighting segment nodes. - CURRENT: select only the segment at currentProgress - CURRENTANDBELOW: select the segment at c…
type_users_rewards_AmountType
string
type_commons_RelationshipData
object
2 properties 2 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_users_rewards_LocationPartnerIdType
string
type_users_rewards_CategoryRelationship
object
1 property 1 required
type_commons_State
string
type_users_rewards_ProgressBarSegmentProgress
object
Fill state of a single segment node, expressed as completed of total.
2 properties 2 required
type_users_rewards_LogoFlareBorderColor
string
Available border color options for logo flare
type_commons_MongoId
string
The unique identifier for a document in the database
type_users_rewards_LocationSortOptions
string
type_commons_ErrorObject
object
5 properties 3 required
type_users_rewards_Amount
object
2 properties 2 required
type_users_rewards_EligibilityOfferIncluded
type_commons_Links
object
Related links to the API call
3 properties 1 required
type_users_rewards_CtaComponent
object
Call-to-action button component for offers
4 properties 2 required
type_users_rewards_LocationAttributes
object
6 properties 6 required
type_users_rewards_OfferComponents
object
UI component data for rendering offer details
9 properties
type_users_rewards_Commission
object
2 properties 2 required
type_users_rewards_CategoryRelationshipObject
object
1 property 1 required
type_commons_ErrorSource
object
3 properties
type_commons_CommissionType
string
Type of commission on offer (% or a flat $)
type_users_rewards_OperationPeriod
object
2 properties 2 required
type_users_rewards_LocationsResponseObject
object
3 properties 2 required
type_users_rewards_EligibilityLocationIncluded
type_users_rewards_OfferSortOptions
string
type_users_rewards_ProgressBarSegment
object
Segment configuration for a specific layout
5 properties 1 required
type_users_rewards_ComponentType
string
Available UI component types for offers
type_users_rewards_ButtonStyle
string
Available button styles for CTA components
type_users_rewards_CategoryIncluded
object
3 properties 3 required
type_users_rewards_OperationHours
object
2 properties 2 required
type_users_rewards_ProgressBarLabelPair
object
Left and right label configuration for a specific layout
2 properties
type_commons_ErrorResponse
object
1 property 1 required
type_users_rewards_OperationTime
object
2 properties 2 required
type_users_rewards_LocationData
object
4 properties 3 required
type_commons_UserId
string
The ID of the user as defined on the issuers system
type_users_rewards_OfferDataUnion
type_users_rewards_ProgressBarSegmentLabel
object
Label configuration for a single node within a segment
2 properties 2 required
type_users_rewards_CtaAction
object
Action configuration for CTA button
2 properties 2 required
type_users_rewards_LogoFlareBadgePosition
string
Available positions for the logo flare badge
type_users_rewards_OffersResponseObject
object
4 properties 2 required
type_users_rewards_ProgressBarSegmentPosition
string
Supported segment positions
type_users_rewards_OffersMeta
object
Metadata about the full result set across all pages
2 properties
type_commons_OrganizationId
string
Your issuer organization ID, provided by Kard
type_commons_RelationshipMultiple
object
1 property 1 required
type_users_rewards_StandardOfferFields
object
16 properties 8 required
type_users_rewards_Asset
object
3 properties 3 required
type_users_rewards_EligibilityOfferRelationship
type_users_rewards_LogoFlareBadge
object
Badge configuration for logo flare
2 properties 2 required
type_users_rewards_LogoFlare
object
Logo flare configuration for offer display
2 properties 1 required
type_users_rewards_LocationPartnerId
object
2 properties 2 required
type_users_rewards_ProgressBarSegmentSeparator
string
Supported separator styles between segment nodes
type_users_rewards_EligibilityLocationAddress
object
4 properties 4 required
type_users_rewards_ProgressBar
object
Progress bar component for tracking offer redemption progress
6 properties 5 required
type_users_rewards_ProgressBarLabels
object
Labels to render around the progress bar in different layouts
2 properties 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
Where this information came from

This is an independent, third-party profile of Kard users > Rewards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.