Skip to content
Tallyfy

List guests

Endpoint

GET /organizations/{org_id}/guests

This endpoint retrieves a list of guest users associated with the specified Tallyfy 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 = ''; // Example: Add query params like '?with=stats&page=2'
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 => {
    return response.json().then(data => { // Attempt to parse JSON regardless of status
        if (!response.ok) {
            console.error("Failed to list guests:", data);
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return data; // Pass successful data along
    });
})
.then(data => {
    console.log('Successfully listed guests:');
    console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
    console.error('Error listing guests:', error.message);
});

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 Tallyfy organization.

{
  "data": [
    {
      "id": "guest_code_abc123", // Unique guest code/identifier
      "email": "guest.user@external.com",
      "last_accessed_at": "2025-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
}

Guests > Get guest

This endpoint retrieves specific guest user details from a Tallyfy organization by making a GET request with the guest’s URL-encoded email address and optional query parameters for including related data like statistics.

Members > List members

This endpoint enables retrieval of all registered members within a Tallyfy organization by making a GET request with optional query parameters for including related group data and pagination controls.

Tags > List tags

This endpoint retrieves all tags within an organization by making a GET request with optional query parameters for searching filtering and pagination while returning tag details like ID title color usage counts and creation timestamps in a JSON response.

Groups > List groups

This documentation explains how to retrieve a list of groups within a Tallyfy organization using a GET API endpoint with code examples provided in JavaScript Python Java Go C++ and C# that demonstrate the request structure including required authorization headers and optional query parameters for including additional data like group logos.
Get in touch
About Tallyfy