Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
userAccounts
/
get_by_uuids
Get userAccounts by UUIDs
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/userAccounts/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "userAccountUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}
'
import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/userAccounts/get_by_uuids"

payload = { "userAccountUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"] }
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({userAccountUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6']})
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/userAccounts/get_by_uuids', 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://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/userAccounts/get_by_uuids",
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([
'userAccountUuids' => [
'3fa85f64-5717-4562-b3fc-2c963f66afa6'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-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://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/userAccounts/get_by_uuids"

payload := strings.NewReader("{\n \"userAccountUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<x-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://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/userAccounts/get_by_uuids")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userAccountUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/userAccounts/get_by_uuids")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userAccountUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ]\n}"

response = http.request(request)
puts response.read_body
[
  {
    "userAccountUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "username": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "jobTitle": "<string>",
    "email": "jsmith@example.com",
    "rootRoleUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rootRoleName": "<string>",
    "organizationUuids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "dateEmailVerified": "2023-11-07T05:31:56Z",
    "datePhoneVerified": "2023-11-07T05:31:56Z",
    "dateActivated": "2023-11-07T05:31:56Z",
    "dateDeactivated": "2023-11-07T05:31:56Z",
    "dateLastLogin": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "phone": "<string>"
  }
]

Headers

x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

Body

application/json
userAccountUuids
string<uuid>[]
required

Array of userAccount UUIDs to retrieve details for

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]

Response

UserAccount details retrieved

userAccountUuid
string<uuid>
required
username
string | null
required
firstName
string
required
lastName
string
required
jobTitle
string | null
required
email
string<email>
required
accountStatus
enum<string>
required
Available options:
PENDING_VERIFICATION,
ACTIVE,
LOCKED,
DEACTIVATED
rootRoleUuid
string<uuid>
required
rootRoleName
string
required

Role display name

organizationUuids
string<uuid>[]
required
dateEmailVerified
string<date-time> | null
required
datePhoneVerified
string<date-time> | null
required
dateActivated
string<date-time> | null
required
dateDeactivated
string<date-time> | null
required
dateLastLogin
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
phone
string | null

10-digit US phone number