---
title: "GET /v1/detailedLeadReports:search"
method: GET
path: "/v1/detailedLeadReports:search"
tags: ["detailedLeadReports"]
---

# GET /v1/detailedLeadReports:search

`GET /v1/detailedLeadReports:search`

## Request

- Base URL: `https://localservices.googleapis.com`
- URL: `https://localservices.googleapis.com/v1/detailedLeadReports:search`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/adwords`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/adwords`
- TypeScript: <https://skmtc.dev/google/apis/localservices/docs/v1/detailedLeadReports:search/get.ts> (a function with typed inputs; its response is checked against the schema)

Get detailed lead reports containing leads that have been received by all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.

## Query parameters

- `endDate.day` integer
- `endDate.month` integer
- `endDate.year` integer
- `pageSize` integer
- `pageToken` string
- `query` string
- `startDate.day` integer
- `startDate.month` integer
- `startDate.year` integer

## Response `200`

Successful response

- GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse: A page of the response received from the SearchDetailedLeadReports method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
  - `detailedLeadReports` GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport[]: List of detailed lead reports uniquely identified by external lead id.
    - `accountId` string, int64: Identifies account that received the lead.
    - `aggregatorInfo` GoogleAdsHomeservicesLocalservicesV1AggregatorInfo: Conatiner for aggregator specific information if lead is for an aggregator GLS account.
      - `aggregatorProviderId` string: Provider id (listed in aggregator system) which maps to a account id in GLS system.
    - `bookingLead` GoogleAdsHomeservicesLocalservicesV1BookingLead: Container for booking lead specific information.
      - `bookingAppointmentTimestamp` string, google-datetime: Timestamp of when service is provided by advertiser.
      - `consumerEmail` string: Consumer email associated with the booking lead.
      - `consumerPhoneNumber` string: Consumer phone number associated with the booking lead.
      - `customerName` string: Name of the customer who created the lead.
      - `jobType` string: The job type of the specified lead.
    - `businessName` string: Business name associated to the account.
    - `chargeStatus` 'CHARGE_STATUS_UNSPECIFIED' | 'CHARGED' | 'NOT_CHARGED': Whether the lead has been charged.
    - `currencyCode` string: Currency code.
    - `disputeStatus` string: Dispute status related to the lead.
    - `geo` string: Location of the associated account's home city.
    - `googleAdsLeadId` string, int64: Unique identifier of a Detailed Lead Report.
    - `leadCategory` string: Lead category (e.g. hvac, plumber)
    - `leadCreationTimestamp` string, google-datetime: Timestamp of when the lead was created.
    - `leadId` string, int64: Deprecated in favor of google_ads_lead_id. Unique identifier of a Detailed Lead Report.
    - `leadPrice` number, double: Price of the lead (available only after it has been charged).
    - `leadType` 'LEAD_TYPE_UNSPECIFIED' | 'MESSAGE' | 'PHONE_CALL' | 'BOOKING': Lead type.
    - `messageLead` GoogleAdsHomeservicesLocalservicesV1MessageLead: Container for message lead specific information.
      - `consumerPhoneNumber` string: Consumer phone number associated with the message lead.
      - `customerName` string: Name of the customer who created the lead.
      - `jobType` string: The job type of the specified lead.
      - `postalCode` string: The postal code of the customer who created the lead.
    - `phoneLead` GoogleAdsHomeservicesLocalservicesV1PhoneLead: Container for phone lead specific information.
      - `chargedCallTimestamp` string, google-datetime: Timestamp of the phone call which resulted in a charged phone lead.
      - `chargedConnectedCallDurationSeconds` string, google-duration: Duration of the charged phone call in seconds.
      - `consumerPhoneNumber` string: Consumer phone number associated with the phone lead.
    - `timezone` GoogleTypeTimeZone: Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).
      - `id` string: IANA Time Zone Database time zone. For example "America/New_York".
      - `version` string: Optional. IANA Time Zone Database version number. For example "2019a".
  - `nextPageToken` string: Pagination token to retrieve the next page of results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set.

## Changes

- **2026-10-10** `fa10d6ccf979`: 1 breaking
  - removed the media type `*/*` for the response with the status `200`

[Operation history](https://skmtc.dev/google/apis/localservices/changes/v1/detailedLeadReports:search/get.md)

---

[API](https://skmtc.dev/google/apis/localservices.md) - [All operations](https://skmtc.dev/google/apis/localservices/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/localservices/revisions/fa10d6ccf979?raw)