Skip to main content

API V2: Lookup

GET Lookup App by Phone Number

{{url}}/Lookup/App?phone={{phone_number}}&org={{crmorg}}

Matching Phone Number Found

If the user is not currently authenticated in the CRM, they will be automatically redirected to the login page and asked to log in. Once a successful connection is established, if the phone number matches, the user will then be navigated to the application.

Not Matching Phone Number Found

The user will be redirected to an empty pipeline view.

Query Params

  • phone 3109099146 (Required, no special characters. It must be a cell, home, or work number assigned to an existing app)

  • org (Required)


GET Lookup App by Phone Number & Assign to CRM User

{{url}}/lookup/app?phone=<PhoneNumber>&org=<ORG>&agentEmail=<email address>

Matching Phone Number Found

If the user is not currently authenticated in the CRM, they will be automatically redirected to the login page and asked to log in. Once a successful connection is established, if the phone number matches, the user will then be navigated to the application.

Not Matching Phone Number Found

The user will be redirected to an empty pipeline view.

Assign App by User Email

When the agentEmail is provided in a lookup, the system will attempt to assign the corresponding user to the app under the user's lead role. However, if the app already has an assignment under the same lead role, the assignment will not proceed.

Query Params

  • phone 3109099146 (Required, no special characters. It must be a cell, home, or work number assigned to an existing app)

  • org org name (Required)

  • Email [email protected] Required if trying to assign app to user.

Did this answer your question?