List invite links

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

GET/v1/suites/{suiteId}/invites

Request

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

import json
import requests

url = "https://studio.grid82.app/v1/suites/<suiteId>/invites"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/suites/<suiteId>/invites", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/suites/<suiteId>/invites");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://studio.grid82.app/v1/suites/<suiteId>/invites", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/suites/<suiteId>/invites"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/suites/<suiteId>/invites")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/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": {}
  }
}

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

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.

Response

application/json

Success

dataobject[]required

Show child attributes

data.idstringrequired

data.appIdstringrequired

data.rolesstring[]required

data.labelstringnullrequired

data.createdAtstringrequired

data.expiresAtstringrequired

data.maxUsesnumbernullrequired

data.usesnumberrequired

data.statusenum<string>requiredone of: live, expired, exhausted, revoked

metaobjectrequired

Show child attributes

meta.nextCursorstringnullrequired

Pass as cursor for the next page. Null on the last one.

meta.hasMorebooleanrequired

meta.fieldsRecord<string, string>

Field id to field name, for the table the records came from.

{ "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": {} } }

List invite links

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown