Backpack
- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
OK
Bad Request
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-11-12T19:49:13.243Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Name of the collection
My CollectionShort description of the Collection
This is a collection of my favorite badgesTrue if the Collection should have a share url
trueThe IDs or entity IDs of the assertions associated with this Collection
UQbhRmNrQ4qn9_FJ5-eTtAThe IDs or entity IDs of the credentials associated with this Collection
UQbhRmNrQ4qn9_FJ5-eTtAOK
Bad Request
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-11-12T19:49:13.243Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
No Content
Bad Request
DELETE /v2/backpack/collections/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
OK
Bad Request
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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"activityEnd": "2025-11-12T19:49:13.243Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-11-12T19:49:13.243Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
OK
Bad Request
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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"activityEnd": "2025-11-12T19:49:13.243Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-11-12T19:49:13.243Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
No Content
Bad Request
DELETE /v2/backpack/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Upload a new Assertion to the backpack using url, image or OpenBadge JSON
- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
URL of the badge to import
https://example.com/assertions/1OpenBadge JSON of the award to import
Image URL or base64 encoded image data of the assertion.
https://example.com/assertions/1/imageCreated
Bad Request
POST /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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"activityEnd": "2025-11-12T19:49:13.243Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-11-12T19:49:13.243Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
OK
Bad Request
GET /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-11-12T19:49:13.243Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Name of the collection
My CollectionShort description of the Collection
This is a collection of my favorite badgesTrue if the Collection should have a share url
trueCreated
Bad Request
POST /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-11-12T19:49:13.243Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}- : See who you are
- : Update your profile
- : Read badge classes and assertions in your issuers
- : Award badges and update your issuers
- : List assertions in your backpack
- : Upload badges to your backpack
- : Read organization data
- : Associate issuers with your organization and update organization data
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
OK
Bad Request
GET /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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"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-11-12T19:49:13.243Z",
"activityEnd": "2025-11-12T19:49:13.243Z",
"licenseNumber": "text",
"role": "text"
}
}
],
"timestamp": "2025-11-12T19:49:13.243Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}Last updated
Was this helpful?