Skip to main content

List geofences

GET 
/api/v1/geofences

Retrieve a list of geofences in the system.

Geofences define geographic boundaries for location-based access control. This endpoint supports filtering, sorting, and pagination to help you find and manage geofences.

Version 13.5.0 (25H2) or higher required

The Geofences REST API was introduced in Journyx version 13.5.0 (25H2). Please ensure your Journyx instance is running this version or later to access these endpoints.

Special Filtering Capabilities​

In addition to standard field filtering, this endpoint supports advanced filtering on assignments:

Filter by assignment target table:

$filter=assignments.target_table eq "users"

Filter by specific assignment target ID:

$filter=assignments.target_id eq "alice"

Filter for geofences with no assignments:

$filter=assignments eq []

Filter for geofences with at least one assignment:

$filter=assignments ne []

Filter by assignment count:

$filter=assignments_count gt 0
Required abilities

This operation requires authentication. Results are filtered based on the user's Geofence - Manage ability or Authority - Administrator role.

Request​

Responses​

A successful response from a paged collection; see the results array in the response for the list of results for this page. Additional pages may be available and can be fetched using the @nextLink URL.

Note that the examples given may include keys (fields) that may not always be present in the response, depending on the fields requested in the $keys parameter, the user's permissions, and other system settings.