List Entities - Serval Documentation

GET

entities

List Entities

curl --request GET \
  --url https://public.api.serval.com/v2/entities \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/entities', 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",
  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 := "https://public.api.serval.com/v2/entities"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entities")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "teamId": "<string>",
      "entityTypeId": "<string>",
      "entityTypeKey": "<string>",
      "createdByUserId": "<string>",
      "updatedByUserId": "<string>",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "updatedAt": "2025-01-15T01:30:15.000Z",
      "deletedAt": "2025-01-15T01:30:15.000Z",
      "archivedAt": "2025-01-15T01:30:15.000Z",
      "fieldValues": [
        {
          "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
        }
      ],
      "sourceAppInstanceIds": [
        "<string>"
      ],
      "sharedMetadata": {
        "sourceTeamId": "<string>",
        "sourceTeamName": "<string>"
      },
      "accessRestricted": true,
      "masked": true,
      "sourceApps": [
        {
          "appInstanceId": "<string>",
          "displayName": "<string>",
          "serviceName": "<string>",
          "serviceDisplayName": "<string>",
          "logoUrl": "<string>",
          "domain": "<string>",
          "useIntegratedServiceRegistry": true,
          "isCustom": true
        }
      ]
    }
  ],
  "nextPageToken": "<string>"
}

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 team entities: 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.

Query Parameters

teamId

string

The ID of the team.

entityTypeId

string

Optional filter by entity type ID.

pageSize

integer<int32>

Maximum number of results to return. Default is 2000, maximum is 5000.

pageToken

string

Token for pagination. Leave empty for the first request.

Response

200 - application/json

Success

data

Entity · object[]

The list of entities.

Show child attributes

nextPageToken

string | null

Token for retrieving the next page of results. Empty if no more results.

List Entities

curl --request GET \
  --url https://public.api.serval.com/v2/entities \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/entities', 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",
  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 := "https://public.api.serval.com/v2/entities"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entities")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "teamId": "<string>",
      "entityTypeId": "<string>",
      "entityTypeKey": "<string>",
      "createdByUserId": "<string>",
      "updatedByUserId": "<string>",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "updatedAt": "2025-01-15T01:30:15.000Z",
      "deletedAt": "2025-01-15T01:30:15.000Z",
      "archivedAt": "2025-01-15T01:30:15.000Z",
      "fieldValues": [
        {
          "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
        }
      ],
      "sourceAppInstanceIds": [
        "<string>"
      ],
      "sharedMetadata": {
        "sourceTeamId": "<string>",
        "sourceTeamName": "<string>"
      },
      "accessRestricted": true,
      "masked": true,
      "sourceApps": [
        {
          "appInstanceId": "<string>",
          "displayName": "<string>",
          "serviceName": "<string>",
          "serviceDisplayName": "<string>",
          "logoUrl": "<string>",
          "domain": "<string>",
          "useIntegratedServiceRegistry": true,
          "isCustom": true
        }
      ]
    }
  ],
  "nextPageToken": "<string>"
}

​Authentication and permissions

Authorizations

Query Parameters

Response

Authentication and permissions