Get user details

1 min

GET

https://dev1.frontu.com//client/api/v2/users/details

Retrieve a single user by identifier. The endpoint tries the provided query parameters in the following order until a match is found: guid, systemId, email, then both name and surname. At least one identifier must be provided, and when name or surname is used they must be supplied together.

Query Parameters

guidstring<uuid>
Description
User GUID. Checked first when provided.
Format
uuid
systemIdstring
Description
External system identifier. Checked if no GUID match.
emailstring<email>
Description
User email. Checked if GUID and systemId do not match.
Format
email
namestring
Description
User name. Used together with surname as the final fallback.
surnamestring
Description
User surname. Used together with name as the final fallback.

Responses

200User found

object
- versioninteger
- namestring
- surnamestring
- emailstring
- officestring
- rolesstring[]
- guidstring
- createdstring
- updatedstring
- deletedboolean
- systemIdstring
- phonestring
- jobTitlestring
- warehousestring
- company_detailsstring
- enabledboolean

400Missing required identifier

404User not found

curl

curl --request GET \
     --url https://dev1.frontu.com//client/api/v2/users/details \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://dev1.frontu.com//client/api/v2/users/details", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://dev1.frontu.com//client/api/v2/users/details")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://dev1.frontu.com//client/api/v2/users/details"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// User found
{
  "version": 0,
  "name": "",
  "surname": "",
  "email": "",
  "office": "",
  "roles": [
    ""
  ],
  "guid": "",
  "created": "",
  "updated": "",
  "deleted": false,
  "systemId": "",
  "phone": "",
  "jobTitle": "",
  "warehouse": "",
  "company_details": "",
  "enabled": false
}

GENERATED

// User found
{
  "version": 0,
  "name": "",
  "surname": "",
  "email": "",
  "office": "",
  "roles": [
    ""
  ],
  "guid": "",
  "created": "",
  "updated": "",
  "deleted": false,
  "systemId": "",
  "phone": "",
  "jobTitle": "",
  "warehouse": "",
  "company_details": "",
  "enabled": false
}

success

{
  "version": 1420114332,
  "name": "Petras",
  "surname": "Petras",
  "email": "[email protected]",
  "office": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e34",
  "roles": [
    "ROLE_ADMIN",
    "ROLE_USER"
  ],
  "guid": "f889fbe9-9d9b-3c8a-8549-e321ee7e3e31",
  "created": "2015-01-01T12:12:12+0000",
  "updated": "2015-01-01T12:12:12+0000",
  "deleted": false,
  "systemId": null,
  "phone": "+37011111111",
  "jobTitle": "Technician",
  "warehouse": null,
  "company_details": null,
  "enabled": true,
  "driverId": "DRV001"
}

400

// Missing required identifier

404

// User not found