Ashley DeBon: /* Successful Response (200) */

2026-07-20T09:14:04Z

‎Successful Response (200)

Ashley DeBon: /* Get All Routes */

2026-07-20T09:13:32Z

‎Get All Routes

Ashley DeBon: Created page with "== Get All Routes == === Base URL === https://apimobile.callproof.com === Endpoint === /api/all-routes === Purpose === Retrieves company routes from users in the same marke..."

2026-07-20T09:13:16Z

Created page with "== Get All Routes == === Base URL === https://apimobile.callproof.com === Endpoint === /api/all-routes === Purpose === Retrieves company routes from users in the same marke..."

New page

== Get All Routes ==

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

=== Endpoint ===
/api/all-routes

=== Purpose ===
Retrieves company routes from users in the same market as the authenticated user, excluding routes the authenticated user already owns. Each result includes assigner details and assigned reps. Results are ordered by route name.

=== HTTP Method ===
GET

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

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
None.

=== Successful Response (200) ===
Returns other users’ routes available in the same market.

{| class="wikitable"
! 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[] ====
{| class="wikitable"
! 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: <code>Y-m-d g:i A</code>)
|-
| route_assigned_reps || array || List of assigned reps; each item includes <code>id</code> (user ID)
|}

==== data.route_details[].route_assigned_reps[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| id || integer || User ID of an assigned rep
|}

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

← Older revision		Revision as of 09:13, 20 July 2026
Line 1:		Line 1:
−	== Get All Routes ==	+	== [[Mobile_API]] »Get All Routes ==

	=== Base URL ===		=== Base URL ===

@@ Line 33: / Line 33: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

All Routes - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Get All Routes */

Ashley DeBon: Created page with "== Get All Routes == === Base URL === https://apimobile.callproof.com === Endpoint === /api/all-routes === Purpose === Retrieves company routes from users in the same marke..."