For the complete documentation index, see llms.txt. This page is also available as Markdown.

Backpack

Get a list of Assertions in authenticated user's backpack

get
Required scopes
This endpoint requires the following scopes:
  • : List assertions in your backpack
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Query parameters
Responses
200

OK

*/*
errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/backpack/assertions

Remove an assertion from the backpack

delete
Required scopes
This endpoint requires the following scopes:
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Responses
204

No Content

No content

delete/v2/backpack/assertions/{idOrEntityId}

No content

Get detail on an Assertion in the user's Backpack

get
Required scopes
This endpoint requires the following scopes:
  • : List assertions in your backpack
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Query parameters
Responses
200

OK

*/*
errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/backpack/assertions/{idOrEntityId}

Update acceptance of an Assertion in the user's Backpack

put
Required scopes
This endpoint requires the following scopes:
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Responses
200

OK

*/*
errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
put/v2/backpack/assertions/{idOrEntityId}

Get Assertion Collection(s) associated with the authenticated user's backpack

get
Required scopes
This endpoint requires the following scopes:
  • : List assertions in your backpack
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Responses
200

OK

*/*
errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/backpack/collections

Create a new Collection

post
Required scopes
This endpoint requires the following scopes:
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Body
descriptionstring · nullableOptional

Short description of the Collection

Example: This is a collection of my favorite badges
namestringRequired

Name of the collection

Example: My Collection
publishedbooleanRequired

True if the Collection should have a share url

Example: true
Responses
201

Created

*/*
errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
post/v2/backpack/collections

Delete a collection

delete
Required scopes
This endpoint requires the following scopes:
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Responses
204

No Content

No content

delete/v2/backpack/collections/{idOrEntityId}

No content

Get Assertion Collection(s) associated with the authenticated user's backpack

get
Required scopes
This endpoint requires the following scopes:
  • : List assertions in your backpack
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Responses
200

OK

*/*
errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/backpack/collections/{idOrEntityId}

Update a Collection

put
Required scopes
This endpoint requires the following scopes:
  • : Upload badges to your backpack
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Body
assertionsstring[] · nullableOptional

The IDs or entity IDs of the assertions associated with this Collection

Example: UQbhRmNrQ4qn9_FJ5-eTtA
credentialsstring[] · nullableOptional

The IDs or entity IDs of the credentials associated with this Collection

Example: UQbhRmNrQ4qn9_FJ5-eTtA
descriptionstring · nullableOptional

Short description of the Collection

Example: This is a collection of my favorite badges
namestring · nullableOptional

Name of the collection

Example: My Collection
publishedboolean · nullableOptional

True if the Collection should have a share url

Example: true
Responses
200

OK

*/*
errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
put/v2/backpack/collections/{idOrEntityId}

Upload a new Assertion to the backpack

post

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
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Body
imagestring · nullableOptional

Image URL or base64 encoded image data of the assertion.

Example: https://example.com/assertions/1/image
urlstring · uri · nullableOptional

URL of the badge to import

Example: https://example.com/assertions/1
Responses
201

Created

*/*
errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
post/v2/backpack/import

Last updated

Was this helpful?