Community

Issuers

Update a staff member's role on the Issuer

put

User must have an owner role on the issuer.

Authorizations
Path parameters
idOrEntityIdstringRequired
Body
emailstringRequired

Email address associated with the staff member

Example: [email protected]
rolestring · enumRequired

Role of the user in the issuer.

Possible values:
Responses
200

OK

*/*
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": "[email protected]",
  "role": "owner"
}
{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "entityType": "BadgeUser",
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "firstName": "Jane",
        "lastName": "Doe",
        "emails": [
          {
            "email": "[email protected]",
            "verified": true,
            "primary": true
          }
        ],
        "url": [
          "https://example.com"
        ],
        "telephone": [
          "text"
        ],
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "agreedTermsVersion": 4,
        "marketingOptIn": true,
        "hasPasswordSet": true
      }
    }
  ],
  "timestamp": "2025-11-04T17:05:35.114Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Add a staff member to an Issuer

post

User must have an owner role on the issuer.

Authorizations
Path parameters
idOrEntityIdstringRequired
Body
emailstringRequired

Email address associated with the staff member

Example: [email protected]
rolestring · enumRequired

Role of the user in the issuer.

Possible values:
Responses
201

Staff member added

*/*
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": "[email protected]",
  "role": "owner"
}
{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "entityType": "BadgeUser",
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "firstName": "Jane",
        "lastName": "Doe",
        "emails": [
          {
            "email": "[email protected]",
            "verified": true,
            "primary": true
          }
        ],
        "url": [
          "https://example.com"
        ],
        "telephone": [
          "text"
        ],
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "agreedTermsVersion": 4,
        "marketingOptIn": true,
        "hasPasswordSet": true
      }
    }
  ],
  "timestamp": "2025-11-04T17:05:35.114Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Update a staff member's role on the Issuer

patch

User must have an owner role on the issuer.

Authorizations
Path parameters
idOrEntityIdstringRequired
Body
emailstringRequired

Email address associated with the staff member

Example: [email protected]
rolestring · enumRequired

Role of the user in the issuer.

Possible values:
Responses
200

OK

