Recipientgroups

Export general data of the recipient groups for a given organization.

get

Authorizations

accessToken

HTTPRequired

Path parameters

organizationIdstringRequired

Query parameters

issuerIdstringOptional

includeCreationDateAndMethodbooleanOptionalDefault: true

includeExpirationDateAndMethodbooleanOptionalDefault: true

includeStaffMembersbooleanOptionalDefault: true

includeArchivedGroupsbooleanOptionalDefault: false

Responses

200

CSV file containing general group data

text/csv

stringOptionalExample: Group ID,Group name,Course/Pathway ID,URL,Learners,Alignment type,Alignment ID,Alignment name,Creation date,Creation method,Expiration date,Expiration method,Staff member name,Staff member ID 68cd3f3a54e2f258d1aedcfa,Teacher epic course,66780,https://zoltanfarkas.instructure.com/courses/66780,1,Badge,68e4bcd536627547e95edeed,Badge 2,Sep 19 2025,Canvas,Sep 19 2026,Manual,Canvas Teacher,[email protected]

400

Bad Request

*/*

get

/v2/organizations/{organizationId}/group-export/general-data

HTTPcURLJavaScriptPython

GET /v2/organizations/{organizationId}/group-export/general-data HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Group ID,Group name,Course/Pathway ID,URL,Learners,Alignment type,Alignment ID,Alignment name,Creation date,Creation method,Expiration date,Expiration method,Staff member name,Staff member ID
68cd3f3a54e2f258d1aedcfa,Teacher epic course,66780,https://zoltanfarkas.instructure.com/courses/66780,1,Badge,68e4bcd536627547e95edeed,Badge 2,Sep 19 2025,Canvas,Sep 19 2026,Manual,Canvas Teacher,[email protected]

Export learner progress data of the recipient groups for a given issuer.

get

Authorizations

accessToken

HTTPRequired

Path parameters

issuerIdstringRequired

Query parameters

includeArchivedGroupsbooleanOptionalDefault: false

Responses

200

CSV file containing learner progress data

text/csv

stringOptionalExample: Group ID,Group Name,Learner Name,Learner ID,Last Badge Earned,Alignment Type,Alignment ID,Alignment Name,Status,Detailed Progress,Evidence 68cd3f3a54e2f258d1aedcfa,Teacher epic course,Canvas Student,[email protected],Jan 20 2026,Badge,68e4bcd536627547e95edeed,Badge 2,Awarded,,https://evidence-1.com|https://evidence-2.com

400

Bad Request

*/*

get

/v2/issuers/{issuerId}/group-export/learner-progress-data

HTTPcURLJavaScriptPython

GET /v2/issuers/{issuerId}/group-export/learner-progress-data HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Group ID,Group Name,Learner Name,Learner ID,Last Badge Earned,Alignment Type,Alignment ID,Alignment Name,Status,Detailed Progress,Evidence
68cd3f3a54e2f258d1aedcfa,Teacher epic course,Canvas Student,[email protected],Jan 20 2026,Badge,68e4bcd536627547e95edeed,Badge 2,Awarded,,https://evidence-1.com|https://evidence-2.com

Export badge data of the recipient groups for a given issuer.

get

Authorizations

accessToken

HTTPRequired

Path parameters

issuerIdstringRequired

Query parameters

includeArchivedGroupsbooleanOptionalDefault: false

Responses

200

CSV file containing badge data

text/csv

stringOptionalExample: Group ID,Group Name,Course ID,Badge ID,Badge Name,Award Method,Course Item,Requirement with link,Trigger Type,Threshold,Evidence Needed,Date Restriction,Leaderboard Points,Learner Progress 68cd3f3a54e2f258d1aedcfa,Teacher epic course,66780,68e4bcd536627547e95edeed,Badge 2,Canvas,Course grade,https://zoltanfarkas.instructure.com/courses/66780,Percentage score,80%,no,,1,1 awarded

400

Bad Request

*/*

get

/v2/issuers/{issuerId}/group-export/badge-data

HTTPcURLJavaScriptPython

GET /v2/issuers/{issuerId}/group-export/badge-data HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Group ID,Group Name,Course ID,Badge ID,Badge Name,Award Method,Course Item,Requirement with link,Trigger Type,Threshold,Evidence Needed,Date Restriction,Leaderboard Points,Learner Progress
68cd3f3a54e2f258d1aedcfa,Teacher epic course,66780,68e4bcd536627547e95edeed,Badge 2,Canvas,Course grade,https://zoltanfarkas.instructure.com/courses/66780,Percentage score,80%,no,,1,1 awarded