v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Entities

Get All Entity Relationship Types

Returns all entity relationship types. For more information, see Entity Relationship Types.

OAuth Scope required: public.entities.readRelationshipTypes

get/entities/relationship-types

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

200

idstring

The unique identifier of the record

namestring

The unique identifier of the relationship type

displayNamestring

The display name of the relationship type

descriptionstring

The description of the relationship type

Example response

[
  {
    "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
    "name": "customer",
    "displayName": "Customer or Custom Vendor",
    "description": "A customer is a business that purchases products or services from a business."
  }
]