I was looking at the Discourse Mobile app source code and noticed it using the user API keys, and calling /user-api-key/new but I don’t see any reference to that in the Discourse API documentation. Are the routes documented anywhere beyond the source code? And, how do users from SSO get their own API key? Most documentation that I find mention getting the API key from the admin panel, but that won’t work for me. I’d like to get a list of notifications from here, on meta, and other instances of discourse where I’m just a user. Similar to what the mobile app does already, but I’d like to use the information in a different context.

The HEAD /user-api-key/new request you are seeing is not creating anything, it’s mostly to check the site exists and it has the correct auth API version. As you can see if it’s a HEAD request we are returning early: discourse/app/controllers/user_api_keys_controller.rb at main · discourse/discourse · GitHub On the mobile app auth is done with an authToken coming back from the site popup when you tap on authorize see: DiscourseMobile/js/site_manager.js at main · discourse/DiscourseMobile · GitHub Concerning the notifications, the documentation is here: Discourse API Docs (I do agree it’s probably incomplete, you might want to grep DiscourseMobile code for “/notifications”)

Is there any documentation on the User/Mobile API?

Product Support

sam (Sam Saffron) June 25, 2019, 12:47am 4

Current docs are at User API keys specification

Topic		Replies	Views
Discourse Login & Registeration Development	4	3776	September 28, 2016
User API keys specification Integrations rest-api , reference	69	38592	September 22, 2025
How to Retrieve user_api_keys Value via API Development	9	514	September 26, 2024
Generating User Api Keys with REST API Development rest-api	20	9094	April 8, 2018
How to create an api key on the admin panel Development rest-api	11	8077	May 16, 2018

Is there any documentation on the User/Mobile API?

Related topics