Search Entities - Serval Documentation

POST

entities

Search Entities

curl --request POST \
  --url https://public.api.serval.com/v2/entities/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "entityTypeId": "<string>",
  "entityTypeKey": "<string>",
  "filterGroups": [
    {
      "filters": [
        {
          "boolValue": {
            "eq": true
          },
          "fieldId": "<string>",
          "fieldKey": "<string>"
        }
      ],
      "sourceFilter": {
        "eq": "<string>",
        "ne": "<string>"
      }
    }
  ],
  "fieldSorts": [
    {
      "entitySource": {},
      "descending": true
    }
  ],
  "pageSize": 123,
  "pageToken": "<string>",
  "key": "<string>",
  "includeArchived": true
}
'

import requests

url = "https://public.api.serval.com/v2/entities/search"

payload = {
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "entityTypeKey": "<string>",
    "filterGroups": [
        {
            "filters": [
                {
                    "boolValue": { "eq": True },
                    "fieldId": "<string>",
                    "fieldKey": "<string>"
                }
            ],
            "sourceFilter": {
                "eq": "<string>",
                "ne": "<string>"
            }
        }
    ],
    "fieldSorts": [
        {
            "entitySource": {},
            "descending": True
        }
    ],
    "pageSize": 123,
    "pageToken": "<string>",
    "key": "<string>",
    "includeArchived": 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({
    teamId: '<string>',
    entityTypeId: '<string>',
    entityTypeKey: '<string>',
    filterGroups: [
      {
        filters: [{boolValue: {eq: true}, fieldId: '<string>', fieldKey: '<string>'}],
        sourceFilter: {eq: '<string>', ne: '<string>'}
      }
    ],
    fieldSorts: [{entitySource: {}, descending: true}],
    pageSize: 123,
    pageToken: '<string>',
    key: '<string>',
    includeArchived: true
  })
};

