Get users eligible to enroll in an institution
curl --request POST \
--url https://pria.praxislxp.com/api/admin/userInstitutions/eligible \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"institution": "67826dfe5d387207aabd6fc1",
"search": "john"
}
'import requests
url = "https://pria.praxislxp.com/api/admin/userInstitutions/eligible"
payload = {
"institution": "67826dfe5d387207aabd6fc1",
"search": "john"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({institution: '67826dfe5d387207aabd6fc1', search: 'john'})
};
fetch('https://pria.praxislxp.com/api/admin/userInstitutions/eligible', 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://pria.praxislxp.com/api/admin/userInstitutions/eligible",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'institution' => '67826dfe5d387207aabd6fc1',
'search' => 'john'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/admin/userInstitutions/eligible"
payload := strings.NewReader("{\n \"institution\": \"67826dfe5d387207aabd6fc1\",\n \"search\": \"john\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/admin/userInstitutions/eligible")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"institution\": \"67826dfe5d387207aabd6fc1\",\n \"search\": \"john\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/userInstitutions/eligible")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"institution\": \"67826dfe5d387207aabd6fc1\",\n \"search\": \"john\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"user": {
"_id": "67826dfe5d387207aabd6fc1",
"fname": "John",
"lname": "Doe",
"email": "john@example.com",
"accountType": "user"
},
"institutions": [
{
"_id": "<string>",
"name": "<string>"
}
]
}
],
"total": 42
}{
"success": false,
"message": "Invalid User Institution",
"error": "<string>"
}{
"success": false,
"message": "Invalid User Institution",
"error": "<string>"
}{
"success": false,
"message": "Invalid User Institution",
"error": "<string>"
}Admin Entitlements
Get users eligible to enroll in an institution
Returns users who are not yet members of the specified institution. Results are capped at 100. If no search term is provided, returns the first 100 eligible users. With a search term (2+ chars), filters by name or email.
POST
/
api
/
admin
/
userInstitutions
/
eligible
Get users eligible to enroll in an institution
curl --request POST \
--url https://pria.praxislxp.com/api/admin/userInstitutions/eligible \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"institution": "67826dfe5d387207aabd6fc1",
"search": "john"
}
'import requests
url = "https://pria.praxislxp.com/api/admin/userInstitutions/eligible"
payload = {
"institution": "67826dfe5d387207aabd6fc1",
"search": "john"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({institution: '67826dfe5d387207aabd6fc1', search: 'john'})
};
fetch('https://pria.praxislxp.com/api/admin/userInstitutions/eligible', 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://pria.praxislxp.com/api/admin/userInstitutions/eligible",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'institution' => '67826dfe5d387207aabd6fc1',
'search' => 'john'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/admin/userInstitutions/eligible"
payload := strings.NewReader("{\n \"institution\": \"67826dfe5d387207aabd6fc1\",\n \"search\": \"john\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/admin/userInstitutions/eligible")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"institution\": \"67826dfe5d387207aabd6fc1\",\n \"search\": \"john\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/userInstitutions/eligible")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"institution\": \"67826dfe5d387207aabd6fc1\",\n \"search\": \"john\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"user": {
"_id": "67826dfe5d387207aabd6fc1",
"fname": "John",
"lname": "Doe",
"email": "john@example.com",
"accountType": "user"
},
"institutions": [
{
"_id": "<string>",
"name": "<string>"
}
]
}
],
"total": 42
}{
"success": false,
"message": "Invalid User Institution",
"error": "<string>"
}{
"success": false,
"message": "Invalid User Institution",
"error": "<string>"
}{
"success": false,
"message": "Invalid User Institution",
"error": "<string>"
}Authorizations
JWT token passed in x-access-token header
Body
application/json
Was this page helpful?
⌘I