User Profile
Tenant Var Code
OK
The email address that is used as login (read only)
User's date of birth
A string with user's country
A string with user's address
A string with user's city or town
A string with user's state or region
A string with user's residence country
A string with user's ZIP or postal code
A string with user's daytime phone (starting with '+' and country code)
A string with user's evening phone (starting with '+' and country code)
A string with user's cell phone (starting with '+' and country code)
Time zone used to format dates and times in a portal (for list of valid time zones see Others tab). All dates are stored in UTC
Culture used in a portal for numbers and date formatting (for list of valid culture names see Others tab)
Language used in a portal for localization (empty value sets preferences to use browser language settings)
A string with spped units used in a portal. Can be either kmh, mph or knots
A string with distance units used in a portal. Can be either m or ft
A string with position format used in a portal. Can be either Decimal, DegreeMinute or Utm
A string with name used as first contact included in emergency email
A string with address used as first contact included in emergency email
A string with phone number used as first contact included in emergency email
A string with name used as second contact included in emergency email
A string with address used as second contact included in emergency email
A string with phone number used as second contact included in emergency email
A string with information provided to responders in the event of an emergency
Timestamp (UTC) indicating version of record being returned
GET /V2/{tenantVarCode}/userprofile HTTP/1.1
Accept: */*
OK
[
{
"Username": "text",
"DateOfBirth": "2026-01-01T00:00:00.000Z",
"Citizenship": "text",
"Address": "text",
"City": "text",
"State": "text",
"Country": "text",
"PostalCode": "text",
"DaytimePhone": "text",
"EveningPhone": "text",
"CellPhone": "text",
"TimeZoneId": "text",
"CultureName": "text",
"UiLanguage": "text",
"SpeedUnits": "text",
"DistanceUnits": "text",
"PositionFormat": "text",
"EmergencyContactName": "text",
"EmergencyContactAddress": "text",
"EmergencyContactTelephoneNumber": "text",
"EmergencyContactName2": "text",
"EmergencyContactAddress2": "text",
"EmergencyContactTelephoneNumber2": "text",
"EmergencyInformation": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]Tenant Var Code
User Id
OK
The email address that is used as login (read only)
User's date of birth
A string with user's country
A string with user's address
A string with user's city or town
A string with user's state or region
A string with user's residence country
A string with user's ZIP or postal code
A string with user's daytime phone (starting with '+' and country code)
A string with user's evening phone (starting with '+' and country code)
A string with user's cell phone (starting with '+' and country code)
Time zone used to format dates and times in a portal (for list of valid time zones see Others tab). All dates are stored in UTC
Culture used in a portal for numbers and date formatting (for list of valid culture names see Others tab)
Language used in a portal for localization (empty value sets preferences to use browser language settings)
A string with spped units used in a portal. Can be either kmh, mph or knots
A string with distance units used in a portal. Can be either m or ft
A string with position format used in a portal. Can be either Decimal, DegreeMinute or Utm
A string with name used as first contact included in emergency email
A string with address used as first contact included in emergency email
A string with phone number used as first contact included in emergency email
A string with name used as second contact included in emergency email
A string with address used as second contact included in emergency email
A string with phone number used as second contact included in emergency email
A string with information provided to responders in the event of an emergency
Timestamp (UTC) indicating version of record being returned
GET /V2/{tenantVarCode}/userprofile/{userId} HTTP/1.1
Accept: */*
OK
{
"Username": "text",
"DateOfBirth": "2026-01-01T00:00:00.000Z",
"Citizenship": "text",
"Address": "text",
"City": "text",
"State": "text",
"Country": "text",
"PostalCode": "text",
"DaytimePhone": "text",
"EveningPhone": "text",
"CellPhone": "text",
"TimeZoneId": "text",
"CultureName": "text",
"UiLanguage": "text",
"SpeedUnits": "text",
"DistanceUnits": "text",
"PositionFormat": "text",
"EmergencyContactName": "text",
"EmergencyContactAddress": "text",
"EmergencyContactTelephoneNumber": "text",
"EmergencyContactName2": "text",
"EmergencyContactAddress2": "text",
"EmergencyContactTelephoneNumber2": "text",
"EmergencyInformation": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Tenant Var Code
User Id
The email address that is used as login (read only)
User's date of birth
A string with user's country
A string with user's address
A string with user's city or town
A string with user's state or region
A string with user's residence country
A string with user's ZIP or postal code
A string with user's daytime phone (starting with '+' and country code)
A string with user's evening phone (starting with '+' and country code)
A string with user's cell phone (starting with '+' and country code)
Time zone used to format dates and times in a portal (for list of valid time zones see Others tab). All dates are stored in UTC
Culture used in a portal for numbers and date formatting (for list of valid culture names see Others tab)
Language used in a portal for localization (empty value sets preferences to use browser language settings)
A string with spped units used in a portal. Can be either kmh, mph or knots
A string with distance units used in a portal. Can be either m or ft
A string with position format used in a portal. Can be either Decimal, DegreeMinute or Utm
A string with name used as first contact included in emergency email
A string with address used as first contact included in emergency email
A string with phone number used as first contact included in emergency email
A string with name used as second contact included in emergency email
A string with address used as second contact included in emergency email
A string with phone number used as second contact included in emergency email
A string with information provided to responders in the event of an emergency
Timestamp (UTC) indicating version of record being returned
OK
No content
PUT /V2/{tenantVarCode}/userprofile/{userId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 683
{
"Username": "text",
"DateOfBirth": "2026-01-01T00:00:00.000Z",
"Citizenship": "text",
"Address": "text",
"City": "text",
"State": "text",
"Country": "text",
"PostalCode": "text",
"DaytimePhone": "text",
"EveningPhone": "text",
"CellPhone": "text",
"TimeZoneId": "text",
"CultureName": "text",
"UiLanguage": "text",
"SpeedUnits": "text",
"DistanceUnits": "text",
"PositionFormat": "text",
"EmergencyContactName": "text",
"EmergencyContactAddress": "text",
"EmergencyContactTelephoneNumber": "text",
"EmergencyContactName2": "text",
"EmergencyContactAddress2": "text",
"EmergencyContactTelephoneNumber2": "text",
"EmergencyInformation": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}OK
No content
OK
No content
PATCH /V2/{tenantVarCode}/userprofile/{userId} HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 56
[
{
"value": null,
"path": "text",
"op": "text",
"from": "text"
}
]OK
No content
Tenant Var Code
Username
OK
The email address that is used as login (read only)
User's date of birth
A string with user's country
A string with user's address
A string with user's city or town
A string with user's state or region
A string with user's residence country
A string with user's ZIP or postal code
A string with user's daytime phone (starting with '+' and country code)
A string with user's evening phone (starting with '+' and country code)
A string with user's cell phone (starting with '+' and country code)
Time zone used to format dates and times in a portal (for list of valid time zones see Others tab). All dates are stored in UTC
Culture used in a portal for numbers and date formatting (for list of valid culture names see Others tab)
Language used in a portal for localization (empty value sets preferences to use browser language settings)
A string with spped units used in a portal. Can be either kmh, mph or knots
A string with distance units used in a portal. Can be either m or ft
A string with position format used in a portal. Can be either Decimal, DegreeMinute or Utm
A string with name used as first contact included in emergency email
A string with address used as first contact included in emergency email
A string with phone number used as first contact included in emergency email
A string with name used as second contact included in emergency email
A string with address used as second contact included in emergency email
A string with phone number used as second contact included in emergency email
A string with information provided to responders in the event of an emergency
Timestamp (UTC) indicating version of record being returned
GET /V2/{tenantVarCode}/userprofile/{username} HTTP/1.1
Accept: */*
OK
{
"Username": "text",
"DateOfBirth": "2026-01-01T00:00:00.000Z",
"Citizenship": "text",
"Address": "text",
"City": "text",
"State": "text",
"Country": "text",
"PostalCode": "text",
"DaytimePhone": "text",
"EveningPhone": "text",
"CellPhone": "text",
"TimeZoneId": "text",
"CultureName": "text",
"UiLanguage": "text",
"SpeedUnits": "text",
"DistanceUnits": "text",
"PositionFormat": "text",
"EmergencyContactName": "text",
"EmergencyContactAddress": "text",
"EmergencyContactTelephoneNumber": "text",
"EmergencyContactName2": "text",
"EmergencyContactAddress2": "text",
"EmergencyContactTelephoneNumber2": "text",
"EmergencyInformation": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Tenant Var Code
Username
The email address that is used as login (read only)
User's date of birth
A string with user's country
A string with user's address
A string with user's city or town
A string with user's state or region
A string with user's residence country
A string with user's ZIP or postal code
A string with user's daytime phone (starting with '+' and country code)
A string with user's evening phone (starting with '+' and country code)
A string with user's cell phone (starting with '+' and country code)
Time zone used to format dates and times in a portal (for list of valid time zones see Others tab). All dates are stored in UTC
Culture used in a portal for numbers and date formatting (for list of valid culture names see Others tab)
Language used in a portal for localization (empty value sets preferences to use browser language settings)
A string with spped units used in a portal. Can be either kmh, mph or knots
A string with distance units used in a portal. Can be either m or ft
A string with position format used in a portal. Can be either Decimal, DegreeMinute or Utm
A string with name used as first contact included in emergency email
A string with address used as first contact included in emergency email
A string with phone number used as first contact included in emergency email
A string with name used as second contact included in emergency email
A string with address used as second contact included in emergency email
A string with phone number used as second contact included in emergency email
A string with information provided to responders in the event of an emergency
Timestamp (UTC) indicating version of record being returned
OK
No content
PUT /V2/{tenantVarCode}/userprofile/{username} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 683
{
"Username": "text",
"DateOfBirth": "2026-01-01T00:00:00.000Z",
"Citizenship": "text",
"Address": "text",
"City": "text",
"State": "text",
"Country": "text",
"PostalCode": "text",
"DaytimePhone": "text",
"EveningPhone": "text",
"CellPhone": "text",
"TimeZoneId": "text",
"CultureName": "text",
"UiLanguage": "text",
"SpeedUnits": "text",
"DistanceUnits": "text",
"PositionFormat": "text",
"EmergencyContactName": "text",
"EmergencyContactAddress": "text",
"EmergencyContactTelephoneNumber": "text",
"EmergencyContactName2": "text",
"EmergencyContactAddress2": "text",
"EmergencyContactTelephoneNumber2": "text",
"EmergencyInformation": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}OK
No content
OK
No content
PATCH /V2/{tenantVarCode}/userprofile/{username} HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 56
[
{
"value": null,
"path": "text",
"op": "text",
"from": "text"
}
]OK
No content
Last updated