*/*
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": "[email protected]",
  "role": "owner"
}
{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "role": "staff",
      "user": "Hey7J-GRSJeu6FNnHQwNyw",
      "userProfile": {
        "entityType": "BadgeUser",
        "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
        "firstName": "Jane",
        "lastName": "Doe",
        "emails": [
          {
            "email": "[email protected]",
            "verified": true,
            "primary": true
          }
        ],
        "url": [
          "https://example.com"
        ],
        "telephone": [
          "text"
        ],
        "badgrDomain": "badgrsupportgroup.badgr.com",
        "agreedTermsVersion": 4,
        "marketingOptIn": true,
        "hasPasswordSet": true
      }
    }
  ],
  "timestamp": "2025-11-04T17:05:35.114Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Get a single Issuer

get
Authorizations
Path parameters
idOrEntityIdstringRequired
Query parameters
include_staffstringOptionalDefault: true
Responses
200

OK

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

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

Update a single Issuer

put
Authorizations
Path parameters
idOrEntityIdstringRequired
Query parameters
include_staffstringOptionalDefault: true
Body
namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty
emailstring · email · max: 255Required

Contact email for the Issuer

Example: [email protected]
urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com
imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.
badgrDomainstringOptional
Responses
200

OK

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

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

Delete a single Issuer

delete
Authorizations
Path parameters
idOrEntityIdstringRequired
Responses
204

Issuer deleted

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

No content

Update a single Issuer

patch
Authorizations
Path parameters
idOrEntityIdstringRequired
Query parameters
include_staffstringOptionalDefault: true
Body
namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty
emailstring · email · max: 255Required

Contact email for the Issuer

Example: [email protected]
urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com
imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.
badgrDomainstringOptional
Responses
200

OK

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

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

Get a single Issuer

get
Authorizations
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault: true
Responses
200

OK

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

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

Update a single Issuer

put
Authorizations
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault: true
Body
namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty
emailstring · email · max: 255Required

Contact email for the Issuer

Example: [email protected]
urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com
imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.
badgrDomainstringOptional
Responses
200

OK

put
/v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64}
PUT /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354

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

Delete a single Issuer

delete
Authorizations
Path parameters
issuerOpenBadgeIdBase64stringRequired
Responses
204

Issuer deleted

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

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "timestamp": "2025-11-04T17:05:35.114Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Update a single Issuer

patch
Authorizations
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault: true
Body
namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty
emailstring · email · max: 255Required

Contact email for the Issuer

Example: [email protected]
urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com
imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.
badgrDomainstringOptional
Responses
200

OK

patch
/v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64}
PATCH /v2/issuers/openBadgeId/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354

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

Get a single Issuer

get
Authorizations
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault: true
Responses
200

OK

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

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

Update a single Issuer

put
Authorizations
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault: true
Body
namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty
emailstring · email · max: 255Required

Contact email for the Issuer

Example: [email protected]
urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com
imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.
badgrDomainstringOptional
Responses
200

OK

put
/v2/issuers/ref/{issuerOpenBadgeIdBase64}
PUT /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354

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

Delete a single Issuer

delete
Authorizations
Path parameters
issuerOpenBadgeIdBase64stringRequired
Responses
204

Issuer deleted

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

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "timestamp": "2025-11-04T17:05:35.114Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Update a single Issuer

patch
Authorizations
Path parameters
issuerOpenBadgeIdBase64stringRequired
Query parameters
include_staffstringOptionalDefault: true
Body
namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty
emailstring · email · max: 255Required

Contact email for the Issuer

Example: [email protected]
urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com
imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
descriptionstring · max: 16384Required

Short description of the Issuer

Example: This is the faculty of the Credentials University.
badgrDomainstringOptional
Responses
200

OK

patch
/v2/issuers/ref/{issuerOpenBadgeIdBase64}
PATCH /v2/issuers/ref/{issuerOpenBadgeIdBase64} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354

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

Get list of Assertions for the specified scope

get
Authorizations
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

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

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

Issue a new Assertion to a recipient

post
Authorizations
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.

badgeclassstringOptional

ID or Entity ID of the badge class to be awarded

Example: K829IK8RS6ercwkpeFOn-Q
badgeclassOpenBadgeIdstring · uriOptional

OB URL of the badge class to be awarded

Example: https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q
issuedOnstring · date-timeOptional

Timestamp when the assertion was issued

allowDuplicateAwardsbooleanOptional

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

narrativestringOptional

Markdown narrative of the achievement

expiresstring · date-timeOptional
Responses
201

Created

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

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

Get a list of Issuers for authenticated user

get
Authorizations
Query parameters
include_staffstringOptionalDefault: true
Responses
200

OK

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

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

Create a new Issuer

post
Authorizations
Query parameters
include_staffstringOptionalDefault: true
Body
namestring · max: 1024Required

Name of the issuer

Example: Credentials Faculty
emailstring · email · max: 255Required

Contact email for the Issuer

Example: [email protected]
urlstring · uri · max: 1024Required

Homepage or website associated with the Issuer

Example: https://example.com
sourceUrlstring · uriOptional

The original URL of the issuer if it was imported

Example: https://example.com/issuers/1
originalJsonstring · max: 2000000Optional

The original OB JSON of the issuer if it was imported

Example: {}
imagestringOptional

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image
descriptionstring · max: 16384Optional

Short description of the Issuer

Example: This is the faculty of the Credentials University.
badgrDomainstringOptional

Organization domain host

Example: badgrsupportgroup.badgr.com
createdBystringOptional

User who created this issuer

organizationIdstringOptional

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

Example: 6f4e4e4e2dc038241ad01d83
Responses
201

Issuer created

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

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

Invite a staff member to an Issuer

post

User must have an owner role on the issuer.

Authorizations
Path parameters
idOrEntityIdstringRequired
Body
emailstringRequired

Email address associated with the staff member

Example: [email protected]
rolestring · enumRequired

Role of the user in the issuer.

Possible values:
Responses
200

OK

*/*
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": "[email protected]",
  "role": "owner"
}
{
  "status": {
    "success": true,
    "description": "ok"
  },
  "result": [
    {
      "email": "[email protected]",
      "role": "owner",
      "status": "PENDING"
    }
  ],
  "timestamp": "2025-11-04T17:05:35.114Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}

Get a list of BadgeClasses for a single Issuer

get
Authorizations
Path parameters
idOrEntityIdstringRequired
Query parameters
include_archivedbooleanOptionalDefault: false
Responses
200

OK

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

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

Create a new BadgeClass associated with an Issuer

post
Authorizations
Path parameters
idOrEntityIdstringRequired
Body
issuerstringOptional

Entity ID of the issuer

Example: ZvYydoQhRtOKalNzFPZR2A-Q
namestring · max: 1024Required

Name of the BadgeClass

Example: Math Expert
imagestringRequired

Image of the issuer. An URL or a bas64 encoded images.

Example: https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image
achievementTypestringOptional

The type of achievement

Example: Course
descriptionstring · max: 16384Required

Short description of the BadgeClass

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

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

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

Markdown formatted description of the criteria

tagsstring[]Optional

List of tags that describe the BadgeClass

imageAltTextstringOptional
Responses
201

Created

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

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

Remove a staff member from the Issuer

delete

User must have an owner role on the issuer.

Authorizations
Path parameters
idOrEntityIdstringRequired
emailBase64stringRequired

Base64 encoded email address of the staff member

Responses
204

Staff member removed

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

{
  "status": {
    "success": true,
    "description": "ok"
  },
  "timestamp": "2025-11-04T17:05:35.114Z",
  "validationErrors": [
    "text"
  ],
  "nonFieldErrors": [
    "text"
  ],
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "errorCode": "text",
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1
}
PreviousBadgeclassesNextOrganizations

Last updated

Was this helpful?