Users
Retrieve
Get a user by id
GET
/
users
/
{id}
Retrieve
curl --request GET \
--url http://localhost:44442/api/v1/users/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:44442/api/v1/users/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:44442/api/v1/users/{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_PORT => "44442",
CURLOPT_URL => "http://localhost:44442/api/v1/users/{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 := "http://localhost:44442/api/v1/users/{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))
}HttpResponse<String> response = Unirest.get("http://localhost:44442/api/v1/users/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/users/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"principal": "<string>",
"name": "<string>",
"alias": null,
"first_name": null,
"last_name": null,
"role": null,
"email": null,
"avatar": null,
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"created_at": 1785846207000,
"updated_at": 1785846207000,
"signin_required": true,
"signed_in_from": [
"<string>"
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}Authorizations
An API key from Settings, API Keys. A caller on this machine needs none.
Path Parameters
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Response
The user
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
OS account the user is identified by
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Example:
1785846207000
Example:
1785846207000
They sign in with pulze.io, as the account with their email, before RenderFlow lets them in
The OS accounts they are signed in at now, as each login's principal. Listed by GET /users only
Was this page helpful?
⌘I
Retrieve
curl --request GET \
--url http://localhost:44442/api/v1/users/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:44442/api/v1/users/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:44442/api/v1/users/{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_PORT => "44442",
CURLOPT_URL => "http://localhost:44442/api/v1/users/{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 := "http://localhost:44442/api/v1/users/{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))
}HttpResponse<String> response = Unirest.get("http://localhost:44442/api/v1/users/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/users/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"principal": "<string>",
"name": "<string>",
"alias": null,
"first_name": null,
"last_name": null,
"role": null,
"email": null,
"avatar": null,
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"created_at": 1785846207000,
"updated_at": 1785846207000,
"signin_required": true,
"signed_in_from": [
"<string>"
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}