---
title: "Get workspace"
method: GET
path: "/api/v2/workspaces/current"
tags: ["Workspace"]
---

# Get workspace

`GET /api/v2/workspaces/current`

Get your current workspace details. Note that this endpoint doesn't require any parameters. It will return the workspace based on the API key sent in the headers.


Requires one of the following scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all`

## Response `200`

The requested Workspace

- Workspace — A workspace entity representing a workspace
  - `id` string, uuid, required — Unique identifier for the workspace
  - `timestamp_created` string, date-time, required — Timestamp when the workspace was created
  - `timestamp_updated` string, date-time, required — Timestamp when the workspace was last updated
  - `scheduled_for_removal_at` string, date-time, nullable — Timestamp when this workspace is scheduled to be removed
  - `owner` string, uuid, required — User ID of the workspace owner
  - `name` string, required — Name of the workspace
  - `plan_id` string, nullable — Plan ID for workspace
  - `plan_id_bundle` string, nullable — Plan ID for workspace bundle
  - `add_unsub_to_block` boolean, nullable — Whether to add unsubscribes to block list
  - `default_opportunity_value` number, nullable — Default value for opportunities
  - `plan_id_leadfinder` string, nullable — Plan ID for leadfinder
  - `plan_id_verification` object — Plan ID for verification service
    - `quantity` number
    - `product_id` string
    - `timestamp_updated` string, date-time
  - `org_logo_url` string, nullable — URL to workspace logo
  - `org_client_domain` string, nullable — The domain for the white label agency mode
  - `plan_id_crm` string, nullable — Plan ID for CRM
  - `plan_id_website_visitor` string, nullable — Plan ID for website visitor tracking
  - `plan_id_inbox_placement` string, nullable — Plan ID for inbox placement

## Other responses

- `401` — This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked)
- `402` — This request cannot be fulfilled because the workspace does not have an active paid plan
- `404` — The requested resource was not found
- `429` — You have exceeded the rate limit. Please check the rate limit docs for more information.

---

[API](https://skmtc.net/instantly/apis/api-explorer.md) · [All operations](https://skmtc.net/instantly/apis/api-explorer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instantly/api-explorer/versions/378d1e253fe7/schema)
