Coding Role List for calling GetUsersByRole

Yves Parent
Yves Parent
Fourth Anniversary Participant Facilitator 1
in Education Management APIs

Has anyone figured out how to code the list of roles passed to the above function. It's a comma delimited list but seems to be coded differently than the other parameters. I have tried everything I can think of but not had any luck. The example on the doc page lists every regular parameter but not how to code the roles, which is required.

I have not encountered anything like this with other function calls.

Comments

  • Dan Bonville
    Dan Bonville
    Eighth Anniversary Kudos 1 Name Dropper Participant

    Hi Yves,

    This looks to be an issue in the documentation. Seems like you need to name the param base+role+ids (replace the + with an underscore, the formatting in this editor is tricky).

    The documentation linked below seems to hold true (for this param) for the users by role endpoint:

    Regards,

    Dan

  • Brian Gray
    Brian Gray Community All-Star
    Eighth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge

    The Users by roles endpoint uses a comma-delimited string of Role IDs.

    The Users Extended by roles endpoint uses a comma-delimited string of BASE Role IDs.

    You can get both the Role ID and the Base Role ID from the Core roles endpoint.

  • Yves Parent
    Yves Parent
    Fourth Anniversary Participant Facilitator 1

    Figured it out. I was missing the & symbol after my comma delimited list.

Categories