List guests

Endpoint

GET /organizations/{org_id}/guests

This endpoint retrieves a list of guest users associated with 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., stats.
Pagination parameters (page, per_page) may also be available.

Code Samples

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

const queryParams = ''; // e.g., '?with=stats'
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/guests${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 guests:');
    console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
    console.error('Error listing guests:', error);
});

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://go.tallyfy.com/api/organizations/{org_id}/guests'

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

params = {
    # 'with': 'stats'
    # 'page': 1,
    # 'per_page': 50
}

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

    guests_data = response.json()
    print('Successfully listed guests:')
    print(json.dumps(guests_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")

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 ListGuests {
    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://go.tallyfy.com/api/organizations/" + orgId + "/guests";

        Map<String, String> queryParamsMap = Map.of(); // Add params if needed
        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 guests:");
                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());
        }
    }
}

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://go.tallyfy.com/api/organizations/%s/guests", orgId)

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

    apiUrl := baseURL
    if len(queryParams) > 0 {
        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 guests:")
  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 guest associated with the organization.

{
  "data": [
    {
      "id": "guest_code_abc123", // Unique guest code/identifier
      "email": "guest.user@external.com",
      "last_accessed_at": "2024-05-15T10:00:00Z",
      "last_known_ip": "192.0.2.1",
      "last_known_country": "US",
      "details": {
        "first_name": "External",
        "last_name": "Collaborator",
        "status": "active", // Can be active, disabled
        "phone_1": null,
        "company_name": "External Inc.",
        "timezone": "UTC",
        "disabled_on": null,
        "disabled_by": null,
        // ... other detail fields ...
      },
       // Included if requested with 'with=stats'
      "stats": {
          "active_tasks": 2,
          "completed_tasks": 5
          // ... other stats ...
      }
    },
    {
       "id": "guest_code_def456",
       "email": "another.guest@domain.com",
       // ... details ...
    }
  ]
  // Potential meta object for pagination if supported
}