Retrieve people in an Org - Zivio API Documentation

Retrieve people in an Org

curl --request GET \
  --url https://api.zivio.net/api/v3/orgs/{org_id}/org_users \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

import requests

url = "https://api.zivio.net/api/v3/orgs/{org_id}/org_users"

headers = {
    "X-API-Key": "<api-key>",
    "zivio-tenant-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', 'zivio-tenant-id': '<api-key>'}
};

fetch('https://api.zivio.net/api/v3/orgs/{org_id}/org_users', 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.zivio.net/api/v3/orgs/{org_id}/org_users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>",
    "zivio-tenant-id: <api-key>"
  ],
]);

$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.zivio.net/api/v3/orgs/{org_id}/org_users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("zivio-tenant-id", "<api-key>")

	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.zivio.net/api/v3/orgs/{org_id}/org_users")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["zivio-tenant-id"] = '<api-key>'

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

[
  {
    "id": "12",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@smith.com",
    "business_unit": "Finance and Investment",
    "division": "Software Development",
    "department": "Technology",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "true"
  }
]

GET

/

orgs

/

{org_id}

/

org_users

Retrieve people in an Org

curl --request GET \
  --url https://api.zivio.net/api/v3/orgs/{org_id}/org_users \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

import requests

url = "https://api.zivio.net/api/v3/orgs/{org_id}/org_users"

headers = {
    "X-API-Key": "<api-key>",
    "zivio-tenant-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', 'zivio-tenant-id': '<api-key>'}
};

fetch('https://api.zivio.net/api/v3/orgs/{org_id}/org_users', 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.zivio.net/api/v3/orgs/{org_id}/org_users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>",
    "zivio-tenant-id: <api-key>"
  ],
]);

$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.zivio.net/api/v3/orgs/{org_id}/org_users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("zivio-tenant-id", "<api-key>")

	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.zivio.net/api/v3/orgs/{org_id}/org_users")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["zivio-tenant-id"] = '<api-key>'

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

[
  {
    "id": "12",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@smith.com",
    "business_unit": "Finance and Investment",
    "division": "Software Development",
    "department": "Technology",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "true"
  }
]

Authorizations

X-API-Key

string

header

required

zivio-tenant-id

string

header

required

Path Parameters

org_id

integer

required

Query Parameters

q

string

Query string. Match by name

created

string

Date range [2020-01-01+TO+2020-01-30], to search based on created timestamp for object.

updated

string

Date range [2020-01-01+TO+2020-01-30] to search based on updated timestamp for object.

limit

integer

Number of results returned per request

page

integer

Paginate results when number of results exceeds limit

Response

ok

id

integer

Example:

"12"

first_name

string

Example:

"John"

last_name

string

Example:

"Smith"

email

string

Example:

"john@smith.com"

business_unit

string

Example:

"Finance and Investment"

division

string

Example:

"Software Development"

department

string

Example:

"Technology"

vetting_status

string

Example:

"PASSED"

created_at

string<date-time>

updated_at

string<date-time>

custom_fields

object

Show child attributes

has_oversight

string

Example:

"true"

⌘I