List groups

Endpoint

GET /organizations/{org_id}/groups

This endpoint retrieves a list of groups defined within the specified organization.

Request

Replace {org_id} with your Organization ID.

Headers

• Authorization: Bearer {your_access_token}
• Accept: application/json
• X-Tallyfy-Client: APIClient

Query Parameters (Optional)

• with (string): Include additional data, e.g., assets (for group logo).
• Pagination parameters might be available.

Code Samples

JavaScript (fetch)

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';

const queryParams = '?with=assets'; // Example
const apiUrl = `https://api.tallyfy.com/organizations/${orgId}/groups${queryParams}`;

const headers = new Headers();
headers.append('Authorization', `Bearer ${accessToken}`);
headers.append('Accept', 'application/json');
headers.append('X-Tallyfy-Client', 'APIClient');

fetch(apiUrl, {
    method: 'GET',
    headers: headers
})
.then(response => {
    if (!response.ok) {
        // Error handling...
        return response.json().then(errData => { throw new Error(/*...*/); }).catch(() => { throw new Error(/*...*/); });
    }
    return response.json();
})
.then(data => {
    console.log('Successfully listed groups:');
    console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
    console.error('Error listing groups:', error);
});

Python (requests)

import requests
import json
import os

access_token = os.environ.get('TALLYFY_ACCESS_TOKEN', 'YOUR_PERSONAL_ACCESS_TOKEN')
org_id = os.environ.get('TALLYFY_ORG_ID', 'YOUR_ORGANIZATION_ID')
api_url = f'https://api.tallyfy.com/organizations/{org_id}/groups'

headers = {
    'Authorization': f'Bearer {access_token}',
    'Accept': 'application/json',
    'X-Tallyfy-Client': 'APIClient'
}

params = {
    'with': 'assets' # Example
}

try:
    response = requests.get(api_url, headers=headers, params=params)
    response.raise_for_status()

    groups_data = response.json()
    print('Successfully listed groups:')
    print(json.dumps(groups_data, indent=4))

except requests.exceptions.RequestException as e:
    # Error handling...
    print(f"Request failed: {e}")
except json.JSONDecodeError:
    print("Failed to decode JSON response")

Java (HttpClient)

import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.stream.Collectors;

public class ListGroups {
    public static void main(String[] args) {
        String accessToken = System.getenv().getOrDefault("TALLYFY_ACCESS_TOKEN", "YOUR_PERSONAL_ACCESS_TOKEN");
        String orgId = System.getenv().getOrDefault("TALLYFY_ORG_ID", "YOUR_ORGANIZATION_ID");
        String baseUrl = "https://api.tallyfy.com/organizations/" + orgId + "/groups";

        Map<String, String> queryParamsMap = Map.of("with", "assets"); // Example
        String queryParams = queryParamsMap.entrySet().stream()
            .map(entry -> URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8) + "=" + URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8))
            .collect(Collectors.joining("&", "?", ""));

        String apiUrl = baseUrl + (queryParamsMap.isEmpty() ? "" : queryParams);

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(apiUrl))
                .header("Authorization", "Bearer " + accessToken)
                .header("Accept", "application/json")
                .header("X-Tallyfy-Client", "APIClient")
                .GET()
                .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            if (response.statusCode() == 200) {
                System.out.println("Successfully listed groups:");
                System.out.println(response.body());
                // TODO: Parse JSON
            } else {
                // Error handling...
                 System.err.println("Failed. Status: " + response.statusCode());
            }
        } catch (IOException | InterruptedException e) {
             // Error handling...
             System.err.println("Request failed: " + e.getMessage());
        }
    }
}

Go (net/http)

package main

import (
  "fmt"
  "io/ioutil"
  "net/http"
  "net/url"
  "os"
)

func main() {
  accessToken := os.Getenv("TALLYFY_ACCESS_TOKEN")
  orgId := os.Getenv("TALLYFY_ORG_ID")
    baseURL := fmt.Sprintf("https://api.tallyfy.com/organizations/%s/groups", orgId)

    queryParams := url.Values{}
    queryParams.Add("with", "assets") // Example

    apiUrl := baseURL + "?" + queryParams.Encode()

  client := &http.Client{}
  req, err := http.NewRequest("GET", apiUrl, nil)
    // Error handling...

  req.Header.Set("Authorization", "Bearer "+accessToken)
  req.Header.Set("Accept", "application/json")
  req.Header.Set("X-Tallyfy-Client", "APIClient")

  resp, err := client.Do(req)
    // Error handling...
  defer resp.Body.Close()

  body, err := ioutil.ReadAll(resp.Body)
    // Error handling...

  if resp.StatusCode != http.StatusOK {
        // Error handling...
    fmt.Printf("Failed. Status: %d\nBody: %s\n", resp.StatusCode, string(body))
    return
  }

  fmt.Println("Successfully listed groups:")
  fmt.Println(string(body))
  // TODO: Unmarshal JSON
}

Response

A successful request returns a 200 OK status code and a JSON object containing a data array. Each element represents a group.

{
  "data": [
    {
      "id": "group_id_abc123", // Unique group ID
      "name": "Sales Team",
      "description": "Handles all sales inquiries.",
      "logo": null, // Or URL if logo uploaded and requested with 'with=assets'
      "members": [1001, 1005], // Array of member user IDs
      "guests": ["client.a@example.com"], // Array of guest emails
      "created_at": "2023-03-10T09:00:00Z",
      "updated_at": "2024-04-20T10:00:00Z",
      "deleted_at": null
    },
    {
      "id": "group_id_def456",
      "name": "Support Tier 1",
      // ... other group details ...
    }
  ]
  // Potential meta object for pagination
}

---

Related articles

Groups > Create group

Create a new group.

Groups > Get group

Get details for a specific group.