Overview
This article provides a complete reference for the most commonly used query parameters in the Mobaro API. Each parameter includes formatting guidance and examples, helping ensure you use the correct internal ID structure for Mobaro resources.
Most Mobaro APIs use internal resource IDs that follow this structure:
📘 resourceType/123456-A
Resource parameters (string arrays)
These parameters must use the internal Mobaro format: resourceType/123456-A. You can locate these IDs from the Mobaro backend or the API directly.
Parameter | Description | Expected Format | Example |
| Filter Results or Assignments by Checklist |
|
|
| Limit queries to specific location groups |
|
|
| Limit to one or more Locations |
|
|
| Used in asset or assignment filtering |
|
|
| Filter results or assignments by schedule |
|
|
| Used to define or filter schedule slots |
|
|
| Filter by user (e.g. responses or assignments) |
|
|
Important: Always include the full resource path prefix (checklists/, locations/, etc.). Omitting this will return an error or no data.
Pagination and limits
These parameters control how many results you get per request and which batch of results to retrieve.
Parameter | Description | Type | Format / Range | Example |
| Max number of results to return | Integer | 1–20 (default endpoints), up to 128 on bulk endpoints |
|
| How many results to skip (pagination) | Integer | 0–2147483647 |
|
Date filters
Date filters use the ISO-8601 format (YYYY-MM-DDTHH:mm:ssZ), and must be UTC timestamps.
Parameter | Description | Type | Example |
| Items created before this time | String |
|
| Items created after this time | String |
|
| Items updated before this time | String |
|
| Items updated after this time | String |
|
Sorting and ordering
Parameter | Description | Type | Example |
| Sort results by a specific field | String |
|
Tip: Add :asc or :desc to control direction. Example: OrderBy=createdAt:desc
Assignment-specific filters
These parameters are specific to the Assignments endpoint.
Parameter | Description | Type | Example |
| Filter by current state of assignment | Array of strings |
|
| Filter by Assignment Definitions | Array of strings |
|
| Filter by states of those definitions | Array of strings |
|
| Filter assignments that use priority settings | Boolean |
|
File- and competency-related filters
Parameter | Description | Type | Example |
| Filter certifications by competency | Array of strings |
|
| For Certifications: filter by award date | String (ISO-8601) |
|
Example query
Here's an example request to filter Results using several parameters:
GET /api/customers/results?
Checklists=checklists/123456-A&
Locations=locations/654321-A&
Users=users/111111-A&
CreatedAfter=2025-01-01T00:00:00Z&
Limit=10
This returns up to 10 results completed after Jan 1st, 2025 by that user, in that location, for that checklist.
Frequently asked questions
Q: How do I find my internal Mobaro ID for a resource?
A: From the Mobaro backend, open the item and look in the URL or use the API to list resources (e.g., GET /api/customers/assets).
Q: What happens if I use the wrong ID format?
A: The API will return an error or empty result. Always use the full internal path like assets/123456-A.
Q: Can I filter by multiple parameters at once?
A: Yes! Most endpoints support combining filters like Checklists, Locations, Users, and more in a single call.
Q: Are these case-sensitive?
A: Yes. IDs and enums must match the expected case exactly (Created, not created).