Issuers

Get a list of Issuers for authenticated user

get

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Query parameters

include_staffstringOptionalDefault: true

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get/v2/issuers

GET /v2/issuers HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Create a new Issuer

post

Creating an Issuer within an Organization (via organizationId) additionally requires the rw:org scope.

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers
: Associate issuers with your organization and update organization data

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Query parameters

include_staffstringOptionalDefault: true

Body

badgrDomainstring · nullableOptional

Organization domain host

Example: badgrsupportgroup.badgr.com

createdBystring · nullableOptional

User who created this issuer

descriptionstring · max: 16384 · nullableOptional

Short description of the Issuer

Example: This is the faculty of the Credentials University.

emailstring · email · max: 255 · nullableRequired

Contact email for the Issuer

Example: contact@example.com

imagestring · nullableOptional

Image of the issuer as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==

namestring · max: 1024 · nullableRequired

Name of the issuer

Example: Credentials Faculty

organizationIdstring · nullableOptional

The ID of the organization which this issuer should be associated with. Requires organization write access.

Example: 6f4e4e4e2dc038241ad01d83

originalJsonstring · max: 2000000 · nullableOptional

The original OB JSON of the issuer if it was imported

Example: {}

sourceUrlstring · uri · nullableOptional

The original URL of the issuer if it was imported

Example: https://example.com/issuers/1

urlstring · uri · max: 1024 · nullableRequired

Homepage or website associated with the Issuer

Example: https://example.com

Responses

201

Issuer created

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

post/v2/issuers

POST /v2/issuers HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 514

{
  "badgrDomain": "badgrsupportgroup.badgr.com",
  "createdBy": "text",
  "description": "This is the faculty of the Credentials University.",
  "email": "contact@example.com",
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "name": "Credentials Faculty",
  "organizationId": "6f4e4e4e2dc038241ad01d83",
  "originalJson": "{}",
  "sourceUrl": "https://example.com/issuers/1",
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "url": "https://example.com"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Delete a single Issuer

delete

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

issuerOpenBadgeIdBase64stringRequired

Responses

204

Issuer deleted

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

delete/v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64}

DELETE /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Get a single Issuer

get

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get/v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64}

GET /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update a single Issuer

patch

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

badgrDomainstringOptional

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

emailstring · email · max: 255 · nullableRequired

Contact email for the Issuer

Example: contact@example.com

imagestringOptional

Image of the issuer as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==

namestring · max: 1024 · nullableRequired

Name of the issuer

Example: Credentials Faculty

urlstring · uri · max: 1024 · nullableRequired

Homepage or website associated with the Issuer

Example: https://example.com

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

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: 892

