> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get all communication forms
> Get all communication forms in the system.
## OpenAPI
````json GET /api/v1/relations/communicationForms
{
"openapi": "3.0.4",
"info": {
"title": "Relations V1",
"description": "# Relation API Documentation\n\nWelcome to the Relationship Management API documentation. This API allows you to perform CRUD operations on various relationship types, including Owners, Persons, Suppliers, Estate Agents, and Organisations. \n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## CRUD Operations \n\nThe API supports CRUD operations for the following relationship types: \n\n- **Owners**\n- **Persons**\n- **Suppliers**\n- **Estate Agents**\n- **Organisations**\n\nFor each relationship type, you can: \n\n- **GET**: Retrieve a list or apply filters.\n- **POST**: Add a new entry.\n- **PUT**: Update existing details.\n- **PATCH**: Apply partial updates.\n- **DELETE**: Remove an entry.\n\nThank you for choosing our Relation API. If you have any questions or need assistance, please contact our support team. \n",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Common"
},
{
"name": "CommunicationFormAPI"
},
{
"name": "EstateAgentAPI"
},
{
"name": "Metadata"
},
{
"name": "OrganisationAPI"
},
{
"name": "OwnerAPI"
},
{
"name": "PersonAPI"
},
{
"name": "RelationTypeAPI"
},
{
"name": "SupplierAPI"
},
{
"name": "SupplierTypeAPI"
}
],
"paths": {
"/api/v1/relations/communicationForms": {
"get": {
"tags": [
"Admin"
],
"summary": "Get all communication forms",
"description": "Get all communication forms in the system.",
"operationId": "GetCommunicationForms",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommunicationFormDataModel"
}
}
}
}
}
},
"x-d360-narrative-url": "Get All Communication Forms
Retrieves the full list of communication forms 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. communicationFormName refers to this list on the Person endpoints, where it is a required field, and decides the standard method of addressing the person in communication coming from the Bloxs application.
A developer calls this endpoint to retrieve the full list of valid options before adding a Person, so that a valid value can be supplied for communicationFormName.
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 |
|---|
name | string, nullable | Optional | The selectable value stored as communicationFormName on a Person, for example \"Man\", \"Vrouw\", or \"Onbekend\". |
title | string, nullable | Optional | The salutation text generated in correspondence for this communication form, for example \"Meneer\" or \"Meneer / mevrouw\". |