# getConnectionHeatmap

Source: /openapi/thomas-federated.openapi.json

## Operation

| Method | URL |
|---|---|
| GET | https://api.thomas.co/v1/organisation/heatmap |

| Field | Value |
|---|---|
| operationId | getConnectionHeatmap |
| method | GET |
| server | https://api.thomas.co/v1 |
| path | /organisation/heatmap |
| tags | `Organization Connection` |
| summary | Get organization connection heatmap data |
| badges | `{"name":"Owner"}`, `{"name":"Admin"}`, `{"name":"Viewer"}` |

## Request Parameters

| Name | In | Required | Schema | Description |
|---|---|---|---|---|
| page | query | false | integer |  |
| pageSize | query | false | integer |  |
| viewMode | query | true | string | FR53 Score/Trends mode (no default — endpoint chooses) |
| period | query | true | string | ISO month for heatmap context; mirrors ConnectionMeasureRunResponseSchema.period |
| teamTypeFilter | query | false | string | DEPRECATED (replaced by departmentFilter/statusFilter/hostFilter): legacy team type filter, still honoured for one release while clients migrate. Omit for both types. |
| departmentFilter | query | false | array | filter to teams whose member departments intersect this selection (OR within filter). Omit for no department filter. |
| statusFilter | query | false | array | filter rows by overall cell state. Mapping: active→scored, inProgress→in-progress, insufficient→insufficient, noData→no-run. OR within filter. Omit for no status filter. |
| hostFilter | query | false | array | filter to teams whose host (team owner for explicit, manager link target for implicit) matches one of the supplied companyIndividual ids. Teams with host=null are excluded when this filter is set. |
| nameSearch | query | false | string | case-insensitive substring filter on team name; applied server-side so pagination operates on the filtered set |

## Request Body

None.

## Responses

| Status | Description | Schema refs |
|---|---|---|
| 200 | Organization connection heatmap data | #/components/schemas/OrganisationHeatmapResponseDto |
| 401 | Invalid or missing authentication token (AUTH_TOKEN_INVALID) | #/components/schemas/ApiErrorResponseDto |

## Artifact Examples

### Response 401 example

```json
{
  "statusCode": 401,
  "message": "Invalid or missing authentication token",
  "error": "AUTH_TOKEN_INVALID"
}
```