Ashley DeBon: Created page with "== GlassUSA Dashboard Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/v1/glassusa-dashboard-details === Purpose === Returns the informatio..."

2026-07-15T12:37:07Z

Created page with "== GlassUSA Dashboard Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/v1/glassusa-dashboard-details === Purpose === Returns the informatio..."

New page

== GlassUSA Dashboard Details ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/v1/glassusa-dashboard-details

=== Purpose ===
Returns the information required to direct the authenticated user to the GlassUSA reporting dashboard.

The response supplies the user's CallProof email address as the external account identifier and provides the GlassUSA dashboard destination URL.

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token.
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.
* The access token must be active and unexpired.
* The authenticated user and associated company account must be active.
* If two-factor authentication is enabled, verification must be completed for the registered device.

=== Parameters ===
This endpoint does not accept path, query, or request body parameters.

=== Successful Response (200) ===
Returns the authenticated user's external account identifier and the GlassUSA reporting dashboard URL.

==== Top-Level Response Fields ====
{| class="wikitable"
! Response Field !! Type !! Description
|-
| clientStatusCode || integer || Business-level response status. A successful request returns <code>200</code>.
|-
| user_id || integer || The authenticated user's unique identifier.
|-
| company_id || integer || The company associated with the authenticated user.
|-
| message || object || Contains the GlassUSA dashboard access details.
|-
| uri || string || The URL of the API request.
|}

==== GlassUSA Access Fields ====
{| class="wikitable"
! Response Field !! Type !! Description
|-
| message.account_id || string || The authenticated user's CallProof email address, used as the external account identifier. An empty string is returned if no email is available.
|-
| message.glass_usa_redirection_uri || string || The GlassUSA reporting dashboard destination URL. The current value is <code>https://stats.omegaedi.com/</code>.
|}

=== Error Responses ===
The endpoint does not define business-specific error responses in Swagger.

{| class="wikitable"
! 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.
|}

==== Error Response Fields ====
{| class="wikitable"
! 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 API request.
|}

==== Common Error Codes ====
{| class="wikitable"
! 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.
|}

GlassUSA Dashboard Details - Revision history

Ashley DeBon: Created page with "== GlassUSA Dashboard Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/v1/glassusa-dashboard-details === Purpose === Returns the informatio..."