Clockify - Get project by ID

Give Feedback | Bug report

Tags: #clockify #project #create #api #rest #documentation

Author: Florent Ravenel

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

Description: This notebook will show how to get a project using Clockify API from a specific workspace.

References:

Clockify API Documentation

Input

Import libraries

In [ ]:

import requests
import naas

Setup Variables

api_key: Get your API key
workspace_id: ID of the workspace
project_id: ID of the project to get

In [ ]:

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

Model

Get project

In [ ]:

def get_project(api_key, workspace_id, project_id):
    url = f"https://api.clockify.me/api/workspaces/{workspace_id}/projects/{project_id}"
    headers = {
        "X-Api-Key": api_key,
        "Content-Type": "application/json"
    }
    response = requests.get(url, headers=headers)
    return response

Output

Display result

In [ ]:

response = get_project(api_key, workspace_id, project_id)
if response.status_code == 200:
    print(f"✅ Project '{project_id}' retrieved from workspace.")
else:
    print(f"❌ Error retrieving project")
response.json()