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

The Files API from Kard — 2 operation(s) for files.

Kard Files 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 Files. 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 20 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 20 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 Files 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.

Files 2
GET
/v2/issuers/{organizationId}/files/metadata
Get Files
get-metadata 9 params → 200400401403500
GET
/issuers/{organizationId}/files
List
list 5 params → 200400401404500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are type_commons:ErrorObject (5 properties), type_files:FileMetadataAttribute (4 properties), type_files:FileAttributes (4 properties), type_files:PaginationLinks (3 properties). Each schema is shown below with its type and property counts.

type_commons:RequestValidationErrorResponse
object
1 property 1 required
type_files:Files
object
3 properties 3 required
type_files:File
Type of document returned. Will always be type file
type_files:FileMetadataWithURL
object
3 properties 3 required
type_commons:ErrorObject
object
5 properties 3 required
type_commons:InvalidRequestUnion
type_files:PaginationMeta
object
2 properties 2 required
type_files:PaginationLinks
object
Related pagination links to the API call.
3 properties 2 required
type_commons:ErrorResponse
object
1 property 1 required
type_files:FileType_2
string
type_files:FileAttributes
object
4 properties 4 required
type_commons:Links
object
Related links to the API call
3 properties 1 required
type_files:GetFilesMetadataResponse
object
3 properties 3 required
type_commons:ErrorSource
object
3 properties
type_commons:OrganizationId
string
Your issuer organization ID, provided by Kard
type_files:FileType
string
type_files:FilesMeta
object
1 property 1 required
type_files:FileMetadataAttribute
object
4 properties 4 required
type_commons:UnauthorizedErrorBody
object
1 property 1 required
type_files:FilesMetadataSortOptions
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kard-files-api-openapi.yml Raw ↑

Other APIs Kard publishes across the network.

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