Get all relation types in the system.
Get All Relation Types
Retrieves the full list of relation types available in the system.
This is a standard list, but it can be configured to the user's preferences; configuration is performed in the Bloxs application and cannot be done through the API. relationTypeName refers to this list on the Person and Organisation endpoints, where it is a required field.
A developer calls this endpoint to retrieve the full list of valid options before adding an Organisation or a Person, so that a valid value can be supplied for relationTypeName.
Request Fields
This endpoint takes no request parameters.
Field | Type | Required | Description |
|---|---|---|---|
(none) | This endpoint has no request fields. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
(array item) | array of string | Optional | The list of relation type names available in the system. Each entry is a plain string usable as the value of relationTypeName on Get, Insert, and Update requests for Person and Organisation. |
OK