import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-campaigns/{campaign_id}/"
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}/interview-campaigns/{campaign_id}/', 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}/interview-campaigns/{campaign_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"interview_count": 123,
"completed_count": 123,
"in_progress_count": 123,
"pending_count": 123,
"latest_activity": "2023-11-07T05:31:56Z",
"assignees": [
"[email protected]"
],
"assignee_count": 123
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Retrieve an interview campaign
Retrieve one campaign with its progress aggregates. Admin only.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-campaigns/{campaign_id}/"
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}/interview-campaigns/{campaign_id}/', 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}/interview-campaigns/{campaign_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"interview_count": 123,
"completed_count": 123,
"in_progress_count": 123,
"pending_count": 123,
"latest_activity": "2023-11-07T05:31:56Z",
"assignees": [
"[email protected]"
],
"assignee_count": 123
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Path Parameters
Response
Successful response
A named group of interviews (a "wave"), with the progress aggregates the interviews page renders. Counts cover every interview in the campaign.
Most recent update across the campaign's interviews, falling back to the campaign's own creation date when it has none. Interview timestamps also move on background writes (summaries, turn state), so treat this as approximate activity rather than message recency.