---
title: "Get workspace overview"
method: GET
path: "/v1/workspaces/{workspaceId}/overview"
tags: ["Workspaces"]
---

# Get workspace overview

`GET /v1/workspaces/{workspaceId}/overview`

## Request

- Base URL: `https://api.atlas-compiler.com`
- URL: `https://api.atlas-compiler.com/v1/workspaces/{workspaceId}/overview`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Retrieve a consolidated overview of workspace usage, quota, and recent activity.

## Path parameters

- `workspaceId` string, required

## Response `200`

The workspace overview.

- object
  - `activeJobs` object[], required
    - `artifactExpiresAt` string, date-time, nullable, required
    - `artifactState` 'not_applicable' | 'pending' | 'ingesting' | 'complete' | 'expired' | 'review', required
    - `cancellationRequestedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `executionTerminalAt` string, date-time, nullable, required
    - `id` string, required
    - `kind` 'compile' | 'crawl' | 'batch', required
    - `progress` object, nullable, required
      - `completedItems` integer, required
      - `etaSeconds` integer, nullable, required
      - `failedItems` integer, required
      - `queuedItems` integer, required
      - `ratePerMinute` integer, nullable, required
    - `projectId` string, nullable, required
    - `readyAt` string, date-time, nullable, required
    - `reviewReason` string, nullable, required
    - `status` 'queued' | 'running' | 'ingesting' | 'ready' | 'failed' | 'cancelled', required
    - `targetUrl` string, nullable
    - `updatedAt` string, date-time, required
    - `workspaceId` string, required
  - `counts` object, required
    - `apiKeys` integer, required
    - `projects` integer, required
    - `webhooks` integer, required
  - `onboarding` object, required
    - `hasConfiguredWebhook` boolean, required
    - `hasCreatedApiKey` boolean, required
    - `hasInvitedTeammate` boolean, required
    - `hasRunCompile` boolean, required
  - `plan` object, required
    - `cancelAtPeriodEnd` boolean, nullable, required
    - `code` string, required
    - `graceExpiresAt` string, date-time, nullable, required
    - `renewalAt` string, date-time, nullable, required
    - `status` string, nullable, required
  - `recentErrors` object[], required
    - `artifactExpiresAt` string, date-time, nullable, required
    - `artifactState` 'not_applicable' | 'pending' | 'ingesting' | 'complete' | 'expired' | 'review', required
    - `cancellationRequestedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `executionTerminalAt` string, date-time, nullable, required
    - `id` string, required
    - `kind` 'compile' | 'crawl' | 'batch', required
    - `progress` object, nullable, required
      - `completedItems` integer, required
      - `etaSeconds` integer, nullable, required
      - `failedItems` integer, required
      - `queuedItems` integer, required
      - `ratePerMinute` integer, nullable, required
    - `projectId` string, nullable, required
    - `readyAt` string, date-time, nullable, required
    - `reviewReason` string, nullable, required
    - `status` 'queued' | 'running' | 'ingesting' | 'ready' | 'failed' | 'cancelled', required
    - `targetUrl` string, nullable
    - `updatedAt` string, date-time, required
    - `workspaceId` string, required
  - `recentJobs` object[], required
    - `artifactExpiresAt` string, date-time, nullable, required
    - `artifactState` 'not_applicable' | 'pending' | 'ingesting' | 'complete' | 'expired' | 'review', required
    - `cancellationRequestedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `executionTerminalAt` string, date-time, nullable, required
    - `id` string, required
    - `kind` 'compile' | 'crawl' | 'batch', required
    - `progress` object, nullable, required
      - `completedItems` integer, required
      - `etaSeconds` integer, nullable, required
      - `failedItems` integer, required
      - `queuedItems` integer, required
      - `ratePerMinute` integer, nullable, required
    - `projectId` string, nullable, required
    - `readyAt` string, date-time, nullable, required
    - `reviewReason` string, nullable, required
    - `status` 'queued' | 'running' | 'ingesting' | 'ready' | 'failed' | 'cancelled', required
    - `targetUrl` string, nullable
    - `updatedAt` string, date-time, required
    - `workspaceId` string, required
  - `usage` object, required
    - `allowance` integer, required
    - `consumed` integer, required
    - `dailyConsumed` object[], required
      - `consumed` integer, required
      - `day` integer, required
    - `grantCreditsRemaining` integer, required
    - `periodEnd` string, date-time, required
    - `periodStart` string, date-time, required
    - `reserved` integer, required
  - `workspaceId` string, required

## Other responses

- `400`: RFC 9457 problem.
- `401`: RFC 9457 problem.
- `403`: RFC 9457 problem.
- `404`: RFC 9457 problem.
- `500`: RFC 9457 problem.
- `503`: RFC 9457 problem.

---

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