Difference between revisions of "Glass America Users"
Ashley DeBon (talk | contribs) (→Get Glass America Users) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 38: | Line 38: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/glass-america/users' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Phpsessid: YOUR_OMEGA_SESSION_ID' \ --header 'Cookie1: YOUR_OMEGA_COOKIE_VALUE' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/glass-america/users' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Phpsessid: YOUR_OMEGA_SESSION_ID' \ --header 'Cookie1: YOUR_OMEGA_COOKIE_VALUE' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 14:05, 21 July 2026
Mobile_API »Get Glass America Users
Base URL
https://apimobile.callproof.com
Endpoint
/api/glass-america/users
Purpose
Retrieves Glass America (Omega) users available to the authenticated CallProof user’s company, returning each user’s ID and display name for dashboard use.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
| Phpsessid | Yes | Omega dashboard session ID used to call the external users API |
| Cookie1 | Yes | Omega dashboard cookie value used with the session ID |
Security
- Yes – Requires Bearer Token authentication.
- Also requires a valid Omega dashboard session (
PhpsessidandCookie1) obtained from the Glass America dashboard login flow.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/glass-america/users' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Phpsessid: YOUR_OMEGA_SESSION_ID' \ --header 'Cookie1: YOUR_OMEGA_COOKIE_VALUE'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/glass-america/users' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Phpsessid: YOUR_OMEGA_SESSION_ID' \ --header 'Cookie1: YOUR_OMEGA_COOKIE_VALUE'
Successful Response (200)
Returns the list of Glass America users.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| user_id | integer | Identifier of the authenticated CallProof user |
| company_id | integer | Identifier of the authenticated user’s company |
| data | object | Users payload |
| uri | string | Requested resource URI |
data.user_details[]
| Field | Type | Description |
|---|---|---|
| id | integer/string | Unique identifier of the Glass America user |
| name | string | Full display name (first name + last name) |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – users could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – Omega session invalid/expired, upstream error message returned from Omega, or another retrieval failure.
- 401 – Authentication failed or the access token is missing/expired.
