APIs
User must have an owner role on the issuer.
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
rolestring · enumRequiredPossible values:
Role of the user in the issuer.
Responses
200
OK
*/*
400
Bad Request
*/*
put
/v2/issuers/{idOrEntityId}/staffPUT /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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.
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
rolestring · enumRequiredPossible values:
Role of the user in the issuer.
Responses
201
Staff member added
*/*
400
Bad Request
*/*
post
/v2/issuers/{idOrEntityId}/staffPOST /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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.
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
rolestring · enumRequiredPossible values:
Role of the user in the issuer.
Responses
200
OK
*/*
400
Bad Request
*/*
patch
/v2/issuers/{idOrEntityId}/staffPATCH /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : See who you are
- : Update your profile
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Responses
200
OK
application/json
400
Bad Request
*/*
get
/v2/users/{idOrEntityId}GET /v2/users/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : See who you are
- : Update your profile
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
firstNamestringOptionalExample:
JanelastNamestringOptionalExample:
DoemarketingOptInbooleanOptionalExample:
trueResponses
200
OK
application/json
400
Bad Request
*/*
put
/v2/users/{idOrEntityId}PUT /v2/users/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"firstName": "Jane",
"lastName": "Doe",
"marketingOptIn": true
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : See who you are
- : Update your profile
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
firstNamestringOptionalExample:
JanelastNamestringOptionalExample:
DoemarketingOptInbooleanOptionalExample:
trueResponses
200
OK
application/json
400
Bad Request
*/*
patch
/v2/users/{idOrEntityId}PATCH /v2/users/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"firstName": "Jane",
"lastName": "Doe",
"marketingOptIn": true
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : See who you are
- : Update your profile
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Responses
200
OK
application/json
400
Bad Request
*/*
get
/v2/users/selfGET /v2/users/self HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : See who you are
- : Update your profile
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Body
firstNamestringOptionalExample:
JanelastNamestringOptionalExample:
DoemarketingOptInbooleanOptionalExample:
trueResponses
200
OK
application/json
400
Bad Request
*/*
put
/v2/users/selfPUT /v2/users/self HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"firstName": "Jane",
"lastName": "Doe",
"marketingOptIn": true
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : See who you are
- : Update your profile
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Body
firstNamestringOptionalExample:
JanelastNamestringOptionalExample:
DoemarketingOptInbooleanOptionalExample:
trueResponses
200
OK
application/json
400
Bad Request
*/*
patch
/v2/users/selfPATCH /v2/users/self HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"firstName": "Jane",
"lastName": "Doe",
"marketingOptIn": true
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Query parameters
include_staffstringOptionalDefault:
trueResponses
200
OK
400
Bad Request
*/*
get
/v2/issuers/{idOrEntityId}GET /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Query parameters
include_staffstringOptionalDefault:
trueBody
namestring · max: 1024RequiredExample:
Name of the issuer
Credentials Facultyurlstring · uri · max: 1024RequiredExample:
Homepage or website associated with the Issuer
https://example.comimagestringOptionalExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/imagedescriptionstring · max: 16384RequiredExample:
Short description of the Issuer
This is the faculty of the Credentials University.badgrDomainstringOptional
Responses
200
OK
400
Bad Request
*/*
put
/v2/issuers/{idOrEntityId}PUT /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Responses
204
Issuer deleted
400
Bad Request
*/*
delete
/v2/issuers/{idOrEntityId}DELETE /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Query parameters
include_staffstringOptionalDefault:
trueBody
namestring · max: 1024RequiredExample:
Name of the issuer
Credentials Facultyurlstring · uri · max: 1024RequiredExample:
Homepage or website associated with the Issuer
https://example.comimagestringOptionalExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/imagedescriptionstring · max: 16384RequiredExample:
Short description of the Issuer
This is the faculty of the Credentials University.badgrDomainstringOptional
Responses
200
OK
400
Bad Request
*/*
patch
/v2/issuers/{idOrEntityId}PATCH /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault:
trueResponses
200
OK
400
Bad Request
*/*
get
/v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64}GET /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault:
trueBody
namestring · max: 1024RequiredExample:
Name of the issuer
Credentials Facultyurlstring · uri · max: 1024RequiredExample:
Homepage or website associated with the Issuer
https://example.comimagestringOptionalExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/imagedescriptionstring · max: 16384RequiredExample:
Short description of the Issuer
This is the faculty of the Credentials University.badgrDomainstringOptional
Responses
200
OK
400
Bad Request
*/*
put
/v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64}PUT /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
issuerOpenBadgeIdBase64stringRequired
Responses
204
Issuer deleted
400
Bad Request
*/*
delete
/v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64}DELETE /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault:
trueBody
namestring · max: 1024RequiredExample:
Name of the issuer
Credentials Facultyurlstring · uri · max: 1024RequiredExample:
Homepage or website associated with the Issuer
https://example.comimagestringOptionalExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/imagedescriptionstring · max: 16384RequiredExample:
Short description of the Issuer
This is the faculty of the Credentials University.badgrDomainstringOptional
Responses
200
OK
400
Bad Request
*/*
patch
/v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64}PATCH /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault:
trueResponses
200
OK
400
Bad Request
*/*
get
/v2/issuers/ref/{issuerOpenBadgeIdBase64}GET /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault:
trueBody
namestring · max: 1024RequiredExample:
Name of the issuer
Credentials Facultyurlstring · uri · max: 1024RequiredExample:
Homepage or website associated with the Issuer
https://example.comimagestringOptionalExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/imagedescriptionstring · max: 16384RequiredExample:
Short description of the Issuer
This is the faculty of the Credentials University.badgrDomainstringOptional
Responses
200
OK
400
Bad Request
*/*
put
/v2/issuers/ref/{issuerOpenBadgeIdBase64}PUT /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
issuerOpenBadgeIdBase64stringRequired
Responses
204
Issuer deleted
400
Bad Request
*/*
delete
/v2/issuers/ref/{issuerOpenBadgeIdBase64}DELETE /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault:
trueBody
namestring · max: 1024RequiredExample:
Name of the issuer
Credentials Facultyurlstring · uri · max: 1024RequiredExample:
Homepage or website associated with the Issuer
https://example.comimagestringOptionalExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/imagedescriptionstring · max: 16384RequiredExample:
Short description of the Issuer
This is the faculty of the Credentials University.badgrDomainstringOptional
Responses
200
OK
400
Bad Request
*/*
patch
/v2/issuers/ref/{issuerOpenBadgeIdBase64}PATCH /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200
OK
400
Bad Request
*/*
get
/v2/pathways/{id}/versions/draftGET /v2/pathways/{id}/versions/draft HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"pathwayId": "66aa04adf5afe00d0a6dac72",
"issuerId": "62aa04adf5afe00d0a6dac72",
"draftStructureVersion": 1,
"lastPublishedAt": "2025-12-06T11:35:48.008Z",
"draftLastUpdatedAt": "2025-12-06T11:35:48.008Z",
"creationDate": "2025-12-06T11:35:48.008Z",
"hasThirdPartyBadges": true,
"hasDraftChanges": true,
"preferences": {
"includeOnPublicPages": true
},
"root": {
"elementId": "65aa04adf5afe00d0a6dac72",
"name": "Math 101",
"shortCode": "M101",
"description": "Complete Math 101 course",
"alignmentUrl": "www.example.com/skills/E1",
"frameworkName": "OSMT",
"targetCode": "E1",
"completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
"requirements": {
"childElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
}
},
"nonChildElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
},
"elementIds": [
"text"
]
},
"badgeRequirements": {
"requiredBadges": [
{
"badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
"displayOrder": 0
}
]
},
"requiredCriteriaCount": 1,
"courseRequirements": {
"requiredCourses": [
{
"lms": "CANVAS",
"domain": "canvas.instructure.com",
"courseId": "123678",
"name": "Math 101",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"displayOrder": 0,
"url": "https://canvas.instructure.com/courses/123678"
}
]
},
"experienceRequirements": {
"requiredExperiences": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Conference",
"description": "Attend Instructure Conference 2025",
"displayOrder": 0
}
]
},
"shortcutBadges": [
"text"
],
"allowCompletionBadgeShortcut": true
},
"requiredForParentCompletion": true,
"children": []
}
}Authorizations
HTTPRequired
Path parameters
idstringRequired
Body
issuerIdstringRequired
Responses
200
OK
400
Bad Request
*/*
put
/v2/pathways/{id}/versions/draftPUT /v2/pathways/{id}/versions/draft HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1216
{
"issuerId": "text",
"root": {
"elementId": "65aa04adf5afe00d0a6dac72",
"name": "Math 101",
"shortCode": "M101",
"description": "Complete Math 101 course",
"alignmentUrl": "www.example.com/skills/E1",
"frameworkName": "OSMT",
"targetCode": "E1",
"completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
"requirements": {
"childElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
}
},
"nonChildElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
},
"elementIds": [
"text"
]
},
"badgeRequirements": {
"requiredBadges": [
{
"badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
"displayOrder": 0
}
]
},
"requiredCriteriaCount": 1,
"courseRequirements": {
"requiredCourses": [
{
"lms": "CANVAS",
"domain": "canvas.instructure.com",
"courseId": "123678",
"name": "Math 101",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"displayOrder": 0
}
]
},
"experienceRequirements": {
"requiredExperiences": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Conference",
"description": "Attend Instructure Conference 2025",
"displayOrder": 0
}
]
},
"shortcutBadges": [
"text"
],
"allowCompletionBadgeShortcut": true
},
"requiredForParentCompletion": true,
"children": []
}
}{
"pathwayId": "66aa04adf5afe00d0a6dac72",
"issuerId": "62aa04adf5afe00d0a6dac72",
"draftStructureVersion": 1,
"lastPublishedAt": "2025-12-06T11:35:48.008Z",
"draftLastUpdatedAt": "2025-12-06T11:35:48.008Z",
"creationDate": "2025-12-06T11:35:48.008Z",
"hasThirdPartyBadges": true,
"hasDraftChanges": true,
"preferences": {
"includeOnPublicPages": true
},
"root": {
"elementId": "65aa04adf5afe00d0a6dac72",
"name": "Math 101",
"shortCode": "M101",
"description": "Complete Math 101 course",
"alignmentUrl": "www.example.com/skills/E1",
"frameworkName": "OSMT",
"targetCode": "E1",
"completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
"requirements": {
"childElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
}
},
"nonChildElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
},
"elementIds": [
"text"
]
},
"badgeRequirements": {
"requiredBadges": [
{
"badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
"displayOrder": 0
}
]
},
"requiredCriteriaCount": 1,
"courseRequirements": {
"requiredCourses": [
{
"lms": "CANVAS",
"domain": "canvas.instructure.com",
"courseId": "123678",
"name": "Math 101",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"displayOrder": 0,
"url": "https://canvas.instructure.com/courses/123678"
}
]
},
"experienceRequirements": {
"requiredExperiences": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Conference",
"description": "Attend Instructure Conference 2025",
"displayOrder": 0
}
]
},
"shortcutBadges": [
"text"
],
"allowCompletionBadgeShortcut": true
},
"requiredForParentCompletion": true,
"children": []
}
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Query parameters
include_archivedbooleanOptionalDefault:
falseResponses
200
OK
400
Bad Request
*/*
get
/v2/badgeclasses/{idOrEntityId}GET /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Previously awarded Assertions will be updated with image rebaking
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
namestring · max: 1024RequiredExample:
Name of the BadgeClass
Math Expertdescriptionstring · max: 16384RequiredExample:
Short description of the BadgeClass
This badge is awarded to students who have demonstrated mastery of Math.imagestringRequiredExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/imageachievementTypestringOptionalExample:
The type of achievement
CoursecriteriaUrlstring · uriOptionalExample:
External URL that describes in a human-readable format the criteria for the BadgeClass
https://example.com/badge-classes/1/criteriacriteriaNarrativestringOptional
Markdown formatted description of the criteria
tagsstring[]Optional
List of tags that describe the BadgeClass
imageAltTextstringOptional
Responses
200
OK
400
Bad Request
*/*
put
/v2/badgeclasses/{idOrEntityId}PUT /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 996
{
"name": "Math Expert",
"description": "This badge is awarded to students who have demonstrated mastery of Math.",
"image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
"achievementType": "Course",
"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"
},
"imageAltText": "text"
}{
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Restricted to owners or editors (not staff) of the corresponding Issuer.
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Query parameters
hard_deletestringOptional
archivalNotestringOptional
Responses
204
BadgeClass deleted
400
Bad Request
*/*
delete
/v2/badgeclasses/{idOrEntityId}DELETE /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
claimCodestringRequired
Body
labelstringOptionalExample:
The label of the claim code
Conference Eventlimitinteger · int64OptionalExample:
The number of times the claim code can be used
10expirationDatestring · date-timeOptional
Responses
200
OK
400
Bad Request
*/*
put
/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}PUT /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"label": "Conference Event",
"limit": 10,
"expirationDate": "2025-12-06T11:35:48.008Z"
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"code": "5678945",
"createdAt": "2025-12-06T11:35:48.008Z",
"label": "Conference Event",
"limit": 10,
"expirationDate": "2025-12-06T11:35:48.008Z",
"enabled": true,
"claimCount": 1,
"claimUrl": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
claimCodestringRequired
Responses
204
No Content
400
Bad Request
*/*
delete
/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}DELETE /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
refstringRequired
Query parameters
include_archivedbooleanOptionalDefault:
falseResponses
200
OK
400
Bad Request
*/*
get
/v2/badgeclasses/ref/{ref}GET /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Previously awarded Assertions will be updated with image rebaking
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
refstringRequired
Body
namestring · max: 1024RequiredExample:
Name of the BadgeClass
Math Expertdescriptionstring · max: 16384RequiredExample:
Short description of the BadgeClass
This badge is awarded to students who have demonstrated mastery of Math.imagestringRequiredExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/imageachievementTypestringOptionalExample:
The type of achievement
CoursecriteriaUrlstring · uriOptionalExample:
External URL that describes in a human-readable format the criteria for the BadgeClass
https://example.com/badge-classes/1/criteriacriteriaNarrativestringOptional
Markdown formatted description of the criteria
tagsstring[]Optional
List of tags that describe the BadgeClass
imageAltTextstringOptional
Responses
200
OK
400
Bad Request
*/*
put
/v2/badgeclasses/ref/{ref}PUT /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 996
{
"name": "Math Expert",
"description": "This badge is awarded to students who have demonstrated mastery of Math.",
"image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
"achievementType": "Course",
"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"
},
"imageAltText": "text"
}{
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Restricted to owners or editors (not staff) of the corresponding Issuer.
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
refstringRequired
Query parameters
hard_deletestringOptional
archivalNotestringOptional
Responses
204
BadgeClass deleted
400
Bad Request
*/*
delete
/v2/badgeclasses/ref/{ref}DELETE /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : List assertions in your backpack
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
get
/v2/backpack/collections/{idOrEntityId}GET /v2/backpack/collections/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6116c84d1ff787222b6c4d15",
"entityId": "dwUFfLWhQ3CutEowC1LB7g",
"name": "My Collection",
"description": "This is a collection of my favorite badges",
"share_url": "https://example.com/collections/1",
"shareHash": "text",
"published": true,
"owner": "UQbhRmNrQ4qn9_FJ5-eTtA",
"assertions": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"credentials": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"entityType": "BackpackCollection"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
namestringOptionalExample:
Name of the collection
My CollectiondescriptionstringOptionalExample:
Short description of the Collection
This is a collection of my favorite badgespublishedbooleanOptionalExample:
True if the Collection should have a share url
trueassertionsstring[]OptionalExample:
The IDs or entity IDs of the assertions associated with this Collection
UQbhRmNrQ4qn9_FJ5-eTtAcredentialsstring[]OptionalExample:
The IDs or entity IDs of the credentials associated with this Collection
UQbhRmNrQ4qn9_FJ5-eTtAResponses
200
OK
*/*
400
Bad Request
*/*
put
/v2/backpack/collections/{idOrEntityId}PUT /v2/backpack/collections/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181
{
"name": "My Collection",
"description": "This is a collection of my favorite badges",
"published": true,
"assertions": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"credentials": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
]
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6116c84d1ff787222b6c4d15",
"entityId": "dwUFfLWhQ3CutEowC1LB7g",
"name": "My Collection",
"description": "This is a collection of my favorite badges",
"share_url": "https://example.com/collections/1",
"shareHash": "text",
"published": true,
"owner": "UQbhRmNrQ4qn9_FJ5-eTtA",
"assertions": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"credentials": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"entityType": "BackpackCollection"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
delete
/v2/backpack/collections/{idOrEntityId}DELETE /v2/backpack/collections/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Required scopes
This endpoint requires the following scopes:
- : List assertions in your backpack
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Query parameters
Responses
200
OK
*/*
400
Bad Request
*/*
get
/v2/backpack/assertions/{idOrEntityId}GET /v2/backpack/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
put
/v2/backpack/assertions/{idOrEntityId}PUT /v2/backpack/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
delete
/v2/backpack/assertions/{idOrEntityId}DELETE /v2/backpack/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Responses
200
OK
400
Bad Request
*/*
get
/v2/assertions/{idOrEntityId}GET /v2/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
narrativestringOptional
Markdown narrative of the achievement
expiresstring · date-timeOptional
issuedOnstring · date-timeOptional
Timestamp when the assertion was issued
Responses
200
OK
400
Bad Request
*/*
put
/v2/assertions/{idOrEntityId}PUT /v2/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 408
{
"narrative": "text",
"evidence": [
{
"url": "text",
"narrative": "text",
"name": "text",
"description": "text",
"genre": "text",
"audience": "text"
}
],
"extensions": {
"value": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"expires": "2025-12-06T11:35:48.008Z",
"issuedOn": "2025-12-06T11:35:48.008Z",
"ob3AwardProperties": {
"activityStart": "2025-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
revocation_reasonstringOptional
Responses
200
OK
400
Bad Request
*/*
delete
/v2/assertions/{idOrEntityId}DELETE /v2/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"revocation_reason": "text"
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"entityType": "Assertion",
"id": "6116c84d1ff787222b6c4d15",
"entityId": "i9CirfwJTuSfiqg0FFUBdQ",
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"createdAt": "2025-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
scopestring · enumRequiredPossible values:
idOrEntityIdstringRequired
Query parameters
recipientstringOptional
A recipient identifier to filter by
numinteger · int32Optional
Request pagination of results, before/after cursors may be provided in response header
include_expiredbooleanOptionalDefault:
falseinclude_revokedbooleanOptionalDefault:
falseafterstringOptional
Pagination cursor provided in "Link" response header
beforestringOptional
Pagination cursor provided in "Link" response header
Responses
200
List of Assertions
400
Bad Request
*/*
get
/v2/{scope}/{idOrEntityId}/assertionsGET /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
scopestring · enumRequiredPossible values:
idOrEntityIdstringRequiredExample:
The entity ID of the selected scope entity
K829IK8RS6ercwkpeFOn-QBody
Request to award an assertion. When request scope is issuers, one of badgeclass or badgeclassOpenBadgeId must be provided.
badgeclassstringOptionalExample:
ID or Entity ID of the badge class to be awarded
K829IK8RS6ercwkpeFOn-QbadgeclassOpenBadgeIdstring · uriOptionalExample:
OB URL of the badge class to be awarded
https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-QissuedOnstring · date-timeOptional
Timestamp when the assertion was issued
allowDuplicateAwardsbooleanOptional
If set to false and the recipient already has this assertion, then the request will fail
narrativestringOptional
Markdown narrative of the achievement
expiresstring · date-timeOptional
Responses
201
Created
400
Bad Request
*/*
post
/v2/{scope}/{idOrEntityId}/assertionsPOST /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"ob3AwardProperties": {
"activityStart": "2025-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Authorizations
HTTPRequired
Body
issuerIdstringRequiredExample:
ID of the issuer where the pathway will be created
62aa04adf5afe00d0a6dac72Responses
200
OK
400
Bad Request
*/*
post
/v2/pathwaysPOST /v2/pathways HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1285
{
"issuerId": "62aa04adf5afe00d0a6dac72",
"preferences": {
"includeOnPublicPages": true
},
"draftRoot": {
"elementId": "65aa04adf5afe00d0a6dac72",
"name": "Math 101",
"shortCode": "M101",
"description": "Complete Math 101 course",
"alignmentUrl": "www.example.com/skills/E1",
"frameworkName": "OSMT",
"targetCode": "E1",
"completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
"requirements": {
"childElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
}
},
"nonChildElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
},
"elementIds": [
"text"
]
},
"badgeRequirements": {
"requiredBadges": [
{
"badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
"displayOrder": 0
}
]
},
"requiredCriteriaCount": 1,
"courseRequirements": {
"requiredCourses": [
{
"lms": "CANVAS",
"domain": "canvas.instructure.com",
"courseId": "123678",
"name": "Math 101",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"displayOrder": 0
}
]
},
"experienceRequirements": {
"requiredExperiences": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Conference",
"description": "Attend Instructure Conference 2025",
"displayOrder": 0
}
]
},
"shortcutBadges": [
"text"
],
"allowCompletionBadgeShortcut": true
},
"requiredForParentCompletion": true,
"children": []
}
}{
"pathwayId": "66aa04adf5afe00d0a6dac72",
"issuerId": "62aa04adf5afe00d0a6dac72",
"draftStructureVersion": 1,
"lastPublishedAt": "2025-12-06T11:35:48.008Z",
"draftLastUpdatedAt": "2025-12-06T11:35:48.008Z",
"creationDate": "2025-12-06T11:35:48.008Z",
"hasThirdPartyBadges": true,
"hasDraftChanges": true,
"preferences": {
"includeOnPublicPages": true
},
"root": {
"elementId": "65aa04adf5afe00d0a6dac72",
"name": "Math 101",
"shortCode": "M101",
"description": "Complete Math 101 course",
"alignmentUrl": "www.example.com/skills/E1",
"frameworkName": "OSMT",
"targetCode": "E1",
"completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
"requirements": {
"childElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
}
},
"nonChildElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
},
"elementIds": [
"text"
]
},
"badgeRequirements": {
"requiredBadges": [
{
"badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
"displayOrder": 0
}
]
},
"requiredCriteriaCount": 1,
"courseRequirements": {
"requiredCourses": [
{
"lms": "CANVAS",
"domain": "canvas.instructure.com",
"courseId": "123678",
"name": "Math 101",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"displayOrder": 0,
"url": "https://canvas.instructure.com/courses/123678"
}
]
},
"experienceRequirements": {
"requiredExperiences": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Conference",
"description": "Attend Instructure Conference 2025",
"displayOrder": 0
}
]
},
"shortcutBadges": [
"text"
],
"allowCompletionBadgeShortcut": true
},
"requiredForParentCompletion": true,
"children": []
}
}Authorizations
HTTPRequired
Path parameters
pathwayIdstringRequired
experienceIdstring · uuidRequired
Body
recipientone ofRequired
all ofOptional
all ofOptional
all ofOptional
passedbooleanRequired
Responses
204
No Content
400
Bad Request
*/*
post
/v2/pathways/{pathwayId}/experience/{experienceId}/submitPOST /v2/pathways/{pathwayId}/experience/{experienceId}/submit HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72
{
"recipient": {
"email": "[email protected]",
"@type": "email"
},
"passed": true
}No content
CSV file should contain recipientId,passed header row. Each row should contain a single entry of recipientId (email:[email protected]) and a passed value (true/false) separated by a comma.
Authorizations
HTTPRequired
Path parameters
pathwayIdstringRequired
experienceIdstring · uuidRequired
Body
stringOptionalExample:
recipientId,passed email:[email protected],trueResponses
200
OK
400
Bad Request
*/*
post
/v2/pathways/{pathwayId}/experience/{experienceId}/submit-csvPOST /v2/pathways/{pathwayId}/experience/{experienceId}/submit-csv HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: text/csv
Accept: */*
Content-Length: 51
"recipientId,passed\nemail:[email protected],true\n"{
"errors": [
{
"recipientId": {
"email": "[email protected]",
"@type": "email"
},
"error": "NOT_SUBSCRIBED"
}
],
"successes": [
{
"email": "[email protected]",
"@type": "email"
}
]
}Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200
OK
400
Bad Request
*/*
get
/v2/pathways/{id}/versions/publishedGET /v2/pathways/{id}/versions/published HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"pathwayId": "66aa04adf5afe00d0a6dac72",
"issuerId": "62aa04adf5afe00d0a6dac72",
"draftStructureVersion": 1,
"lastPublishedAt": "2025-12-06T11:35:48.008Z",
"draftLastUpdatedAt": "2025-12-06T11:35:48.008Z",
"creationDate": "2025-12-06T11:35:48.008Z",
"hasThirdPartyBadges": true,
"hasDraftChanges": true,
"preferences": {
"includeOnPublicPages": true
},
"root": {
"elementId": "65aa04adf5afe00d0a6dac72",
"name": "Math 101",
"shortCode": "M101",
"description": "Complete Math 101 course",
"alignmentUrl": "www.example.com/skills/E1",
"frameworkName": "OSMT",
"targetCode": "E1",
"completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
"requirements": {
"childElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
}
},
"nonChildElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
},
"elementIds": [
"text"
]
},
"badgeRequirements": {
"requiredBadges": [
{
"badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
"displayOrder": 0
}
]
},
"requiredCriteriaCount": 1,
"courseRequirements": {
"requiredCourses": [
{
"lms": "CANVAS",
"domain": "canvas.instructure.com",
"courseId": "123678",
"name": "Math 101",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"displayOrder": 0,
"url": "https://canvas.instructure.com/courses/123678"
}
]
},
"experienceRequirements": {
"requiredExperiences": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Conference",
"description": "Attend Instructure Conference 2025",
"displayOrder": 0
}
]
},
"shortcutBadges": [
"text"
],
"allowCompletionBadgeShortcut": true
},
"requiredForParentCompletion": true,
"children": []
}
}Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200
OK
400
Bad Request
*/*
post
/v2/pathways/{id}/versions/publishedPOST /v2/pathways/{id}/versions/published HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"pathwayId": "66aa04adf5afe00d0a6dac72",
"issuerId": "62aa04adf5afe00d0a6dac72",
"draftStructureVersion": 1,
"lastPublishedAt": "2025-12-06T11:35:48.008Z",
"draftLastUpdatedAt": "2025-12-06T11:35:48.008Z",
"creationDate": "2025-12-06T11:35:48.008Z",
"hasThirdPartyBadges": true,
"hasDraftChanges": true,
"preferences": {
"includeOnPublicPages": true
},
"root": {
"elementId": "65aa04adf5afe00d0a6dac72",
"name": "Math 101",
"shortCode": "M101",
"description": "Complete Math 101 course",
"alignmentUrl": "www.example.com/skills/E1",
"frameworkName": "OSMT",
"targetCode": "E1",
"completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
"requirements": {
"childElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
}
},
"nonChildElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
},
"elementIds": [
"text"
]
},
"badgeRequirements": {
"requiredBadges": [
{
"badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
"displayOrder": 0
}
]
},
"requiredCriteriaCount": 1,
"courseRequirements": {
"requiredCourses": [
{
"lms": "CANVAS",
"domain": "canvas.instructure.com",
"courseId": "123678",
"name": "Math 101",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"displayOrder": 0,
"url": "https://canvas.instructure.com/courses/123678"
}
]
},
"experienceRequirements": {
"requiredExperiences": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Conference",
"description": "Attend Instructure Conference 2025",
"displayOrder": 0
}
]
},
"shortcutBadges": [
"text"
],
"allowCompletionBadgeShortcut": true
},
"requiredForParentCompletion": true,
"children": []
}
}Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200
OK
400
Bad Request
*/*
post
/v2/pathways/{id}/versions/draft/revertPOST /v2/pathways/{id}/versions/draft/revert HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"pathwayId": "66aa04adf5afe00d0a6dac72",
"issuerId": "62aa04adf5afe00d0a6dac72",
"draftStructureVersion": 1,
"lastPublishedAt": "2025-12-06T11:35:48.008Z",
"draftLastUpdatedAt": "2025-12-06T11:35:48.008Z",
"creationDate": "2025-12-06T11:35:48.008Z",
"hasThirdPartyBadges": true,
"hasDraftChanges": true,
"preferences": {
"includeOnPublicPages": true
},
"root": {
"elementId": "65aa04adf5afe00d0a6dac72",
"name": "Math 101",
"shortCode": "M101",
"description": "Complete Math 101 course",
"alignmentUrl": "www.example.com/skills/E1",
"frameworkName": "OSMT",
"targetCode": "E1",
"completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
"requirements": {
"childElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
}
},
"nonChildElementRequirements": {
"countRule": {
"notRequiredCount": 1,
"@type": "allButN"
},
"elementIds": [
"text"
]
},
"badgeRequirements": {
"requiredBadges": [
{
"badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw",
"displayOrder": 0
}
]
},
"requiredCriteriaCount": 1,
"courseRequirements": {
"requiredCourses": [
{
"lms": "CANVAS",
"domain": "canvas.instructure.com",
"courseId": "123678",
"name": "Math 101",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"displayOrder": 0,
"url": "https://canvas.instructure.com/courses/123678"
}
]
},
"experienceRequirements": {
"requiredExperiences": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Conference",
"description": "Attend Instructure Conference 2025",
"displayOrder": 0
}
]
},
"shortcutBadges": [
"text"
],
"allowCompletionBadgeShortcut": true
},
"requiredForParentCompletion": true,
"children": []
}
}Authorizations
HTTPRequired
Path parameters
idstringRequired
Body
groupIdsToAddstring[]RequiredExample:
61aa04adf5afe00d0a6dac72groupIdsToRemovestring[]RequiredExample:
67aa04adf5afe00d0a6dac72Responses
200
OK
No content
400
Bad Request
*/*
post
/v2/pathways/{id}/subscriptionsPOST /v2/pathways/{id}/subscriptions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"groupIdsToAdd": [
"61aa04adf5afe00d0a6dac72"
],
"groupIdsToRemove": [
"67aa04adf5afe00d0a6dac72"
]
}No content
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Query parameters
include_staffstringOptionalDefault:
trueResponses
200
OK
400
Bad Request
*/*
get
/v2/issuersGET /v2/issuers HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Query parameters
include_staffstringOptionalDefault:
trueBody
namestring · max: 1024RequiredExample:
Name of the issuer
Credentials Facultyurlstring · uri · max: 1024RequiredExample:
Homepage or website associated with the Issuer
https://example.comsourceUrlstring · uriOptionalExample:
The original URL of the issuer if it was imported
https://example.com/issuers/1originalJsonstring · max: 2000000OptionalExample:
The original OB JSON of the issuer if it was imported
{}imagestringOptionalExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/imagedescriptionstring · max: 16384OptionalExample:
Short description of the Issuer
This is the faculty of the Credentials University.badgrDomainstringOptionalExample:
Organization domain host
badgrsupportgroup.badgr.comcreatedBystringOptional
User who created this issuer
organizationIdstringOptionalExample:
The ID of the organization which this issuer should be associated with. Requires organization write access.
6f4e4e4e2dc038241ad01d83Responses
201
Issuer created
400
Bad Request
*/*
post
/v2/issuersPOST /v2/issuers HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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/",
"linkMode": "DEFAULT",
"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-12-06T11:35:48.008Z",
"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.
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
rolestring · enumRequiredPossible values:
Role of the user in the issuer.
Responses
200
OK
*/*
400
Bad Request
*/*
post
/v2/issuers/{idOrEntityId}/staff/invitationsPOST /v2/issuers/{idOrEntityId}/staff/invitations HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Query parameters
include_archivedbooleanOptionalDefault:
falseResponses
200
OK
400
Bad Request
*/*
get
/v2/issuers/{idOrEntityId}/badgeclassesGET /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
issuerstringOptionalExample:
Entity ID of the issuer
ZvYydoQhRtOKalNzFPZR2A-Qnamestring · max: 1024RequiredExample:
Name of the BadgeClass
Math ExpertimagestringRequiredExample:
Image of the issuer. An URL or a bas64 encoded images.
https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/imageachievementTypestringOptionalExample:
The type of achievement
Coursedescriptionstring · max: 16384RequiredExample:
Short description of the BadgeClass
This badge is awarded to students who have demonstrated mastery of Math.criteriaUrlstring · uriOptionalExample:
External URL that describes in a human-readable format the criteria for the BadgeClass
https://example.com/badge-classes/1/criteriacriteriaNarrativestringOptional
Markdown formatted description of the criteria
tagsstring[]Optional
List of tags that describe the BadgeClass
imageAltTextstringOptional
Responses
201
Created
400
Bad Request
*/*
post
/v2/issuers/{idOrEntityId}/badgeclassesPOST /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1032
{
"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"
},
"imageAltText": "text"
}{
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Query parameters
include_archivedbooleanOptionalDefault:
falseResponses
200
OK
400
Bad Request
*/*
get
/v2/badgeclassesGET /v2/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Body
issuerstringRequiredExample:
Entity ID of the issuer
ZvYydoQhRtOKalNzFPZR2A-Qnamestring · max: 1024RequiredExample:
Name of the BadgeClass
Math Expertdescriptionstring · max: 16384RequiredExample:
Short description of the BadgeClass
This badge is awarded to students who have demonstrated mastery of Math.imagestringRequiredExample:
Image of the issuer. An URL or a bas64 encoded images.
https://example.com/images/1achievementTypestringOptionalExample:
The type of achievement
CoursecriteriaUrlstring · uriOptionalExample:
External URL that describes in a human-readable format the criteria for the BadgeClass
https://example.com/badge-classes/1/criteriacriteriaNarrativestringOptional
Markdown formatted description of the criteria
tagsstring[]Optional
List of tags that describe the BadgeClass
imageAltTextstringOptional
Responses
201
BadgeClass created
400
Bad Request
*/*
post
/v2/badgeclassesPOST /v2/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 997
{
"issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
"name": "Math Expert",
"description": "This badge is awarded to students who have demonstrated mastery of Math.",
"image": "https://example.com/images/1",
"achievementType": "Course",
"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"
},
"imageAltText": "text"
}{
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Create a duplicate of the original BadgeClass with a new name
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
newNamestringRequiredExample:
The new name for the duplicate badgeclass
Badgeclass CopyResponses
201
BadgeClass created
400
Bad Request
*/*
post
/v2/badgeclasses/{idOrEntityId}/duplicatePOST /v2/badgeclasses/{idOrEntityId}/duplicate HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"newName": "Badgeclass Copy"
}{
"id": "68e9d238c5afe622816febb3",
"entityType": "BadgeClass",
"entityId": "iOMWsaF1QbmMCofM54JlUg",
"openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
"sourceUrl": "https://example.com/badge-classes/1",
"originalJson": "{}",
"createdAt": "2025-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Query parameters
includeClaimCodeCountbooleanOptional
Responses
200
OK
400
Bad Request
*/*
get
/v2/badgeclasses/{idOrEntityId}/claim-codesGET /v2/badgeclasses/{idOrEntityId}/claim-codes HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"code": "5678945",
"createdAt": "2025-12-06T11:35:48.008Z",
"label": "Conference Event",
"limit": 10,
"expirationDate": "2025-12-06T11:35:48.008Z",
"enabled": true,
"claimCount": 1,
"claimUrl": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Body
labelstringOptionalExample:
The label of the claim code
Conference Eventlimitinteger · int64OptionalExample:
The number of times the claim code can be used
10expirationDatestring · date-timeOptional
Responses
201
Created
400
Bad Request
*/*
post
/v2/badgeclasses/{idOrEntityId}/claim-codesPOST /v2/badgeclasses/{idOrEntityId}/claim-codes HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"label": "Conference Event",
"limit": 10,
"expirationDate": "2025-12-06T11:35:48.008Z"
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"code": "5678945",
"createdAt": "2025-12-06T11:35:48.008Z",
"label": "Conference Event",
"limit": 10,
"expirationDate": "2025-12-06T11:35:48.008Z",
"enabled": true,
"claimCount": 1,
"claimUrl": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Reactivate a BadgeClass that was archived
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
Responses
200
OK
400
Bad Request
*/*
post
/v2/badgeclasses/reactivate/{idOrEntityId}POST /v2/badgeclasses/reactivate/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Reactivate an archived BadgeClass by its base64 encoded OpenBadge ID
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
refstringRequired
Responses
200
OK
400
Bad Request
*/*
post
/v2/badgeclasses/reactivate/ref/{ref}POST /v2/badgeclasses/reactivate/ref/{ref} HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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"
},
"imageAltText": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Upload a new Assertion to the backpack using url, image or OpenBadge JSON
Required scopes
This endpoint requires the following scopes:
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Body
urlstring · uriOptionalExample:
URL of the badge to import
https://example.com/assertions/1assertionobjectOptional
OpenBadge JSON of the award to import
imagestringOptionalExample:
Image URL or base64 encoded image data of the assertion.
https://example.com/assertions/1/imageResponses
201
Created
*/*
400
Bad Request
*/*
post
/v2/backpack/importPOST /v2/backpack/import HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"url": "https://example.com/assertions/1",
"assertion": {},
"image": "https://example.com/assertions/1/image"
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"entityType": "Assertion",
"id": "6116c84d1ff787222b6c4d15",
"entityId": "i9CirfwJTuSfiqg0FFUBdQ",
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"createdAt": "2025-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : List assertions in your backpack
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Responses
200
OK
*/*
400
Bad Request
*/*
get
/v2/backpack/collectionsGET /v2/backpack/collections HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6116c84d1ff787222b6c4d15",
"entityId": "dwUFfLWhQ3CutEowC1LB7g",
"name": "My Collection",
"description": "This is a collection of my favorite badges",
"share_url": "https://example.com/collections/1",
"shareHash": "text",
"published": true,
"owner": "UQbhRmNrQ4qn9_FJ5-eTtA",
"assertions": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"credentials": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"entityType": "BackpackCollection"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Body
namestringRequiredExample:
Name of the collection
My CollectiondescriptionstringOptionalExample:
Short description of the Collection
This is a collection of my favorite badgespublishedbooleanRequiredExample:
True if the Collection should have a share url
trueResponses
201
Created
*/*
400
Bad Request
*/*
post
/v2/backpack/collectionsPOST /v2/backpack/collections HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100
{
"name": "My Collection",
"description": "This is a collection of my favorite badges",
"published": true
}{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "6116c84d1ff787222b6c4d15",
"entityId": "dwUFfLWhQ3CutEowC1LB7g",
"name": "My Collection",
"description": "This is a collection of my favorite badges",
"share_url": "https://example.com/collections/1",
"shareHash": "text",
"published": true,
"owner": "UQbhRmNrQ4qn9_FJ5-eTtA",
"assertions": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"credentials": [
"UQbhRmNrQ4qn9_FJ5-eTtA"
],
"entityType": "BackpackCollection"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Bodyobject[]
idstringOptionalExample:
ID of the Assertion to revoke
62aa04adf5afe00d0a6dac72entityIdstringOptionalExample:
Entity ID of the Assertion to revoke
i9CirfwJTuSfiqg0FFUBdQrevocationReasonstringRequiredExample:
Short description of why the Assertion is being revoked
Course was cancelledrevokedbooleanRead-onlyOptional
reasonstringRead-onlyOptional
Error reason if assertion could not be revoked
codestringRead-onlyOptional
Error code if assertion could not be revoked
Responses
200
OK
400
Bad Request
*/*
post
/v2/assertions/revokePOST /v2/assertions/revoke HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113
[
{
"id": "62aa04adf5afe00d0a6dac72",
"entityId": "i9CirfwJTuSfiqg0FFUBdQ",
"revocationReason": "Course was cancelled"
}
][
{
"id": "62aa04adf5afe00d0a6dac72",
"entityId": "i9CirfwJTuSfiqg0FFUBdQ",
"revocationReason": "Course was cancelled",
"revoked": true,
"reason": "text",
"code": "text"
}
]Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
claimCodestringRequired
Responses
200
OK
400
Bad Request
*/*
patch
/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/enablePATCH /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/enable HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"code": "5678945",
"createdAt": "2025-12-06T11:35:48.008Z",
"label": "Conference Event",
"limit": 10,
"expirationDate": "2025-12-06T11:35:48.008Z",
"enabled": true,
"claimCount": 1,
"claimUrl": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
claimCodestringRequired
Responses
200
OK
400
Bad Request
*/*
patch
/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/disablePATCH /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/disable HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"code": "5678945",
"createdAt": "2025-12-06T11:35:48.008Z",
"label": "Conference Event",
"limit": 10,
"expirationDate": "2025-12-06T11:35:48.008Z",
"enabled": true,
"claimCount": 1,
"claimUrl": "text"
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Authorizations
HTTPRequired
Path parameters
idstringRequired
Query parameters
recipientIdentifierstringRequiredExample:
Identifier of the recipient, format: recipientType:recipientId
email:[email protected]Responses
200
OK
400
Bad Request
*/*
get
/v2/pathways/{id}/recipient-progressGET /v2/pathways/{id}/recipient-progress?recipientIdentifier=text HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "61aa04adf5afe00d0a6dac72",
"scope": {
"identifier": {
"email": "[email protected]",
"@type": "email"
},
"@type": "recipient"
},
"pathwayId": "66aa04adf5afe00d0a6dac72",
"calculationInfo": {
"staleBeforeVersion": 1,
"stale": true,
"computedVersion": 1,
"computedDate": "2025-12-06T11:35:48.008Z",
"computedPublishedStructureVersion": 1
},
"progress": {
"endProgress": {
"status": "COMPLETED",
"required": 10,
"completed": 4,
"failed": 1,
"inProgress": 3,
"notStarted": 2
},
"elementProgress": {
"ANY_ADDITIONAL_PROPERTY": {
"status": "COMPLETED",
"cappedProgress": {
"required": 5,
"completed": 1,
"inProgress": 1,
"failed": 2,
"preRequisiteStepFailed": 1,
"directRequirementFailed": 1,
"notStarted": 1
},
"completionBadgeNewlyAwarded": true,
"completedByShortcut": true,
"badgeProgress": {
"earnedBadges": [
"https://api.staging.badgr.dev/public/badges/2Lkni4uvRjGqlz8zCg_5uA"
],
"maxBadgeCount": 1
},
"courseProgress": {
"earnedCriteria": [
{
"lms": "CANVAS",
"domain": "text",
"courseId": "text",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
},
"evaluatedAt": "2025-12-06T11:35:48.008Z"
}
]
},
"experienceProgress": {
"evaluations": [
{
"experienceId": "123e4567-e89b-12d3-a456-426614174000",
"passed": true,
"lastEvaluatedAt": "2025-12-06T11:35:48.008Z"
}
]
}
}
}
}
}Authorizations
HTTPRequired
Path parameters
idstringRequired
recipientGroupIdstringRequired
Responses
200
OK
400
Bad Request
*/*
get
/v2/pathways/{id}/recipient-groups/{recipientGroupId}/progressGET /v2/pathways/{id}/recipient-groups/{recipientGroupId}/progress HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "61aa04adf5afe00d0a6dac72",
"scope": {
"recipientGroupId": "text",
"@type": "groupAggregate"
},
"pathwayId": "66aa04adf5afe00d0a6dac72",
"calculationInfo": {
"staleBeforeVersion": 1,
"stale": true,
"computedVersion": 1,
"computedDate": "2025-12-06T11:35:48.008Z",
"computedPublishedStructureVersion": 1
},
"progressAggregate": {
"elementProgress": {
"ANY_ADDITIONAL_PROPERTY": {
"overallProgress": {
"progress": {
"completedValue": 1,
"requiredValue": 2,
"failedValue": 1,
"maxValue": 1
},
"notStartedCount": 1,
"inProgressCount": 1,
"failedCount": 1,
"completedCount": 1
},
"experienceProgress": {
"experienceIdsWithFailedRecipients": [
"123e4567-e89b-12d3-a456-426614174000"
],
"experienceIdsWithNotEvaluatedRecipients": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"courseProgress": {
"byRequirements": [
{
"requirementId": {
"lms": "CANVAS",
"domain": "text",
"courseId": "text",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
}
},
"completed": 5
}
]
}
}
}
}
}Authorizations
HTTPRequired
Path parameters
idstringRequired
Responses
200
OK
400
Bad Request
*/*
get
/v2/pathways/{id}/aggregate-progressGET /v2/pathways/{id}/aggregate-progress HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "61aa04adf5afe00d0a6dac72",
"pathwayId": "66aa04adf5afe00d0a6dac72",
"calculationInfo": {
"staleBeforeVersion": 1,
"stale": true,
"computedVersion": 1,
"computedDate": "2025-12-06T11:35:48.008Z",
"computedPublishedStructureVersion": 1
},
"progressAggregate": {
"elementProgress": {
"ANY_ADDITIONAL_PROPERTY": {
"overallProgress": {
"progress": {
"completedValue": 1,
"requiredValue": 2,
"failedValue": 1,
"maxValue": 1
},
"notStartedCount": 1,
"inProgressCount": 1,
"failedCount": 1,
"completedCount": 1
},
"experienceProgress": {
"experienceIdsWithFailedRecipients": [
"123e4567-e89b-12d3-a456-426614174000"
],
"experienceIdsWithNotEvaluatedRecipients": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"courseProgress": {
"byRequirements": [
{
"requirementId": {
"lms": "CANVAS",
"domain": "text",
"courseId": "text",
"completionRequirement": {
"doNotAwardBefore": "2025-12-06T11:35:48.008Z",
"@type": "completed"
}
},
"completed": 5
}
]
}
}
}
}
}Required scopes
This endpoint requires the following scopes:
- : Read organization data
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Responses
200
OK
400
Bad Request
*/*
get
/v2/organizationsGET /v2/organizations HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"organizations": [
{
"id": "67ae3efe2ee1d96b56fc1957",
"name": "University of Credentials",
"profile": {
"url": "https://www.example.com",
"email": "[email protected]",
"description": "A university that issues credentials.",
"imageUrl": "https://www.example.com/logo.png"
}
}
]
}Required scopes
This endpoint requires the following scopes:
- : List assertions in your backpack
- : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Query parameters
Responses
200
OK
*/*
400
Bad Request
*/*
get
/v2/backpack/assertionsGET /v2/backpack/assertions HTTP/1.1
Host: api.badges.parchment.com
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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"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-12-06T11:35:48.008Z",
"activityEnd": "2025-12-06T11:35:48.008Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-12-06T11:35:48.008Z",
"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.
Required scopes
This endpoint requires the following scopes:
- : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequiredAuthorization URL: Token URL:
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Path parameters
idOrEntityIdstringRequired
emailBase64stringRequired
Base64 encoded email address of the staff member
Responses
204
Staff member removed
*/*
400
Bad Request
*/*
delete
/v2/issuers/{idOrEntityId}/staff/{emailBase64}DELETE /v2/issuers/{idOrEntityId}/staff/{emailBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"timestamp": "2025-12-06T11:35:48.008Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Last updated
Was this helpful?