# Get Workspace

> The workspace the key works in, with the role of the user who created the key.

Requires an API key with the `read` scope.

With `X-Workspace-Id` it returns that client workspace instead (see [Agency mode](/product/agency-mode)). `role` is the role of the user who created the key in this workspace. If that user is no longer a member the call is `403`.

## Response

Returns the workspace in `data`: `id`, `name`, `slug`, `ownerId`, `isPersonal`, `role`, `memberCount`, `createdAt`.

<RequestExample>
```bash cURL
curl -X GET "https://api.foxreach.io/api/v1/workspace" \
  -H "X-API-Key: otr_your_key"
```

```python Python SDK
from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
workspace = client.workspace.get()
```

```typescript TypeScript SDK
import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const workspace = await client.workspace.get();
```

</RequestExample>

<ResponseExample>
```json
{ "data": { "id": "ws_abc123", "name": "Acme", "slug": "acme", "ownerId": "usr_1", "isPersonal": false, "role": "owner", "memberCount": 3, "createdAt": "2026-10-01T08:00:00+00:00" } }
```
</ResponseExample>

## Errors

| Status | Description |
|--------|-------------|
| `401` | Missing, invalid, revoked or expired API key |
| `403` | Missing `read` scope, or the key's creator is not a member of this workspace |

## Rate Limit

- **300 requests per minute, shared by every `read` call in your workspace.** Fixed 60-second window.
- Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (unix epoch seconds) and `X-RateLimit-Bucket` (`read`).
- A `429` response includes a `Retry-After` header (seconds until the bucket resets).

For client-side patterns, see [Rate Limiting](/rate-limiting).