List Users

Lists users. Optionally filter by account_group_id or account_id.

GET /organizations/users

List Users

cURL

curl --request GET \
  --url https://api-sandbox.y.uno/v1/organizations/users \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>'

import requests

url = "https://api-sandbox.y.uno/v1/organizations/users"

headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'PUBLIC-API-KEY': '<api-key>', 'PRIVATE-SECRET-KEY': '<api-key>'}
};

fetch('https://api-sandbox.y.uno/v1/organizations/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-sandbox.y.uno/v1/organizations/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 => [
    "PRIVATE-SECRET-KEY: <api-key>",
    "PUBLIC-API-KEY: <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-sandbox.y.uno/v1/organizations/users"

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

	req.Header.Add("PUBLIC-API-KEY", "<api-key>")
	req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")

	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-sandbox.y.uno/v1/organizations/users")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/organizations/users")

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

request = Net::HTTP::Get.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'

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

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "account_permissions": [
        {
          "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "role_id": "<string>"
        }
      ],
      "account_group_permissions": [
        {
          "account_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "role_id": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total_items": 123,
    "total_pages": 123,
    "has_next": true,
    "has_previous": true
  }
}

Lists all users belonging to the authenticated organization. You can optionally filter the results by account group or account ID.

Authorizations

PUBLIC-API-KEY · string · header · default: <Your PUBLIC-API-KEY> · required

PRIVATE-SECRET-KEY · string · header · default: <Your PRIVATE-SECRET-KEY> · required

Query Parameters

account_group_id · string<uuid>

Filter by account group.

account_id · string<uuid>

Filter by account.

page · integer · default: 1

Page number.

page_size · integer · default: 20

Page size.

Required range: x <= 100

Response

200 - application/json

OK

data · object[]

Show child attributes

pagination · object

Show child attributes