parchment API call user IDs

aamirghanchi

https://api.badges.parchment.com/v2/users/{idOrEntityId}

Hi. What type of ID should I be using to get the badges and pathway progress for a particular user? I have used all the SIS ID, or the ID as shown on the badger portal, but nothing is working. What kind of the ID does the API calls accept? please give an example.

James

@aamirghanchi

I have not used the badges API, but an example id and entityId can be found in the Get your own BadeUser profile API endpoint. They are not the same as the Canvas User ID or your SIS ID.

I would start with the API to get your own IDs and verify that those IDs work in the endpoint you're trying to use.

There's also a note from 2025-03-10 to the Canvas Credentials 2025 API Change Log that says most APIs now accept both the internal ID and the public entity ID for issuers, badge classes, assertions, and users. It gives some examples.

If those aren't working for you, it may be a permissions issue. That's why I suggest starting with your own account as you should have permissions to make that request.