import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/home-summary/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/home-summary/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/home-summary/ \
--header 'Authorization: Bearer <token>'{
"is_admin": true,
"doc_count": 123,
"artifact_count": 123,
"member_count": 123,
"my_interviews": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "pending",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"self_started": true
}
],
"team_pending_interviews": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "pending",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"self_started": true,
"assigned_to_email": "<string>",
"assigned_to_invite_email": "<string>",
"invite_config": {
"custom_message": "<string>",
"scheduled_send_at": "2023-11-07T05:31:56Z",
"invitation_email_sent_at": "2023-11-07T05:31:56Z",
"reminders_enabled": true,
"reminder_start_after_days": 123,
"reminder_interval_days": 123,
"reminder_max_count": 123,
"reminders_sent": 123,
"next_reminder_at": "2023-11-07T05:31:56Z",
"reminders_stopped": true
}
}
],
"feedbacks_to_review": 123,
"pending_invite_count": 123,
"team_interview_count": 123,
"signal_count": 123
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Home dashboard summary
Everything the Standard-interface Home dashboard needs in one call: document count and last-added timestamp, plus the caller’s open (pending or in-progress) interviews. For project admins the response additionally includes the team’s pending interviews and the count of feedbacks awaiting review; these fields are omitted entirely for non-admin members. Available to all project members.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/home-summary/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/home-summary/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/home-summary/ \
--header 'Authorization: Bearer <token>'{
"is_admin": true,
"doc_count": 123,
"artifact_count": 123,
"member_count": 123,
"my_interviews": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "pending",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"self_started": true
}
],
"team_pending_interviews": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "pending",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"self_started": true,
"assigned_to_email": "<string>",
"assigned_to_invite_email": "<string>",
"invite_config": {
"custom_message": "<string>",
"scheduled_send_at": "2023-11-07T05:31:56Z",
"invitation_email_sent_at": "2023-11-07T05:31:56Z",
"reminders_enabled": true,
"reminder_start_after_days": 123,
"reminder_interval_days": 123,
"reminder_max_count": 123,
"reminders_sent": 123,
"next_reminder_at": "2023-11-07T05:31:56Z",
"reminders_stopped": true
}
}
],
"feedbacks_to_review": 123,
"pending_invite_count": 123,
"team_interview_count": 123,
"signal_count": 123
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Authorizations
Use Authorization: Bearer
Path Parameters
UUID of the project
Response
Successful response
Whether the caller has admin permissions on the project.
Number of active documents in the project.
Total filled knowledge artifacts: every playbook and design template, plus one for each non-empty singleton artifact (brief, general knowledge, library description, mental map).
Number of registered project members (pending invitees excluded).
Every interview the caller still has to finish, oldest first: interviews assigned to them plus interview-type conversations they created without an assignee (self-run open interviews and the onboarding interview). Excludes completed interviews and plain conversations.
Show child attributes
Show child attributes
Admin only. Pending interviews assigned to other members or pending invitees, oldest first. Omitted for non-admins.
Show child attributes
Show child attributes
Admin only. Count of feedbacks with status to_review. Omitted for non-admins.
Admin only. Count of pending (not yet accepted or cancelled) invites to
the project. Drives the Home "invite your team" prompt; accepted invites
are already reflected in member_count. Omitted for non-admins.
Admin only. Interviews ever assigned to someone other than the caller (a member or a pending invitee), any status, excluding onboarding. Zero means the caller has never assigned an interview to their team — Home shows an "assign interviews" prompt. Omitted for non-admins.
Admin only. Count of feedbacks ever recorded for the project, any
status (feedbacks_to_review only counts open ones). Zero means no
signal has ever existed — Home shows a "put your knowledge to work"
prompt. Omitted for non-admins.