Referrals

This organisation's referral code and what it has earned

The code a sign-up link carries, the referrals it brought (status and date, never who), and the credits promised for them.

GET/v1/organizations/{organizationId}/referrals

Request

curl --request GET \
  --url 'https://studio.gtable.app/v1/organizations/<organizationId>/referrals' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://studio.gtable.app/v1/organizations/<organizationId>/referrals"
headers = {
  "Authorization": "Bearer <token>"
}

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

const response = await fetch("https://studio.gtable.app/v1/organizations/<organizationId>/referrals", {
  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.gtable.app/v1/organizations/<organizationId>/referrals");
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.gtable.app/v1/organizations/<organizationId>/referrals", 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.gtable.app/v1/organizations/<organizationId>/referrals"))
    .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.gtable.app/v1/organizations/<organizationId>/referrals")
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": {
    "code": "<string>",
    "link": "<string>",
    "signupsOpen": true,
    "referrals": [
      {
        "status": "pending",
        "createdAt": "<string>"
      }
    ],
    "rewards": {
      "pendingCredits": 123.45,
      "earnedCredits": 123.45,
      "perReferral": {
        "referrer": 123.45,
        "referred": 123.45
      }
    }
  }
}

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

Rewards stay pending until billing is live, and while sign-ups are closed a code cannot bring anybody in. Admins, and builders on every suite.

Requires the account:read scope. Operation referrals.get. MCP tool referrals_get. CLI, once published: gtable referrals get.

Path parameters

Name	Type	Required	Description
`organizationId`	string	yes

Response

application/json

Success

dataobjectrequired

Show child attributes

codestringrequired

linkstringrequired

signupsOpenbooleanrequired

referralsobject[]required

rewardsobjectrequired

{ "data": { "code": "<string>", "link": "<string>", "signupsOpen": true, "referrals": [ { "status": "pending", "createdAt": "<string>" } ], "rewards": { "pendingCredits": 123.45, "earnedCredits": 123.45, "perReferral": { "referrer": 123.45, "referred": 123.45 } } } }

This organisation's referral code and what it has earned

Path parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown