My Routes
Contents
Mobile_API »Get My Routes
Base URL
https://apimobile.callproof.com
Endpoint
/api/my-routes
Purpose
Retrieves the routes owned by the authenticated user for their company, including who assigned each route and which reps are associated with it. Results are ordered by route name.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/my-routes' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/my-routes' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the authenticated user’s routes.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| user_id | integer | Identifier of the authenticated user |
| company_id | integer | Identifier of the authenticated user’s company |
| data | object | Routes payload |
| uri | string | Requested resource URI |
data.route_details[]
| Field | Type | Description |
|---|---|---|
| route_id | integer | Unique identifier of the route |
| route_name | string | Route name |
| route_assigned_by_id | string | User ID of the person who assigned the route (empty string when not set) |
| route_assigned_by_name | string | Full name of the person who assigned the route |
| created | string | Created date/time in the user’s timezone (format: Y-m-d g:i A)
|
| route_assigned_reps | array | List of assigned reps; each item includes id (user ID)
|
data.route_details[].route_assigned_reps[]
| Field | Type | Description |
|---|---|---|
| id | integer | User ID of an assigned rep |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – routes could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while retrieving routes (for example, "Error while retriving the routes").
- 401 – Authentication failed or the access token is missing/expired.
