Create Entity Type

POST

entity-types

Create Entity Type

curl --request POST \
  --url https://public.api.serval.com/v2/entity-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "key": "<string>",
  "name": "<string>",
  "fields": [
    {
      "key": "<string>",
      "name": "<string>",
      "enumOptions": [
        {
          "value": "<string>",
          "displayName": "<string>",
          "displayOrder": 123,
          "description": "<string>"
        }
      ],
      "isKeyField": true,
      "isNameField": true,
      "refEntityTypeId": "<string>",
      "refEntityTypeIds": [
        "<string>"
      ]
    }
  ],
  "parentEntityTypeId": "<string>",
  "schemaKey": "<string>",
  "isEdgeType": true
}
'

import requests

url = "https://public.api.serval.com/v2/entity-types"

payload = {
    "teamId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "fields": [
        {
            "key": "<string>",
            "name": "<string>",
            "enumOptions": [
                {
                    "value": "<string>",
                    "displayName": "<string>",
                    "displayOrder": 123,
                    "description": "<string>"
                }
            ],
            "isKeyField": True,
            "isNameField": True,
            "refEntityTypeId": "<string>",
            "refEntityTypeIds": ["<string>"]
        }
    ],
    "parentEntityTypeId": "<string>",
    "schemaKey": "<string>",
    "isEdgeType": 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>',
    key: '<string>',
    name: '<string>',
    fields: [
      {
        key: '<string>',
        name: '<string>',
        enumOptions: [
          {
            value: '<string>',
            displayName: '<string>',
            displayOrder: 123,
            description: '<string>'
          }
        ],
        isKeyField: true,
        isNameField: true,
        refEntityTypeId: '<string>',
        refEntityTypeIds: ['<string>']
      }
    ],
    parentEntityTypeId: '<string>',
    schemaKey: '<string>',
    isEdgeType: true
  })
};

fetch('https://public.api.serval.com/v2/entity-types', 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/entity-types",
  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>',
    'key' => '<string>',
    'name' => '<string>',
    'fields' => [
        [
                'key' => '<string>',
                'name' => '<string>',
                'enumOptions' => [
                                [
                                                                'value' => '<string>',
                                                                'displayName' => '<string>',
                                                                'displayOrder' => 123,
                                                                'description' => '<string>'
                                ]
                ],
                'isKeyField' => true,
                'isNameField' => true,
                'refEntityTypeId' => '<string>',
                'refEntityTypeIds' => [
                                '<string>'
                ]
        ]
    ],
    'parentEntityTypeId' => '<string>',
    'schemaKey' => '<string>',
    'isEdgeType' => 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/entity-types"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"name\": \"<string>\",\n      \"enumOptions\": [\n        {\n          \"value\": \"<string>\",\n          \"displayName\": \"<string>\",\n          \"displayOrder\": 123,\n          \"description\": \"<string>\"\n        }\n      ],\n      \"isKeyField\": true,\n      \"isNameField\": true,\n      \"refEntityTypeId\": \"<string>\",\n      \"refEntityTypeIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"parentEntityTypeId\": \"<string>\",\n  \"schemaKey\": \"<string>\",\n  \"isEdgeType\": 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/entity-types")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"name\": \"<string>\",\n      \"enumOptions\": [\n        {\n          \"value\": \"<string>\",\n          \"displayName\": \"<string>\",\n          \"displayOrder\": 123,\n          \"description\": \"<string>\"\n        }\n      ],\n      \"isKeyField\": true,\n      \"isNameField\": true,\n      \"refEntityTypeId\": \"<string>\",\n      \"refEntityTypeIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"parentEntityTypeId\": \"<string>\",\n  \"schemaKey\": \"<string>\",\n  \"isEdgeType\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entity-types")

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  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"name\": \"<string>\",\n      \"enumOptions\": [\n        {\n          \"value\": \"<string>\",\n          \"displayName\": \"<string>\",\n          \"displayOrder\": 123,\n          \"description\": \"<string>\"\n        }\n      ],\n      \"isKeyField\": true,\n      \"isNameField\": true,\n      \"refEntityTypeId\": \"<string>\",\n      \"refEntityTypeIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"parentEntityTypeId\": \"<string>\",\n  \"schemaKey\": \"<string>\",\n  \"isEdgeType\": true\n}"

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

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "parentEntityTypeId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "updatedAt": "2025-01-15T01:30:15.000Z",
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "fields": [
      {
        "id": "<string>",
        "entityTypeId": "<string>",
        "key": "<string>",
        "name": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>",
        "enumOptions": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123,
            "description": "<string>"
          }
        ],
        "isKeyField": true,
        "isNameField": true,
        "fieldId": "<string>",
        "refEntityTypeId": "<string>",
        "refEntityTypeIds": [
          "<string>"
        ],
        "description": "<string>",
        "sourceEntityTypeId": "<string>",
        "viewerCanViewValues": true,
        "viewerCanEdit": true,
        "helpAgentVisible": true,
        "sensitive": true,
        "sectionId": "<string>",
        "displayOptions": {
          "boolean": {
            "style": "STYLE_UNSPECIFIED"
          }
        },
        "valueSource": "FIELD_VALUE_SOURCE_UNSPECIFIED",
        "formula": "<string>",
        "defaultFormula": "<string>",
        "formulaDisabledAt": "2025-01-15T01:30:15.000Z",
        "autoNumber": {
          "prefix": "<string>",
          "digits": 123,
          "scope": "AUTO_NUMBER_SCOPE_UNSPECIFIED"
        },
        "timestampRange": {
          "allowsOpenEnd": true
        }
      }
    ],
    "color": "<string>",
    "iconSlug": "<string>",
    "entitySchemaId": "<string>",
    "helpAgentVisibility": "HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED",
    "viewerCanViewValues": true,
    "viewerCanEdit": true,
    "sections": [
      {
        "id": "<string>",
        "entityTypeId": "<string>",
        "name": "<string>",
        "sourceEntityTypeId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>"
      }
    ],
    "isEdgeType": true,
    "description": "<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:write`
