> ## 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 relations for a contact person
> Get all relations for a contact person. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the relation.
## OpenAPI
````json GET /api/v1/relations/contacts/relations
{
"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/contacts/relations": {
"get": {
"tags": [
"ContactPersons"
],
"summary": "Get all relations for a contact person",
"description": "Get all relations for a contact person. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the relation.",
"operationId": "GetContactPersonRelations",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"type": "string"
}
},
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationReferenceModel"
}
}
}
}
},
"404": {
"description": "The requested contact person was not found."
}
},
"x-d360-narrative-url": "Retrieves every relation that a given contact person is linked to.
A developer calls this endpoint to find out which relations, for example a supplier, organisation, estate agent, owner or another person, a contact person belongs to. This is the reverse lookup of the \"Get all contacts for a relation\" endpoint, which starts from a relation and returns its contact persons.
Use this endpoint when contact data needs to be resolved back to the relations it serves, for example when synchronising a contact person record from an external system.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | Conditional | The internal identifier of the contact person, for example its Reference or Code. Either reference or externalIdentifier must be given. If both are given, both are used to locate the contact person. |
externalIdentifier | string | Conditional | The external API identifier of the contact person. Either reference or externalIdentifier must be given. If both are given, both are used to locate the contact person. |
Response Fields
Field | Type | Required | Description |
|---|
reference | string, nullable | No | The internal identifier of the relation that the contact person is linked to. |
type | integer (int32) | No | The type of the linked relation, returned as a numeric code. Allowed values: 1 (Person), 2 (Organisation), 3 (Supplier), 4 (Owner), 5 (EstateAgent), 6 (Financier). |
displayName | string, nullable | No | The formatted display name of the linked relation. |