fetch('https://public.api.serval.com/v2/entities/search', 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/search",
  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([
    'teamId' => '<string>',
    'entityTypeId' => '<string>',
    'entityTypeKey' => '<string>',
    'filterGroups' => [
        [
                'filters' => [
                                [
                                                                'boolValue' => [
                                                                                                                                'eq' => true
                                                                ],
                                                                'fieldId' => '<string>',
                                                                'fieldKey' => '<string>'
                                ]
                ],
                'sourceFilter' => [
                                'eq' => '<string>',
                                'ne' => '<string>'
                ]
        ]
    ],
    'fieldSorts' => [
        [
                'entitySource' => [
                                
                ],
                'descending' => true
        ]
    ],
    'pageSize' => 123,
    'pageToken' => '<string>',
    'key' => '<string>',
    'includeArchived' => 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/search"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"entityTypeId\": \"<string>\",\n  \"entityTypeKey\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"boolValue\": {\n            \"eq\": true\n          },\n          \"fieldId\": \"<string>\",\n          \"fieldKey\": \"<string>\"\n        }\n      ],\n      \"sourceFilter\": {\n        \"eq\": \"<string>\",\n        \"ne\": \"<string>\"\n      }\n    }\n  ],\n  \"fieldSorts\": [\n    {\n      \"entitySource\": {},\n      \"descending\": true\n    }\n  ],\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"key\": \"<string>\",\n  \"includeArchived\": 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/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"entityTypeId\": \"<string>\",\n  \"entityTypeKey\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"boolValue\": {\n            \"eq\": true\n          },\n          \"fieldId\": \"<string>\",\n          \"fieldKey\": \"<string>\"\n        }\n      ],\n      \"sourceFilter\": {\n        \"eq\": \"<string>\",\n        \"ne\": \"<string>\"\n      }\n    }\n  ],\n  \"fieldSorts\": [\n    {\n      \"entitySource\": {},\n      \"descending\": true\n    }\n  ],\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"key\": \"<string>\",\n  \"includeArchived\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"teamId\": \"<string>\",\n  \"entityTypeId\": \"<string>\",\n  \"entityTypeKey\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"boolValue\": {\n            \"eq\": true\n          },\n          \"fieldId\": \"<string>\",\n          \"fieldKey\": \"<string>\"\n        }\n      ],\n      \"sourceFilter\": {\n        \"eq\": \"<string>\",\n        \"ne\": \"<string>\"\n      }\n    }\n  ],\n  \"fieldSorts\": [\n    {\n      \"entitySource\": {},\n      \"descending\": true\n    }\n  ],\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"key\": \"<string>\",\n  \"includeArchived\": true\n}"

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": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "fieldValues": [
        {
          "id": "<string>",
          "entityId": "<string>",
          "fieldId": "<string>",
          "fieldKey": "<string>",
          "fieldName": "<string>",
          "value": 123,
          "setByUserId": "<string>",
          "setByAppInstanceId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "pinned": true
        }
      ],
      "sourceAppInstanceIds": [
        "<string>"
      ],
      "sharedMetadata": {
        "sourceTeamId": "<string>",
        "sourceTeamName": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>"
}

{
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

teamId

string

The ID of the team.

entityTypeId

string | null

Optional filter by entity type ID.

entityTypeKey

string | null

Optional filter by entity type key (alternative to entity_type_id).

filterGroups

EntityFilterGroup · object[]

Filter groups for complex filtering. OR between groups, AND within each group.

Show child attributes

fieldSorts

(Entity Source · object | Field Id · object | Field Key · object)[]

Sorting specifications.

Entity Source
Field Id
Field Key

Show child attributes

pageSize

integer<int32> | null

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

pageToken

string | null

Token for pagination. Leave empty for the first request.

key

string | null

Optional filter by entity key (exact match).

includeArchived

boolean

Include archived entities in the results. Default false (archived entities are hidden). Archived items keep their key reserved and can be unarchived; set this to discover them (e.g. to call UnarchiveEntity).

Response

Success

data

Entity · object[]

The list of matching entities.

Show child attributes

nextPageToken

string | null

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

Search Entities

curl --request POST \
  --url https://public.api.serval.com/v2/entities/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "entityTypeId": "<string>",
  "entityTypeKey": "<string>",
  "filterGroups": [
    {
      "filters": [
        {
          "boolValue": {
            "eq": true
          },
          "fieldId": "<string>",
          "fieldKey": "<string>"
        }
      ],
      "sourceFilter": {
        "eq": "<string>",
        "ne": "<string>"
      }
    }
  ],
  "fieldSorts": [
    {
      "entitySource": {},
      "descending": true
    }
  ],
  "pageSize": 123,
  "pageToken": "<string>",
  "key": "<string>",
  "includeArchived": true
}
'

import requests

url = "https://public.api.serval.com/v2/entities/search"

payload = {
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "entityTypeKey": "<string>",
    "filterGroups": [
        {
            "filters": [
                {
                    "boolValue": { "eq": True },
                    "fieldId": "<string>",
                    "fieldKey": "<string>"
                }
            ],
            "sourceFilter": {
                "eq": "<string>",
                "ne": "<string>"
            }
        }
    ],
    "fieldSorts": [
        {
            "entitySource": {},
            "descending": True
        }
    ],
    "pageSize": 123,
    "pageToken": "<string>",
    "key": "<string>",
    "includeArchived": 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({
    teamId: '<string>',
    entityTypeId: '<string>',
    entityTypeKey: '<string>',
    filterGroups: [
      {
        filters: [{boolValue: {eq: true}, fieldId: '<string>', fieldKey: '<string>'}],
        sourceFilter: {eq: '<string>', ne: '<string>'}
      }
    ],
    fieldSorts: [{entitySource: {}, descending: true}],
    pageSize: 123,
    pageToken: '<string>',
    key: '<string>',
    includeArchived: true
  })
};

fetch('https://public.api.serval.com/v2/entities/search', 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/search",
  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([
    'teamId' => '<string>',
    'entityTypeId' => '<string>',
    'entityTypeKey' => '<string>',
    'filterGroups' => [
        [
                'filters' => [
                                [
                                                                'boolValue' => [
                                                                                                                                'eq' => true
                                                                ],
                                                                'fieldId' => '<string>',
                                                                'fieldKey' => '<string>'
                                ]
                ],
                'sourceFilter' => [
                                'eq' => '<string>',
                                'ne' => '<string>'
                ]
        ]
    ],
    'fieldSorts' => [
        [
                'entitySource' => [
                                
                ],
                'descending' => true
        ]
    ],
    'pageSize' => 123,
    'pageToken' => '<string>',
    'key' => '<string>',
    'includeArchived' => 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/search"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"entityTypeId\": \"<string>\",\n  \"entityTypeKey\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"boolValue\": {\n            \"eq\": true\n          },\n          \"fieldId\": \"<string>\",\n          \"fieldKey\": \"<string>\"\n        }\n      ],\n      \"sourceFilter\": {\n        \"eq\": \"<string>\",\n        \"ne\": \"<string>\"\n      }\n    }\n  ],\n  \"fieldSorts\": [\n    {\n      \"entitySource\": {},\n      \"descending\": true\n    }\n  ],\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"key\": \"<string>\",\n  \"includeArchived\": 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/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"entityTypeId\": \"<string>\",\n  \"entityTypeKey\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"boolValue\": {\n            \"eq\": true\n          },\n          \"fieldId\": \"<string>\",\n          \"fieldKey\": \"<string>\"\n        }\n      ],\n      \"sourceFilter\": {\n        \"eq\": \"<string>\",\n        \"ne\": \"<string>\"\n      }\n    }\n  ],\n  \"fieldSorts\": [\n    {\n      \"entitySource\": {},\n      \"descending\": true\n    }\n  ],\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"key\": \"<string>\",\n  \"includeArchived\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"teamId\": \"<string>\",\n  \"entityTypeId\": \"<string>\",\n  \"entityTypeKey\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"boolValue\": {\n            \"eq\": true\n          },\n          \"fieldId\": \"<string>\",\n          \"fieldKey\": \"<string>\"\n        }\n      ],\n      \"sourceFilter\": {\n        \"eq\": \"<string>\",\n        \"ne\": \"<string>\"\n      }\n    }\n  ],\n  \"fieldSorts\": [\n    {\n      \"entitySource\": {},\n      \"descending\": true\n    }\n  ],\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"key\": \"<string>\",\n  \"includeArchived\": true\n}"

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": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "fieldValues": [
        {
          "id": "<string>",
          "entityId": "<string>",
          "fieldId": "<string>",
          "fieldKey": "<string>",
          "fieldName": "<string>",
          "value": 123,
          "setByUserId": "<string>",
          "setByAppInstanceId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "pinned": true
        }
      ],
      "sourceAppInstanceIds": [
        "<string>"
      ],
      "sharedMetadata": {
        "sourceTeamId": "<string>",
        "sourceTeamName": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>"
}

{
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}