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.

Available options:

Responses

*/*

objectoptional

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-15T03:28:56.254Z",
  "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.

Available options:

Responses

*/*

objectoptional

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-15T03:28:56.254Z",
  "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.

Available options:

Responses

*/*

objectoptional

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-15T03:28:56.254Z",
  "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

objectoptional

get

HTTPcURLJavaScriptPython

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

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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

staffobject[]required

extensionsobjectoptional

Responses

application/jsonapplication/ld+json

objectoptional

put

HTTPcURLJavaScriptPython

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

{
  "name": "Credentials Faculty",
  "email": "[e-mail]",
  "url": "https://example.com",
  "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
  "description": "This is the faculty of the Credentials University.",
  "badgrDomain": "text",
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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

staffobject[]required

extensionsobjectoptional

Responses

application/jsonapplication/ld+json

objectoptional

patch

HTTPcURLJavaScriptPython

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

{
  "name": "Credentials Faculty",
  "email": "[e-mail]",
  "url": "https://example.com",
  "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
  "description": "This is the faculty of the Credentials University.",
  "badgrDomain": "text",
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "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

issuerOpenBadgeIdBase64stringrequired

Query parameters

include_staffstringoptionalDefault: true

Responses

application/jsonapplication/ld+json

objectoptional

get

HTTPcURLJavaScriptPython

GET /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Accept: */*

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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

staffobject[]required

extensionsobjectoptional

Responses

application/jsonapplication/ld+json

objectoptional

put

HTTPcURLJavaScriptPython

PUT /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "name": "Credentials Faculty",
  "email": "[e-mail]",
  "url": "https://example.com",
  "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
  "description": "This is the faculty of the Credentials University.",
  "badgrDomain": "text",
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Delete a single Issuer

delete

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringrequired

Responses

application/jsonapplication/ld+json

objectoptional

delete

HTTPcURLJavaScriptPython

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

204

Issuer deleted

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {}
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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

staffobject[]required

extensionsobjectoptional

Responses

application/jsonapplication/ld+json

objectoptional

patch

HTTPcURLJavaScriptPython

PATCH /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "name": "Credentials Faculty",
  "email": "[e-mail]",
  "url": "https://example.com",
  "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
  "description": "This is the faculty of the Credentials University.",
  "badgrDomain": "text",
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "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

issuerOpenBadgeIdBase64stringrequired

Query parameters

include_staffstringoptionalDefault: true

Responses

application/jsonapplication/ld+json

objectoptional

get

HTTPcURLJavaScriptPython

GET /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Accept: */*

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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

staffobject[]required

extensionsobjectoptional

Responses

application/jsonapplication/ld+json

objectoptional

put

HTTPcURLJavaScriptPython

PUT /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "name": "Credentials Faculty",
  "email": "[e-mail]",
  "url": "https://example.com",
  "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
  "description": "This is the faculty of the Credentials University.",
  "badgrDomain": "text",
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Delete a single Issuer

delete

Authorizations

oauthaccessToken

Path parameters

issuerOpenBadgeIdBase64stringrequired

Responses

application/jsonapplication/ld+json

objectoptional

delete

HTTPcURLJavaScriptPython

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

204

Issuer deleted

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {}
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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

staffobject[]required

extensionsobjectoptional

Responses

application/jsonapplication/ld+json

objectoptional

patch

HTTPcURLJavaScriptPython

PATCH /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "name": "Credentials Faculty",
  "email": "[e-mail]",
  "url": "https://example.com",
  "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
  "description": "This is the faculty of the Credentials University.",
  "badgrDomain": "text",
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Get list of Assertions for the specified scope

get

Authorizations

oauthaccessToken

Path parameters

scopestring · enumrequiredAvailable options:

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

objectoptional

get

HTTPcURLJavaScriptPython

GET /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badgr.io
Accept: */*

200

