Skip to main content

TeamItemResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
results object

The Teams feature allows you to create groups of users with shared characteristics for making preliminary "team assignments" to scheduled tasks before you have determined the individual(s) who will do the work.

See the List Teams endpoint for general information about the purpose and role of Teams in the Journyx system.

iduuid

The internal ID of the resource or object.

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

Example: 64BBA147B9AC41D9978062300826C89F
uriuri-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
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 [
    • iduuid

    The Group ID.

    pnamestring

    The Group name.

    uristring

    The URI of the Group.

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

  • ]
    • groupsuuid[]

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

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

    The name of the Team.

    Example: Sales Team
    auto_addboolean

    Indicates whether the Team is automatically added to new Groups as they are created.

    Example: false
    hiddenboolean

    Indicates whether the Team is hidden.

    Example: false
    team_members object[]

    A list of Team Members that belongs to current Team.

  • Array [
    • fullnamestring

    The full name of the user.

    Example: Alex Denton
    id_useruuid

    The unique internal ID of this user.

    Example: 66C197E19B1645A8A3D4A966F39907CF
    skillsstring[]

    A list of skills for the user.

    Important: the list of available skills is determined by the "Team Skills" User Custom Field definition, a multi-selection typed Custom Field. In order to modify the list of available skills, this User Custom Field definition must be updated.

  • ]
    • 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.

    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.

    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.

    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.

    reserved2float

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

    reserved3float

    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.

    create_timestampfloat

    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_isodate-time

    The creation timestamp in ISO 8601 format.

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

    The internal User ID of the user who most recently modified the object.

    Example: 64BBA147B9AC41D9978062300826C89F
    modifier_fullnamestring

    The full name of the user who most recently modified the object.

    Example: John Doe
    modifier_properties object

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

    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.

    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.

    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.

    reserved2float

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

    reserved3float

    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_timestampfloat

    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_isodate-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
    id_teamuuid

    The internal ID of the Team.

    Example: 64BBA147B9AC41D9978062300826C89F
    skills_field_namestring

    Indicates the name of the User Custom Field that defines the available Skills to be assigned to Teams.

    Example: Team Skills
    team_member_group_iduuid

    The ID of a special group that contains the members of this Team.

    Example: 96C197E19B1645A8A3D4A966F39907CF
    team_typeinteger

    The type of team - usually 1.

    Example: 1
    team_type_namestring

    The name of Team type.

    Example: PX Team
    successboolean

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

    Default value: true
    uristring

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

    Example: https://example.apps.journyx.com/api/v1/users
    TeamItemResponse
    {
      "response_code": 200,
      "results": {
        "id": "64BBA147B9AC41D9978062300826C89F",
        "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
        "tablename": "users",
        "table_label": "codes_pay_types",
        "group_names": [
          {
            "id": "5088C427E8B64EBEBE1C5B5961DB1902",
            "pname": "Sales"
          },
          {
            "id": "3553F715A6F54DAB95D0D25B08468195",
            "pname": "Accounting"
          }
        ],
        "groups": [
          "5088C427E8B64EBEBE1C5B5961DB1902",
          "3553F715A6F54DAB95D0D25B08468195"
        ],
        "pname": "Sales Team",
        "auto_add": false,
        "hidden": false,
        "team_members": [
          {
            "fullname": "Alex Denton",
            "id_user": "66C197E19B1645A8A3D4A966F39907CF",
            "skills": [
              "C++ Programming"
            ]
          }
        ],
        "creator": "64BBA147B9AC41D9978062300826C89F",
        "creator_fullname": "John Doe",
        "creator_properties": {
          "expense_gui": "string",
          "time_gui": "string",
          "travel_gui": "string",
          "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": {
          "expense_gui": "string",
          "time_gui": "string",
          "travel_gui": "string",
          "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",
        "id_domain": "install_root_dom",
        "id_team": "64BBA147B9AC41D9978062300826C89F",
        "skills_field_name": "Team Skills",
        "team_member_group_id": "96C197E19B1645A8A3D4A966F39907CF",
        "team_type": 1,
        "team_type_name": "PX Team"
      },
      "success": true,
      "uri": "https://example.apps.journyx.com/api/v1/users"
    }