User detail

Returns one user's profile, including the service provider and location attached to that user.

POST /fieldservicegateway/usermanagement/v3/user/detail

Request

Field	Type	Required	Description
userNumber	number	yes	User to look up

Example

{
  "userNumber": 1001
}

cURL

curl --request POST 'https://[BASE_URL]/fieldservicegateway/usermanagement/v3/user/detail' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {{x-api-key}}' \
  --header 'Authorization: {{Authorization}}' \
  --header 'Asurion-correlationid: correlation-id' \
  --header 'Asurion-enduser: end-user' \
  --header 'Asurion-sourcesystem: source-system' \
  --header 'Asurion-serviceprovider: company-id' \
  --header 'Asurion-client: default' \
  --data '{
    "userNumber": 1001
  }'

Response

200 OK

{
  "success": true,
  "message": "Successfully retrieved user",
  "data": {
    "user": {
      "userNumber": 1001,
      "username": "user@example.com",
      "email": "user@example.com",
      "firstName": "Ada",
      "middleName": "",
      "lastName": "Lovelace",
      "phone": "5550100",
      "profilePictureUrl": "",
      "asurionEmpId": "",
      "userRegisteredDate": "2026-10-16T00:00:00.000Z",
      "activeIndicator": true,
      "createdBy": "system",
      "createdDatetime": "2026-10-16T00:00:00.000Z",
      "updatedBy": "system",
      "updatedDatetime": "2026-10-16T00:00:00.000Z",
      "serviceProvider": {
        "serviceProviderName": "Example Provider",
        "serviceProviderNumber": "10001"
      },
      "serviceProviderLocation": {
        "serviceProviderLocationName": "Example Location",
        "serviceProviderLocationNumber": "20001"
      },
      "authenticationType": "PASSWORD"
    }
  }
}

Errors

404 Not Found

{
  "success": false,
  "message": "User not found with number: 1001"
}

Status	Code	When
400	VALIDATION_ERROR	userNumber is missing or is not a number
404		No user has that number
500	INTERNAL_ERROR	Something unexpected failed