# Read the workspace at a glance

The workspace at a glance: the pipeline by stage, what is new this week, the comms picture, recent activity and the facility count. The first call for "how are we doing" and "what needs attention". `delinquency` is how far behind the book is right now: overdue instalments, what they add up to in minor units, and how many schedules carry one — the Payments board's `overdue` view, counted.

Access class: `workspace`.

## Endpoint

`GET /v1/workspace/summary`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| body | query | null | No |
| params | query | object | No |
| query | query | object | No |

## Responses

### 200

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "comms": {
      "pendingResponses": 1.5,
      "totalChannels": 1.5,
      "totalConversations": 1.5,
      "unreadConversations": 1.5
    },
    "delinquency": {
      "behind": 1.5,
      "overdue": 1.5,
      "overdueAmountMinor": 1.5
    },
    "newThisWeek": 1.5,
    "pipelineByStage": {},
    "recentActivity": [
      {
        "actorName": "string",
        "createdAt": "string",
        "entityName": "string",
        "entityType": "string",
        "eventType": "string",
        "id": "",
        "summary": "string"
      }
    ],
    "totalFacilities": 1.5
  }
}
```

### default

a refusal: `{"error": "<what a person needs to read>"}`. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

Content type: `application/json`.

```json
{
  "error": "string"
}
```