GET /users - Bengal

Parameters

Query Parameters

page integer

query

Page number (1-based)

page_size integer

query

Number of results per page

role string

query

Filter by role

200 Paginated users

Content-Type: application/json

Schema: PaginatedUserList

401 Authentication required

Examples

BASH

curl -X GET "https://api.example.com/users" \
  -H "Authorization: Bearer $API_KEY"

python

PYTHON

import requests

url = "https://api.example.com/users"
headers = {
    "Authorization": "Bearer " + API_KEY,
}

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

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/users";

const options = {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
  },
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/users"

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/users")

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

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/users";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
    ],
];

$response = $client->request('GET', $url, $options);

echo $response->getBody();

List users

Parameters

Query Parameters

Responses

Parameters

Filter Query Parameters

Query Parameters