Reveal Sensitive Entity Field Value

POST

entities

{entity_id}

reveal-field

curl --request POST \
  --url https://public.api.serval.com/v2/entities/{entity_id}/reveal-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldId": "<string>",
  "includeHistory": true
}
'

import requests

url = "https://public.api.serval.com/v2/entities/{entity_id}/reveal-field"

payload = {
    "fieldId": "<string>",
    "includeHistory": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fieldId: '<string>', includeHistory: true})
};

fetch('https://public.api.serval.com/v2/entities/{entity_id}/reveal-field', 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.serval.com/v2/entities/{entity_id}/reveal-field",
  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([
    'fieldId' => '<string>',
    'includeHistory' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.serval.com/v2/entities/{entity_id}/reveal-field"

	payload := strings.NewReader("{\n  \"fieldId\": \"<string>\",\n  \"includeHistory\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.serval.com/v2/entities/{entity_id}/reveal-field")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fieldId\": \"<string>\",\n  \"includeHistory\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entities/{entity_id}/reveal-field")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fieldId\": \"<string>\",\n  \"includeHistory\": true\n}"

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

{
  "data": {
    "id": "<string>",
    "entityId": "<string>",
    "fieldId": "<string>",
    "fieldKey": "<string>",
    "fieldName": "<string>",
    "dataType": "DATA_TYPE_UNSPECIFIED",
    "value": 123,
    "setByUserId": "<string>",
    "setByAppInstanceId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "deletedAt": "2025-01-15T01:30:15.000Z",
    "pinned": true,
    "redacted": true,
    "sensitive": true,
    "setByFormula": true
  },
  "history": [
    {
      "id": "<string>",
      "entityId": "<string>",
      "fieldId": "<string>",
      "fieldKey": "<string>",
      "fieldName": "<string>",
      "dataType": "DATA_TYPE_UNSPECIFIED",
      "value": 123,
      "setByUserId": "<string>",
      "setByAppInstanceId": "<string>",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "deletedAt": "2025-01-15T01:30:15.000Z",
      "pinned": true,
      "redacted": true,
      "sensitive": true,
      "setByFormula": true
    }
  ]
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	`entities:read`
Team-scoped API key	`entities:read`
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Read a record in a team’s database, or in a database shared with one of your teams: The permission is checked on the record’s owning team, or on a team the record’s database is shared with (“Can read” or “Can write”). A record in a database not shared with one of your teams is refused. Schema and row-access rules still apply.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entity_id

string

required

The ID of the entity. Readable in its owning team or through a team its database is shared with.

Body

application/json

RevealEntityFieldValueRequest
RevealEntityFieldValueRequest

fieldId

string

required

The field's ID as returned in field_values[].field_id by entity reads. Set exactly one of field_id or field_key.

includeHistory

boolean

Also return the field's value history on this entity, most recent first. Recorded on the audit event.

Response

200 - application/json

Success

data

data · object

The current value. sensitive is false and value is set when the entity stores one.

Show child attributes

history

EntityFieldValue · object[]

Present only when include_history was requested.

Show child attributes

Reveal Sensitive Entity Field Value

curl --request POST \
  --url https://public.api.serval.com/v2/entities/{entity_id}/reveal-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldId": "<string>",
  "includeHistory": true
}
'

import requests

url = "https://public.api.serval.com/v2/entities/{entity_id}/reveal-field"

payload = {
    "fieldId": "<string>",
    "includeHistory": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fieldId: '<string>', includeHistory: true})
};

fetch('https://public.api.serval.com/v2/entities/{entity_id}/reveal-field', 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.serval.com/v2/entities/{entity_id}/reveal-field",
  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([
    'fieldId' => '<string>',
    'includeHistory' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.serval.com/v2/entities/{entity_id}/reveal-field"

	payload := strings.NewReader("{\n  \"fieldId\": \"<string>\",\n  \"includeHistory\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.serval.com/v2/entities/{entity_id}/reveal-field")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fieldId\": \"<string>\",\n  \"includeHistory\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entities/{entity_id}/reveal-field")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fieldId\": \"<string>\",\n  \"includeHistory\": true\n}"

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

{
  "data": {
    "id": "<string>",
    "entityId": "<string>",
    "fieldId": "<string>",
    "fieldKey": "<string>",
    "fieldName": "<string>",
    "dataType": "DATA_TYPE_UNSPECIFIED",
    "value": 123,
    "setByUserId": "<string>",
    "setByAppInstanceId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "deletedAt": "2025-01-15T01:30:15.000Z",
    "pinned": true,
    "redacted": true,
    "sensitive": true,
    "setByFormula": true
  },
  "history": [
    {
      "id": "<string>",
      "entityId": "<string>",
      "fieldId": "<string>",
      "fieldKey": "<string>",
      "fieldName": "<string>",
      "dataType": "DATA_TYPE_UNSPECIFIED",
      "value": 123,
      "setByUserId": "<string>",
      "setByAppInstanceId": "<string>",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "deletedAt": "2025-01-15T01:30:15.000Z",
      "pinned": true,
      "redacted": true,
      "sensitive": true,
      "setByFormula": true
    }
  ]
}

Get started

Authentication

Endpoints

Development

Reveal Sensitive Entity Field Value

Authentication and permissions

Authorizations

Path Parameters

Body

Response

​Authentication and permissions

Authorizations

Path Parameters

Body

Response

Authentication and permissions