Skip to main content
GET
/
prospects
/
{id}
cURL
curl --request GET \
  --url https://api.patterns.company/v1/prospects/{id} \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "status": "enriching",
    "email": "<string>",
    "additional": {},
    "linkedin": "<string>",
    "name": "<string>",
    "company": "<string>",
    "role": "<string>",
    "industry": "<string>",
    "domain": "<string>",
    "profile": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<ObjectId>
required

ID of prospect to look up

Response

Prospect response

​
id
string<ObjectId>

ID of the prospect

​
status
enum<string>

Status of the prospect

Available options:
enriching,
enriched
​
email
string

Email of the prospect

​
additional
object

Additional information about the prospect

​
linkedin
string

LinkedIn of the prospect

​
name
string

Name of the prospect

​
company
string

Company of the prospect

​
role
string

Role in the company

​
industry
string

Industry of the company

​
domain
string

Domain of the company

​
profile
string

Combined profile of the prospect

​
createdAt
string<date-time>

Date and time when the prospect was created

​
updatedAt
string<date-time>

Date and time when the prospect was last updated