API Keys

API Keys is the tab where you generate tokens for reaching Useroam's REST API from outside. Automation tools (n8n and the like), your own mobile app or an integration connect to the panel with a key generated here.

How do I open this screen? Open My Profile (Profilim) and switch to the API Keys tab.

1. Creating a key

New key opens a dialog with three fields:

• Label: Tells your keys apart — e.g. n8n integration, Mobile App, Test. When you need to revoke one, this is how you find it.
• IP whitelist: Where the key may be used from. Accepts a single address, a network block (10.0.0.0/24) or a comma-separated list. Every token is restricted to specific IPs — filling this in is the main layer of security.
• Validity (days): How many days until the key expires.

Create generates the key; Cancel closes the dialog.

Copy the key the moment it is created. For security, tokens are never shown in full again; lose one and you have to generate a replacement.

2. The key list

Generated keys are listed in a table:

• Label: The name you gave it.
• Key: The token, abbreviated.
• IP whitelist: The allowed addresses.
• Created and Expires: Generation and expiry dates.
• Last used: When the key was last called. A key that has never been used is a forgotten integration — delete it.
• Usage: Total number of calls.
• Status: Whether the key is active.

3. Endpoint list

Lower down the page, the API's endpoints are listed under Endpoint and Description. Use it to find where each kind of data lives, and follow the How is it used? link for the detailed reference.

Related pages: Getting Started → My Profile (Account Info).