curl --request GET \
--url https://api.vori.com/v1/employees/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vori.com/v1/employees/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vori.com/v1/employees/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vori.com/v1/employees/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vori.com/v1/employees/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vori.com/v1/employees/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vori.com/v1/employees/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"authentication_rule": {
"methods": [
"barcode"
],
"operator": "and"
},
"created_at": "2023-11-07T05:31:56Z",
"deactivated_at": "2023-11-07T05:31:56Z",
"editable": true,
"email_address": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"roles": [
{
"id": "<string>",
"name": "everyone",
"store_id": "<string>"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"virtual": true,
"badge_barcode": "<string>",
"pin": "<string>"
}{
"error_code": "insufficient_permissions",
"error_details": {
"action": "*",
"resource": "*"
}
}Retrieve an employee
Retrieve an employee
curl --request GET \
--url https://api.vori.com/v1/employees/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vori.com/v1/employees/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vori.com/v1/employees/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vori.com/v1/employees/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vori.com/v1/employees/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vori.com/v1/employees/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vori.com/v1/employees/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"authentication_rule": {
"methods": [
"barcode"
],
"operator": "and"
},
"created_at": "2023-11-07T05:31:56Z",
"deactivated_at": "2023-11-07T05:31:56Z",
"editable": true,
"email_address": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"roles": [
{
"id": "<string>",
"name": "everyone",
"store_id": "<string>"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"virtual": true,
"badge_barcode": "<string>",
"pin": "<string>"
}{
"error_code": "insufficient_permissions",
"error_details": {
"action": "*",
"resource": "*"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
^[0-9]+$Query Parameters
Credentials to return on each employee. Neither is returned by default. Repeat the parameter to request both, for example ?include=pin&include=badge_barcode.
Requesting a credential without the employees:read_credentials permission is rejected rather than silently omitted.
pin— returnspin, the PIN the employee signs in with.badge_barcode— returnsbadge_barcode, the badge the employee scans to sign in.
badge_barcode, pin Response
A staff member at a store, to whom point-of-sale activity can be attributed.
Unique identifier for the record.
Effective rule that determines how the employee authenticates at the POS.
Show child attributes
Show child attributes
When the record was created.
When the employee was deactivated, or null when the employee is active.
Whether the employee can be changed. Employees Vori creates and manages are not editable.
Employee's email address, or null when none is configured.
254Employee's first name.
Employee's last name.
Roles assigned to the employee.
Show child attributes
Show child attributes
When the record was last changed.
Whether the employee exists only to attribute orders and cannot sign in at a terminal.
Barcode on the badge the employee scans to sign in at the point of sale, or null when none is configured. Returned only when requested with include=badge_barcode by a caller holding the employees:read_credentials permission, and absent from the response otherwise.
Numeric PIN used by the employee for POS authentication, or null when none is configured. Returned only when requested with include=pin by a caller holding the employees:read_credentials permission, and absent from the response otherwise.
6^[0-9]+$Was this page helpful?