Retrieve a list of users

curl --request GET \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users

const options = {method: 'GET'};

fetch('https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users"

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

	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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users")

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

request = Net::HTTP::Get.new(url)

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

{
  "results": [
    {
      "id": "674d0bf5c28b69001f8e03a1",
      "created_at": "2024-04-22T10:00:00Z",
      "updated_at": "2024-04-22T10:00:00Z",
      "user_name": "john_doe",
      "email": "johndoe@gmail.com",
      "password": "P@ssw0rd!",
      "role": "manager"
    }
  ],
  "total_results": 20
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

GET

users

Retrieve a list of users

curl --request GET \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users

const options = {method: 'GET'};

fetch('https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users"

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

	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://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/users")

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

request = Net::HTTP::Get.new(url)

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

{
  "results": [
    {
      "id": "674d0bf5c28b69001f8e03a1",
      "created_at": "2024-04-22T10:00:00Z",
      "updated_at": "2024-04-22T10:00:00Z",
      "user_name": "john_doe",
      "email": "johndoe@gmail.com",
      "password": "P@ssw0rd!",
      "role": "manager"
    }
  ],
  "total_results": 20
}

{
  "title": "Human-readable error title.",
  "detail": "Human-readable error details."
}

Query Parameters

sort

string

Sort the list in the response by a specific property. Used with the order parameter.

order

string

Set the sort order to asc for ascending or desc for descending. Must be used with the sort parameter.

fields

string

Restrict which properties are returned in the response.

filter

string

Filter the response to include only items that have properties equal to the specified value.

Example:

"created_at.gt~2024-05-07|user_name.eq~apiuser01"

limit

integer

Limit the number of objects in the response.

Required range: x <= 30

offset

integer

Offsets the start of the list by the set value. Defaults to 0.

Example:

0

Response

Request successful

results

object[]

Show child attributes

total_results

integer

Example:

20

API Documentation

Endpoints

Retrieve a list of users

Query Parameters

Response