Purpose: Use this API to search for user using an external ID. It is important to note that an external_id & integration_name are unique.

Response Parameters

user

• Type: Object
• Description: Details of a user.

id

• Type: Integer
• Description: The unique identifier for the user.

first_name

• Type: String
• Description: The first name of the user.

last_name

• Type: String
• Description: The last name of the user.

email

• Type: String
• Description: The primary email address of the user.

role

• Type: String
• Description: The system role assigned to the user (e.g., driver).

status

• Type: String
• Description: The current account status of the user (e.g., active).

phone

• Type: String
• Description: The primary phone number of the user.

phone_country_code

• Type: String
• Description: The ISO country code for the primary phone number.

phone_ext

• Type: String (or Null)
• Description: The extension for the primary phone number, if applicable.

phone2

• Type: String
• Description: The secondary phone number of the user.

phone_country_code2

• Type: String
• Description: The ISO country code for the secondary phone number.

time_zone

• Type: String
• Description: The preferred time zone setting for the user.

metric_units

• Type: Boolean
• Description: Indicates whether the user prefers metric units for measurement.

username

• Type: String
• Description: The unique username used for authentication.

driver_company_id

• Type: String
• Description: The internal company identifier assigned to the driver.

drivers_license_number

• Type: String
• Description: The driver's license number.

drivers_license_state

• Type: String
• Description: The state, region, or jurisdiction that issued the driver's license.

drivers_license_country

• Type: String
• Description: The country code of the issuing authority for the driver's license.

time_tracking_mode

• Type: String
• Description: The method used for tracking the driver's work hours (e.g., tachograph).

joined_at

• Type: String (Date)
• Description: The date when the user joined the company or platform.

user_notes

• Type: String
• Description: Additional comments or administrator notes regarding the user.

require_job_type_for_timecard_details

• Type: Boolean
• Description: Indicates whether specifying a job type is mandatory when submitting timecards.

company_reference_id

• Type: String
• Description: External reference identifier used by the company for the user.

group_ids

• Type: Array (Integer)
• Description: A list of group identifiers associated with the user.

tachograph_card_number

• Type: String
• Description: The identification number of the driver's smart tachograph card.

tachograph_card_expiry_date

• Type: String (Date)
• Description: The expiration date of the driver's tachograph card.

external_ids

• Type: Array (Object)
• Description: A collection of external integration mapping identifiers.

external_id

• Type: String
• Description: The identifier used in an external integration system.

integration_name

• Type: String
• Description: The name of the external integration platform.

company_connection

• Type: Object
• Description: Details regarding the user's connection state to the company.

company_connection_user_roles

• Type: Array
• Description: Specific sub-roles assigned to the user within the company connection.

mobile_last_active_at

• Type: String (Timestamp)
• Description: The date and time when the user was last active on the mobile application.

mobile_current_sign_in_at

• Type: String (Timestamp)
• Description: The timestamp of the user's current mobile session sign-in.

mobile_last_sign_in_at

• Type: String (Timestamp)
• Description: The timestamp of the user's previous mobile session sign-in.

web_last_active_at

• Type: String (Timestamp or Null)
• Description: The date and time when the user was last active on the web application.

created_at

• Type: String (Timestamp)
• Description: The timestamp when the user record was initially created.

updated_at

• Type: String (Timestamp)
• Description: The timestamp when the user record was last modified.

---