Retrieve an employee - Vori Help Center

Retrieve an employee

curl --request GET \
  --url https://api.vori.com/v1/employees/{id} \
  --header 'Authorization: Bearer <token>'

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))

}

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": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "deactivated_at": "2023-11-07T05:31:56Z",
  "email_address": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "roles": [
    {
      "id": "<string>",
      "store_id": "<string>"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "virtual": true
}

{
  "error_code": "insufficient_permissions",
  "error_details": {}
}

GET

/

v1

/

employees

/

{id}

Retrieve an employee

curl --request GET \
  --url https://api.vori.com/v1/employees/{id} \
  --header 'Authorization: Bearer <token>'

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))

}

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": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "deactivated_at": "2023-11-07T05:31:56Z",
  "email_address": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "roles": [
    {
      "id": "<string>",
      "store_id": "<string>"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "virtual": true
}

{
  "error_code": "insufficient_permissions",
  "error_details": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

id

string

required

Pattern: ^[0-9]+$

Response

A staff member at a store, to whom point-of-sale activity can be attributed.

id

string

required

Unique identifier for the record.

authentication_rule

object | null

required

Effective rule that determines how the employee authenticates at the POS.

Show child attributes

created_at

string<date-time>

required

When the record was created.

deactivated_at

string<date-time> | null

required

When the employee was deactivated, or null when the employee is active.

email_address

string<email> | null

required

Employee's email address, or null when none is configured.

Maximum string length: 254

first_name

string

required

Employee's first name.

last_name

string

required

Employee's last name.

roles

object[]

required

Roles assigned to the employee.

Show child attributes

updated_at

string<date-time>

required

When the record was last changed.

virtual

boolean

required

Whether the employee exists only to attribute orders and cannot sign in at a terminal.

Related topics

Retrieve a store Retrieve a lane Retrieve a discount