---
title: "Get a list of leads"
method: GET
path: "/leads"
tags: ["Leads"]
---

# Get a list of leads

`GET /leads`

Get a list of all leads and associated data in your Nutshell Instance.

## Query parameters

- `q` string
- `sort` '-age' | '-value' | '-milestone' | '-confidence' | '-name' | '-closedTime' | '-owner' | '-sources' | 'age' | 'value' | 'milestone' | 'confidence' | 'name' | 'closedTime' | 'owner' | 'sources'
- `filter` object — Filter the returned leads based on various criteria. Use /rest/leads/list/fields to get a full list of valid filter keys.
- `page[page]` integer
- `page[limit]` integer

## Response `200`

Leads

- LeadResponse — A full response object for a lead-related endpoint.
  - `meta` Meta — Information about the Nutshell instance making the request
    - `instanceId` string — The Nutshell instance ID
    - `siteId` string — Site ID for WebFX customers
  - `links` object
  - `leads` FullLead[]
    - `htmlUrl` string — The link to the entity within the app.
    - `htmlUrlPath` string — The path to the entity within the app.
    - `avatarUrl` string — The URL of the entity's avatar image.
    - `initials` string — The initials of the entity, used as a fallback for the avatar image.
    - `id` string — The API ID of this entity, formatted {integer}-{entityType}
    - `deletedTime` string
    - `name` string — The full name of the lead
    - `value` Value
      - `formatted` string — The value formatted as a string
      - `amount` string — The value as a number
      - `currency` string — The currency code
    - `number` integer
    - `description` string
    - `createdTime` CreatedTime — When the lead was created.
      - `absoluteLocalizedString` string — The value formatted as a string
      - `timestamp` number
      - `value` string — The value to be formatted
    - `closedTime` string
    - `dueTime` string
    - `anticipatedClosedTime` string
    - `ownerType` string
    - `status` string — The current status of the lead
    - `lastContactedTime` unknown
    - `pieState` string
    - `isOverdue` boolean — Whether the lead is overdue to have a final outcome set
    - `overdueTime` string
    - `href` string
    - `confidence` integer — How confident, as a percentage, that the lead will close
    - `priority` integer — Whether a lead is marked as hot (1) or not (0)
    - `isCurrentUserWatching` boolean — Whether the current authenticated user is subscribed to receive notifications about this lead

---

[API](https://skmtc.net/nutshell/apis/nutshell-api.md) · [All operations](https://skmtc.net/nutshell/apis/nutshell-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutshell/nutshell-api/versions/91e98426903e/schema)