Issuers
User must have an owner role on the issuer.
Role of the user in the issuer.
PUT /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"email": "[email protected]",
"role": "owner"
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"role": "staff",
"user": "Hey7J-GRSJeu6FNnHQwNyw",
"userProfile": {
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"marketingOptIn": true,
"hasPasswordSet": true
}
}
],
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
User must have an owner role on the issuer.
Role of the user in the issuer.
POST /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"email": "[email protected]",
"role": "owner"
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"role": "staff",
"user": "Hey7J-GRSJeu6FNnHQwNyw",
"userProfile": {
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"marketingOptIn": true,
"hasPasswordSet": true
}
}
],
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
User must have an owner role on the issuer.
Role of the user in the issuer.
PATCH /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"email": "[email protected]",
"role": "owner"
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"role": "staff",
"user": "Hey7J-GRSJeu6FNnHQwNyw",
"userProfile": {
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"marketingOptIn": true,
"hasPasswordSet": true
}
}
],
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
GET /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
Name of the issuer
Credentials Faculty
Homepage or website associated with the Issuer
https://example.com
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
Short description of the Issuer
This is the faculty of the Credentials University.
PUT /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354
{
"name": "Credentials Faculty",
"email": "[email protected]",
"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": {}
}
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
Name of the issuer
Credentials Faculty
Homepage or website associated with the Issuer
https://example.com
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
Short description of the Issuer
This is the faculty of the Credentials University.
PATCH /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354
{
"name": "Credentials Faculty",
"email": "[email protected]",
"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": {}
}
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
GET /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
Name of the issuer
Credentials Faculty
Homepage or website associated with the Issuer
https://example.com
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
Short description of the Issuer
This is the faculty of the Credentials University.
PUT /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354
{
"name": "Credentials Faculty",
"email": "[email protected]",
"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": {}
}
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
DELETE /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
Name of the issuer
Credentials Faculty
Homepage or website associated with the Issuer
https://example.com
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
Short description of the Issuer
This is the faculty of the Credentials University.
PATCH /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354
{
"name": "Credentials Faculty",
"email": "[email protected]",
"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": {}
}
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
GET /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
Name of the issuer
Credentials Faculty
Homepage or website associated with the Issuer
https://example.com
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
Short description of the Issuer
This is the faculty of the Credentials University.
PUT /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354
{
"name": "Credentials Faculty",
"email": "[email protected]",
"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": {}
}
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
DELETE /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
Name of the issuer
Credentials Faculty
Homepage or website associated with the Issuer
https://example.com
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
Short description of the Issuer
This is the faculty of the Credentials University.
PATCH /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354
{
"name": "Credentials Faculty",
"email": "[email protected]",
"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": {}
}
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
A recipient identifier to filter by
Request pagination of results, before/after cursors may be provided in response header
false
false
Pagination cursor provided in "Link" response header
Pagination cursor provided in "Link" response header
GET /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"entityType": "Assertion",
"id": "6116c84d1ff787222b6c4d15",
"entityId": "i9CirfwJTuSfiqg0FFUBdQ",
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"createdAt": "2025-07-05T06:27:31.169Z",
"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": "[email protected]"
},
"issuedOn": "2025-07-05T06:27:31.169Z",
"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-07-05T06:27:31.169Z",
"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-07-05T06:27:31.169Z",
"activityEnd": "2025-07-05T06:27:31.169Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
The entity ID of the selected scope entity
K829IK8RS6ercwkpeFOn-Q
Request to award an assertion. When request scope is issuers, one of badgeclass or badgeclassOpenBadgeId must be provided.
ID or Entity ID of the badge class to be awarded
K829IK8RS6ercwkpeFOn-Q
OB URL of the badge class to be awarded
https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q
Timestamp when the assertion was issued
If set to false and the recipient already has this assertion, then the request will fail
Markdown narrative of the achievement
POST /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 650
{
"badgeclass": "K829IK8RS6ercwkpeFOn-Q",
"badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
"issuedOn": "2025-07-05T06:27:31.169Z",
"recipient": {
"identity": "[email protected]",
"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-07-05T06:27:31.169Z",
"ob3AwardProperties": {
"activityStart": "2025-07-05T06:27:31.169Z",
"activityEnd": "2025-07-05T06:27:31.169Z",
"licenseNumber": "text",
"role": "text"
}
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"entityType": "Assertion",
"id": "6116c84d1ff787222b6c4d15",
"entityId": "i9CirfwJTuSfiqg0FFUBdQ",
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"createdAt": "2025-07-05T06:27:31.169Z",
"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": "[email protected]"
},
"issuedOn": "2025-07-05T06:27:31.169Z",
"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-07-05T06:27:31.169Z",
"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-07-05T06:27:31.169Z",
"activityEnd": "2025-07-05T06:27:31.169Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
GET /v2/issuers HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
true
Name of the issuer
Credentials Faculty
Homepage or website associated with the Issuer
https://example.com
The original URL of the issuer if it was imported
https://example.com/issuers/1
The original OB JSON of the issuer if it was imported
{}
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
Short description of the Issuer
This is the faculty of the Credentials University.
Organization domain host
badgrsupportgroup.badgr.com
User who created this issuer
The ID of the organization which this issuer should be associated with. Requires organization write access.
6f4e4e4e2dc038241ad01d83
POST /v2/issuers HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 460
{
"name": "Credentials Faculty",
"email": "[email protected]",
"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"
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6016c84d1ff787222b6c4d15",
"entityType": "Issuer",
"entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
"openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
"createdAt": "2025-07-05T06:27:31.169Z",
"name": "Credentials Faculty",
"image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
"email": "[email protected]",
"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": "[email protected]",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
User must have an owner role on the issuer.
Role of the user in the issuer.
POST /v2/issuers/{idOrEntityId}/staff/invitations HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"email": "[email protected]",
"role": "owner"
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"email": "[email protected]",
"role": "owner",
"status": "PENDING"
}
],
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
false
GET /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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-07-05T06:27:31.169Z",
"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-07-05T06:27:31.169Z",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
Entity ID of the issuer
ZvYydoQhRtOKalNzFPZR2A-Q
Name of the BadgeClass
Math Expert
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image
The type of achievement
Course
Short description of the BadgeClass
This badge is awarded to students who have demonstrated mastery of Math.
External URL that describes in a human-readable format the criteria for the BadgeClass
https://example.com/badge-classes/1/criteria
Markdown formatted description of the criteria
List of tags that describe the BadgeClass
POST /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
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"
}
}
{
"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-07-05T06:27:31.169Z",
"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-07-05T06:27:31.169Z",
"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-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
User must have an owner role on the issuer.
Base64 encoded email address of the staff member
DELETE /v2/issuers/{idOrEntityId}/staff/{emailBase64} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-07-05T06:27:31.169Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
Last updated
Was this helpful?