Find Contact

V2 Reference

Contacts

GET

/api/partner/v2/contacts/find

const url = 'https://api.linqapp.com/api/partner/v2/contacts/find?email=john%40example.com&phone_number=%2B15551234567';
const options = {
  method: 'GET',
  headers: {'X-LINQ-INTEGRATION-TOKEN': '<X-LINQ-INTEGRATION-TOKEN>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.linqapp.com/api/partner/v2/contacts/find?email=john%40example.com&phone_number=%2B15551234567' \
  --header 'X-LINQ-INTEGRATION-TOKEN: <X-LINQ-INTEGRATION-TOKEN>'

Finds a contact by email or phone number. At least one search parameter must be provided.

If both email and phone_number are provided, the search uses OR logic (returns the contact if either matches).

Phone Number Handling: Phone numbers are automatically normalized to E.164 format before searching. You can provide phone numbers in various formats (e.g., “(555) 123-4567”, “555-123-4567”, “+15551234567”) and they will be normalized for matching.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

email

string format: email

Email address to search for

Example

[email protected]

phone_number

string

Phone number to search for. The API will automatically normalize it to E.164 format for searching (e.g., “+15551234567”).

Example

+15551234567

Responses

200

Successful response (returns contact if found, or null if not found)

application/json

One of:

object
object

object

integer

first_name

string

last_name

string

full_name

string

email

string

phone_number

string

company

string

title

string

location

string

image_url

string

nullable

created_at

string format: date-time

updated_at

string format: date-time

contact_owner

The user who owns this contact in your organization

object

integer

email

string

first_name

string

last_name

string

name

string

Examples

Contact found

{
  "id": 123,
  "first_name": "John",
  "last_name": "Doe",
  "full_name": "John Doe",
  "email": "[email protected]",
  "phone_number": "+15551234567",
  "company": "Acme Corp",
  "title": "CEO",
  "location": "San Francisco, CA",
  "image_url": null,
  "created_at": "2025-07-30T10:00:00.000-05:00",
  "updated_at": "2025-07-30T10:00:00.000-05:00",
  "contact_owner": {
    "id": 456,
    "email": "[email protected]",
    "first_name": "Jane",
    "last_name": "Owner",
    "name": "Jane Owner"
  }
}

Contact not found

{
  "contact": null
}

400

Bad request - Missing search parameters (client-side error). Please verify all required parameters are included and properly formatted.

application/json

Alternative error format used by Contacts and Webhook Subscriptions endpoints (render_standard_error format)

object

status

string

error_code

string

message

string

errors

Array<string>

Example

{
  "status": "error",
  "error_code": "MISSING_SEARCH_PARAMS",
  "message": "At least one search parameter is required",
  "errors": [
    "Please provide either email or phone_number"
  ]
}

422

Validation error - Invalid email or phone format

application/json

Alternative error format used by Contacts and Webhook Subscriptions endpoints (render_standard_error format)

object

status

string

error_code

string

message

string

errors

Array<string>

Examples

Invalid email format

{
  "status": "error",
  "error_code": "INVALID_EMAIL_FORMAT",
  "message": "Invalid email format",
  "errors": [
    "The provided email address is not in a valid format"
  ]
}

Invalid phone format

{
  "status": "error",
  "error_code": "INVALID_PHONE_FORMAT",
  "message": "Invalid phone number format",
  "errors": [
    "The provided phone number is not in a valid format. Please use E.164 format (e.g., +15551234567)"
  ]
}

500

Internal server error

application/json

Alternative error format used by Contacts and Webhook Subscriptions endpoints (render_standard_error format)

object

status

string

error_code

string

message

string

errors

Array<string>

Example

{
  "status": "error",
  "error_code": "INTERNAL_ERROR",
  "message": "Unable to find contact",
  "errors": [
    "Internal server error. Please try again or contact support if the issue persists."
  ]
}