CrewSheetsCollectionResponse
HTTP status code of the response for reference purposes.
200200Indicates whether the request was successful (normally true if it's
not an error response).
trueURL of the current request / resource, for reference purposes.
https://example.apps.journyx.com/api/v1/usersThe total number of items matching the query; not the number of items in the current response.
100The number of items skipped in the query; in other words, the offset of the first item in the current response compared to the total set of items in the collection. When used as a query parameter, this is the number of items to skip over.
0The number of items returned in the current response. When used as a query parameter, this is the maximum number of items to return.
10The URL to fetch the next set (page) of results.
https://example.apps.journyx.com/api/v1/users?$top=10&$skip=10results object[]
One user you may keep sheets for, together with that user's sheet in each
entry type for the period containing the requested sheet_date.
The collection is a list of users, not of sheets. A user appears once per
page even when they have three sheets, and appears even when they have none
yet, so long as they match the filters. When a user matches but no sheet
block can be built for them, the row still carries id_user and the
fullname and user_login properties, so that page counts stay correct.
Beyond the fields listed here, a row carries one additional property for
each user custom field configured as a column on the Crew Entry screen. The
property name is the literal prefix users_attribs: followed by the custom
field's ID, and the value is that user's value for the field. For example, a
row might include "users_attribs:users_dept": "Sales". The same name works
as a $filter key, whether or not the field is configured as a column.
The internal ID of the user this row describes.
aliceid_user_properties objectrequired
Details of the user the row describes. These are properties of the user, not of any one sheet, so they are returned whether or not the user has sheets in the period.
The entry screen name fields (time_gui_pname and friends) and the approval
plan name fields are only returned when a matching column is configured on
the Crew Entry screen, because each one costs an extra lookup. Configure
columns through the
Screen settings endpoints.
The user's full name.
Alice DevThe user's sign-in name.
aliceThe user's preferred time zone as an IANA name, or an empty string when the user has not set one, in which case the server's zone applies. Use this when displaying punch times from the user's sheets.
America/New_YorkThe name of the approval plan that governs the user's time sheets, or an
empty string when none applies. Only returned when the
id_user_properties.time_approvals_pname column is configured on the
Crew Entry screen.
Weekly Manager ApprovalThe name of the approval plan that governs the user's expense sheets, or
an empty string when none applies. Only returned when the
id_user_properties.expense_approvals_pname column is configured on the
Crew Entry screen.
Expense ReviewThe name of the approval plan that governs the user's custom entry
sheets, or an empty string when none applies. Only returned when the
id_user_properties.custom_approvals_pname column is configured on the
Crew Entry screen.
Mileage ReviewThe ID of the time entry screen assigned to the user. Only returned when
the id_user_properties.time_gui_pname column is configured on the Crew
Entry screen.
4C1D9F0A78B94E1C8E5B2D6F3A70C915The name of the time entry screen assigned to the user. Only returned when this column is configured on the Crew Entry screen.
Standard Weekly TimeThe ID of the expense entry screen assigned to the user. Only returned
when the id_user_properties.expense_gui_pname column is configured on
the Crew Entry screen.
9E2F4B7C15D8402A93C6E1B84F70D3A2The name of the expense entry screen assigned to the user. Only returned when this column is configured on the Crew Entry screen.
Standard ExpenseThe ID of the custom entry screen assigned to the user. Only returned
when the id_user_properties.custom_gui_pname column is configured on
the Crew Entry screen.
B7D3169E4A0C42F5810B9C2E7D45A836The name of the custom entry screen assigned to the user. Only returned when this column is configured on the Crew Entry screen.
Standard Mileagetime object
The state of one user's sheet of a single entry type, for the period that
contains the requested sheet_date.
A block is present for an entry type only when all of the following are
true: the type is enabled on the Crew Entry screen, you hold that type's
keeper ability, you share a group with the user that carries the role
granting it, and the type was not excluded by the sheet_types parameter.
A block describes a period, not necessarily a saved sheet. When the user has
no sheet for the period, the block is still returned but the sheet-specific
fields (id_sheet, status_int, status_str, pname, dates) are all
absent. Test for id_sheet to tell the two apart. If the sheet_state
filter is in use, a block is only returned when its own state is one of the
requested states, so a user can appear with fewer blocks than you asked for.
A block also carries a few fields that exist to drive the Journyx web interface, such as display classes and a link into a server-rendered screen. They are deliberately left out of this reference, are not part of the supported interface, and may change or disappear in any release. Build against the fields documented below.
The internal ID of the user's sheet. Absent when the user has no sheet for this period yet. Pass this to the Submit crew sheets endpoint.
6C5469825DAE4ABF9654B7A567141CD8The entry type this block describes. Note that the third type is called
custom here (it is the Custom Entry / mileage type); elsewhere in the
API and in the product's history it is sometimes called mileage.
Possible values: [time, expense, custom]
timeThe administrator-configurable display label for this entry type, for
example Time. Site labels are renameable, so do not test against this
value; use sheettype instead.
TimeThe sheet's state as a number: 0 open, 1 submitted, 2 approved,
3 rejected. Absent when no sheet exists for the period.
This is the field to test in code. The sheet_state filter uses the
equivalent names (open, submitted, approved, rejected), plus
no_sheet for a period with no sheet, which has no numeric form.
Possible values: [0, 1, 2, 3]
0A human-readable label for the sheet's state, suitable for display.
Absent when no sheet exists for the period. Do not test against this
value; use status_int.
Open for EntryThe sheet's name, which for a period sheet is normally its date range. Absent when no sheet exists for the period.
03/09/2025 - 03/15/2025The sheet's date range as displayed, in the signed-in user's date format. Absent when no sheet exists for the period.
03/09/2025 - 03/15/2025Why an approver rejected the sheet. Present only when status_int is
3 (rejected).
Please split the Friday hours across the two tasks.The full name of the user who owns the sheet. This repeats
id_user_properties.fullname on the enclosing row, and exists so that
a submit request echoed back from a block can be labeled in an error
message.
Alice Devexpense object
The state of one user's sheet of a single entry type, for the period that
contains the requested sheet_date.
A block is present for an entry type only when all of the following are
true: the type is enabled on the Crew Entry screen, you hold that type's
keeper ability, you share a group with the user that carries the role
granting it, and the type was not excluded by the sheet_types parameter.
A block describes a period, not necessarily a saved sheet. When the user has
no sheet for the period, the block is still returned but the sheet-specific
fields (id_sheet, status_int, status_str, pname, dates) are all
absent. Test for id_sheet to tell the two apart. If the sheet_state
filter is in use, a block is only returned when its own state is one of the
requested states, so a user can appear with fewer blocks than you asked for.
A block also carries a few fields that exist to drive the Journyx web interface, such as display classes and a link into a server-rendered screen. They are deliberately left out of this reference, are not part of the supported interface, and may change or disappear in any release. Build against the fields documented below.
The internal ID of the user's sheet. Absent when the user has no sheet for this period yet. Pass this to the Submit crew sheets endpoint.
6C5469825DAE4ABF9654B7A567141CD8The entry type this block describes. Note that the third type is called
custom here (it is the Custom Entry / mileage type); elsewhere in the
API and in the product's history it is sometimes called mileage.
Possible values: [time, expense, custom]
timeThe administrator-configurable display label for this entry type, for
example Time. Site labels are renameable, so do not test against this
value; use sheettype instead.
TimeThe sheet's state as a number: 0 open, 1 submitted, 2 approved,
3 rejected. Absent when no sheet exists for the period.
This is the field to test in code. The sheet_state filter uses the
equivalent names (open, submitted, approved, rejected), plus
no_sheet for a period with no sheet, which has no numeric form.
Possible values: [0, 1, 2, 3]
0A human-readable label for the sheet's state, suitable for display.
Absent when no sheet exists for the period. Do not test against this
value; use status_int.
Open for EntryThe sheet's name, which for a period sheet is normally its date range. Absent when no sheet exists for the period.
03/09/2025 - 03/15/2025The sheet's date range as displayed, in the signed-in user's date format. Absent when no sheet exists for the period.
03/09/2025 - 03/15/2025Why an approver rejected the sheet. Present only when status_int is
3 (rejected).
Please split the Friday hours across the two tasks.The full name of the user who owns the sheet. This repeats
id_user_properties.fullname on the enclosing row, and exists so that
a submit request echoed back from a block can be labeled in an error
message.
Alice Devcustom object
The state of one user's sheet of a single entry type, for the period that
contains the requested sheet_date.
A block is present for an entry type only when all of the following are
true: the type is enabled on the Crew Entry screen, you hold that type's
keeper ability, you share a group with the user that carries the role
granting it, and the type was not excluded by the sheet_types parameter.
A block describes a period, not necessarily a saved sheet. When the user has
no sheet for the period, the block is still returned but the sheet-specific
fields (id_sheet, status_int, status_str, pname, dates) are all
absent. Test for id_sheet to tell the two apart. If the sheet_state
filter is in use, a block is only returned when its own state is one of the
requested states, so a user can appear with fewer blocks than you asked for.
A block also carries a few fields that exist to drive the Journyx web interface, such as display classes and a link into a server-rendered screen. They are deliberately left out of this reference, are not part of the supported interface, and may change or disappear in any release. Build against the fields documented below.
The internal ID of the user's sheet. Absent when the user has no sheet for this period yet. Pass this to the Submit crew sheets endpoint.
6C5469825DAE4ABF9654B7A567141CD8The entry type this block describes. Note that the third type is called
custom here (it is the Custom Entry / mileage type); elsewhere in the
API and in the product's history it is sometimes called mileage.
Possible values: [time, expense, custom]
timeThe administrator-configurable display label for this entry type, for
example Time. Site labels are renameable, so do not test against this
value; use sheettype instead.
TimeThe sheet's state as a number: 0 open, 1 submitted, 2 approved,
3 rejected. Absent when no sheet exists for the period.
This is the field to test in code. The sheet_state filter uses the
equivalent names (open, submitted, approved, rejected), plus
no_sheet for a period with no sheet, which has no numeric form.
Possible values: [0, 1, 2, 3]
0A human-readable label for the sheet's state, suitable for display.
Absent when no sheet exists for the period. Do not test against this
value; use status_int.
Open for EntryThe sheet's name, which for a period sheet is normally its date range. Absent when no sheet exists for the period.
03/09/2025 - 03/15/2025The sheet's date range as displayed, in the signed-in user's date format. Absent when no sheet exists for the period.
03/09/2025 - 03/15/2025Why an approver rejected the sheet. Present only when status_int is
3 (rejected).
Please split the Friday hours across the two tasks.The full name of the user who owns the sheet. This repeats
id_user_properties.fullname on the enclosing row, and exists so that
a submit request echoed back from a block can be labeled in an error
message.
Alice Devscreen object
Returned only when the request sets $screenInclude=1. This carries the
Crew Entry screen's column configuration, in the shape shared by all
collection endpoints, plus a few fields specific to crew entry that describe
what the signed-in user is allowed to do.
A client that only reads sheet data does not need this. It exists so that a user interface can lay out the correct columns and hide actions the user cannot perform.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typesThe internal User ID of the user who created the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who created the object.
John Doecreator_properties object
Extended information about the User who
created the object.
This field is only included if the $keys parameter requests it.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typescustom_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
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.
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.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
STRING_100Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupgroup_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.
The Group ID (32-character hexadecimal string).
The Group name.
The URI of the Group.
WARNING: this field is planned in a future release but is not yet available.
A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.
["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195","5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]The login name of the user.
john.smith@example.comThe full name of the user.
John SmithThe default comment on the user's time entry screen.
The status of the user; either active, inactive, or hidden.
This is a write-enabled field if you have the appropriate permissions.
This field can also be used in a $filter expression, e.g.
$filter=status eq "active" or
$filter=status intersects ["active","inactive"].
Note: unlike most other objects, users do not use the generic
visibility statuses (Loggable and Reportable, Reportable Only),
and User records do not include a status_code field.
Possible values: [active, hidden, inactive]
activeThe ID of the user's default memorized timesheet.
The user's default IANA timezone name (e.g. America/Chicago).
Used as a fallback when the client does not supply a timezone with
a save request. Set to null or empty string to clear.
Must be a valid IANA timezone name or a Windows timezone name
(which will be converted to the canonical IANA name). Invalid values
will cause a 400 Bad Request error.
The Timezones endpoint provides a searchable list of valid timezone values.
America/ChicagoThe number of items in a selection list to trigger a forced search.
Indicates whether the user is hidden.
Note: the User object is the only one that uses this field; other objects
use is_hidden.
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.
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.
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.
A list of role IDs belonging to this user.
This list can be modified to change the user's roles.
The number of blank rows to show on the entry screen.
3The "Entry Screen period" (time-span) associated with the user's Time Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Expense Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Custom Entry screen.
default_weeklyThe ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal User ID of the user who most recently modified the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who most recently modified the object.
John DoeExtended information about the User who
last modified the object.
This field is only included if the $keys parameter requests it.
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.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domUNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname field.
The unique internal ID of this user. (Same as id.)
5CD906A3941C463B9CC98F49DBCC25AAIndicates whether the user is hidden.
See also status. To hide or un-hide a user, write the hide or
status field instead.
Indicates whether the user is hidden.
Read-only alias for is_hidden; only included when requested via
$keys (e.g. $keys=$extended).
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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal User ID of the user who most recently modified the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who most recently modified the object.
John Doemodifier_properties object
Extended information about the User who
last modified the object.
This field is only included if the $keys parameter requests it.
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.
64BBA147B9AC41D9978062300826C89FThe 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.
/api/v1/objects/64BBA147B9AC41D9978062300826C89FThe name of the internal database table associated with this resource.
usersThe user-visible label of the database table associated with this object.
codes_pay_typescustom_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
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.
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.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
STRING_100Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupgroup_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.
The Group ID (32-character hexadecimal string).
The Group name.
The URI of the Group.
WARNING: this field is planned in a future release but is not yet available.
A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.
["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195","5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]The login name of the user.
john.smith@example.comThe full name of the user.
John SmithThe default comment on the user's time entry screen.
The status of the user; either active, inactive, or hidden.
This is a write-enabled field if you have the appropriate permissions.
This field can also be used in a $filter expression, e.g.
$filter=status eq "active" or
$filter=status intersects ["active","inactive"].
Note: unlike most other objects, users do not use the generic
visibility statuses (Loggable and Reportable, Reportable Only),
and User records do not include a status_code field.
Possible values: [active, hidden, inactive]
activeThe ID of the user's default memorized timesheet.
The user's default IANA timezone name (e.g. America/Chicago).
Used as a fallback when the client does not supply a timezone with
a save request. Set to null or empty string to clear.
Must be a valid IANA timezone name or a Windows timezone name
(which will be converted to the canonical IANA name). Invalid values
will cause a 400 Bad Request error.
The Timezones endpoint provides a searchable list of valid timezone values.
America/ChicagoThe number of items in a selection list to trigger a forced search.
Indicates whether the user is hidden.
Note: the User object is the only one that uses this field; other objects
use is_hidden.
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.
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.
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.
A list of role IDs belonging to this user.
This list can be modified to change the user's roles.
The number of blank rows to show on the entry screen.
3The "Entry Screen period" (time-span) associated with the user's Time Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Expense Entry screen.
default_weeklyThe "Entry Screen period" (time-span) associated with the user's Custom Entry screen.
default_weeklyThe ID of the user's assigned Expense entry screen configuration.
The ID of the user's assigned time entry screen configuration.
The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
The internal User ID of the user who created the object.
64BBA147B9AC41D9978062300826C89FThe full name of the user who created the object.
John DoeExtended information about the User who
created the object.
This field is only included if the $keys parameter requests it.
The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The object creation date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The object creation date in the "short date" format defined in the system settings.
03/22/2023The object creation date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe object creation date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe creation timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domUNUSED FIELD This is a legacy field that is no longer used.
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.
The first name of the user.
Note: read-only; set via the fullname field.
The unique internal ID of this user. (Same as id.)
5CD906A3941C463B9CC98F49DBCC25AAIndicates whether the user is hidden.
See also status. To hide or un-hide a user, write the hide or
status field instead.
Indicates whether the user is hidden.
Read-only alias for is_hidden; only included when requested via
$keys (e.g. $keys=$extended).
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.
The internal ID of the memorized timesheet.
The name of the memorized timesheet.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
UNUSED FIELD This is a legacy field that is no longer used.
Details about the user's assigned time entry screen configuration.
Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.
Details about the user's assigned Expense entry screen configuration.
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.
1696021987.01375The last modification date in the "long date" format defined in the system settings.
Wednesday, March 22, 2023The last modification date in the "short date" format defined in the system settings.
03/22/2023The last modification date and time in the "long date" format defined in the system settings.
Wednesday, March 22, 2023 12:18:46 CDTThe last modification date and time in the "short date" format defined in the system settings.
03/22/2023 12:18:46 CDTThe last modification timestamp in ISO 8601 format.
2023-03-22T12:18:46-05:00The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.
install_root_domIndicates whether the user can customize the columns displayed in the screen.
truecf_filters object[]
A list of custom field filters that are available for this screen.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
STRING_100Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupcf_filters_unused object[]
A list of custom field filters that are available for this screen, but are not currently used.
The unique internal ID of this Custom Field definition (same as id field)
2DDD372DC4D3422D9E73F6DE936C4265Datatype 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.
STRING_100Description of custom field
Name of custom field
Pay GroupURI of the custom field to get more information about the custom field definition.
/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9Value 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.
XYZ Pay Groupfields object[]
The list of fields to show in this management screen's search results.
The default tooltip for the field shown when hovering over the field label.
The name of the Accrual.The database ID for the instance of the configured field within the screen. This is a generated value (not fixed).
34If this field represents a Custom Field, this is the ID of the Custom Field Type.
nullThe hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens.
id_user_properties.fullnameThe internal database ID for the configured field, if this is a global settings field.
34The unique identifier for the screen that this field belongs to.
accrualsWhether the field is a boolean field, which will be displayed as a "Yes" or "No" value in the column.
falseWhether the field is a Custom Field.
falseWhether the field is a date-time field, which will be displayed as a formatted date-time value in the column.
falseWhether the field is a numeric field, which will be displayed as a formatted number in the column.
falseWhether the field is a percentage field, which will be displayed as a formatted percentage value in the column.
falseWhether the field is automatically truncated when displayed in the search results; the full value can be seen in the tooltip.
falseWhether the field is a URL field, which will be displayed as a clickable link in the column.
falseThe key for the field, which is used to identify the field in the
search results and in the API.
Same as id_field.
id_user_properties.fullnameThe label to show for this field in the management screen search results.
Owner NameThe order in which this field should be displayed in the search results.
1properties object
Additional extended properties of the field.
Whether the field is searchable in the search panel area on the management screen.
trueWhether the field is sortable in the search results.
trueLabel of the database table that stores field settings.
Field Config (global)The name of the database table that stores the field settings.
fields_config_globalThe tooltip to show for this field in the management screen search results.
The full name of the owner of this Accrual.Indicates whether the screen's global settings allow for per-user customization of the columns displayed in the screen.
trueThe unique internal ID of this screen. (Same as id.)
These are fixed values that are defined in the system.
accrualsIndicates whether this user is currently user global settings for this screen. If false, the user is using their own settings.
falseA list of other search filters that are available for this screen.
["project","group","project","group"]A list of other search filters that are available for this screen, but are not currently used.
["px_teams","px_teams"]A list of additional properties for this screen. Currently unused.
The date the server actually used, in YYYYMMDD form. Compare this
against what you sent to confirm how a value was interpreted.
20250309The entry types enabled as columns on the Crew Entry screen, in display order, regardless of the signed-in user's abilities.
["time","expense","custom"]The subset of screen_sheet_types the signed-in user holds the
keeper ability for. Sheet blocks are only ever returned for these
types. Passing a type absent from this list in sheet_types is
ignored rather than rejected.
["time","expense"]Whether the signed-in user holds the Authority - Timekeeper
ability, or is an administrator.
trueWhether the signed-in user holds the Authority - Expensekeeper
ability, or is an administrator.
trueWhether the signed-in user holds the
Authority - Custom Entry keeper ability, or is an administrator.
false{
"response_code": 200,
"success": true,
"uri": "https://example.apps.journyx.com/api/v1/users",
"$count": 100,
"$skip": 0,
"$top": 10,
"@nextLink": "https://example.apps.journyx.com/api/v1/users?$top=10&$skip=10",
"results": [
{
"id_user": "alice",
"id_user_properties": {
"fullname": "Alice Dev",
"user_login": "alice",
"default_timezone": "America/New_York",
"time_approvals_pname": "Weekly Manager Approval",
"expense_approvals_pname": "Expense Review",
"custom_approvals_pname": "Mileage Review",
"time_gui_id": "4C1D9F0A78B94E1C8E5B2D6F3A70C915",
"time_gui_pname": "Standard Weekly Time",
"expense_gui_id": "9E2F4B7C15D8402A93C6E1B84F70D3A2",
"expense_gui_pname": "Standard Expense",
"custom_gui_id": "B7D3169E4A0C42F5810B9C2E7D45A836",
"custom_gui_pname": "Standard Mileage"
},
"time": {
"id_sheet": "6C5469825DAE4ABF9654B7A567141CD8",
"sheettype": "time",
"sheettype_label": "Time",
"status_int": 0,
"status_str": "Open for Entry",
"pname": "03/09/2025 - 03/15/2025",
"dates": "03/09/2025 - 03/15/2025",
"reject_reason": "Please split the Friday hours across the two tasks.",
"user_name": "Alice Dev"
},
"expense": {
"id_sheet": "6C5469825DAE4ABF9654B7A567141CD8",
"sheettype": "time",
"sheettype_label": "Time",
"status_int": 0,
"status_str": "Open for Entry",
"pname": "03/09/2025 - 03/15/2025",
"dates": "03/09/2025 - 03/15/2025",
"reject_reason": "Please split the Friday hours across the two tasks.",
"user_name": "Alice Dev"
},
"custom": {
"id_sheet": "6C5469825DAE4ABF9654B7A567141CD8",
"sheettype": "time",
"sheettype_label": "Time",
"status_int": 0,
"status_str": "Open for Entry",
"pname": "03/09/2025 - 03/15/2025",
"dates": "03/09/2025 - 03/15/2025",
"reject_reason": "Please split the Friday hours across the two tasks.",
"user_name": "Alice Dev"
}
}
],
"screen": {
"id": "64BBA147B9AC41D9978062300826C89F",
"uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
"tablename": "users",
"table_label": "codes_pay_types",
"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"
},
{
"id": "5088C427E8B64EBEBE1C5B5961DB1902",
"pname": "Sales"
},
{
"id": "3553F715A6F54DAB95D0D25B08468195",
"pname": "Accounting"
}
],
"groups": [
"5088C427E8B64EBEBE1C5B5961DB1902",
"3553F715A6F54DAB95D0D25B08468195",
"5088C427E8B64EBEBE1C5B5961DB1902",
"3553F715A6F54DAB95D0D25B08468195"
],
"user_login": "john.smith@example.com",
"fullname": "John Smith",
"u_comment": "string",
"status": "active",
"default_memorized_sheet": "string",
"default_timezone": "America/Chicago",
"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",
"is_hidden": true,
"hidden": true,
"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"
},
{
"id": "5088C427E8B64EBEBE1C5B5961DB1902",
"pname": "Sales"
},
{
"id": "3553F715A6F54DAB95D0D25B08468195",
"pname": "Accounting"
}
],
"groups": [
"5088C427E8B64EBEBE1C5B5961DB1902",
"3553F715A6F54DAB95D0D25B08468195",
"5088C427E8B64EBEBE1C5B5961DB1902",
"3553F715A6F54DAB95D0D25B08468195"
],
"user_login": "john.smith@example.com",
"fullname": "John Smith",
"u_comment": "string",
"status": "active",
"default_memorized_sheet": "string",
"default_timezone": "America/Chicago",
"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",
"is_hidden": true,
"hidden": true,
"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",
"id_domain": "install_root_dom",
"allow_customize": true,
"cf_filters": [
{
"id_attr_type": "2DDD372DC4D3422D9E73F6DE936C4265",
"attr_type": "STRING_100",
"description": "string",
"pname": "Pay Group",
"id_attr_type_uri": "/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9",
"value": "XYZ Pay Group"
}
],
"cf_filters_unused": [
{
"id_attr_type": "2DDD372DC4D3422D9E73F6DE936C4265",
"attr_type": "STRING_100",
"description": "string",
"pname": "Pay Group",
"id_attr_type_uri": "/api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9",
"value": "XYZ Pay Group"
}
],
"fields": [
{
"default_tooltip": "The name of the Accrual.",
"id": "34",
"id_attr_type": null,
"id_field": "id_user_properties.fullname",
"id_field_global": "34",
"id_screen": "accruals",
"is_boolean": false,
"is_custom_field": false,
"is_datetime_float": false,
"is_numeric": false,
"is_percent": false,
"is_truncated": false,
"is_url": false,
"key": "id_user_properties.fullname",
"label": "Owner Name",
"ordering": 1,
"properties": {},
"searchable": true,
"sortable": true,
"table_label": "Field Config (global)",
"tablename": "fields_config_global",
"tooltip": "The full name of the owner of this Accrual."
}
],
"global_allows_customize": true,
"id_screen": "accruals",
"is_global": false,
"other_search_filters": [
"project",
"group",
"project",
"group"
],
"other_search_filters_unused": [
"px_teams",
"px_teams"
],
"properties": {},
"sheet_date": "20250309",
"screen_sheet_types": [
"time",
"expense",
"custom"
],
"visible_sheet_types": [
"time",
"expense"
],
"timekeeper": true,
"expensekeeper": true,
"customkeeper": false
}
}