Get all relation types
  • 13 Jul 2024
  • 1 Minute to read
  • Dark
    Light

Get all relation types

  • Dark
    Light

Article summary

Get
/api/v1/relations/relationTypes

Get all relation types in the system.

Description

Returns the list of all available relation types. This is a standard list, however it can be configured to the preferences of the user. Configuration is performed in the Bloxs application and cannot be conducted through the API. RelationTypes refers to the 'relationTypeName' field in the organisation & person endpoints. In order to enter a valid option in 'relationTypeName', the endpoint 'Get RelationTypes' can be used to retrieve the full list of available options.

Use Case

The Bloxs user wants to add an organisation or a person. One of the compulsory fields is the relationTypeName. However, the user does not know which options are available. By calling the Get RelationTypes endpoint a full list will be returned of available options. Subsequently this can be used as input for adding an organisation or a person.

Security
HTTP
Type Bearer

Please enter a valid token

Responses
200

Success

Array of string 
string