Yoobic

Yoobic Badges API

A badge is a customized reward earned by a learner after completing a lesson. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`badge_id` | string | x | x | | Unique id of the badge | |`creator_id` | string | | x | | Unique id of the badge creator | |`title` | string | | x | | Badge title | |`icon` | string | | x | | Badge icon name | |`created_date` | date | | x | | Creation date | |`updated_date` | date | | x | x | Last update date |

GitHub OpenAPI

Operations 4

GET /public/api/badges/{id} Get #
GET /public/api/badges?filter={filter} Get All #
GET /public/api/badges/count?where={where} Count #
GET /public/api/badges/export?type={type}&filter={filter} Export #

Documentation

📖
Documentation
https://docs.yoobic.com/api.html
📖
APIReference
https://docs.yoobic.com/api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-badges-api-openapi.yml

Other Resources

🔗
Postman
https://assets.yoobic.com/raw/upload/v1767016464/3c85c240-dd03-4981-9814-bc6e5e861fa0.zip
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/errors/yoobic-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conventions/yoobic-conventions.yml
🔗
ChangeLog
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/changelog/yoobic-changelog.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/lifecycle/yoobic-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conformance/yoobic-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/sandbox/yoobic-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/asyncapi/yoobic-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/yoobic-badges-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yoobic-badges-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: YOOBIC Public Badges API
  version: ''
  description: Welcome to the **YOOBIC Public API** documentation.
servers:
- url: https://<base_url>/
tags:
- name: Badges
  description: A badge is a customized reward earned by a learner after completing a lesson.
paths:
  /public/api/badges/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  badge_id:
                    type: string
                  creator_id:
                    type: string
                  title:
                    type: string
                  icon:
                    type: string
                  created_date:
                    type: string
                  updated_date:
                    type: string
                example:
                  badge_id: 61b9b435c8f864003a552378
                  creator_id: 61af7b01ee30bd0025145674
                  title: woohoo
                  icon: award-trophy-star
                  created_date: '2021-12-15T09:24:05.652Z'
                  updated_date: '2021-12-15T09:24:05.652Z'
              examples:
                response:
                  value:
                    badge_id: 61b9b435c8f864003a552378
                    creator_id: 61af7b01ee30bd0025145674
                    title: woohoo
                    icon: award-trophy-star
                    created_date: '2021-12-15T09:24:05.652Z'
                    updated_date: '2021-12-15T09:24:05.652Z'
      summary: Get
      operationId: Get
      description: Get a badge for the given id.
      tags:
      - Badges
      parameters:
      - name: id
        in: path
        description: The id of the badge
        required: true
        example: 61b9b435c8f864003a552378
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      security:
      - oauth2: []
  /public/api/badges?filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  paging:
                    type: object
                    properties:
                      total:
                        type: number
                      skip:
                        type: number
                      limit:
                        type: number
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        badge_id:
                          type: string
                        creator_id:
                          type: string
                        title:
                          type: string
                        icon:
                          type: string
                        created_date:
                          type: string
                        updated_date:
                          type: string
                      required:
                      - badge_id
                      - creator_id
                      - title
                      - icon
                      - created_date
                      - updated_date
                example:
                  paging:
                    total: 2
                    skip: 0
                    limit: 1000
                  data:
                  - badge_id: 61b8de5b55c2d5002449ab27
                    creator_id: 61af7b01ee30bd0025145674
                    title: doc lesson
                    icon: folder-add
                    created_date: '2021-12-14T18:11:39.026Z'
                    updated_date: '2021-12-14T18:11:39.026Z'
                  - badge_id: 61a622f2a9accb0024ea732b
                    creator_id: 6194baa5aedfd900296e744f
                    title: Yoobic Master
                    icon: automotive-airplane
                    created_date: '2021-11-30T13:11:14.247Z'
                    updated_date: '2021-11-30T13:11:14.247Z'
              examples:
                response:
                  value:
                    paging:
                      total: 2
                      skip: 0
                      limit: 1000
                    data:
                    - badge_id: 61b8de5b55c2d5002449ab27
                      creator_id: 61af7b01ee30bd0025145674
                      title: doc lesson
                      icon: folder-add
                      created_date: '2021-12-14T18:11:39.026Z'
                      updated_date: '2021-12-14T18:11:39.026Z'
                    - badge_id: 61a622f2a9accb0024ea732b
                      creator_id: 6194baa5aedfd900296e744f
                      title: Yoobic Master
                      icon: automotive-airplane
                      created_date: '2021-11-30T13:11:14.247Z'
                      updated_date: '2021-11-30T13:11:14.247Z'
      summary: Get All
      operationId: Get All
      description: Get all the badges.
      tags:
      - Badges
      parameters:
      - name: filter
        in: query
        description: A valid JSON filter object
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/badges/count?where={where}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: number
                example:
                  count: 10
              examples:
                response:
                  value:
                    count: 10
      summary: Count
      operationId: Count
      description: Count all the existing entities based on the where filter
      tags:
      - Badges
      parameters:
      - name: where
        in: query
        description: A valid JSON [Where filter](#section-api-requests-filter-where)
        required: false
        example: '{ "property": "value" }'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
  /public/api/badges/export?type={type}&filter={filter}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  type:
                    type: string
                  priority:
                    type: number
                  nextRunAt:
                    type: string
                  _id:
                    type: string
                example:
                  name: Export file
                  type: normal
                  priority: 0
                  nextRunAt: '2018-09-11T15:56:05.387Z'
                  _id: 5b97e5954b99568b4b9101af
              examples:
                response:
                  value:
                    name: Export file
                    type: normal
                    priority: 0
                    nextRunAt: '2018-09-11T15:56:05.387Z'
                    _id: 5b97e5954b99568b4b9101af
      summary: Export
      operationId: Export
      description: 'Export all results as a file.

        This action is asynchronous and returns the id of a job. See `jobs` endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource.'
      tags:
      - Badges
      parameters:
      - name: type
        in: path
        description: The type of file, either `csv` (default value) or `excel`
        required: true
        example: csv
        schema:
          type: string
      - name: filter
        in: query
        description: A valid JSON filter object (does not accept a `fields` filter)
        required: false
        example: '{}'
        schema:
          type: string
      - name: Accept
        in: header
        description: e.g. application/json
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/Get_AllBody'
components:
  schemas:
    Default_Header:
      type: object
      required:
      - Authorization
      properties:
        Authorization:
          type: string
          example: Bearer JWT
  requestBodies:
    Get_AllBody:
      content:
        application/json:
          schema:
            type: object
            properties:
              Authorization:
                $ref: '#/components/schemas/Default_Header'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /
          tokenUrl: /
          scopes: {}