> ## 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 complexes
> Get a list of teams for complexes
## OpenAPI
````json GET /api/v1/realestateobjects/complexes/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/complexes/teams": {
"get": {
"tags": [
"Complexes"
],
"summary": "Get a list of teams for complexes",
"description": "Get a list of teams for complexes",
"operationId": "GetComplexTeams",
"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 complexes
This endpoint retrieves the supplier team configured for a complex.
A supplier team is a predefined set of preferred suppliers, or relations, that Bloxs users set up in advance for a complex to cover specific activities or service needs.
Integrators typically call this endpoint while handling a service ticket for the complex, whether the ticket is linked to the complex directly or indirectly through one of its units or sections, so the reported issue can be routed to the correct supplier without needing to know the underlying setup.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | Conditional | Internal identifier of the complex. Either reference or externalIdentifier must be provided. If both are given, the complex must match both values. |
externalIdentifier | string | Conditional | External identifier of the complex, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the complex 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. |