Clockify_Find_all_users_on_workspace.ipynb

Kernel: Python 3

Clockify - Find all users on workspace

Give Feedback | Bug report

Tags: #clockify #workspace #users #find #api #python

Author: Florent Ravenel

Last update: 2023-05-16 (Created: 2023-05-16)

Description: This notebook will show how to find all users on a workspace using Clockify API. It will return a dataframe with columns as follow:

• id: This column stores an identifier or unique identifier associated with a user. It likely contains alphanumeric values that uniquely identify each user in the DataFrame.

• email: This column stores the email addresses associated with the users in the DataFrame. It likely contains text values representing the email addresses of the users.

• name: This column stores the names or titles associated with the users in the DataFrame. It likely contains text values representing the names of the users.

• memberships: This column represents the memberships or group affiliations of the users. It likely contains a list or nested data structure that indicates the groups or memberships the users belong to.

• profilePicture: This column stores the URLs or paths to the profile pictures of the users. It likely contains text values representing the image URLs or file paths.

• activeWorkspace: This column represents the identifier or unique identifier of the active workspace for each user. It likely contains alphanumeric values that uniquely identify the active workspace.

• defaultWorkspace: This column stores the identifier or unique identifier of the default workspace for each user. It likely contains alphanumeric values that uniquely identify the default workspace.

• settings: This column stores user-specific settings or configurations. It likely contains nested data structures or dictionaries that hold various settings related to the user, such as the week start day and timezone.

• status: This column indicates the status of the users, whether they are active or inactive. It likely contains text values such as "ACTIVE" or "INACTIVE".

• customFields: This column stores custom fields or additional information specific to each user. It may contain nested data structures or lists that hold user-specific custom field values.

References:

• Clockify API Documentation

Input

Import libraries

import requests
import naas
import pandas as pd

Setup Variables

• api_key: Get your API key

• workspace_id: ID of the workspace

api_key = naas.secret.get("CLOCKIFY_API_KEY") or "YOUR_API_KEY"
workspace_id = "626f9e3b36c2670314c0386e" #"<WORKSPACE_ID>"

Model

Get all users from workspace

This function will get all users from a workspace using Clockify API.

def get_users_from_workspace(workspace_id, api_key):
    url = f"https://api.clockify.me/api/v1/workspaces/{workspace_id}/users"
    headers = {"X-Api-Key": api_key}
    response = requests.get(url, headers=headers)
    return response.json()

users = get_users_from_workspace(workspace_id, api_key)

Output

Display result

print("Users found:", len(users), "\n")
for user in users:
    print("-", user["name"], f'(id: {user["id"]})')
    
df = pd.DataFrame(users)
df