## Get a lead by ID

`client.leads.retrieve(stringid, LeadRetrieveParamsparams, RequestOptionsoptions?): LeadRetrieveResponse`

**get** `/leads/{id}`

Get a lead by ID

### Parameters

- `id: string`

- `params: LeadRetrieveParams`

  - `rotorAPIVersion: "1.1.0"`

    Required OpenAPI version header.

    - `"1.1.0"`

### Returns

- `LeadRetrieveResponse`

  - `data?: Data`

    - `id?: string`

    - `archived?: boolean | null`

    - `archived_at?: string | null`

    - `assigned_to?: string | null`

    - `created_at?: string | null`

    - `email?: string | null`

    - `follow_up_date?: string | null`

    - `lead_source?: string | null`

    - `location?: Array<number> | null`

    - `name?: string`

    - `notes?: string | null`

    - `phone?: string | null`

    - `priority?: "low" | "medium" | "high" | null`

      - `"low"`

      - `"medium"`

      - `"high"`

    - `projected_value?: number | null`

    - `property_city?: string | null`

    - `property_country?: string | null`

    - `property_state?: string | null`

    - `property_street1?: string | null`

    - `property_street2?: string | null`

    - `property_zip?: string | null`

    - `service_type?: string | null`

    - `stage?: string | null`

      Pipeline stage

    - `tags?: Array<string>`

    - `value_score?: number | null`

  - `status?: string`

### Example

```typescript
import Rotor from 'getrotor';

const client = new Rotor({
  rotorAPIVersion: '1.1.0',
  apiKey: process.env['ROTOR_API_KEY'], // This is the default and can be omitted
});

const lead = await client.leads.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  'rotor-api-version': '1.1.0',
});

console.log(lead.data);
```

#### Response

```json
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "archived": true,
    "archived_at": "2019-12-27T18:11:19.117Z",
    "assigned_to": "assigned_to",
    "created_at": "2019-12-27T18:11:19.117Z",
    "email": "dev@stainless.com",
    "follow_up_date": "2019-12-27T18:11:19.117Z",
    "lead_source": "lead_source",
    "location": [
      0
    ],
    "name": "name",
    "notes": "notes",
    "phone": "phone",
    "priority": "low",
    "projected_value": 0,
    "property_city": "property_city",
    "property_country": "property_country",
    "property_state": "property_state",
    "property_street1": "property_street1",
    "property_street2": "property_street2",
    "property_zip": "property_zip",
    "service_type": "service_type",
    "stage": "stage",
    "tags": [
      "string"
    ],
    "value_score": 0
  },
  "status": "success"
}
```