Skip to content

Get member

Endpoint

GET /organizations/{org_id}/users/{user_id}

This endpoint retrieves the profile information for a specific member (user) within the organization, identified by their unique user ID.

Request

Replace {org_id} with your Organization ID and {user_id} with the numeric ID of the member you want to retrieve.

Headers

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

Query parameters (optional)

  • with (string): Include additional related data. Common options might be stats, assets, groups (check Swagger for specifics).

Code samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const userId = 12345; // ID of the member to retrieve
const queryParams = '?with=groups'; // Example: get groups the member belongs to
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/users/${userId}${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 get member ${userId}:`, data);
throw new Error(`HTTP error! status: ${response.status}`);
}
return data; // Pass successful data along
});
})
.then(data => {
console.log(`Successfully retrieved member ${userId}:`);
console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
console.error(`Error getting member ${userId}:`, error.message);
});

Response

A successful request returns a 200 OK status code and a JSON object containing a data field. The value of data is an object representing the requested member’s profile.

{
"data": {
"id": 12345,
"email": "specific.user@example.com",
"username": "specificuser",
"first_name": "Specific",
"last_name": "User",
"full_name": "Specific User",
"profile_pic": "https://.../avatar.png",
"active": true,
"status": "active",
"user_role": "Standard",
"timezone": "America/Los_Angeles",
"created_at": "2023-02-01T12:00:00Z",
// ... other standard user properties ...
// Included if requested with 'with=stats':
"stats": {
"active_tasks": 15,
"completed_tasks": 120,
// ... other stats ...
},
// Included if requested with 'with=groups':
"groups": [
{ "id": "group_id_3", "name": "Project Alpha" }
]
}
}

If the user ID is not found or you lack permission, you will receive a 404 Not Found or 403 Forbidden error.


Members > List members

A comprehensive API endpoint documentation for retrieving organization members through various programming languages including authentication headers optional query parameters and response structure with sample code snippets.

Groups > Get group

The GET endpoint allows retrieving detailed information about a specific group within an organization using its unique ID through authenticated API requests with code examples in multiple programming languages.

Tags > Get tag

The GET endpoint enables retrieval of specific tag details through unique IDs with optional related data inclusion and returns a JSON response containing tag information along with error handling for invalid requests or permissions.

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.