---
title: "Read a suite"
description: "The suite's name, branding and login switches: which providers its users may sign in with, and whether a stranger may sign themselves up."
canonical: "https://grid82.com/docs/builder-api/suites/get"
updated: "2026-11-13"
---

# Read a suite

`GET https://studio.grid82.app/v1/suites/{suiteId}`

The suite's name, branding and login switches: which providers its users may sign in with, and whether a stranger may sign themselves up.

Requires the `account:read` scope. Operation `suites.get`. MCP tool `suites_get`. CLI: `grid82 suites get` (`npx grid82`).

## Path parameters

| Name      | Type   | Required | Description |
| --------- | ------ | -------- | ----------- |
| `suiteId` | string | yes      |             |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.id` (`string`, required)
- `data.organizationId` (`string`, required)
- `data.name` (`string`, required, length: `1–120 chars`)
- `data.slug` (`string`, required, length: `2–40 chars`, pattern: `^[a-z0-9][a-z0-9-]*[a-z0-9]$`)
- `data.slugPrefix` (`string`)
- `data.authPassword` (`boolean`, required)
- `data.authGoogle` (`boolean`, required)
- `data.allowSelfSignup` (`boolean`, required)
- `data.accent` (`string | null`, required)
- `data.logoUrl` (`string | null`, required)
- `data.createdAt` (`string`, required)
- `data.assistantMonthlyCredits` (`integer | null`, required)
- `data.apps` (`integer`, required)
- `data.users` (`integer`, required)
- `data.assistantCreditsUsed` (`number`)
- `data.assistantCreditsLimit` (`number,null`)
- `data.assistantPresets` (`object[]`, required)
- `data.assistantPresets.label` (`string`, required, length: `1–24 chars`)
- `data.assistantPresets.model` (`string`, required, length: `1–120 chars`)
- `data.assistantPresets.reasoning` (`enum<string> | null`, required)
- `data.assistantPresetsEditable` (`boolean`)

```json
{
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "slugPrefix": "<string>",
    "authPassword": true,
    "authGoogle": true,
    "allowSelfSignup": true,
    "accent": "<string>",
    "logoUrl": "<string>",
    "createdAt": "<string>",
    "assistantMonthlyCredits": 123,
    "apps": 123,
    "users": 123,
    "assistantCreditsUsed": 123.45,
    "assistantCreditsLimit": null,
    "assistantPresets": [
      {
        "label": "<string>",
        "model": "<string>",
        "reasoning": "none"
      }
    ],
    "assistantPresetsEditable": true
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

```json
{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}
```

**Example request**

```bash
curl --request GET \
  --url 'https://studio.grid82.app/v1/suites/<suiteId>' \
  --header 'Authorization: Bearer <token>'
```