---
title: "A suite's directory"
description: "Check existing suite accounts before inviting a user again."
canonical: "https://grid82.com/docs/builder-api/users/list"
updated: "2026-11-13"
---

# A suite's directory

`GET https://studio.grid82.app/v1/users`

Check existing suite accounts before inviting a user again.

List users and their app memberships; each has one suite account and can belong to multiple apps. `apps` includes those apps and the user's roles in each.

Requires the `members:read` scope. Operation `users.list`. MCP tool `users_list`. CLI: `grid82 users list` (`npx grid82`).

## Query parameters

| Name      | Type    | Required | Description           |
| --------- | ------- | -------- | --------------------- |
| `limit`   | integer | no       | Default `50`.         |
| `cursor`  | string  | no       | Up to 512 characters. |
| `suiteId` | string  | yes      | Up to 64 characters.  |
| `search`  | string  | no       | Up to 200 characters. |

**Authorizations**

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

## Response

**200**: Success

- `data` (`object[]`, required)
- `data.userId` (`string`, required)
- `data.email` (`string`, required)
- `data.name` (`string,null`, required)
- `data.status` (`string`, required)
- `data.kind` (`enum<string>`, required, one of: `builder, member`)
- `data.apps` (`object[]`, required)
- `data.apps.id` (`string`, required)
- `data.apps.name` (`string`, required)
- `data.apps.roles` (`string[]`, required)
- `meta` (`object`, required)
- `meta.nextCursor` (`string,null`, required): Pass as `cursor` for the next page. Null on the last one.
- `meta.hasMore` (`boolean`, required)
- `meta.fields` (`Record<string, string>`): Field id to field name, for the table the records came from.

```json
{
  "data": [
    {
      "userId": "<string>",
      "email": "<string>",
      "name": null,
      "status": "<string>",
      "kind": "builder",
      "apps": [
        {
          "id": "<string>",
          "name": "<string>",
          "roles": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "meta": {
    "nextCursor": null,
    "hasMore": true,
    "fields": {}
  }
}
```

**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/users?suiteId=<suiteId>' \
  --header 'Authorization: Bearer <token>'
```