Team-scoped API key	`entities:write`
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.

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.

key

string | null

The unique key for the entity type. If not provided, will be auto-generated from the name.

name

string

The display name of the entity type (required).

fields

EntityTypeFieldInput · object[]

The fields to create on the entity type.

Show child attributes

parentEntityTypeId

string | null

Optional parent entity type ID for nesting under a parent type.

schemaKey

string | null

Optional schema key for placing the entity type in a non-default schema. When omitted, the entity type is created in the team's default schema. Use "reference-data" for entity types that represent external reference tables (e.g., ServiceNow reference tables) rather than user-facing assets.

helpAgentVisibility

enum<string> | null

Controls whether the help agent can see entities of this type. Defaults to REQUESTER_ASSOCIATED if not specified.

Available options:

HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED,

HELP_AGENT_ENTITY_VISIBILITY_NONE,

HELP_AGENT_ENTITY_VISIBILITY_REQUESTER_ASSOCIATED,

HELP_AGENT_ENTITY_VISIBILITY_ALWAYS

isEdgeType

boolean | null

When true, marks the type as an edge/relationship type whose instances connect two other entities. The type must have exactly two single-valued ENTITY_REF fields in fields with the reserved keys "source" and "target" (the endpoints); each may target a specific entity type or be left open. Direction labels are derived from those field names, so no extra edge config is needed.

Response

200 - application/json

Success

data

data · object

The created entity type.

Show child attributes

Create Entity Type

curl --request POST \
  --url https://public.api.serval.com/v2/entity-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "key": "<string>",
  "name": "<string>",
  "fields": [
    {
      "key": "<string>",
      "name": "<string>",
      "enumOptions": [
        {
          "value": "<string>",
          "displayName": "<string>",
          "displayOrder": 123,
          "description": "<string>"
        }
      ],
      "isKeyField": true,
      "isNameField": true,
      "refEntityTypeId": "<string>",
      "refEntityTypeIds": [
        "<string>"
      ]
    }
  ],
  "parentEntityTypeId": "<string>",
  "schemaKey": "<string>",
  "isEdgeType": true
}
'

import requests

url = "https://public.api.serval.com/v2/entity-types"

payload = {
    "teamId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "fields": [
        {
            "key": "<string>",
            "name": "<string>",
            "enumOptions": [
                {
                    "value": "<string>",
                    "displayName": "<string>",
                    "displayOrder": 123,
                    "description": "<string>"
                }
            ],
            "isKeyField": True,
            "isNameField": True,
            "refEntityTypeId": "<string>",
            "refEntityTypeIds": ["<string>"]
        }
    ],
    "parentEntityTypeId": "<string>",
    "schemaKey": "<string>",
    "isEdgeType": 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>',
    key: '<string>',
    name: '<string>',
    fields: [
      {
        key: '<string>',
        name: '<string>',
        enumOptions: [
          {
            value: '<string>',
            displayName: '<string>',
            displayOrder: 123,
            description: '<string>'
          }
        ],
        isKeyField: true,
        isNameField: true,
        refEntityTypeId: '<string>',
        refEntityTypeIds: ['<string>']
      }
    ],
    parentEntityTypeId: '<string>',
    schemaKey: '<string>',
    isEdgeType: true
  })
};

