GeofenceItemResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200

Example: 200

resultsobject

successboolean

Indicates whether the request was successful (normally true if it's not an error response)

Default value: true

uristring<uri-reference>

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users

result object

A geofence definition that specifies a geographic boundary for location-based access control.

Geofences are used to ensure users are physically present at approved locations when submitting time entries, expense entries, or custom entries. When a geofence is assigned to users, groups, projects, or entry screens, the system validates that the user's location falls within at least one applicable geofence boundary before allowing entry submission.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-reference>

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

The name of the internal database table associated with this resource.

Example: users

table_labelstring

The user-visible label of the database table associated with this object.

Example: codes_pay_types

pnamestringrequired

The display name of the geofence. Must be unique across all geofences.

Possible values: non-empty and <= 100 characters

Example: Downtown Office

descriptionstring

Optional description providing additional context about this geofence.

Possible values: <= 500 characters

Default value:

Example: Main office building and parking garage

typestring

The shape type of the geofence. Currently, only "circle" is supported.

Database Representation: The API accepts and returns string values, but the database stores this as an integer (1 = circle).

Possible values: [circle]

Default value: circle

Example: circle

latitudenumber<float>required

The latitude of the geofence center point in decimal degrees.

Must be between -90 (South Pole) and 90 (North Pole). Cannot be 0.0 if longitude is also 0.0.

Field Aliases: The API also accepts center_lat as an alternative field name.

Possible values: >= -90 and <= 90

Example: 30.2672

longitudenumber<float>required

The longitude of the geofence center point in decimal degrees.

Must be between -180 and 180. Cannot be 0.0 if latitude is also 0.0.

Field Aliases: The API also accepts center_lon as an alternative field name.

Possible values: >= -180 and <= 180

Example: -97.7431

radiusnumber<float>required

The radius of the geofence in meters.

Must be greater than 0 and less than or equal to 100,000 meters (100 km / 62 miles).

Field Aliases: The API also accepts radius_meters as an alternative field name.

Possible values: >= 0.001 and <= 100000

Example: 100

min_accuracynumber<float>

The minimum required GPS accuracy in meters for location validation.

When a user submits an entry with location data, if the GPS accuracy is worse (larger value) than this threshold, the validation will fail. Set to 0 to accept any accuracy level.

Field Aliases: The API also accepts min_accuracy_meters as an alternative field name.

Possible values: >= 0

Default value: 10

Example: 10

activeboolean

Whether this geofence is currently active.

Inactive geofences are not enforced but remain in the system for historical or future use.

Database Representation: The API accepts and returns boolean values, but the database stores this as an integer (0 = false, 1 = true).

Default value: true

Example: true

is_priorityboolean

Whether this is a priority geofence.

When a user/project combination has multiple applicable geofences, if ANY of them are marked as priority, ONLY the priority geofences are checked. This allows you to create more restrictive boundaries that override general geofences.

For example, a general office geofence might cover a large area, but a priority geofence could restrict certain projects to a specific floor or section.

Database Representation: The API accepts and returns boolean values, but the database stores this as an integer (0 = false, 1 = true).

Field Aliases: The API also accepts priority as an alternative field name.

Default value: false

Example: false

colorstringnullable

Optional hex color code for displaying this geofence on a map.

Must be in the format #RRGGBB (e.g., #FF0000 for red, #3366CC for blue).

Possible values: Value must match regular expression ^#[0-9A-Fa-f]{6}$

Example: #3366CC

assignments object[]

List of entity assignments for this geofence. A geofence can be assigned to users, groups, projects, or entry screens. When determining if a geofence applies to a particular entry, the system checks if the user or project matches any of these assignments.

The geofence enforcement uses OR logic: a user only needs to be within ONE applicable geofence to pass validation.

Note: This field is computed from the geofence_assignments table and is read-only in GET responses. To modify assignments, include an assignments array in POST/PUT requests.

Array [

target_tablestringrequired

The database table name of the entity type being assigned.

Valid target tables:

users - Individual user assignments
groups - User group assignments (applies to all group members)
projects - Project assignments (including PX tasks, which are projects)
time_guis - Time entry screen assignments
expense_guis - Expense entry screen assignments
travel_entry_guis - Custom entry screen assignments (formerly "Mileage Entry")

Possible values: [expense_guis, groups, projects, time_guis, travel_entry_guis, users]

Example: users

target_idstringrequired

The ID of the entity being assigned. This must be a valid ID from the specified target_table.

When creating or updating assignments, the API validates that all referenced entities exist. If any target entity does not exist, the request will fail with a 400 Bad Request error.

Example: 5CD906A3941C463B9CC98F49DBCC25AA

]

creatorstring

The internal User ID of the user who created the object.

Example: 64BBA147B9AC41D9978062300826C89F

creator_fullnamestring

The full name of the user who created the object.

Example: John Doe

creator_properties object

Extended information about the User who created the object. This field is only included if the $keys parameter requests it.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-reference>

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

The name of the internal database table associated with this resource.

Example: users

table_labelstring

The user-visible label of the database table associated with this object.

Example: codes_pay_types

custom_fields object

An object with Custom Fields for this record. The key is the field ID and the value a description of the field. Additional details here: CustomFields Schema

tip

Updating Custom Field values

When creating or updating an existing object that uses Custom Fields, for example a User record, you can follow this custom_field key structure to update the custom field values. The value field is the only required field for updating a custom field value; other fields such as pname will be ignored.

info

Important: depending on the endpoint, this may only be included in the response if $keys=custom_fields or $keys=$extended was set as a query parameter.

There is also a more compact representation available in most object types, where each custom field value is a separate key in the main object (not under custom_fields).

See the CustomFields Schema page for more detailed information on these topics.

property name* CustomFieldValue

A specific instance (value) of a Custom field for a particular object.

id_attr_typestring

The unique internal ID of this Custom Field definition (same as id field)

Example: 2DDD372DC4D3422D9E73F6DE936C4265

attr_typestring

Datatype of the custom field. The basic types available are:

STRING - a variable-length string.
CHAR - a fixed-length string. (The value may be padded with spaces.)
NUMBER - a floating-point number.
INTEGER - an integer (whole number).
TIMESTAMP - a date and time, stored in Unix epoch format.
DATE - a YYYYMMDD (F8) date.

In addition, most types can be modified with a prefix to indicate whether they are "select lists" (ENUM or enumerated) or "multi-select lists" (M_ENUM) which can take on multiple values.

Strings and char may also have a maximum length specified, such as STRING_100.

Example: STRING_100

descriptionstring

Description of custom field

pnamestring

Name of custom field

Example: Pay Group

id_attr_type_uristring

URI of the custom field to get more information about the custom field definition.

Example: /api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9

valuestring

Value of the custom field for this object. To update the value, see the note on the CustomFields schema page.

Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

Example: XYZ Pay Group

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

lr for Loggable and Reportable
ro for Reportable Only
h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

expense_guistring

The ID of the user's assigned Expense entry screen configuration.

time_guistring

The ID of the user's assigned time entry screen configuration.

travel_guistring

The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

creatorstring

The internal User ID of the user who created the object.

Example: 64BBA147B9AC41D9978062300826C89F

creator_fullnamestring

The full name of the user who created the object.

Example: John Doe

creator_propertiesobject

Extended information about the User who created the object. This field is only included if the $keys parameter requests it.

create_timestampnumber<float>

The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

create_timestamp_date_longstring

The object creation date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

create_timestamp_date_shortstring

The object creation date in the "short date" format defined in the system settings.

Example: 03/22/2023

create_timestamp_datetime_longstring

The object creation date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

create_timestamp_datetime_shortstring

The object creation date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

create_timestamp_isostring<date-time>

The creation timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

modify_timestampnumber<float>

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

modify_timestamp_date_longstring

The last modification date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

modify_timestamp_date_shortstring

The last modification date in the "short date" format defined in the system settings.

Example: 03/22/2023

modify_timestamp_datetime_longstring

The last modification date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

modify_timestamp_datetime_shortstring

The last modification date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

modify_timestamp_isostring<date-time>

The last modification timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

id_domainstring

The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

Example: install_root_dom

daysinlistinteger

UNUSED FIELD This is a legacy field that is no longer used.

emailstring

The email address of the user.

Note: This is a read-only field. To change the user's email address, you must modify the users_attribs:users_email field, or custom_fields.users_email.value.

first_namestring

The first name of the user.

Note: read-only; set via the fullname field.

id_userstring

The unique internal ID of this user. (Same as id.)

Example: 5CD906A3941C463B9CC98F49DBCC25AA

last_namestring

The last name of the user.

Note: read-only; set via the fullname field.

memorized_sheet_choices object[]

A list of memorized timesheets associated with the user.

These are the choices available to set in the default_memorized_sheet field.

Array [

valuestring

The internal ID of the memorized timesheet.

textstring

The name of the memorized timesheet.

]

reserved1string

UNUSED FIELD This is a legacy field that is no longer used.

reserved2number<float>

UNUSED FIELD This is a legacy field that is no longer used.

reserved3number<float>

UNUSED FIELD This is a legacy field that is no longer used.

timerecs_outinteger

UNUSED FIELD This is a legacy field that is no longer used.

time_gui_propertiesobject

Details about the user's assigned time entry screen configuration.

travel_gui_propertiesobject

Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

expense_gui_propertiesobject

Details about the user's assigned Expense entry screen configuration.

modify_timestampnumber<float>

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

modify_timestamp_date_longstring

The last modification date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

modify_timestamp_date_shortstring

The last modification date in the "short date" format defined in the system settings.

Example: 03/22/2023

modify_timestamp_datetime_longstring

The last modification date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

modify_timestamp_datetime_shortstring

The last modification date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

modify_timestamp_isostring<date-time>

The last modification timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

assignments_countinteger

The total number of assignments for this geofence. This is a computed field that counts the number of records in the geofence_assignments table for this geofence.

This field can be used for filtering, e.g., $filter=assignments_count gt 0 to find geofences with at least one assignment.

Example: 5

GeofenceItemResponse
{
  "response_code": 200,
  "results": {},
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users",
  "result": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "pname": "Downtown Office",
    "description": "Main office building and parking garage",
    "type": "circle",
    "latitude": 30.2672,
    "longitude": -97.7431,
    "radius": 100,
    "min_accuracy": 10,
    "active": true,
    "is_priority": false,
    "color": "#3366CC",
    "assignments": [
      {
        "target_table": "users",
        "target_id": "5CD906A3941C463B9CC98F49DBCC25AA"
      }
    ],
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_properties": {
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types",
      "custom_fields": {
        "C41B2DDA662F4EF6B730F9CB6DB04696": {
          "attr_type": "ENUM_STRING_252",
          "description": "Employee pay group.",
          "id_attr_type": "C41B2DDA662F4EF6B730F9CB6DB04696",
          "id_attr_type_uri": "/api/v1/custom_fields/C41B2DDA662F4EF6B730F9CB6DB04696",
          "pname": "Pay Group",
          "value": "XYZ Pay Group"
        },
        "users_email": {
          "attr_type": "STRING_252",
          "description": "Email address",
          "id_attr_type": "users_email",
          "id_attr_type_uri": "/api/v1/custom_fields/users_email",
          "pname": "Email Address",
          "value": "username@example.com"
        }
      },
      "group_names": [
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        }
      ],
      "groups": [
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195"
      ],
      "is_hidden": true,
      "hidden": true,
      "status": "Loggable and Reportable",
      "status_code": "lr",
      "user_login": "john.smith@example.com",
      "fullname": "John Smith",
      "u_comment": "string",
      "default_memorized_sheet": "string",
      "dropdownthreshold": 0,
      "hide": true,
      "expire_new_pw": true,
      "new_pw": "string",
      "new_pw2": "string",
      "roles": [
        "string"
      ],
      "timerecs_in": 3,
      "time_period": "default_weekly",
      "expense_period": "default_weekly",
      "custom_period": "default_weekly",
      "expense_gui": "string",
      "time_gui": "string",
      "travel_gui": "string",
      "create_timestamp": 1696021987.01375,
      "create_timestamp_date_long": "Wednesday, March 22, 2023",
      "create_timestamp_date_short": "03/22/2023",
      "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
      "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
      "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
      "modifier": "64BBA147B9AC41D9978062300826C89F",
      "modifier_fullname": "John Doe",
      "modifier_properties": {},
      "modify_timestamp": 1696021987.01375,
      "modify_timestamp_date_long": "Wednesday, March 22, 2023",
      "modify_timestamp_date_short": "03/22/2023",
      "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
      "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
      "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
      "id_domain": "install_root_dom",
      "daysinlist": 0,
      "email": "string",
      "first_name": "string",
      "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
      "last_name": "string",
      "memorized_sheet_choices": [
        {
          "value": "string",
          "text": "string"
        }
      ],
      "reserved1": "string",
      "reserved2": 0,
      "reserved3": 0,
      "timerecs_out": 0,
      "time_gui_properties": {},
      "travel_gui_properties": {},
      "expense_gui_properties": {}
    },
    "create_timestamp": 1696021987.01375,
    "create_timestamp_date_long": "Wednesday, March 22, 2023",
    "create_timestamp_date_short": "03/22/2023",
    "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "modifier": "64BBA147B9AC41D9978062300826C89F",
    "modifier_fullname": "John Doe",
    "modifier_properties": {
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types",
      "custom_fields": {
        "C41B2DDA662F4EF6B730F9CB6DB04696": {
          "attr_type": "ENUM_STRING_252",
          "description": "Employee pay group.",
          "id_attr_type": "C41B2DDA662F4EF6B730F9CB6DB04696",
          "id_attr_type_uri": "/api/v1/custom_fields/C41B2DDA662F4EF6B730F9CB6DB04696",
          "pname": "Pay Group",
          "value": "XYZ Pay Group"
        },
        "users_email": {
          "attr_type": "STRING_252",
          "description": "Email address",
          "id_attr_type": "users_email",
          "id_attr_type_uri": "/api/v1/custom_fields/users_email",
          "pname": "Email Address",
          "value": "username@example.com"
        }
      },
      "group_names": [
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        }
      ],
      "groups": [
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195"
      ],
      "is_hidden": true,
      "hidden": true,
      "status": "Loggable and Reportable",
      "status_code": "lr",
      "user_login": "john.smith@example.com",
      "fullname": "John Smith",
      "u_comment": "string",
      "default_memorized_sheet": "string",
      "dropdownthreshold": 0,
      "hide": true,
      "expire_new_pw": true,
      "new_pw": "string",
      "new_pw2": "string",
      "roles": [
        "string"
      ],
      "timerecs_in": 3,
      "time_period": "default_weekly",
      "expense_period": "default_weekly",
      "custom_period": "default_weekly",
      "expense_gui": "string",
      "time_gui": "string",
      "travel_gui": "string",
      "creator": "64BBA147B9AC41D9978062300826C89F",
      "creator_fullname": "John Doe",
      "creator_properties": {},
      "create_timestamp": 1696021987.01375,
      "create_timestamp_date_long": "Wednesday, March 22, 2023",
      "create_timestamp_date_short": "03/22/2023",
      "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
      "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
      "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
      "modify_timestamp": 1696021987.01375,
      "modify_timestamp_date_long": "Wednesday, March 22, 2023",
      "modify_timestamp_date_short": "03/22/2023",
      "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
      "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
      "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
      "id_domain": "install_root_dom",
      "daysinlist": 0,
      "email": "string",
      "first_name": "string",
      "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
      "last_name": "string",
      "memorized_sheet_choices": [
        {
          "value": "string",
          "text": "string"
        }
      ],
      "reserved1": "string",
      "reserved2": 0,
      "reserved3": 0,
      "timerecs_out": 0,
      "time_gui_properties": {},
      "travel_gui_properties": {},
      "expense_gui_properties": {}
    },
    "modify_timestamp": 1696021987.01375,
    "modify_timestamp_date_long": "Wednesday, March 22, 2023",
    "modify_timestamp_date_short": "03/22/2023",
    "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "assignments_count": 5
  }
}