---
title: "Gets a list of Prospects filtered by tags"
method: GET
path: "/Prospect/SearchByTag"
tags: ["Prospects"]
---

# Gets a list of Prospects filtered by tags

`GET /Prospect/SearchByTag`

## Request

- Base URL: `https://api.insightly.com/v3.1`
- URL: `https://api.insightly.com/v3.1/Prospect/SearchByTag`
- Auth: none declared. Required headers: `Authorization`

Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

## Query parameters

- `tagName` string, required
- `brief` boolean
- `skip` integer
- `top` integer
- `count_total` boolean

## Headers

- `Authorization` string, required

## Response `200`

Request succeeded.

- object[]
  - `PROSPECT_ID` integer
  - `LEAD_ID` integer
  - `CONTACT_ID` integer
  - `ORGANISATION_ID` integer
  - `SALUTATION` string, string
  - `FIRST_NAME` string, string
  - `LAST_NAME` string, string
  - `ORGANISATION_NAME` string, string
  - `TITLE` string, string
  - `EMAIL_ADDRESS` string, string, required
  - `PHONE` string, string
  - `MOBILE` string, string
  - `FAX` string, string
  - `WEBSITE` string, string
  - `ADDRESS_STREET` string, string
  - `ADDRESS_CITY` string, string
  - `ADDRESS_STATE` string, string
  - `ADDRESS_POSTCODE` string, string
  - `ADDRESS_COUNTRY` string, string
  - `INDUSTRY` string, string
  - `EMPLOYEE_COUNT` integer
  - `SCORE` integer
  - `GRADE` string, string
  - `DESCRIPTION` string, string
  - `DO_NOT_EMAIL` boolean
  - `DO_NOT_CALL` boolean
  - `OPTED_OUT` boolean
  - `LAST_ACTIVITY_DATE_UTC` string, date-time
  - `CREATED_USER_ID` integer
  - `OWNER_USER_ID` integer
  - `DATE_CREATED_UTC` string, date-time
  - `DATE_UPDATED_UTC` string, date-time
  - `DO_NOT_SYNC` boolean
  - `LEAD_CONVERSION_DATE_UTC` string, date-time
  - `GRADE_PROFILE_ID` integer
  - `CUSTOMFIELDS` APICustomField[]
    - `FIELD_NAME` string
    - `FIELD_VALUE` object
  - `TAGS` APITag[]
    - `TAG_NAME` string

## Other responses

- `400`: Often missing or invalid parameter.
- `401`: Authentication failed.

---

[API](https://skmtc.dev/insightly/apis/insightly-api-v3-1.md) - [All operations](https://skmtc.dev/insightly/apis/insightly-api-v3-1/llms.txt) - [OpenAPI document](https://skmtc.dev/insightly/apis/insightly-api-v3-1/revisions/e7df0c3b65fb?raw)