---
title: "Get the workspace"
method: GET
path: "/workspace"
tags: ["workspace"]
---

# Get the workspace

`GET /workspace`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/workspace`
- Auth: HTTP bearer

The company's details and policies, plus your email, your role and whether you are an officer.

## Response `200`

The result.

- object
  - `id` string, required
  - `slug` string, required
  - `legal_name` string, required
  - `entity_type` 'corporation' | 'llc' | 'other', required
  - `jurisdiction` string, required
  - `address` object, nullable, required
    - `lines` string[], required
    - `country` string, required: ISO 3166-1 alpha-2
    - `region` string
  - `fiscal_year_end` string, nullable, required
  - `formation_date` string, date, nullable, required
  - `policies` object, required
    - `agent_connections` boolean, required
    - `ai_features` boolean, required
    - `match_fields_with_ai` boolean, required
    - `check_drafts_with_ai` boolean, required
    - `file_uploads_with_ai` boolean, required
    - `preshare_with_ai` boolean, required
    - `questions_with_ai` boolean, required
    - `answer_drafts_with_ai` boolean, required
    - `digest_summary_with_ai` boolean, required
    - `template_search_with_ai` boolean, required
    - `no_public_links` boolean, required
    - `agent_links` boolean, required
    - `agent_links_daily_cap` integer, required
    - `fundraising_in_chats` 'on' | 'off', required
    - `hiring_in_chats` 'on' | 'off', required
  - `link_domain` object, nullable, required
    - `domain` string, required
    - `verified` boolean, required
    - `txt_name` string, required
    - `txt_value` string, required
  - `company_domain` object, nullable, required
    - `domain` string, required
    - `verified` boolean, required
    - `txt_name` string, required
    - `txt_value` string, required
  - `brand` object, required
    - `sender_name` string, nullable, required
    - `color` string, nullable, required
    - `logo` boolean, required
    - `footer_line` boolean, required
  - `created_at` string, date-time, required
  - `me` object, required
    - `member_id` string, required
    - `email` string, required
    - `role` string, required
    - `officer` boolean, required
  - `signing` object, required
    - `seal` object, required
      - `name` string, required
      - `self_signed` boolean, required
      - `expires_at` string, date-time, required
      - `expires_within_a_year` boolean, required
      - `acrobat` string, required
    - `steps` string[], required
    - `key_storage` object, required
      - `kind` 'file' | 'hsm', required
      - `rating` 'lower' | 'good', required
      - `why` string, required
    - `timestamp` object, required
      - `url` string, nullable, required
      - `source` 'workspace' | 'instance' | 'test', required
      - `tested_at` string, date-time, nullable, required
      - `error` string, nullable, required
    - `sending_blocked` string, nullable, required
  - `ai` object, required
    - `decision_model` string, nullable, required
    - `language_model` 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)
