Users

User Custom Fields

User Custom Fields allow you to store additional, company-specific information against users in Timeero.
These fields are fully configurable and can be used to capture metadata beyond the default user attributes.


Related API Reference

All operations related to users—including reading and updating custom fields—are handled through the Users API.

👉 Users API Reference
GET /api/public/users
POST /api/public/users
PUT /api/public/users/{id}

For full request and response schemas, refer to:
Users API Reference

Supported Input Types

User custom fields support the following input types:

  • text
  • textarea
  • numeric
  • monetary
  • dropdown
  • dropdown_multiselect
  • checkbox
  • radio_button
  • date_picker
  • time_picker
📘

Input types determine how data is captured and validated.


Creating User Custom Fields

User custom fields can be created and managed from the Timeero web application.

Steps:

  1. Go to Company Settings → Custom Fields
  2. Select Users → Configure Fields
  3. Click Add Custom Field
  4. Choose an input type and configure its options
  5. Save the field

Once created, the field becomes available for all users.


API Representation

User custom field values are returned under the custom_fields object in the API response.

Example Response

{
  "first_name": "Alexandria",
  "last_name": "Rodriguez",
  "email": "[email protected]",
  "phone": "03237824623",
  "password": "kz6tG48]^G7",
  "company_employee_id": "674343",
  "employee_code": "",
  "role_id": 2,
  "track_location": true,
  "track_mileage": true,
  "pay_rate": 10,
  "billing_rate_type": 0,
  "timesheet_option": true,
  "schedule_option": true,
  "job_option": true,
  "report_option": true,
  "whoworking_option": true,
  "custom_fields": {
    "1390": "09/02/2025",
    "1833": "ID_876545"
  }
}

Updating User Custom Fields via API

User custom fields can be updated when creating or updating a user.
Example Payload

{
  "name": "John Doe",
  "email": "[email protected]",
  "custom_fields": {
    "311": "EMP-1001",
    "324": "Full Time",
    "312": 25.5,
    "454": true,
    "123": "2025-01-10"
  }
}

Validation Rules

  • Values must match the configured input type
  • Dropdown and radio fields only accept predefined options
  • Numeric and monetary fields only accept valid numbers
  • Date and time fields must follow supported formats