Locations (Occupant/Customer)

To retrieve locations, call the endpoint at GET/api/locations

❗️
Important
The Locations API retrieves data pertaining to locations, including properties, buildings, work zones, and associated spaces, that are registered within the CorrigoPro system on the customer side. The response returned by this endpoint is determined by a set of defined eligibility criteria that govern which work zones are associated with a given service provider.
Specifically, the system automatically evaluates and detects all work zones that are associated with the connected provider. A work zone is deemed eligible for inclusion in the location retrieval response if the service provider satisfies at least one of the following conditions:

Active PMRM/Schedule Assignment – The service provider has been assigned to a minimum of one active Preventive Maintenance/Recurring Maintenance (PMRM) schedule.

Specialty Dispatch Table Assignment – The service provider is listed within the Specialty Dispatch Table, whether through a direct (local) assignment or via an inherited assignment from a parent configuration.

On-Call Schedule Table Assignment – The service provider appears within the On-Call Schedule Table, either as a locally configured entry or as an inherited assignment.

Work Order Assignment History – The service provider has been designated as the assignee for either a completed or currently active work order associated with the location in question.

If any one or more of these conditions is satisfied, the corresponding work zone, along with its related location data, will be included in the API response. Should none of the above conditions be met for a given work zone, that work zone will be excluded from the retrieval, and the response may return NULL results for the connected service provider.