Overview
Every record in Mobaro — Users, Locations, Assets, Checklists, Results, Assignments and so on — has a unique ID. The Mobaro API, and integrations built on it such as Power Automate flows or scripts, use these IDs to refer to exactly the right record. This article explains what IDs look like, where to find them, and how to link them to the identifiers in your other systems.
At a glance |
|
Who can do this | Anyone with API access can look up IDs. Setting External ID on Users, User Groups and Locations: Super Users. |
Where | The Mobaro API, the Checklist editor's address bar, and External ID fields in the Backend |
Works on | Backend (web) and Public API |
Availability | All organizations. API access: see Creating and Managing API Keys. |
What an ID looks like
A Mobaro ID is a record type, a slash, a number, a hyphen and a letter. The record type is always plural and lowercase.
Record | Example ID |
User |
|
Location |
|
Asset |
|
Checklist |
|
Result |
|
Assignment |
|
The letter at the end is part of the ID. Always store and send the whole ID, including the record type and the letter. The API always uses these system IDs, even where a record also has a name or an External ID.
ℹ️ Note: If you rename a record in Mobaro, its ID doesn't change, so your integrations keep working.
Where to find IDs
1. Use the API
The most reliable way is to list the records with the API and read each item's id field. For example:
curl "https://app.mobaro.com/api/customers/users" \
--header "X-Api-Key: YOUR_SECRET_TOKEN"
curl "https://app.mobaro.com/api/customers/locations" \
--header "X-Api-Key: YOUR_SECRET_TOKEN"
To get one record, put its ID at the end of the address. You can leave out the record type, for example /api/customers/users/185465-B, or write the slash as %2F. For the parameters each endpoint accepts, see Mobaro API parameter reference.
2. Look in the Checklist editor
When you open a Checklist in the Backend, the end of the browser address is its ID number. For example, https://app.mobaro.com/#/checklist/editor/102170-A is the Checklist checklists/102170-A. Other pages don't reliably show the ID, so use the API for other records.
How IDs relate to each other
Records refer to each other by ID. For example, a Result from the API includes:
Field | Meaning |
| The Checklist that was completed |
| The Location where it was completed |
| The Asset it was completed for, if any |
| The User who completed it |
| The Schedule it came from, if any |
For pulling Results, see Pulling Results via the API.
Match your other systems with External IDs
If your HR, maintenance or scheduling system has its own identifiers, you don't need to replace them. Store them in Mobaro's External ID field instead, so both systems refer to the same record. External ID is available on Users, User Groups, Locations, Location Groups and Assets. In the Backend, only Super Users can set it on Users, User Groups and Locations.
Your system | Identifier | Where to store it in Mobaro |
HR or identity system | Employee number | The User's External ID |
Maintenance system (CMMS) | Asset tag or equipment code | The Asset's External ID |
Scheduling or rostering system | Location or area code | The Location's External ID |
When you get a single User, User Group, Location, Location Group or Asset through the API, you can use its External ID in place of the Mobaro ID. For Users, you can also use their email address.
Avoid duplicates when you sync
When you sync Users, Locations or Assets from another system:
Look for an existing record by a unique value, such as the External ID, an email address or an asset tag.
If you find one, update it.
If you don't, create it and store your system's identifier in its External ID.
This stops you from creating several Mobaro records for the same person, place or piece of equipment.
Best practices
Store the full Mobaro ID, including the record type and letter, in your scripts or sync tables.
Use External ID to link records to your other systems, and email addresses to match people when you first connect systems.
Document any ID you hard-code in a script, so others know what it refers to.
Frequently asked questions
Where do I find a location's ID?
List Locations with the API (GET /api/customers/locations) and read the id field, for example locations/78264-C. If the Location has an External ID, you can use that to get it instead.
Why is the External ID field greyed out?
On Users, User Groups and Locations, only Super Users can set External ID in the Backend. Ask a Super User to set or change it. See What is a Mobaro super user?.
What does an External ID on a location do?
It stores another system's code for that Location, such as a rostering area code. Integrations can then find the Location by that code instead of by its Mobaro ID.
What do the letters A, B and C at the end of an ID mean?
The letter is part of the ID, so always keep it. You don't need to interpret it: store and send the whole ID, such as assignments/1847225-A.
Who or what is 123456-A?
Any record type can have that number. Look it up with the API using the record type you expect, for example GET /api/customers/users/123456-A. A 404 response means no User with that ID is available to your API key.