{
  "badgrDomain": "text",
  "description": "This is the faculty of the Credentials University.",
  "email": "contact@example.com",
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "name": "Credentials Faculty",
  "preferences": {
    "customPropertyDefinitions": [
      {
        "choiceValues": [
          {
            "id": "65663ceb977692fcafcea0b9",
            "label": "text"
          }
        ],
        "label": "Award Type",
        "propertyId": "66bf8231d88b51901d49d637",
        "propertyType": "STRING_CHOICE",
        "public": true,
        "required": true,
        "subLabel": "Type of award",
        "targetEntityType": "BADGE_CLASS"
      }
    ],
    "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
    "enabledPrintCertTemplateIds": [
      "5f4e4e4e2dc038241ad01d83",
      "6f4e4e4e2dc038241ad01d83"
    ],
    "ob3Enabled": false,
    "showOnOrgPublicPage": true
  },
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "url": "https://example.com"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update a single Issuer

put

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

badgrDomainstringOptional

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

emailstring · email · max: 255 · nullableRequired

Contact email for the Issuer

Example: contact@example.com

imagestringOptional

Image of the issuer as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==

namestring · max: 1024 · nullableRequired

Name of the issuer

Example: Credentials Faculty

urlstring · uri · max: 1024 · nullableRequired

Homepage or website associated with the Issuer

Example: https://example.com

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

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: 892

{
  "badgrDomain": "text",
  "description": "This is the faculty of the Credentials University.",
  "email": "contact@example.com",
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "name": "Credentials Faculty",
  "preferences": {
    "customPropertyDefinitions": [
      {
        "choiceValues": [
          {
            "id": "65663ceb977692fcafcea0b9",
            "label": "text"
          }
        ],
        "label": "Award Type",
        "propertyId": "66bf8231d88b51901d49d637",
        "propertyType": "STRING_CHOICE",
        "public": true,
        "required": true,
        "subLabel": "Type of award",
        "targetEntityType": "BADGE_CLASS"
      }
    ],
    "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
    "enabledPrintCertTemplateIds": [
      "5f4e4e4e2dc038241ad01d83",
      "6f4e4e4e2dc038241ad01d83"
    ],
    "ob3Enabled": false,
    "showOnOrgPublicPage": true
  },
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "url": "https://example.com"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Delete a single Issuer

delete

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

issuerOpenBadgeIdBase64stringRequired

Responses

204

Issuer deleted

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

delete/v2/issuers/ref/{issuerOpenBadgeIdBase64}

DELETE /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Get a single Issuer

get

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get/v2/issuers/ref/{issuerOpenBadgeIdBase64}

GET /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update a single Issuer

patch

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

badgrDomainstringOptional

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

emailstring · email · max: 255 · nullableRequired

Contact email for the Issuer

Example: contact@example.com

imagestringOptional

Image of the issuer as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==

namestring · max: 1024 · nullableRequired

Name of the issuer

Example: Credentials Faculty

urlstring · uri · max: 1024 · nullableRequired

Homepage or website associated with the Issuer

Example: https://example.com

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

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: 892

{
  "badgrDomain": "text",
  "description": "This is the faculty of the Credentials University.",
  "email": "contact@example.com",
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "name": "Credentials Faculty",
  "preferences": {
    "customPropertyDefinitions": [
      {
        "choiceValues": [
          {
            "id": "65663ceb977692fcafcea0b9",
            "label": "text"
          }
        ],
        "label": "Award Type",
        "propertyId": "66bf8231d88b51901d49d637",
        "propertyType": "STRING_CHOICE",
        "public": true,
        "required": true,
        "subLabel": "Type of award",
        "targetEntityType": "BADGE_CLASS"
      }
    ],
    "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
    "enabledPrintCertTemplateIds": [
      "5f4e4e4e2dc038241ad01d83",
      "6f4e4e4e2dc038241ad01d83"
    ],
    "ob3Enabled": false,
    "showOnOrgPublicPage": true
  },
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "url": "https://example.com"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update a single Issuer

put

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

issuerOpenBadgeIdBase64stringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

badgrDomainstringOptional

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

emailstring · email · max: 255 · nullableRequired

Contact email for the Issuer

Example: contact@example.com

imagestringOptional

Image of the issuer as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==

namestring · max: 1024 · nullableRequired

Name of the issuer

Example: Credentials Faculty

urlstring · uri · max: 1024 · nullableRequired

Homepage or website associated with the Issuer

Example: https://example.com

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

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: 892

{
  "badgrDomain": "text",
  "description": "This is the faculty of the Credentials University.",
  "email": "contact@example.com",
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "name": "Credentials Faculty",
  "preferences": {
    "customPropertyDefinitions": [
      {
        "choiceValues": [
          {
            "id": "65663ceb977692fcafcea0b9",
            "label": "text"
          }
        ],
        "label": "Award Type",
        "propertyId": "66bf8231d88b51901d49d637",
        "propertyType": "STRING_CHOICE",
        "public": true,
        "required": true,
        "subLabel": "Type of award",
        "targetEntityType": "BADGE_CLASS"
      }
    ],
    "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
    "enabledPrintCertTemplateIds": [
      "5f4e4e4e2dc038241ad01d83",
      "6f4e4e4e2dc038241ad01d83"
    ],
    "ob3Enabled": false,
    "showOnOrgPublicPage": true
  },
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "url": "https://example.com"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Delete a single Issuer

delete

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Responses

204

Issuer deleted

No content

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

delete/v2/issuers/{idOrEntityId}

DELETE /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get a single Issuer

get

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Query parameters

include_staffstringOptionalDefault: true

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get/v2/issuers/{idOrEntityId}

GET /v2/issuers/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update a single Issuer

patch

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

badgrDomainstringOptional

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

emailstring · email · max: 255 · nullableRequired

Contact email for the Issuer

Example: contact@example.com

imagestringOptional

Image of the issuer as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==

namestring · max: 1024 · nullableRequired

Name of the issuer

Example: Credentials Faculty

urlstring · uri · max: 1024 · nullableRequired

Homepage or website associated with the Issuer

Example: https://example.com

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

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: 892

{
  "badgrDomain": "text",
  "description": "This is the faculty of the Credentials University.",
  "email": "contact@example.com",
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "name": "Credentials Faculty",
  "preferences": {
    "customPropertyDefinitions": [
      {
        "choiceValues": [
          {
            "id": "65663ceb977692fcafcea0b9",
            "label": "text"
          }
        ],
        "label": "Award Type",
        "propertyId": "66bf8231d88b51901d49d637",
        "propertyType": "STRING_CHOICE",
        "public": true,
        "required": true,
        "subLabel": "Type of award",
        "targetEntityType": "BADGE_CLASS"
      }
    ],
    "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
    "enabledPrintCertTemplateIds": [
      "5f4e4e4e2dc038241ad01d83",
      "6f4e4e4e2dc038241ad01d83"
    ],
    "ob3Enabled": false,
    "showOnOrgPublicPage": true
  },
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "url": "https://example.com"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update a single Issuer

put

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Query parameters

include_staffstringOptionalDefault: true

Body

badgrDomainstringOptional

descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.

emailstring · email · max: 255 · nullableRequired

Contact email for the Issuer

Example: contact@example.com

imagestringOptional

Image of the issuer as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==

namestring · max: 1024 · nullableRequired

Name of the issuer

Example: Credentials Faculty

urlstring · uri · max: 1024 · nullableRequired

Homepage or website associated with the Issuer

Example: https://example.com

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

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: 892

{
  "badgrDomain": "text",
  "description": "This is the faculty of the Credentials University.",
  "email": "contact@example.com",
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "name": "Credentials Faculty",
  "preferences": {
    "customPropertyDefinitions": [
      {
        "choiceValues": [
          {
            "id": "65663ceb977692fcafcea0b9",
            "label": "text"
          }
        ],
        "label": "Award Type",
        "propertyId": "66bf8231d88b51901d49d637",
        "propertyType": "STRING_CHOICE",
        "public": true,
        "required": true,
        "subLabel": "Type of award",
        "targetEntityType": "BADGE_CLASS"
      }
    ],
    "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
    "enabledPrintCertTemplateIds": [
      "5f4e4e4e2dc038241ad01d83",
      "6f4e4e4e2dc038241ad01d83"
    ],
    "ob3Enabled": false,
    "showOnOrgPublicPage": true
  },
  "staff": [
    {
      "role": "owner",
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "url": "https://example.com"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9",
                "label": "text"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "ob3Enabled": false,
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "orgRole": "BillingAdmin",
          "role": "staff",
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com",
                "primary": true,
                "verified": true
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "hasPasswordSet": true,
            "lastName": "Doe",
            "marketingOptIn": true,
            "telephone": [
              "text"
            ],
            "url": [
              "https://example.com"
            ]
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Get a list of BadgeClasses for a single Issuer

get

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Query parameters

include_archivedbooleanOptionalDefault: false

Responses

200

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get/v2/issuers/{idOrEntityId}/badgeclasses

GET /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Create a new BadgeClass associated with an Issuer

post

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Body

achievementTypestring · nullableOptional

The type of achievement

Example: Course

criteriaNarrativestring · nullableOptional

Markdown formatted description of the criteria

criteriaUrlstring · uri · nullableOptional

External URL that describes in a human-readable format the criteria for the BadgeClass

Example: https://example.com/badge-classes/1/criteria

descriptionstring · max: 16384 · nullableRequired

Short description of the BadgeClass

Example: This badge is awarded to students who have demonstrated mastery of Math.

imagestring · nullableRequired

Image of the badge class as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==

imageAltTextstring · nullableOptional

issuerstring · nullableOptional

Entity ID of the issuer

Example: ZvYydoQhRtOKalNzFPZR2A-Q

namestring · max: 1024 · nullableRequired

Name of the BadgeClass

Example: Math Expert

tagsstring[] · nullableOptional

List of tags that describe the BadgeClass

Responses

201

Created

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

post/v2/issuers/{idOrEntityId}/badgeclasses

POST /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1087

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

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

List all pathways for the issuer

get

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Responses

200

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get/v2/issuers/{idOrEntityId}/pathways

GET /v2/issuers/{idOrEntityId}/pathways HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pathwayInfos": [
    {
      "draftCompletionBadgeUrl": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
      "draftName": "Road",
      "issuerId": "62aa04adf5afe00d0a6dac72",
      "issuerName": "Springfield University",
      "issuerVerified": true,
      "lastPublishedAt": "2026-01-01T00:00:00.000Z",
      "pathwayGroupLtiToolCountsByLmsType": {
        "Blackboard": 3,
        "Canvas": 2,
        "Moodle": 4,
        "Other": 5
      },
      "pathwayId": "66aa04adf5afe00d0a6dac72",
      "publishedCompletionBadgeUrl": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
      "publishedName": "Highway",
      "subscribedGroupCount": 2,
      "uniqueMemberCount": 100
    }
  ]
}

Remove a staff member from the Issuer

delete

User must have an owner role on the issuer.

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Body

emailstring · email · nullableRequired

Email address of the staff member to remove

Example: jane.doe@example.com

Responses

204

Staff member removed

*/*

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

delete/v2/issuers/{idOrEntityId}/staff

DELETE /v2/issuers/{idOrEntityId}/staff HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "email": "jane.doe@example.com"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update a staff member's role on the Issuer

patch

User must have an owner role on the issuer.

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Body

emailstring · email · nullableRequired

Email address associated with the staff member

Example: jane.doe@example.com

rolestring · enum · nullableRequired

Role of the user in the issuer.

Possible values:

Responses

200

*/*

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

patch/v2/issuers/{idOrEntityId}/staff

PATCH /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": "jane.doe@example.com",
  "role": "owner"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "orgRole": "BillingAdmin",
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "agreedTermsVersion": 4,
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "emails": [
          {
            "email": "Jane.Doe@example.com",
            "primary": true,
            "verified": true
          }
        ],
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "entityType": "BadgeUser",
        "firstName": "Jane",
        "hasPasswordSet": true,
        "lastName": "Doe",
        "marketingOptIn": true,
        "telephone": [
          "text"
        ],
        "url": [
          "https://example.com"
        ]
      }
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Add a staff member to an Issuer

post

User must have an owner role on the issuer.

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Body

emailstring · email · nullableRequired

Email address associated with the staff member

Example: jane.doe@example.com

rolestring · enum · nullableRequired

Role of the user in the issuer.

Possible values:

Responses

201

Staff member added

*/*

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

post/v2/issuers/{idOrEntityId}/staff

POST /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": "jane.doe@example.com",
  "role": "owner"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "orgRole": "BillingAdmin",
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "agreedTermsVersion": 4,
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "emails": [
          {
            "email": "Jane.Doe@example.com",
            "primary": true,
            "verified": true
          }
        ],
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "entityType": "BadgeUser",
        "firstName": "Jane",
        "hasPasswordSet": true,
        "lastName": "Doe",
        "marketingOptIn": true,
        "telephone": [
          "text"
        ],
        "url": [
          "https://example.com"
        ]
      }
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update a staff member's role on the Issuer

put

User must have an owner role on the issuer.

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Body

emailstring · email · nullableRequired

Email address associated with the staff member

Example: jane.doe@example.com

rolestring · enum · nullableRequired

Role of the user in the issuer.

Possible values:

Responses

200

*/*

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

put/v2/issuers/{idOrEntityId}/staff

PUT /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": "jane.doe@example.com",
  "role": "owner"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "orgRole": "BillingAdmin",
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "agreedTermsVersion": 4,
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "emails": [
          {
            "email": "Jane.Doe@example.com",
            "primary": true,
            "verified": true
          }
        ],
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "entityType": "BadgeUser",
        "firstName": "Jane",
        "hasPasswordSet": true,
        "lastName": "Doe",
        "marketingOptIn": true,
        "telephone": [
          "text"
        ],
        "url": [
          "https://example.com"
        ]
      }
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Invite a staff member to an Issuer

post

User must have an owner role on the issuer.

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

idOrEntityIdstringRequired

Body

emailstring · email · nullableRequired

Email address associated with the staff member

Example: jane.doe@example.com

rolestring · enum · nullableRequired

Role of the user in the issuer.

Possible values:

Responses

200

*/*

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

post/v2/issuers/{idOrEntityId}/staff/invitations

POST /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": "jane.doe@example.com",
  "role": "owner"
}

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "email": "jane.doe@example.com",
      "role": "owner",
      "status": "PENDING"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

List public issuers for the specified organization with pagination and optional name filtering

get

Authorizations

HTTPRequired

Path parameters

idstringRequired

Query parameters

nameQuerystring · max: 256Optional

Case-insensitive filter for the name of the issuers

numstring · min: 1 · max: 100Optional

Number of items to return per page

Default: 10Example: 10

pagestring · min: 1Optional

Index of the requested page (1-based)

Default: 1Example: 1

Responses

200

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get/v2/organizations/{id}/public-issuers

GET /v2/organizations/{id}/public-issuers HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "linkMode": "DEFAULT",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "issuerId": "67e9d238c5afe622816febb3",
      "obIssuer": {
        "@context": "text",
        "description": "text",
        "email": "text",
        "extensions": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "id": "text",
        "image": "text",
        "name": "text",
        "url": "text"
      },
      "organizationId": "65e9d238c5afe622816febb3"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "hasNextPage": true,
    "nextLink": "text",
    "pageSize": 10,
    "previousLink": "text",
    "totalCount": 100,
    "totalPages": 6
  }
}

Get list of Assertions for the specified scope

get

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

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: false

include_revokedbooleanOptionalDefault: false

afterstringOptional

Pagination cursor provided in "Link" response header

beforestringOptional

Pagination cursor provided in "Link" response header

Responses

200

List of Assertions

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get/v2/{scope}/{idOrEntityId}/assertions

GET /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Issue a new Assertion to a recipient

post

Required scopes

This endpoint requires the following scopes:

: Award badges and update your issuers

Authorizations

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Path parameters

scopestring · enumRequiredPossible values:

idOrEntityIdstringRequired

The entity ID of the selected scope entity

Example: K829IK8RS6ercwkpeFOn-Q

Body

Request to award an assertion. When request scope is issuers, one of badgeclass or badgeclassOpenBadgeId must be provided.

allowDuplicateAwardsbooleanOptional

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

badgeclassstring · nullableOptional

ID or Entity ID of the badge class to be awarded

Example: K829IK8RS6ercwkpeFOn-Q

badgeclassOpenBadgeIdstring · uri · nullableOptional

OB URL of the badge class to be awarded

Example: https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q

expiresstring · date-time · nullableOptional

issuedOnstring · date-time · nullableOptional

Timestamp when the assertion was issued

narrativestring · nullableOptional

Markdown narrative of the achievement

Responses

201

Created

errorCodestring · nullableOptional

latestTermsVersioninteger · int32 · nullableOptional

nonFieldErrorsstring[]Required

timestampstring · date-time · nullableOptional

validationErrorsstring[]Required

400

Bad Request

*/*

404

Not Found

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

post/v2/{scope}/{idOrEntityId}/assertions

POST /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

{
  "allowDuplicateAwards": true,
  "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
  "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
  "evidence": [
    {
      "audience": "text",
      "description": "text",
      "genre": "text",
      "name": "text",
      "narrative": "text",
      "url": "https://example.com"
    }
  ],
  "expires": "2026-01-01T00:00:00.000Z",
  "extensions": {
    "value": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "issuedOn": "2026-01-01T00:00:00.000Z",
  "narrative": "text",
  "ob3AwardProperties": {
    "activityEnd": "2026-01-01T00:00:00.000Z",
    "activityStart": "2026-01-01T00:00:00.000Z",
    "licenseNumber": "text",
    "role": "text"
  },
  "recipient": {
    "hashed": true,
    "identity": "jane.doe@example.com",
    "type": "email"
  }
}

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

PreviousBadgeconnect NextOrganizations

Last updated 22 days ago

Was this helpful?