Skip to content

Overview

Early access

The BadgeCert REST API is currently evolving as new capabilities are added. While the core authentication model and resource concepts are stable, some endpoints and behaviors may change as the API matures.

Developers should consult the API Reference (Swagger) for the most up-to-date operations and schemas.

Start here

New to the BadgeCert API?

  1. Follow the Quick Start to make your first request.
  2. Review the Data Model to understand core entities.
  3. Explore the API reference (Swagger) for endpoint details: Swagger UI.

What the API enables

The BadgeCert API provides programmatic access to your organization’s data and operations. It allows you to automate workflows, integrate BadgeCert with other systems (such as LMS, HR, or identity platforms), and build internal tools without relying on manual actions in the web interface.

Who should use it

The API is intended for developers and integrators building or maintaining connections on behalf of an organization.

Operational users typically continue to use the BadgeCert web application for everyday tasks such as reviewing badges, managing programs, and administering issuances.

UI vs CSV vs API

BadgeCert supports several ways to interact with the platform:

  • Web UI: Best for one-off administration, reviewing what was issued, and interactive work performed by people in your organization.

  • CSV: Best for bulk imports or exports where the product supports file-based workflows (for example large one-time loads or data extracts).

  • API: Best for ongoing automation, real-time integrations, and processes that must run from your own servers or services on a schedule or in response to system events.

Core Concepts

The API works with the same core entities used throughout BadgeCert:

  • Organization: The tenant that owns badges, users, and issuances.
  • User: A person who receives a badge.
  • Badge: A credential definition that can be issued to users.
  • Issuance: A specific badge granted to a specific user.

These concepts are explained in the Data Model page.

API Base URL

All REST resources are available under the /v1 path on your API host, for example:

https://api.badgecert.com/v1/...

API Reference (Swagger)

Interactive API documentation and schemas: Swagger UI.

The OpenAPI specification can also be retrieved directly at:

    /v3/api-docs

This can be imported into API clients or gateways if needed.

Getting started

Ready to try the API?

Follow the Quick Start guide to obtain an API token and make your first request in a few minutes.