Skip to content
Tallyfy

List members

Endpoint

GET /organizations/{org_id}/users

This endpoint returns a paginated list of members (users) in your Tallyfy organization.

Request

Replace {org_id} with your actual Organization ID.

Headers

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

Query parameters (optional)

  • with (string): Comma-separated list of related data to include. Supported values include groups, stats, organizations, preferences, assets, member_watchers, guest_watchers, auth_methods, country.
  • q (string): Search query to filter members by first name, last name, or email.
  • sort (string): Field to sort by. Prefix with - for descending order (e.g., -created_at).
  • per_page (integer): Number of results per page. Defaults to 9999 if not specified.
  • page (integer): Page number for paginated results.

Code samples

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


const queryParams = '?with=groups&per_page=50&page=1';
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 => {
        if (!response.ok) {
            console.error("Failed to list members:", data);
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return data;
    });
})
.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 with a data array of member objects, plus a meta object containing pagination details.

{
  "data": [
    {
      "id": 1001,
      "email": "alice@example.com",
      "username": "alice",
      "first_name": "Alice",
      "last_name": "Smith",
      "full_name": "Alice Smith",
      "profile_pic": "https://.../profile.jpg",
      "country_id": 1,
      "is_active": true,
      "last_login_at": "2025-01-15T10:30:00+00:00",
      "activated_at": "2024-06-01T08:00:00+00:00",
      "type": "standard",
      "created_at": "2024-06-01T08:00:00+00:00",
      "updated_at": "2025-01-15T10:30:00+00:00",
      "phone": "+1234567890",
      "job_title": "Project Manager",
      "timezone": "America/New_York",
      "UTC_offset": "-05:00",
      "role": "Admin",
      "status": "active",
      "date_format": "MM/DD/YYYY",
      "is_default_admin": false,
      "groups": {
        "data": [
          { "id": "group_id_1", "name": "Sales Team", "logo": null, "members": [1001, 1002], "guests": [] }
        ]
      }
    },
    {
      "id": 1002,
      "email": "bob@example.com",
      "first_name": "Bob",
      "last_name": "Jones",
      "status": "active",
      "role": "Standard"
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Groups > List groups

Retrieve a paginated list of groups in your Tallyfy organization using the GET endpoint with optional search, sorting, and related data includes.

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#.

Guests > List guests

Retrieve all guest users for a Tallyfy organization with optional search, sorting, and pagination.

Tags > List tags

Retrieve all tags for an organization with optional search, filtering, sorting, and pagination. Returns tag details including title, color, and usage statistics.
Get in touch
About Tallyfy