fetch('https://public.api.serval.com/v2/entity-types', 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/entity-types",
  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>',
    'key' => '<string>',
    'name' => '<string>',
    'fields' => [
        [
                'key' => '<string>',
                'name' => '<string>',
                'enumOptions' => [
                                [
                                                                'value' => '<string>',
                                                                'displayName' => '<string>',
                                                                'displayOrder' => 123,
                                                                'description' => '<string>'
                                ]
                ],
                'isKeyField' => true,
                'isNameField' => true,
                'refEntityTypeId' => '<string>',
                'refEntityTypeIds' => [
                                '<string>'
                ]
        ]
    ],
    'parentEntityTypeId' => '<string>',
    'schemaKey' => '<string>',
    'isEdgeType' => 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/entity-types"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"name\": \"<string>\",\n      \"enumOptions\": [\n        {\n          \"value\": \"<string>\",\n          \"displayName\": \"<string>\",\n          \"displayOrder\": 123,\n          \"description\": \"<string>\"\n        }\n      ],\n      \"isKeyField\": true,\n      \"isNameField\": true,\n      \"refEntityTypeId\": \"<string>\",\n      \"refEntityTypeIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"parentEntityTypeId\": \"<string>\",\n  \"schemaKey\": \"<string>\",\n  \"isEdgeType\": 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/entity-types")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"name\": \"<string>\",\n      \"enumOptions\": [\n        {\n          \"value\": \"<string>\",\n          \"displayName\": \"<string>\",\n          \"displayOrder\": 123,\n          \"description\": \"<string>\"\n        }\n      ],\n      \"isKeyField\": true,\n      \"isNameField\": true,\n      \"refEntityTypeId\": \"<string>\",\n      \"refEntityTypeIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"parentEntityTypeId\": \"<string>\",\n  \"schemaKey\": \"<string>\",\n  \"isEdgeType\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entity-types")

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  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"name\": \"<string>\",\n      \"enumOptions\": [\n        {\n          \"value\": \"<string>\",\n          \"displayName\": \"<string>\",\n          \"displayOrder\": 123,\n          \"description\": \"<string>\"\n        }\n      ],\n      \"isKeyField\": true,\n      \"isNameField\": true,\n      \"refEntityTypeId\": \"<string>\",\n      \"refEntityTypeIds\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"parentEntityTypeId\": \"<string>\",\n  \"schemaKey\": \"<string>\",\n  \"isEdgeType\": true\n}"

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

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "parentEntityTypeId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "updatedAt": "2025-01-15T01:30:15.000Z",
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "fields": [
      {
        "id": "<string>",
        "entityTypeId": "<string>",
        "key": "<string>",
        "name": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>",
        "enumOptions": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123,
            "description": "<string>"
          }
        ],
        "isKeyField": true,
        "isNameField": true,
        "fieldId": "<string>",
        "refEntityTypeId": "<string>",
        "refEntityTypeIds": [
          "<string>"
        ],
        "description": "<string>",
        "sourceEntityTypeId": "<string>",
        "viewerCanViewValues": true,
        "viewerCanEdit": true,
        "helpAgentVisible": true,
        "sensitive": true,
        "sectionId": "<string>",
        "displayOptions": {
          "boolean": {
            "style": "STYLE_UNSPECIFIED"
          }
        },
        "valueSource": "FIELD_VALUE_SOURCE_UNSPECIFIED",
        "formula": "<string>",
        "defaultFormula": "<string>",
        "formulaDisabledAt": "2025-01-15T01:30:15.000Z",
        "autoNumber": {
          "prefix": "<string>",
          "digits": 123,
          "scope": "AUTO_NUMBER_SCOPE_UNSPECIFIED"
        },
        "timestampRange": {
          "allowsOpenEnd": true
        }
      }
    ],
    "color": "<string>",
    "iconSlug": "<string>",
    "entitySchemaId": "<string>",
    "helpAgentVisibility": "HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED",
    "viewerCanViewValues": true,
    "viewerCanEdit": true,
    "sections": [
      {
        "id": "<string>",
        "entityTypeId": "<string>",
        "name": "<string>",
        "sourceEntityTypeId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>"
      }
    ],
    "isEdgeType": true,
    "description": "<string>"
  }
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Body

Response

​Authentication and permissions

Authorizations

Body

Response

Authentication and permissions