The Instructure Community will enter a read-only state on November 22, 2025 as we prepare to migrate to our new Community platform in early December. Read our blog post for more info about this change.
Found this content helpful? Log in or sign up to leave a like!
It would be helpful if Canvas user pronoun selections were made available via API or report (or even Canvas Data). We have a desire to get the pronoun selection data out of Canvas.
If this already exists, I'll be happy to take any information on this, but I haven't found it in the API documentation, reports, or Canvas Data schema. Thanks.
Solved! Go to Solution.
Even though it may not be documented, it looks like as long as the user has set their pronouns, then it will appear as part of the response when you use "Get users profile":
https://canvas.instructure.com/doc/api/users.html#method.profile.settings
It appears that if the user hasn't set their pronouns yet, then it won't appear as key in the response when you use "Get user profile"
@JamesSekcienski - thanks! I've been testing this out a bit, and I also see it in a "pronouns" field in /api/v1/users/:user_id - even though it, too, isn't documented.
Even though it may not be documented, it looks like as long as the user has set their pronouns, then it will appear as part of the response when you use "Get users profile":
https://canvas.instructure.com/doc/api/users.html#method.profile.settings
It appears that if the user hasn't set their pronouns yet, then it won't appear as key in the response when you use "Get user profile"
@JamesSekcienski - thanks! I've been testing this out a bit, and I also see it in a "pronouns" field in /api/v1/users/:user_id - even though it, too, isn't documented.
@atcarver Thanks for sharing that you discovered it just from getting the user too. That is good to know.
Community helpTo interact with Panda Bot, our automated chatbot, you need to sign up or log in:
Sign inTo interact with Panda Bot, our automated chatbot, you need to sign up or log in:
Sign in