API ReferenceRelationship Types

List custom relationship types

Returns org-defined relationship types for the current environment. Use these alongside built-in user types when creating identity relationships. Requires Enterprise plan.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Query parameters

include_inactivebooleanOptionalDefaults to false
Include disabled types in the results.

Response

A list of custom relationship types.
datalist of objects

Errors

401
Unauthorized Error
403
Forbidden Error