List of Assertions

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "entityType": "Assertion",
      "id": "6116c84d1ff787222b6c4d15",
      "entityId": "i9CirfwJTuSfiqg0FFUBdQ",
      "openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
      "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "image": "https://api.badgr.io/public/assertions/SsCfI7FlTr6hAJe4irXnfQ/image",
      "recipient": {
        "identity": "sha256$4c2657856f",
        "hashed": true,
        "type": "email",
        "salt": "jgsu868",
        "plaintextIdentity": "[e-mail]"
      },
      "issuedOn": "2025-04-15T03:28:56.254Z",
      "narrative": "text",
      "evidence": [
        {
          "url": "https://example.com",
          "narrative": "text",
          "name": "text",
          "description": "text",
          "genre": "text",
          "audience": "text"
        }
      ],
      "revoked": true,
      "revocationReason": "text",
      "acceptance": "Unaccepted",
      "expires": "2025-04-15T03:28:56.254Z",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "assertionRef": {
        "assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
      },
      "badgeRef": {
        "badgeUrl": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg"
      },
      "issuerRef": {
        "issuerUrl": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw"
      },
      "pending": true,
      "source": "local",
      "sourceUrl": "https://example.com/assertions/1",
      "originalJson": "{}",
      "imagePath": "uploads/badges/assertion-lY1LJ6K4RqG7ThGLYvWNng.png",
      "ob3AwardProperties": {
        "activityStart": "2025-04-15T03:28:56.254Z",
        "activityEnd": "2025-04-15T03:28:56.254Z",
        "licenseNumber": "text",
        "role": "text"
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Issue a new Assertion to a recipient

post

Authorizations

oauthaccessToken

Path parameters

scopestring · enumrequiredAvailable options:

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

recipientobjectrequired

allowDuplicateAwardsbooleanoptional

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

narrativestringoptional

Markdown narrative of the achievement

evidenceobject[]optional

List of evidence associated with the achievement

extensionsobjectoptional

expiresstring · date-timeoptional

ob3AwardPropertiesobjectoptional

Responses

application/jsonapplication/ld+json

objectoptional

post

HTTPcURLJavaScriptPython

POST /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 650

{
  "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
  "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
  "issuedOn": "2025-04-15T03:28:56.254Z",
  "recipient": {
    "identity": "[e-mail]",
    "type": "email",
    "hashed": true
  },
  "allowDuplicateAwards": true,
  "narrative": "text",
  "evidence": [
    {
      "url": "https://example.com",
      "narrative": "text",
      "name": "text",
      "description": "text",
      "genre": "text",
      "audience": "text"
    }
  ],
  "extensions": {
    "value": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "expires": "2025-04-15T03:28:56.254Z",
  "ob3AwardProperties": {
    "activityStart": "2025-04-15T03:28:56.254Z",
    "activityEnd": "2025-04-15T03:28:56.254Z",
    "licenseNumber": "text",
    "role": "text"
  }
}

201

Created

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "entityType": "Assertion",
      "id": "6116c84d1ff787222b6c4d15",
      "entityId": "i9CirfwJTuSfiqg0FFUBdQ",
      "openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
      "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "image": "https://api.badgr.io/public/assertions/SsCfI7FlTr6hAJe4irXnfQ/image",
      "recipient": {
        "identity": "sha256$4c2657856f",
        "hashed": true,
        "type": "email",
        "salt": "jgsu868",
        "plaintextIdentity": "[e-mail]"
      },
      "issuedOn": "2025-04-15T03:28:56.254Z",
      "narrative": "text",
      "evidence": [
        {
          "url": "https://example.com",
          "narrative": "text",
          "name": "text",
          "description": "text",
          "genre": "text",
          "audience": "text"
        }
      ],
      "revoked": true,
      "revocationReason": "text",
      "acceptance": "Unaccepted",
      "expires": "2025-04-15T03:28:56.254Z",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "assertionRef": {
        "assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
      },
      "badgeRef": {
        "badgeUrl": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg"
      },
      "issuerRef": {
        "issuerUrl": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw"
      },
      "pending": true,
      "source": "local",
      "sourceUrl": "https://example.com/assertions/1",
      "originalJson": "{}",
      "imagePath": "uploads/badges/assertion-lY1LJ6K4RqG7ThGLYvWNng.png",
      "ob3AwardProperties": {
        "activityStart": "2025-04-15T03:28:56.254Z",
        "activityEnd": "2025-04-15T03:28:56.254Z",
        "licenseNumber": "text",
        "role": "text"
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Get a list of Issuers for authenticated user

get

Authorizations

oauthaccessToken

Query parameters

include_staffstringoptionalDefault: true

Responses

application/jsonapplication/ld+json

objectoptional

get

HTTPcURLJavaScriptPython

GET /v2/issuers HTTP/1.1
Host: api.badgr.io
Accept: */*

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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.

staffobject[]optional

Staff members of this issuer.

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

objectoptional

post

HTTPcURLJavaScriptPython

POST /v2/issuers HTTP/1.1
Host: api.badgr.io
Content-Type: application/json
Accept: */*
Content-Length: 460

{
  "name": "Credentials Faculty",
  "email": "[e-mail]",
  "url": "https://example.com",
  "sourceUrl": "https://example.com/issuers/1",
  "originalJson": "{}",
  "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
  "description": "This is the faculty of the Credentials University.",
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "badgrDomain": "badgrsupportgroup.badgr.com",
  "createdBy": "text",
  "organizationId": "6f4e4e4e2dc038241ad01d83"
}

201

Issuer created

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "6016c84d1ff787222b6c4d15",
      "entityType": "Issuer",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "name": "Credentials Faculty",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "email": "[e-mail]",
      "description": "This is the faculty of the Credentials University.",
      "url": "https://example.com",
      "staff": [
        {
          "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
          }
        }
      ],
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdBy": "text",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "originalJson": "{}",
      "badgeSkillLinkingPreferences": {
        "type": "TALENT_NEURON",
        "serverUri": "https://example.com/",
        "indeedRegion": "us"
      },
      "preferences": {
        "customPropertyDefinitions": [
          {
            "propertyType": "STRING_CHOICE",
            "targetEntityType": "BADGE_CLASS",
            "propertyId": "66bf8231d88b51901d49d637",
            "label": "Award Type",
            "subLabel": "Type of award",
            "public": true,
            "required": true,
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ]
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ]
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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.

Available options:

Responses

*/*

objectoptional

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-15T03:28:56.254Z",
  "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

objectoptional

get

HTTPcURLJavaScriptPython

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

200

OK

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-15T03:28:56.254Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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

alignmentsobject[]optional

List of objects describing objectives or educational standards

expiresobjectoptional

Optional default expiration period for awards of this BadgeClass

extensionsobjectoptional

ob3Propertiesobjectoptional

preferencesobjectoptional

Responses

application/jsonapplication/ld+json

objectoptional

post

HTTPcURLJavaScriptPython

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

{
  "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
  "name": "Math Expert",
  "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
  "achievementType": "Course",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "criteriaNarrative": "text",
  "tags": [
    "text"
  ],
  "alignments": [
    {
      "targetName": "text",
      "targetUrl": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetCode": "text",
      "displayAsSkill": true
    }
  ],
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "includeOnPublicPages": true,
    "customPropertyValues": [
      {
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "stringValue": "text",
        "doubleValue": 1,
        "arrayValue": [
          "text"
        ],
        "public": true
      }
    ],
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
  }
}

201

Created

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "id": "68e9d238c5afe622816febb3",
      "entityType": "BadgeClass",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "sourceUrl": "https://example.com/badge-classes/1",
      "originalJson": "{}",
      "createdAt": "2025-04-15T03:28:56.254Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "achievementType": "Course",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "criteriaNarrative": "text",
      "alignments": [
        {
          "targetName": "text",
          "targetUrl": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetCode": "text",
          "displayAsSkill": true
        }
      ],
      "tags": [
        "text"
      ],
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "source": "local",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "archived": true,
      "archivedDate": "2025-04-15T03:28:56.254Z",
      "archivalNote": "text",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "preferences": {
        "includeOnPublicPages": true,
        "customPropertyValues": [
          {
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "stringValue": "text",
            "doubleValue": 1,
            "arrayValue": [
              "text"
            ],
            "public": true
          }
        ],
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3"
      }
    }
  ],
  "timestamp": "2025-04-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

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

*/*

objectoptional

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-15T03:28:56.254Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}