Skip to navigation

Get User

Get detailed information about a specific user.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

user_idstringRequiredformat: "uuid"
The unique identifier of the user.

Query parameters

include_source_databooleanOptionalDefaults to false

Include the raw data from the telematics provider. Useful for auditing or accessing fields not normalized by Catena

Response

Successful Response
fleet_idstring or nullformat: "uuid"
Internal fleet identifier.
idstringformat: "uuid"
Unique identifier of the record at Catena Telematics.
created_atdatetime

Immutable: The datetime the record was ingested into Catena Telematics.

updated_atdatetime
The dateime the record was last modified in Catena Telematics.
connection_idstringformat: "uuid"

Unique identifier of the connection at Catena Telematics through which this record was ingested. A connection represents a Fleet/TSP pairing.

source_nameenum

The underlying telematics platform that provided this data (e.g., samsara, motive, hos247). Note: Some platforms like hos247 offer white-labeling, so multiple TSPs may share the same source_name — use tsp_id or tsp_slug to identify the specific ELD provider.

source_idstring

Unique identifier of the record in the TSP. Note: we generate a unique composite key based on available fields if the TSP does not provide an unique ID.

source_data_hashstring<=64 characters

SHA-256 hash of the source data payload. Note: we use it internally for idempotence and deduplication.

fleet_refstring or nullOptional
External fleet reference in the partner system.
deleted_atdatetime or nullOptional
The datetime the record was logically deleted from Catena Telematics.
tsp_idstring or nullOptionalformat: "uuid"
Unique identifier of the TSP at Catena Telematics from which this record was ingested.
tsp_slugstring or nullOptional
Human readable slug of the TSP at Catena Telematics from which this record was ingested.
source_datamap from strings to anyOptional

Raw source payload as ingested from the TSP. Note: use it for audit/debugging.

occurred_atdatetime or nullOptional

Datetime of when the underlying event/observation occurred, as reported by the TSP, or the moment it was ingested by us if not available in the source data.

execution_idstring or nullOptionalformat: "uuid"

Unique identifier for the execution that ingested this record into Catena Telematics. Note: useful for tracing.

schedule_idstring or nullOptionalformat: "uuid"

Unique identifier for schedule that triggered this record’s execution. Note: useful for tracing.

extrasmap from strings to any or nullOptional

Additional data available in the TSP (e.g., we may have external_id, provider_resource_id, etc. — this field captures all those extra attributes in a flexible way).

usernamestring or nullOptional

Unique username/login for the user (source or Catena).

started_atdatetime or nullOptional

Timestamp when this user record became active/in service (UTC).

ended_atdatetime or nullOptional

Timestamp when this user record ended/out of service (UTC).

is_activeboolean or nullOptional
Indicates whether the user is currently active.
statusstring or nullOptional

User/account status label (e.g., ‘ACTIVE’, ‘INACTIVE’, ‘SUSPENDED’).

is_driverboolean or nullOptional

Indicates whether the user is a driver (vs. back-office/admin).

user_designationstring or nullOptional

Role/title or TSP designation (e.g., ‘DRIVER’, ‘DISPATCHER’, ‘ADMIN’).

user_emailstring or nullOptional
Email address for the user.
first_namestring or nullOptional
User's given name.
last_namestring or nullOptional

User’s family/surname.

phone_numberstring or nullOptional
User's phone number.
country_codestring or nullOptional

User’s country code (ISO-3166-1 alpha-3, e.g., ‘USA’, ‘CAN’).

license_countrystring or nullOptional

Issuing country for the driver’s license (ISO-3166-1 alpha-3, e.g., ‘USA’, ‘CAN’).

license_regionstring or nullOptional

Issuing region/subdivision for the license (state/province code, e.g., ‘CA’, ‘ON’).

license_numberstring or nullOptional
Driver's license number as recorded by the source.
license_expirationdate or nullOptional

License expiration date (YYYY-MM-DD, local to issuing authority).

employee_numberstring or nullOptional

Employer/HR or payroll identifier for the user (if applicable).

company_groupsmap from strings to any or nullOptional

JSON map of company/organization group memberships (segmentation/visibility).

private_user_groupsmap from strings to any or nullOptional

JSON map of user-specific private groups (per-user tags/categories).

report_groupsmap from strings to any or nullOptional

JSON map of reporting groups (used for dashboards/permissions).

security_groupsmap from strings to any or nullOptional

JSON map of security/role groups (authorization).

authority_namestring or nullOptional

Authority name associated with the user for RODS/inspection docs (as provided by the TSP).

authority_addressstring or nullOptional

Authority mailing/address line associated with the user for RODS/inspection docs (from TSP).

company_namestring or nullOptional

Employer/carrier name associated with the user.

company_addressstring or nullOptional

Employer/carrier address associated with the user.

carrier_numberstring or nullOptional

Carrier/company identifier as provided by the TSP (e.g., USDOT/MC or internal).

last_tsp_logindatetime or nullOptional

Timestamp of the user’s last login in the source TSP (UTC).

notesstring or nullOptional

Free-text notes about the user (plain text).

hos_ruleset_codeenum or nullOptional

Assigned HOS ruleset code for the user (normalized; see ref_hos_ruleset_codes).

hos_ruleset_namestring or nullOptional

Human-readable name of the HOS ruleset assigned to the user (e.g., ‘US Property (60/7)’).

allow_yard_moveboolean or nullOptional

Indicates whether the user is allowed to use Yard Move (YM).

allow_personal_conveyanceboolean or nullOptional

Indicates whether the user is allowed to use Personal Conveyance (PC).

allow_adverse_drivingboolean or nullOptional
Indicates whether the user can apply the Adverse Driving exemption.
default_time_zoneenum or nullOptional

IANA time zone ID (e.g., ‘America/Chicago’); used as the user’s default for UI/log normalization.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
501
Not Implemented Error