Get Assigned Routes
Contents
Mobile_API »Get Assigned Routes
Base URL
https://apimobile.callproof.com
Endpoint
/api/get-assign-routes
Purpose
Retrieves routes assigned to users in the same market as the authenticated user, excluding routes the authenticated user owns. Useful for seeing routes assigned by others that are relevant to the user’s market.
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/get-assign-routes' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/get-assign-routes' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns assigned routes for the user’s market.
| 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 | Assigned 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 | integer/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 timestamp (format: Y-m-d H:i:s), or empty string when unavailable
|
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – assigned 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.
