Overview
This article is a reference for the query parameters you'll use most with the Mobaro API: ID filters, paging, date filters and sorting. Parameters differ between endpoints, so each section says which endpoints accept what.
For the complete, always-current list, open the interactive Mobaro API documentation. It's also linked from the book icon (tooltip Open Documentation) on the API Keys panel under Configuration › API. New to the API? Start with Getting started with the Mobaro API.
At a glance |
|
Who can do this | Anyone calling the Mobaro API with an API key |
Where | Full reference: Configuration › API › API Keys › Open Documentation |
Works on | Public API |
Availability | Enabled per organization by Mobaro — ask your CSM |
How API filters combine
Parameters go in the query string. To pass several values for the same filter, repeat the parameter:
GET /api/customers/results?Locations=locations/345678-A&Locations=locations/345679-A
Different filters combine: a record must match all of them. Several values for one filter match any of them. One exception: on Results, Locations and LocationGroups are merged into one list, so a Result matches if its Location is in either.
API ID filters
These filters take one or more full IDs, including the prefix.
⚠️ Heads-up: Mobaro IDs include the resource type as a prefix: resourceType/123456-A, for example locations/654321-A. Always include the prefix (checklists/, locations/ and so on). An ID without its prefix doesn't match anything, so a list filter returns no data.
Parameter | Accepted by | Example value |
| Results |
|
| Results, Assignments, Assets, Downtimes, Notes, Uptime periods |
|
| Results, Assignments, Downtimes, Notes, Locations |
|
| Results |
|
| Assets (parent asset) |
|
| Results |
|
| Results (schedule slot IDs) | See the Mobaro API documentation |
| Results, Timesheets |
|
| Assignments |
|
| Certifications |
|
API paging
Parameter | Range and default | Example |
| Most list endpoints: 1–128, default 128. Results (including resumable results): 1–20, default 20. |
|
| 0 or more, default 0 |
|
List responses are wrapped in an envelope: items (the page), amount (items in this page), offset, and total (matching items across all pages). Increase Offset by your Limit until offset + amount reaches total.
⚠️ Heads-up: A Limit above the maximum isn't trimmed down; the request fails with 400 Bad Request. On Results, Limit=100 fails. See Handling errors, rate limits, and retry logic.
API date filters
Date filters take ISO 8601 date-times. Include the time zone, for example 2025-07-01T00:00:00Z for UTC. Each …Before and …After pair can be used on its own or together to make a range. Which pairs exist depends on the endpoint:
Endpoint | Date filters |
Results |
|
Users, Locations, Assets, Notes, Assignments |
|
Downtimes |
|
Uptime periods |
|
Timesheets |
|
Certifications |
|
For example, AnsweredAfter=2025-06-01T00:00:00Z on Results, or CreatedAfter=2025-06-01T00:00:00Z on Users.
Sort API results
OrderBy takes one field name. Add a minus sign in front to sort descending: OrderBy=answered sorts oldest first, OrderBy=-answered newest first. An unsupported value returns 400 with the allowed values.
Endpoint | Allowed OrderBy values (add - for descending) |
Results |
|
Resumable results |
|
Assignments, Locations |
|
Users |
|
Assets, Notes |
|
Downtimes |
|
Uptime periods |
|
Timesheets |
|
Certifications |
|
Assignment definitions, Calendars, Competencies, Location groups, Roles, Schedules, User groups |
|
Assignment and Downtime filters
Parameter | Description | Example |
| Current state: |
|
| Assignment Definition IDs |
|
| Assignment Definition state IDs | See the Mobaro API documentation |
|
|
|
|
|
|
Example Results query
This request returns up to 10 Results for that Checklist, Location and User, answered after 1 January 2025, newest first:
GET /api/customers/results?Checklists=checklists/123456-A&Locations=locations/654321-A&Users=users/111111-A&AnsweredAfter=2025-01-01T00:00:00Z&OrderBy=-answered&Limit=10
For a worked example of pulling Results on a schedule, see Pulling Results via the API.
Best practices
When you page through a large set, always set
OrderByso every page uses the same order.Always use full, prefixed IDs in ID filters.
Frequently asked questions
How do I find the ID of a Location or other record?
List the resource through the API (for example GET /api/customers/locations) and read the id field. For what IDs look like, including the letter at the end, see Understanding IDs in Mobaro.
What happens if I use the wrong Mobaro ID format in an API filter?
A list filter with an ID that's missing its prefix matches nothing, so you get an empty page. Always use the full ID, like assets/123456-A.
Results show questions as elements/XXXX IDs. How do I get the question text?
Look them up in the Checklist with GET /api/customers/checklists/{checklistId}?includeContent=true&revision={checklistRevision}. See Pulling Results via the API.
Can the Assignments endpoint return deleted Assignments?
No. GET /api/customers/assignments never returns deleted Assignments, and there's no parameter to include them. To track deletions, use an Assignments webhook with the Deleted event. See Using webhooks in Mobaro.