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

2026-07-21T11:27:20Z

‎Successful Response (200)

Ashley DeBon: /* External User Search */

2026-07-21T11:26:40Z

‎External User Search

Ashley DeBon: Created page with "== External User Search == === Base URL === https://apimobile.callproof.com === Endpoint === /api/external-user-search === Purpose === Searches for another user by email ad..."

2026-07-21T11:26:03Z

Created page with "== External User Search == === Base URL === https://apimobile.callproof.com === Endpoint === /api/external-user-search === Purpose === Searches for another user by email ad..."

New page

== External User Search ==

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

=== Endpoint ===
/api/external-user-search

=== Purpose ===
Searches for another user by email address (including users outside the authenticated user’s company). Returns profile details when the user is found, enabled, and allowed to be contacted (or when the searcher’s company is in the exception list / same company). Cross-company searches are logged.

=== 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 ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| search || string || Yes || Email address of the user to find (must be a valid email format)
|}

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

=== Successful Response (200) ===
Returns the matched user details when available. If no eligible user is found, <code>data</code> may be <code>null</code>.

{| 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/null || Matched user payload, or <code>null</code> when no eligible match
|-
| uri || string || Requested resource URI
|}

==== data ====
{| class="wikitable"
! Field !! Type !! Description
|-
| search_result_user_id || integer || Identifier of the matched user
|-
| search_result_company_id || integer || Company identifier of the matched user
|-
| name || string || Full name of the matched user
|-
| company_name || string || Company name of the matched user
|-
| role || string || Job title / role name of the matched user
|-
| badges_image || string || URL of the user’s badge image, when available
|-
| is_cross_company || boolean || <code>true</code> when the matched user belongs to a different company
|-
| room_id || integer/string || Messaging room ID between the authenticated user and the matched user, when available
|-
| profile_image || string || URL of the user’s profile thumbnail, when available
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 401 with the first validation error message
|-
| 400 || Bad Request – external user search failed
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing <code>search</code>, or value is not a valid email.
* '''400''' – An error occurred while retrieving the external user (for example, "Error while retrieving external user").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 11:26, 21 July 2026
Line 1:		Line 1:
−	== External User Search ==	+	== [[Mobile_API]] »External User Search ==

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

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

Other company user search - Revision history

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

Ashley DeBon: /* External User Search */

Ashley DeBon: Created page with "== External User Search == === Base URL === https://apimobile.callproof.com === Endpoint === /api/external-user-search === Purpose === Searches for another user by email ad..."