Skip to content

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": "2023-01-15T09:00:00Z",
"last_updated": "2024-05-10T11:00:00Z",
"last_login_at": "2024-05-20T10:30:00Z",
"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

The GET endpoint retrieves detailed profile information of an organization member including their personal details roles permissions and optional related data like stats assets or groups based on the provided user ID.

Groups > List groups

The GET endpoint allows retrieving organization-specific groups with their details such as IDs names descriptions logos member lists and timestamps through authenticated API requests using various programming languages.

Guests > List guests

The GET endpoint retrieves guest users from an organization with their details like email access history location information and optional statistics using various programming languages through authenticated API requests.

Code Samples > Managing members (Users)

The API enables organizations to manage their registered users through functionalities like inviting listing updating and removing members along with their roles and profiles.