COcommpeak
Requests

Search for Results

Search per-number lookup results across past tasks. Filter by phone number (exact, prefix or substring), task IDs, task creation date range, lookup type, validation outcome, number type, country, and ported / roaming flags. Paginate with limit and skip; set with_totals=1 to also get total, unique, invalid and mobile counts.

post/search_results

Request

  • Base URL
    https://api.commpeak.com/lookup
  • URL
    https://api.commpeak.com/lookup/search_results
  • Auth
    API key in header Authorization

Request body

keystring nullable

Exact-match phone number (E.164 without leading "+").

key_startstring nullable

Phone-number prefix match (e.g. "1212" for New York).

key_containsstring nullable

Substring match anywhere in the phone number.

job_idsstring[] nullable

Restrict the search to results produced by these task ids.

keysstring[] nullable

Restrict the search to this set of phone numbers.

search_fromstring nullable

Lower bound on task creation time (ISO 8601).

search_tillstring nullable

Upper bound on task creation time (ISO 8601).

search_datestring nullable

Filter for a single calendar date (YYYY-MM-DD).

resultstring nullable

Filter by top-level result string (e.g. "Active", "valid").

request_typeinteger nullable

Filter by lookup type id (1 = hlr, 2 = validate).

validboolean nullable

Filter by validation outcome.

number_typestring nullable

Filter by detected number type ("mobile", "fixed_line", etc.).

limitinteger nullable

Maximum number of rows to return (page size).

skipinteger nullable

Offset into the result set (for pagination).

with_totalsinteger nullable

Set to 1 to include the aggregate counts (total, unique, invalid, mobile) in the response.

countrystring nullable

Filter by ISO 3166-1 alpha-2 country code (e.g. "US").

is_portedboolean nullable

Filter by port-status flag.

is_roamingboolean nullable

Filter by roaming-status flag.

Response

Successful Response

totalinteger nullable

Total matching numbers across the result set.

uniqueinteger nullable

Distinct numbers among the matches.

invalidinteger nullable

Count of matches where validation failed.

mobileinteger nullable

Count of matches identified as mobile.

Example response

{
  "results": [
    {
      "request_key": "12125551234",
      "request_time": "2026-05-26T12:00:00",
      "request_type": "hlr",
      "request_uuid": "a1b2c3d4-0000-4000-8000-000000000001"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.