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 API

The users API from Kard — 5 operation(s) for users.

Kard users 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. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an AsyncAPI specification.

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

8 operations 5 paths 31 schemas 2 DELETE1 GET3 POST2 PUT

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 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

Paths & Operations 8

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

users 8
POST
/v2/issuers/{organizationId}/users
Create Users
create 2 params body → 201207400401409500
PUT
/v2/issuers/{organizationId}/users/{userId}
Update User
update 3 params body → 200400401404500
DELETE
/v2/issuers/{organizationId}/users/{userId}
Delete User
delete 3 params → 200400401404500
GET
/v2/issuers/{organizationId}/users/{userId}
Get User By ID
get 3 params → 200401404500
POST
/users/users
Create User
create-user 1 param body → 201400401404409500
POST
/users/users/{id}/cards
Create User Card
create-user-card 2 params body → 201400401404409500
PUT
/users/users/{id}
Update User
update-user 2 params body → 200400401404500
DELETE
/users/users/{id}
Delete User
delete-user-by-id 2 params → 200400401404500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are type_users:CreateUserCardResponse (17 properties), type_users:CreateUserRequestBody (14 properties), type_users:UserRequestBody (11 properties), type_users:UpdateUserResponse (11 properties). Each schema is shown below with its type and property counts.

type_users:UserResponseUnionNoData
type_users:UserResponseObject
object
1 property 1 required
type_users:CardStatus
string
type_commons:RequestValidationErrorResponse
object
1 property 1 required
type_commons:UserId
string
The ID of the user as defined on the issuers system
type_users:UpdateUserObject
object
1 property 1 required
type_users:UserRequestBody
object
11 properties 1 required
type_commons:ErrorObject
object
5 properties 3 required
type_users:CreateUserCardRequestBody
object
3 properties 1 required
type_users:CreateUsersObject
object
1 property 1 required
type_commons:EnrolledRewardsType_2
string
Enrolled Rewards
type_users:UserRequestAttributes
object
7 properties 1 required
type_commons:InvalidRequestUnion
type_commons:ErrorResponse
object
1 property 1 required
type_users:CardInfoResponse
object
Credit Card Information
8 properties 6 required
type_users:UpdateUserRequestAttributes
object
7 properties 1 required
type_commons:MongoId
string
The unique identifier for a document in the database
type_users:UpdateUserResponse
object
11 properties 1 required
type_commons:EmptyObject
object
type_users:CreateUsersMultiStatusResponse
object
2 properties 1 required
type_users:UpdateUserRequestDataUnion
type_users:CreateUserCardResponse
object
17 properties 7 required
type_commons:ErrorSource
object
3 properties
type_commons:OrganizationId
string
Your issuer organization ID, provided by Kard
type_users:CardInfoRequest
object
7 properties 4 required
type_commons:Network
string
type_commons:EnrolledRewardsType
string
Enrolled Rewards
type_users:DeleteUserResponseObject
object
1 property 1 required
type_commons:UnauthorizedErrorBody
object
1 property 1 required
type_users:UserRequestDataUnion
type_users:CreateUserRequestBody
object
14 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kard-users-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 > attributions API