> ## 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 a list of teams for buildings
> Get a list of teams for buildings
## OpenAPI
````json GET /api/v1/realestateobjects/buildings/teams
{
"openapi": "3.0.4",
"info": {
"title": "RealEstateObjects V1",
"description": "Welcome to BETA version of the new RealEstateObjects API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Admin"
},
{
"name": "Buildings"
},
{
"name": "Complexes"
},
{
"name": "Generic"
},
{
"name": "Metadata"
},
{
"name": "PublishObjects"
},
{
"name": "ScoringPointTotals"
},
{
"name": "Sections"
},
{
"name": "Units"
}
],
"paths": {
"/api/v1/realestateobjects/buildings/teams": {
"get": {
"tags": [
"Buildings"
],
"summary": "Get a list of teams for buildings",
"description": "Get a list of teams for buildings",
"operationId": "GetBuildingTeams",
"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/TeamMemberAPIModel"
}
}
}
}
}
},
"x-d360-narrative-url": "Get a list of teams for buildings
This endpoint retrieves the supplier team configured for a building.
A supplier team is a predefined set of preferred suppliers, or relations, that Bloxs users set up in advance for a building to cover specific activities or service needs.
Integrators typically call this endpoint while handling a service ticket for the building, so the reported issue can be routed to the correct supplier without needing to know the underlying setup, which is useful in organizations where the person handling ticket processing is not the same person who maintains the supplier team configuration.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | Conditional | Internal identifier of the building. Either reference or externalIdentifier must be provided. If both are given, the building must match both values. |
externalIdentifier | string | Conditional | External identifier of the building, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the building must match both values. |
Response Fields
Field | Type | Required | Description |
|---|
supplierReference | string | No | Internal identifier of the supplier assigned to the team. |
supplierType | string | No | Name of the supplier type assigned to this team entry. Supplier type values are configurable in the Bloxs admin module. |
description | string | No | Description of the supplier type, for example contractor, roofer, or glazier. |