---
title: "List invite links"
description: "List every invite link across the suite's apps, including its app, granted roles, use count, and whether it is still live."
canonical: "https://grid82.com/docs/builder-api/invites/list"
updated: "2026-11-13"
---

# List invite links

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

List every invite link across the suite's apps, including its app, granted roles, use count, and whether it is still live.

The URL is never returned after creation.

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

## Path parameters

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

## Query parameters

| Name     | Type    | Required | Description           |
| -------- | ------- | -------- | --------------------- |
| `limit`  | integer | no       | Default `50`.         |
| `cursor` | string  | no       | Up to 512 characters. |

**Authorizations**

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

## Response

**200**: Success

- `data` (`object[]`, required)
- `data.id` (`string`, required)
- `data.appId` (`string`, required)
- `data.roles` (`string[]`, required)
- `data.label` (`string,null`, required)
- `data.createdAt` (`string`, required)
- `data.expiresAt` (`string`, required)
- `data.maxUses` (`number,null`, required)
- `data.uses` (`number`, required)
- `data.status` (`enum<string>`, required, one of: `live, expired, exhausted, revoked`)
- `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": [
    {
      "id": "<string>",
      "appId": "<string>",
      "roles": [
        "<string>"
      ],
      "label": null,
      "createdAt": "<string>",
      "expiresAt": "<string>",
      "maxUses": null,
      "uses": 123.45,
      "status": "live"
    }
  ],
  "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/suites/<suiteId>/invites' \
  --header 'Authorization: Bearer <token>'
```