Issuers

Update a staff member's role on the Issuer

put

User must have an owner role on the issuer.

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Body

emailstringRequired

Email address associated with the staff member

Example: [e-mail]

rolestring · enumRequired

Role of the user in the issuer.

Possible values:

Responses

put

HTTPcURLJavaScriptPython

PUT /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "email": "[e-mail]",
  "role": "owner"
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "entityType": "BadgeUser",
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "firstName": "Jane",
        "lastName": "Doe",
        "emails": [
          {
            "email": "[e-mail]",
            "verified": true,
            "primary": true
          }
        ],
        "url": [
          "https://example.com"
        ],
        "telephone": [
          "text"
        ],
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "agreedTermsVersion": 4,
        "marketingOptIn": true,
        "hasPasswordSet": true
      }
    }
  ],
  "timestamp": "2025-04-25T10:22:36.167Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Add a staff member to an Issuer

post

User must have an owner role on the issuer.

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Body

emailstringRequired

Email address associated with the staff member

Example: [e-mail]

rolestring · enumRequired

Role of the user in the issuer.

Possible values:

Responses

post

HTTPcURLJavaScriptPython

POST /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "email": "[e-mail]",
  "role": "owner"
}

201

Staff member added

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "entityType": "BadgeUser",
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "firstName": "Jane",
        "lastName": "Doe",
        "emails": [
          {
            "email": "[e-mail]",
            "verified": true,
            "primary": true
          }
        ],
        "url": [
          "https://example.com"
        ],
        "telephone": [
          "text"
        ],
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "agreedTermsVersion": 4,
        "marketingOptIn": true,
        "hasPasswordSet": true
      }
    }
  ],
  "timestamp": "2025-04-25T10:22:36.167Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Update a staff member's role on the Issuer

patch

User must have an owner role on the issuer.

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Body

emailstringRequired

Email address associated with the staff member

Example: [e-mail]

rolestring · enumRequired

Role of the user in the issuer.

Possible values:

Responses

patch

HTTPcURLJavaScriptPython

PATCH /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "email": "[e-mail]",
  "role": "owner"
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "entityType": "BadgeUser",
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "firstName": "Jane",
        "lastName": "Doe",
        "emails": [
          {
            "email": "[e-mail]",
            "verified": true,
            "primary": true
          }
        ],
        "url": [
          "https://example.com"
        ],
        "telephone": [
          "text"
        ],
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "agreedTermsVersion": 4,
        "marketingOptIn": true,
        "hasPasswordSet": true
      }
    }
  ],
  "timestamp": "2025-04-25T10:22:36.167Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Get a single Issuer

get

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Query parameters

include_staffstringOptionalDefault: true

Responses

application/jsonapplication/ld+json

Update a single Issuer

put

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty

emailstring · email · max: 255Required

Contact email for the Issuer

Example: [e-mail]

urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com

imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

badgrDomainstringOptional

Responses

application/jsonapplication/ld+json

Delete a single Issuer

