v2

latestOpenAPI 3.0.02026-08-08112115411.4 KB
Competitors
Leads

Get a list of lead-competitor relationships

get/competitormaps

Response

A list of lead-competitor relationships

Example response

{
  "competitorMaps": [
    {
      "id": "3-contacts"
    }
  ],
  "leads": [
    {
      "htmlUrl": "https://app.nutshell.com/lead/1006",
      "htmlUrlPath": "/lead/1006",
      "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
      "initials": "AF",
      "id": "3-contacts",
      "name": "John Doe",
      "value": {
        "formatted": "$100.00",
        "amount": "100.00",
        "currency": "USD"
      },
      "description": "This is a description",
      "createdTime": {
        "absoluteLocalizedString": "May 28, 2024",
        "value": "May 28, 2024"
      },
      "ownerType": "users",
      "status": "open",
      "confidence": 25
    }
  ],
  "competitors": [
    {
      "id": "3-contacts"
    }
  ]
}