Skip to main content
API Reference
Cards
Groups

Groups represent organizations using Increase. You can retrieve information about your own organization via the API. More commonly, OAuth platforms can retrieve information about the organizations that have granted them access. Learn more about OAuth here.

The Group object
{
  "created_at": "2020-01-31T23:59:59Z",
  "id": "group_1g4mhziu6kvrs3vz35um",
  "type": "group"
}
Attributes
created_at
string

The ISO 8601 time at which the Group was created.

id
string

The Group identifier.

type
string

A constant representing the object’s type. For this resource it will always be group.

Retrieve Group details

Returns details for the currently authenticated Group.

curl \
  --url "${INCREASE_URL}/groups/current" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const group = await client.groups.retrieve();

console.log(group.id);
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
group = client.groups.retrieve()
print(group.id)
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

group = increase.groups.retrieve

puts(group)
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	group, err := client.Groups.Get(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", group.ID)
}
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.groups.Group;
import com.increase.api.models.groups.GroupRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        Group group = client.groups().retrieve();
    }
}
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.groups.Group
import com.increase.api.models.groups.GroupRetrieveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val group: Group = client.groups().retrieve()
}
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $group = $client->groups->retrieve();

  var_dump($group);
} catch (APIException $e) {
  echo $e->getMessage();
}
using System;
using Increase.Api;
using Increase.Api.Models.Groups;

IncreaseClient client = new();

GroupRetrieveParams parameters = new();

var group = await client.Groups.Retrieve(parameters);

Console.WriteLine(group);