delete

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Accept: */*

204

Issuer deleted

No content

Update a single Issuer

patch

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty

emailstring · email · max: 255Required

Contact email for the Issuer

Example: [e-mail]

urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com

imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

badgrDomainstringOptional

Responses

application/jsonapplication/ld+json

Get a single Issuer

get

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Responses

application/jsonapplication/ld+json

Update a single Issuer

put

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty

emailstring · email · max: 255Required

Contact email for the Issuer

Example: [e-mail]

urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com

imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

badgrDomainstringOptional

Responses

application/jsonapplication/ld+json

Delete a single Issuer

delete

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringRequired

Responses

application/jsonapplication/ld+json

Update a single Issuer

patch

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty

emailstring · email · max: 255Required

Contact email for the Issuer

Example: [e-mail]

urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com

imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

badgrDomainstringOptional

Responses

application/jsonapplication/ld+json

Get a single Issuer

get

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Responses

application/jsonapplication/ld+json

Update a single Issuer

put

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty

emailstring · email · max: 255Required

Contact email for the Issuer

Example: [e-mail]

urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com

imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

badgrDomainstringOptional

Responses

application/jsonapplication/ld+json

Delete a single Issuer

delete

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringRequired

Responses

application/jsonapplication/ld+json

Update a single Issuer

patch

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty

emailstring · email · max: 255Required

Contact email for the Issuer

Example: [e-mail]

urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com

imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

badgrDomainstringOptional

Responses

application/jsonapplication/ld+json

Get list of Assertions for the specified scope

get

Authorizations

oauthaccessToken

Path parameters

scopestring · enumRequiredPossible values:

idOrEntityIdstringRequired

Query parameters

recipientstringOptional

A recipient identifier to filter by

numinteger · int32Optional

Request pagination of results, before/after cursors may be provided in response header

include_expiredbooleanOptionalDefault: false

include_revokedbooleanOptionalDefault: false

afterstringOptional

Pagination cursor provided in "Link" response header

beforestringOptional

Pagination cursor provided in "Link" response header

Responses

application/jsonapplication/ld+json

Issue a new Assertion to a recipient

post

Authorizations

oauthaccessToken

Path parameters

scopestring · enumRequiredPossible values:

idOrEntityIdstringRequired

The entity ID of the selected scope entity

Example: K829IK8RS6ercwkpeFOn-Q

Body

Request to award an assertion. When request scope is issuers, one of badgeclass or badgeclassOpenBadgeId must be provided.

badgeclassstringOptional

ID or Entity ID of the badge class to be awarded

Example: K829IK8RS6ercwkpeFOn-Q

badgeclassOpenBadgeIdstring · uriOptional

OB URL of the badge class to be awarded

Example: https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q

issuedOnstring · date-timeOptional

Timestamp when the assertion was issued

allowDuplicateAwardsbooleanOptional

If set to false and the recipient already has this assertion, then the request will fail

narrativestringOptional

Markdown narrative of the achievement

expiresstring · date-timeOptional

Responses

application/jsonapplication/ld+json

Get a list of Issuers for authenticated user

get

Authorizations

oauthaccessToken

Query parameters

include_staffstringOptionalDefault: true

Responses

application/jsonapplication/ld+json

Create a new Issuer

post

Authorizations

oauthaccessToken

Query parameters

include_staffstringOptionalDefault: true

Body

namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty

emailstring · email · max: 255Required

Contact email for the Issuer

Example: [e-mail]

urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com

sourceUrlstring · uriOptional

The original URL of the issuer if it was imported

Example: https://example.com/issuers/1

originalJsonstring · max: 2000000Optional

The original OB JSON of the issuer if it was imported

Example: {}

imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image

descriptionstring · max: 16384Optional

Short description of the Issuer

Example: This is the faculty of the Credentials University.

badgrDomainstringOptional

Organization domain host

Example: badgrsupportgroup.badgr.com

createdBystringOptional

User who created this issuer

organizationIdstringOptional

The ID of the organization which this issuer should be associated with. Requires organization write access.

Example: 6f4e4e4e2dc038241ad01d83

Responses

application/jsonapplication/ld+json

Invite a staff member to an Issuer

post

User must have an owner role on the issuer.

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Body

emailstringRequired

Email address associated with the staff member

Example: [e-mail]

rolestring · enumRequired

Role of the user in the issuer.

Possible values:

Responses

post

HTTPcURLJavaScriptPython

POST /v2/issuers/{idOrEntityId}/staff/invitations HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "email": "[e-mail]",
  "role": "owner"
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "email": "[e-mail]",
      "role": "owner",
      "status": "PENDING"
    }
  ],
  "timestamp": "2025-04-25T10:22:36.167Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Get a list of BadgeClasses for a single Issuer

get

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Query parameters

include_archivedbooleanOptionalDefault: false

Responses

application/jsonapplication/ld+json

Create a new BadgeClass associated with an Issuer

post

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

Body

issuerstringOptional

Entity ID of the issuer

Example: ZvYydoQhRtOKalNzFPZR2A-Q

namestring · max: 1024Required

Name of the BadgeClass

Example: Math Expert

imagestringRequired

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image

achievementTypestringOptional

The type of achievement

Example: Course

descriptionstring · max: 16384Required

Short description of the BadgeClass

Example: This badge is awarded to students who have demonstrated mastery of Math.

criteriaUrlstring · uriOptional

External URL that describes in a human-readable format the criteria for the BadgeClass

Example: https://example.com/badge-classes/1/criteria

criteriaNarrativestringOptional

Markdown formatted description of the criteria

tagsstring[]Optional

List of tags that describe the BadgeClass

Responses

application/jsonapplication/ld+json

Remove a staff member from the Issuer

delete

User must have an owner role on the issuer.

Authorizations

oauthaccessToken

Path parameters

idOrEntityIdstringRequired

emailBase64stringRequired

Base64 encoded email address of the staff member

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v2/issuers/{idOrEntityId}/staff/{emailBase64} HTTP/1.1
Host: api.badgr.io
Accept: */*

204

Staff member removed

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {}
  ],
  "timestamp": "2025-04-25T10:22:36.167Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}