Badgr Users API

The Users API from Badgr — 3 operation(s) for users.

Operations 5

GET /v2/users/self Get the authenticated user's profile #
PUT /v2/users/self Update the authenticated user's profile #
GET /v2/users/{entityId} Get a user #
PUT /v2/users/{entityId} Update a user #
GET /v2/termsVersions/latest Get the latest terms of service version #

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/badgr-users-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.

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

OpenAPI Specification

badgr-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Badgr Users API
  version: '2.0'
  description: REST API for the Badgr open digital badging platform (Instructure Canvas Credentials), implementing the Open Badges standard.
  contact:
    name: API Evangelist
    email: kin@apievangelist.com
  license:
    name: Badgr API Terms / badgr-server GNU AGPL-3.0 (open source)
    url: https://github.com/concentricsky/badgr-server
servers:
- url: https://api.badgr.io
  description: Badgr US (production)
- url: https://api.eu.badgr.io
  description: Badgr EU region
- url: https://api.ca.badgr.io
  description: Badgr Canada region
- url: https://api.au.badgr.io
  description: Badgr Australia region
security:
- OAuth2: []
tags:
- name: Users
paths:
  /v2/users/self:
    get:
      tags:
      - Users
      summary: Get the authenticated user's profile
      responses:
        '200':
          description: The current user's profile.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    $ref: '#/components/schemas/Status'
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
      operationId: getV2UsersSelf
      x-operation-id-source: derived
    put:
      tags:
      - Users
      summary: Update the authenticated user's profile
      responses:
        '200':
          description: Profile updated.
      operationId: putV2UsersSelf
      x-operation-id-source: derived
  /v2/users/{entityId}:
    parameters:
    - name: entityId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Users
      summary: Get a user
      responses:
        '200':
          description: The requested user.
      operationId: getV2UsersByEntityId
      x-operation-id-source: derived
    put:
      tags:
      - Users
      summary: Update a user
      responses:
        '200':
          description: User updated.
      operationId: putV2UsersByEntityId
      x-operation-id-source: derived
  /v2/termsVersions/latest:
    get:
      tags:
      - Users
      summary: Get the latest terms of service version
      responses:
        '200':
          description: The latest terms version.
      operationId: getV2TermsVersionsLatest
      x-operation-id-source: derived
components:
  schemas:
    User:
      type: object
      properties:
        entityId:
          type: string
        entityType:
          type: string
          example: BadgeUser
        firstName:
          type: string
        lastName:
          type: string
        emails:
          type: array
          items:
            type: object
        url:
          type: array
          items:
            type: string
    Status:
      type: object
      properties:
        success:
          type: boolean
        description:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        password:
          tokenUrl: https://api.badgr.io/o/token
          scopes:
            rw:profile: Read and write the user profile
            rw:issuer: Read and write issuers, badge classes, and assertions
            rw:backpack: Read and write the earner backpack and collections
        authorizationCode:
          authorizationUrl: https://api.badgr.io/o/authorize
          tokenUrl: https://api.badgr.io/o/token
          scopes:
            rw:profile: Read and write the user profile
            rw:issuer: Read and write issuers, badge classes, and assertions
            rw:backpack: Read and write the earner backpack and collections