Skip to content
Tallyfy

List members

Endpoint

GET /organizations/{org_id}/users

This endpoint retrieves a list of registered members (users) within your 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 related data such as groups.
  • Pagination parameters (page, per_page) may also be available (check Swagger documentation).

Code samples

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


const queryParams = '?with=groups&page=1&per_page=50'; // Example: Include group info and paginate
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/users${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 members:", data);
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return data; // Pass successful data along
    });
})
.then(data => {
    console.log('Successfully listed members:');
    console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
    console.error('Error listing members:', error.message);
});

Response

A successful request returns a 200 OK status code and a JSON object containing a data array. Each element in the array represents a member user.

{
  "data": [
    {
      "id": 1001,
      "email": "alice@example.com",
      "username": "alice",
      "first_name": "Alice",
      "last_name": "Smith",
      "full_name": "Alice Smith",
      "profile_pic": "https://.../profile.jpg",
      "active": true,
      "is_suspended": false,
      "created_at": "...",
      "last_updated": "...",
      "last_login_at": "...",
      "status": "active",
      "user_role": "Admin", // Role within the current organization
       // Included if requested with 'with=groups':
      "groups": [
          { "id": "group_id_1", "name": "Sales Team" },
          { "id": "group_id_2", "name": "Support" }
      ]
      // ... other user properties ...
    },
    {
      "id": 1002,
      "email": "bob@example.com",
       // ... details for another member ...
    }
  ]
  // Potential meta object for pagination if supported
}

Members > Get member

This API endpoint retrieves detailed profile information for a specific organization member by their user ID and supports optional query parameters to include related data like statistics and group memberships with code examples provided in JavaScript Python Java Go C++ and C#.

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.

Guests > List guests

This API endpoint retrieves all guest users associated with a Tallyfy organization by making a GET request with proper authorization headers and optional query parameters for pagination and additional statistics data.

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.
Get in touch
About Tallyfy