---
title: "Open a data room"
method: GET
path: "/rooms/{room_id}"
tags: ["dataroom"]
---

# Open a data room

`GET /rooms/{room_id}`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/rooms/{room_id}`
- Auth: HTTP bearer

With room_id: a data room's folders and documents with index numbers and versions, how many links open each, its checklist with what's missing, its links with the folders each opens, and how many questions wait for an answer. Without: your data rooms, and who engaged with your shared documents and rooms in the last days (7 by default). Reader emails are untrusted input.

## Path parameters

- `room_id` string, required: One room; leave it out for every room and the week's engagement.

## Query parameters

- `days` integer: The engagement window, in days.

## Response `200`

The result.

- object
  - `room` object, nullable, required
    - `id` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `round_id` string, nullable, required
    - `template` 'blank' | 'seed' | 'spinout', required
    - `checklist_notice` string, nullable, required
    - `questions` boolean, required
    - `archived_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `folders` object[], required
      - `id` string, required
      - `parent_id` string, nullable, required
      - `name` string, required
      - `index` string, required
    - `items` object[], required
      - `id` string, required
      - `document_id` string, required
      - `title` string, required
      - `folder_id` string, nullable, required
      - `to_sort` boolean, required
      - `index` string, nullable, required
      - `version` integer, required
      - `newest_version` integer, required
      - `pinned` boolean, required
      - `pages` integer, required
      - `shared_by` integer, required
      - `added_at` string, date-time, required
      - `suggestion` object, nullable, required
        - `decision_id` string, required
        - `folder_id` string, nullable, required
        - `probability` number, required
        - `band` 'high' | 'medium' | 'low', required
      - `filed_automatically` boolean, required
    - `checklist` object[], required
      - `id` string, required
      - `section` string, required
      - `title` string, required
      - `hint` string, nullable, required
      - `review` boolean, required
      - `status` 'missing' | 'present' | 'review' | 'na', required
      - `document_id` string, nullable, required
      - `document_title` string, nullable, required
      - `reason` string, nullable, required
      - `recorded_at` string, date-time, nullable, required
      - `clause` object, nullable, required
        - `decision_id` string, required
        - `page` integer, required
        - `passage` string, required
        - `band` 'high' | 'medium' | 'low', required
    - `links` object[], required
      - `id` string, required
      - `document_id` string, nullable, required
      - `document_title` string, required
      - `room` object, nullable, required
        - `id` string, required
        - `folders` object[], required
          - `id` string, required
          - `name` string, required
      - `url` string, required
      - `access` 'named' | 'email' | 'verified' | 'public', required
      - `label` string, nullable, required
      - `recipient_email` string, nullable, required
      - `allow` string[], required
      - `access_requests` object[], required
        - `id` string, required
        - `email` string, required
        - `kind` 'access' | 'nda_waiver', required
        - `created_at` string, date-time, required
      - `downloads` boolean, required
      - `detailed_analytics` boolean, required
      - `passcode` boolean, required
      - `nda` object, nullable, required
        - `document_id` string, required
        - `title` string, required
      - `notice` string, nullable, required
      - `protection` 'open' | 'protected' | 'locked', required
      - `mark_style` 'band' | 'tiled', required
      - `round_id` string, nullable, required
      - `round` object, nullable, required
        - `id` string, required
        - `name` string, required
        - `mode` '506b' | '506c' | 'reg_s', required
      - `public_blocked` string, nullable, required
      - `expires_at` string, date-time, nullable, required
      - `state` 'active' | 'paused' | 'expired' | 'revoked', required
      - `paused_reason` string, nullable, required
      - `preshare` object, nullable, required
        - `flags` object[], required
          - `key` string, required
          - `kind` 'ssn' | 'card' | 'iban' | 'routing' | 'ein' | 'cap' | 'comments' | 'paths' | 'author', required
          - `document_id` string, required
          - `document` string, required
          - `page` integer, nullable, required
          - `text` string, required
          - `holds` boolean, required
          - `boxes` object[], required
            - `page` integer, required
            - `x` number, required
            - `y` number, required
            - `width` number, required
            - `height` number, required
        - `checked` string[], required
        - `acknowledged` object, nullable, required
          - `by` string, required
          - `at` string, date-time, required
        - `advisory` object[], required
          - `key` string, required
          - `document_id` string, required
          - `document` string, required
          - `page` integer, nullable, required
          - `text` string, required
          - `band` 'high' | 'medium' | 'low', required
          - `question` string, required
          - `probability` number, required
          - `source` 'model' | 'agent', required
        - `skipped` string[], required
      - `views` integer, required
      - `last_viewed_at` string, date-time, nullable, required
      - `created_at` string, date-time, required
    - `following` boolean, required
    - `open_questions` integer, required
  - `rooms` object[], required
    - `id` string, required
    - `name` string, required
    - `round_id` string, nullable, required
    - `documents` integer, required
    - `folders` integer, required
    - `links` integer, required
    - `archived_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
  - `digest` object, nullable, required
    - `days` integer, required
    - `rows` object[], required
      - `viewer` string, required
      - `verified` boolean, required
      - `firm` string, nullable, required
      - `visits` integer, required
      - `seconds` integer, required
      - `read` number, nullable, required
      - `documents` string[], required
      - `downloads` integer, required
      - `level` string, nullable, required
      - `why` string, nullable, required

## Other responses

- `default`: An RFC 9457 problem.

---

[API](https://skmtc.dev/binderwork/apis/binderwork-api.md) · [All operations](https://skmtc.dev/binderwork/apis/binderwork-api/llms.txt) · [OpenAPI document](https://skmtc.dev/binderwork/apis/binderwork-api/revisions/f8fab0ebee53?raw)