# Get Prospect

`GET /crm/prospects/{id}`

Group: CRM › Prospects · Operation ID: `getProspect`

Returns the prospect with the given identifier. Use the prospect's id, not its prospectNumber.

Returns one prospect by its id. To look a prospect up by its number, use POST crm/prospects/search with prospectNumber. This endpoint and POST crm/prospects/search return contacts[], every contact recorded against the prospect. GET crm/prospects omits it.

[Open in the interactive reference](https://docs.api.lensing.ai/?op=getProspect)

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | `"v1"` | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`. |
| `id` | path | string | yes | The unique identifier for the prospect to return. |

## Response

`200` Success

Under `data` (getProspectOutput):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes | The unique identifier for the prospect. |
| `prospectNumber` | string | no | The prospect number, for example 'PR-1042'. Absent while none has been assigned. |
| `prospectName` | string | yes | The name of the prospect organization. |
| `billingEmail` | string | no | The email address invoices for this prospect would be sent to. |
| `crmId` | string | no | The identifier of this prospect in the external CRM system it was integrated from. |
| `customerType` | string | no | The commercial relationship. Possible values: 'default', 'partner', 'endCustomer'. |
| `dataSource` | string | no | The system the prospect originated in, for example 'Everest', 'Salesforce' or 'HubSpot'. |
| `defaultCurrency` | string | no | The currency quotes for this prospect default to. Format ISO 4217, for example 'USD'. |
| `entityId` | string | yes | The legal entity that owns the prospect. |
| `entityName` | string | no | The name of the legal entity that owns the prospect. See entityName on GET base/entities. |
| `customerId` | string | no | The identifier of the customer created from this prospect. Absent until the prospect has been converted, so its presence marks a converted prospect. See id on GET accounting/customers/:id. |
| `sameAsBillToAddress` | boolean | no | Whether the sold-to address repeats the bill-to address. soldToAddress is populated either way, so you never have to resolve this flag to read an address. |
| `billToAddress` | object | no | The prospect's bill-to address, with the default contact for that role. Absent when none is recorded. |
| `billToAddress.id` | string | yes | The unique identifier for the address. |
| `billToAddress.line1` | string | no | The first address line: street number and name, or PO box. |
| `billToAddress.line2` | string | no | The second address line: apartment, suite, unit, building or floor. |
| `billToAddress.city` | string | no | The city or locality. |
| `billToAddress.stateProvince` | string | no | The state, province or region. Absent where the country has no such division. |
| `billToAddress.country` | string | no | The country, as a name or ISO 3166-1 code. |
| `billToAddress.zipCode` | string | no | The postal or ZIP code. |
| `billToAddress.attention` | string | no | The person or department that mail to this address is for. |
| `billToAddress.contact` | object | no | The default contact for this address role. Absent when the prospect has no default contact for it. |
| `billToAddress.contact.id` | string | yes | The unique identifier for the contact. |
| `billToAddress.contact.displayName` | string | no | The contact's display name, assembled from the name parts. |
| `billToAddress.contact.salutation` | string | no | The contact's form of address, for example 'Ms' or 'Dr'. |
| `billToAddress.contact.firstName` | string | no | The contact's given name. |
| `billToAddress.contact.middleName` | string | no | The contact's middle name or initial. |
| `billToAddress.contact.lastName` | string | no | The contact's family name. |
| `billToAddress.contact.suffix` | string | no | The contact's name suffix, for example 'Jr' or 'PhD'. |
| `billToAddress.contact.emailAddress` | string | no | The email address the contact is reached at. |
| `billToAddress.contact.workPhone` | string | no | The contact's work telephone number. |
| `soldToAddress` | object | no | The prospect's sold-to address, with the default contact for that role. Absent when none is recorded. |
| `soldToAddress.id` | string | yes | The unique identifier for the address. |
| `soldToAddress.line1` | string | no | The first address line: street number and name, or PO box. |
| `soldToAddress.line2` | string | no | The second address line: apartment, suite, unit, building or floor. |
| `soldToAddress.city` | string | no | The city or locality. |
| `soldToAddress.stateProvince` | string | no | The state, province or region. Absent where the country has no such division. |
| `soldToAddress.country` | string | no | The country, as a name or ISO 3166-1 code. |
| `soldToAddress.zipCode` | string | no | The postal or ZIP code. |
| `soldToAddress.attention` | string | no | The person or department that mail to this address is for. |
| `soldToAddress.contact` | object | no | The default contact for this address role. Absent when the prospect has no default contact for it. |
| `soldToAddress.contact.id` | string | yes | The unique identifier for the contact. |
| `soldToAddress.contact.displayName` | string | no | The contact's display name, assembled from the name parts. |
| `soldToAddress.contact.salutation` | string | no | The contact's form of address, for example 'Ms' or 'Dr'. |
| `soldToAddress.contact.firstName` | string | no | The contact's given name. |
| `soldToAddress.contact.middleName` | string | no | The contact's middle name or initial. |
| `soldToAddress.contact.lastName` | string | no | The contact's family name. |
| `soldToAddress.contact.suffix` | string | no | The contact's name suffix, for example 'Jr' or 'PhD'. |
| `soldToAddress.contact.emailAddress` | string | no | The email address the contact is reached at. |
| `soldToAddress.contact.workPhone` | string | no | The contact's work telephone number. |
| `lastModifiedDate` | string (date-time) | yes | The date and time the prospect record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
| `contacts` | array of object | yes | Every contact recorded against the prospect, with the two per-role defaults flagged. An empty array when the prospect has none. GET crm/prospects/:id and POST crm/prospects/search return this array. GET crm/prospects omits it. |
| `contacts[].id` | string | yes | The unique identifier for the contact. |
| `contacts[].displayName` | string | no | The contact's display name, assembled from the name parts. |
| `contacts[].salutation` | string | no | The contact's form of address, for example 'Ms' or 'Dr'. |
| `contacts[].firstName` | string | no | The contact's given name. |
| `contacts[].middleName` | string | no | The contact's middle name or initial. |
| `contacts[].lastName` | string | no | The contact's family name. |
| `contacts[].suffix` | string | no | The contact's name suffix, for example 'Jr' or 'PhD'. |
| `contacts[].emailAddress` | string | no | The email address the contact is reached at. |
| `contacts[].workPhone` | string | no | The contact's work telephone number. |
| `contacts[].isDefaultBillToContact` | boolean | yes | Whether this is the default contact for the prospect's bill-to address. At most one contact is. |
| `contacts[].isDefaultSoldToContact` | boolean | yes | Whether this is the default contact for the prospect's sold-to address. At most one contact is. |

## Errors

| Code | Status |
| --- | --- |
| `NOT_FOUND` | 400 |

## Statuses

- `400` — Invalid request or business failure. Codes: NOT_FOUND
- `401` — Missing or invalid access token
- `403` — Not authorized
- `404` — Not found
- `429` — Too many requests
- `500` — Internal server error