---
title: "Get a list of lead-competitor relationships"
method: GET
path: "/competitormaps"
tags: ["Competitors", "Leads"]
---

# Get a list of lead-competitor relationships

`GET /competitormaps`

## Response `200`

A list of lead-competitor relationships

- LeadCompetitorMapResponse
  - `competitorMaps` LeadCompetitorMap[]
    - `id` string — The API ID of this entity, formatted {integer}-{entityType}
    - `relationship` string
    - `name` string — A shortcut to the name of the competitor
    - `status` string
    - `links` object
      - `lead` string
      - `competitor` string
  - `leads` Lead[]
    - `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
  - `competitors` Competitor[]
    - `id` string — The API ID of this entity, formatted {integer}-{entityType}

---

[API](https://skmtc.dev/nutshell/apis/nutshell-api.md) · [All operations](https://skmtc.dev/nutshell/apis/nutshell-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nutshell/nutshell-api/revisions/14f59cf6a09a/schema)