Team Member Details
Contents
Team Member Activity Details
Base URL
https://apimobile.callproof.com
Endpoint
/api/v1/team-member-details
Purpose
Returns an activity summary for a selected team member over a requested reporting period.
The summary includes calls, appointments, emails, webinars, general events, follow-ups, submitted event forms, and the probability-adjusted value of sales opportunities.
All date calculations use the selected team member's configured time zone.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token. |
| Content-Type | Yes | application/x-www-form-urlencoded or application/json.
|
Security
- Yes – Requires Bearer Token authentication.
- The access token must be active and unexpired.
- The authenticated user and company account must be active.
- If two-factor authentication is enabled, verification must be completed for the registered device.
Parameters
Request Body Fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | integer | Yes | The unique identifier of the team member whose activity should be summarized. |
| type | integer | Yes | Selects the reporting period. Accepted values are 1, 2, 3, and 4.
|
| from_date | string | Conditional | Beginning of the custom reporting period. Required when type is 4.
|
| to_date | string | Conditional | End of the custom reporting period. Required when type is 4.
|
Reporting Period Values
| Value | Reporting Period |
|---|---|
| 1 | Today, from the beginning through the end of the current day. |
| 2 | The previous calendar week. |
| 3 | The period beginning one month before the current date and ending today. |
| 4 | A custom period defined by from_date and to_date.
|
The required date format for from_date and to_date is Not specified in Swagger. A standard date value such as YYYY-MM-DD should be used.
Successful Response (200)
Returns activity totals for the selected team member and reporting period.
The top-level user_id and company_id identify the authenticated requester and their company. The activity under data.events belongs to the team member selected through the request's user_id parameter.
Top-Level Response Fields
| Response Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Business-level response status. A successful request returns 200.
|
| user_id | integer | The authenticated requester's unique identifier. |
| company_id | integer | The authenticated requester's company identifier. |
| data | object | Contains the selected team member's activity summary. |
| uri | string | The URL of the request. |
Activity Summary Fields
| Response Field | Type | Description |
|---|---|---|
| data.events.call_count | integer | Total calls recorded during the selected period. |
| data.events.appointment_count | integer | Total appointments during the selected period. |
| data.events.email_count | integer | Total email activity during the selected period. |
| data.events.webinar_count | integer | Total webinar activity during the selected period. |
| data.events.event_count | integer | Total general activity events during the selected period. |
| data.events.followup_count | integer | Total follow-up activities during the selected period. |
| data.events.event_form_count | integer | Total event forms submitted during the selected period. |
| data.events.opportunity_derived_value | string | Total probability-adjusted opportunity value, formatted to two decimal places. |
The probability-adjusted opportunity value represents the sum of each opportunity's value multiplied by its probability percentage.
Error Responses
| HTTP Status Code | Client Status Code | Meaning |
|---|---|---|
| 200 | 401 | Two-factor authentication is required but has not been completed for the registered device. |
| 401 | 401 | The Bearer token is missing or invalid. |
| 401 | 401 | The access token has expired. |
| 401 | 401 | The authenticated user or company account is disabled. |
| 401 | 401 | A required client application update must be installed. |
| 200 | 200 | Activity totals could not be retrieved; failure information may be returned within data.events.
|
Structured validation errors for a missing or unsupported type, missing user_id, or incomplete custom date range are Not specified in Swagger.
Activity Retrieval Failure Fields
When activity totals cannot be calculated, data.events may contain:
| Response Field | Type | Description |
|---|---|---|
| status | boolean | Returns false when the activity summary could not be prepared.
|
| message | string | Explanation that event counts could not be retrieved. |
| response | string | Empty response value. |
Standard Error Response Fields
| Response Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | The business-level error status. |
| error.code | integer | The business error code. |
| error.message | string | A plain-language explanation of the request failure. |
| uri | string | The URL of the request. |
Common Error Codes
| Error Code | Meaning |
|---|---|
| 1500 | Authentication, authorization, or two-factor verification failed. |
| 1800 | The user or company account is disabled. |
| 8000 | The access token has expired. |
| 9000 | A required client application update is available. |