Prospect

A descriptor of a person.

addedAt	string <date-time> The date and time the prospect was added to any system.
addressCity	string <= 255 characters The prospect’s city (e.g. "Seattle").
addressCountry	string <= 255 characters The prospect’s country (e.g. "USA").
addressState	string <= 255 characters The prospect’s state (e.g. "Washington").
addressStreet	string <= 255 characters The prospect’s street address (e.g. "1441 N 34th St").
addressStreet2	string <= 255 characters The prospect’s second street address, if applicable.
addressZip	string <= 255 characters The prospect’s postal code (e.g. "98103").
angelListUrl	string <= 255 characters The prospect’s AngelList URL.
availableAt	string <date-time> The date and time the prospect is available to contact again.
callOptedOut	boolean Whether the prospect is opted out of calling, or opted out in general if granular opt-out is not enabled.
callsOptStatus	string <= 255 characters A string ("opted_in", "opted_out", "null") that represents whether a prospect has opted into or out of calls.
callsOptedAt	string <date-time> The date and time the prospect opted in/out of calls.
campaignName	string <= 255 characters The name of the campaign the prospect is associated with.
clickCount	integer The number of clicks the prospect has made since the last touch point.
company	string The name of the company the prospect works at. If associated with an account, this is the name of the account. (e.g. Acme International).
contactHistogram	Array of any <contact histogram> The last 12 months of email contact history with the prospect, with the current month being the last element. The format for each month is '[inboundCount, outboundCount]'. Note: Retrieving this field will slow down the queries. Unless this field is required, it is best to filter it out. See Specify Sparse Fieldsets for examples
createdAt	string <date-time> The date and time the prospect was created.
custom1	string <= 32000 characters The value of the prospect’s first custom field.
custom2	string <= 32000 characters The value of the prospect’s second custom field.
custom3	string <= 32000 characters The value of the prospect’s third custom field.
custom4	string <= 32000 characters The value of the prospect’s fourth custom field.
custom5	string <= 32000 characters The value of the prospect’s fifth custom field.
custom6	string <= 32000 characters The value of the prospect’s sixth custom field.
custom7	string <= 32000 characters The value of the prospect’s seventh custom field.
custom8	string <= 32000 characters The value of the prospect’s eight custom field.
custom9	string <= 32000 characters The value of the prospect’s ninth custom field.
custom10	string <= 32000 characters The value of the prospect’s 10th custom field.
custom11	string <= 32000 characters The value of the prospect’s 11th custom field.
custom12	string <= 32000 characters The value of the prospect’s 12th custom field.
custom13	string <= 32000 characters The value of the prospect’s 13th custom field.
custom14	string <= 32000 characters The value of the prospect’s 14th custom field.
custom15	string <= 32000 characters The value of the prospect’s 15th custom field.
custom16	string <= 32000 characters The value of the prospect’s 16th custom field.
custom17	string <= 32000 characters The value of the prospect’s 17th custom field.
custom18	string <= 32000 characters The value of the prospect’s 18th custom field.
custom19	string <= 32000 characters The value of the prospect’s 19th custom field.
custom20	string <= 32000 characters The value of the prospect’s 20th custom field.
custom21	string <= 32000 characters The value of the prospect’s 21st custom field.
custom22	string <= 32000 characters The value of the prospect’s 22nd custom field.
custom23	string <= 32000 characters The value of the prospect’s 23rd custom field.
custom24	string <= 32000 characters The value of the prospect’s 24th custom field.
custom25	string <= 32000 characters The value of the prospect’s 25th custom field.
custom26	string <= 32000 characters The value of the prospect’s 26th custom field.
custom27	string <= 32000 characters The value of the prospect’s 27th custom field.
custom28	string <= 32000 characters The value of the prospect’s 28th custom field.
custom29	string <= 32000 characters The value of the prospect’s 29th custom field.
custom30	string <= 32000 characters The value of the prospect’s 30th custom field.
custom31	string <= 32000 characters The value of the prospect’s 31st custom field.
custom32	string <= 32000 characters The value of the prospect’s 32nd custom field.
custom33	string <= 32000 characters The value of the prospect’s 33rd custom field.
custom34	string <= 32000 characters The value of the prospect’s 34th custom field.
custom35	string <= 32000 characters The value of the prospect’s 35th custom field.
custom36	string <= 32000 characters The value of the prospect’s 36th custom field.
custom37	string <= 32000 characters The value of the prospect’s 37th custom field.
custom38	string <= 32000 characters The value of the prospect’s 38th custom field.
custom39	string <= 32000 characters The value of the prospect’s 39th custom field.
custom40	string <= 32000 characters The value of the prospect’s 40th custom field.
custom41	string <= 32000 characters The value of the prospect’s 41st custom field.
custom42	string <= 32000 characters The value of the prospect’s 42nd custom field.
custom43	string <= 32000 characters The value of the prospect’s 43rd custom field.
custom44	string <= 32000 characters The value of the prospect’s 44th custom field.
custom45	string <= 32000 characters The value of the prospect’s 45th custom field.
custom46	string <= 32000 characters The value of the prospect’s 46th custom field.
custom47	string <= 32000 characters The value of the prospect’s 47th custom field.
custom48	string <= 32000 characters The value of the prospect’s 48th custom field.
custom49	string <= 32000 characters The value of the prospect’s 49th custom field.
custom50	string <= 32000 characters The value of the prospect’s 50th custom field.
custom51	string <= 32000 characters The value of the prospect’s 51st custom field.
custom52	string <= 32000 characters The value of the prospect’s 52nd custom field.
custom53	string <= 32000 characters The value of the prospect’s 53rd custom field.
custom54	string <= 32000 characters The value of the prospect’s 54th custom field.
custom55	string <= 32000 characters The value of the prospect’s 55th custom field.
custom56	string <= 32000 characters The value of the prospect’s 56th custom field.
custom57	string <= 32000 characters The value of the prospect’s 57th custom field.
custom58	string <= 32000 characters The value of the prospect’s 58th custom field.
custom59	string <= 32000 characters The value of the prospect’s 59th custom field.
custom60	string <= 32000 characters The value of the prospect’s 60th custom field.
custom61	string <= 32000 characters The value of the prospect’s 61st custom field.
custom62	string <= 32000 characters The value of the prospect’s 62nd custom field.
custom63	string <= 32000 characters The value of the prospect’s 63rd custom field.
custom64	string <= 32000 characters The value of the prospect’s 64th custom field.
custom65	string <= 32000 characters The value of the prospect’s 65th custom field.
custom66	string <= 32000 characters The value of the prospect’s 66th custom field.
custom67	string <= 32000 characters The value of the prospect’s 67th custom field.
custom68	string <= 32000 characters The value of the prospect’s 68th custom field.
custom69	string <= 32000 characters The value of the prospect’s 69th custom field.
custom70	string <= 32000 characters The value of the prospect’s 70th custom field.
custom71	string <= 32000 characters The value of the prospect’s 71st custom field.
custom72	string <= 32000 characters The value of the prospect’s 72nd custom field.
custom73	string <= 32000 characters The value of the prospect’s 73rd custom field.
custom74	string <= 32000 characters The value of the prospect’s 74th custom field.
custom75	string <= 32000 characters The value of the prospect’s 75th custom field.
custom76	string <= 32000 characters The value of the prospect’s 76th custom field.
custom77	string <= 32000 characters The value of the prospect’s 77th custom field.
custom78	string <= 32000 characters The value of the prospect’s 78th custom field.
custom79	string <= 32000 characters The value of the prospect’s 79th custom field.
custom80	string <= 32000 characters The value of the prospect’s 80th custom field.
custom81	string <= 32000 characters The value of the prospect’s 81st custom field.
custom82	string <= 32000 characters The value of the prospect’s 82nd custom field.
custom83	string <= 32000 characters The value of the prospect’s 83rd custom field.
custom84	string <= 32000 characters The value of the prospect’s 84th custom field.
custom85	string <= 32000 characters The value of the prospect’s 85th custom field.
custom86	string <= 32000 characters The value of the prospect’s 86th custom field.
custom87	string <= 32000 characters The value of the prospect’s 87th custom field.
custom88	string <= 32000 characters The value of the prospect’s 88th custom field.
custom89	string <= 32000 characters The value of the prospect’s 89th custom field.
custom90	string <= 32000 characters The value of the prospect’s 90th custom field.
custom91	string <= 32000 characters The value of the prospect’s 91st custom field.
custom92	string <= 32000 characters The value of the prospect’s 92nd custom field.
custom93	string <= 32000 characters The value of the prospect’s 93rd custom field.
custom94	string <= 32000 characters The value of the prospect’s 94th custom field.
custom95	string <= 32000 characters The value of the prospect’s 95th custom field.
custom96	string <= 32000 characters The value of the prospect’s 96th custom field.
custom97	string <= 32000 characters The value of the prospect’s 97th custom field.
custom98	string <= 32000 characters The value of the prospect’s 98th custom field.
custom99	string <= 32000 characters The value of the prospect’s 99th custom field.
custom100	string <= 32000 characters The value of the prospect’s 100th custom field.
custom101	string <= 32000 characters The value of the prospect’s 101st custom field.
custom102	string <= 32000 characters The value of the prospect’s 102nd custom field.
custom103	string <= 32000 characters The value of the prospect’s 103rd custom field.
custom104	string <= 32000 characters The value of the prospect’s 104th custom field.
custom105	string <= 32000 characters The value of the prospect’s 105th custom field.
custom106	string <= 32000 characters The value of the prospect’s 106th custom field.
custom107	string <= 32000 characters The value of the prospect’s 107th custom field.
custom108	string <= 32000 characters The value of the prospect’s 108th custom field.
custom109	string <= 32000 characters The value of the prospect’s 109th custom field.
custom110	string <= 32000 characters The value of the prospect’s 110th custom field.
custom111	string <= 32000 characters The value of the prospect’s 111th custom field.
custom112	string <= 32000 characters The value of the prospect’s 112th custom field.
custom113	string <= 32000 characters The value of the prospect’s 113th custom field.
custom114	string <= 32000 characters The value of the prospect’s 114th custom field.
custom115	string <= 32000 characters The value of the prospect’s 115th custom field.
custom116	string <= 32000 characters The value of the prospect’s 116th custom field.
custom117	string <= 32000 characters The value of the prospect’s 117th custom field.
custom118	string <= 32000 characters The value of the prospect’s 118th custom field.
custom119	string <= 32000 characters The value of the prospect’s 119th custom field.
custom120	string <= 32000 characters The value of the prospect’s 120th custom field.
custom121	string <= 32000 characters The value of the prospect’s 121st custom field.
custom122	string <= 32000 characters The value of the prospect’s 122nd custom field.
custom123	string <= 32000 characters The value of the prospect’s 123rd custom field.
custom124	string <= 32000 characters The value of the prospect’s 124th custom field.
custom125	string <= 32000 characters The value of the prospect’s 125th custom field.
custom126	string <= 32000 characters The value of the prospect’s 126th custom field.
custom127	string <= 32000 characters The value of the prospect’s 127th custom field.
custom128	string <= 32000 characters The value of the prospect’s 128th custom field.
custom129	string <= 32000 characters The value of the prospect’s 129th custom field.
custom130	string <= 32000 characters The value of the prospect’s 130th custom field.
custom131	string <= 32000 characters The value of the prospect’s 131st custom field.
custom132	string <= 32000 characters The value of the prospect’s 132nd custom field.
custom133	string <= 32000 characters The value of the prospect’s 133rd custom field.
custom134	string <= 32000 characters The value of the prospect’s 134th custom field.
custom135	string <= 32000 characters The value of the prospect’s 135th custom field.
custom136	string <= 32000 characters The value of the prospect’s 136th custom field.
custom137	string <= 32000 characters The value of the prospect’s 137th custom field.
custom138	string <= 32000 characters The value of the prospect’s 138th custom field.
custom139	string <= 32000 characters The value of the prospect’s 139th custom field.
custom140	string <= 32000 characters The value of the prospect’s 140th custom field.
custom141	string <= 32000 characters The value of the prospect’s 141st custom field.
custom142	string <= 32000 characters The value of the prospect’s 142nd custom field.
custom143	string <= 32000 characters The value of the prospect’s 143rd custom field.
custom144	string <= 32000 characters The value of the prospect’s 144th custom field.
custom145	string <= 32000 characters The value of the prospect’s 145th custom field.
custom146	string <= 32000 characters The value of the prospect’s 146th custom field.
custom147	string <= 32000 characters The value of the prospect’s 147th custom field.
custom148	string <= 32000 characters The value of the prospect’s 148th custom field.
custom149	string <= 32000 characters The value of the prospect’s 149th custom field.
custom150	string <= 32000 characters The value of the prospect’s 150th custom field.
dateOfBirth	string <date> The date the prospect was born.
degree	string <= 255 characters The degree(s) the prospect has received.
emailOptedOut	boolean Whether the prospect is opted out of email, or opted out in general if granular opt-out is not enabled.
emails	Array of strings <email> A list of email addresses associated with the prospect.
emailsOptStatus	string <= 255 characters A string ("opted_in", "opted_out", "null") that represents whether a prospect has opted into or out of emails.
emailsOptedAt	string <date-time> The date and time the prospect opted in/out of emails.
engagedAt	string <date-time> The date and time the prospect last engaged.
engagedScore	number <float> A number representing the quality of the lead, based on the number of the prospect’s opens, clicks and mailing replies.
eventName	string <= 255 characters The name of the event the prospect was met at.
externalId	string <= 255 characters A custom ID for the prospect, often referencing an ID in an external system.
externalOwner	string <= 255 characters A custom owner for the prospect, often referencing an ownering in an external system.
externalSource	string <= 255 characters The source of the resource’s creation (e.g. "outreach-api").
facebookUrl	string <= 255 characters The prospect’s Facebook URL.
firstName	string <= 255 characters The first name of the prospect.
gender	string <= 255 characters The gender of the prospect.
githubUrl	string <= 1000 characters The prospect’s GitHub URL.
githubUsername	string <= 255 characters The prospect’s GitHub username.
googlePlusUrl	string <= 255 characters The prospect’s Google+ URL.
graduationDate	string <date> The graduation date of the prospect.
homePhones	Array of strings A list of home phone numbers associated with the prospect.
jobStartDate	string <date> The starting date of the prospect’s current job.
lastName	string <= 255 characters The last name of the prospect.
linkedInConnections	integer The number of connections on the prospect’s LinkedIn profile.
linkedInId	string <= 255 characters The prospect’s LinkedIn ID.
linkedInSlug	string <= 255 characters The prospect’s LinkedIn slug.
linkedInUrl	string <= 1000 characters The prospect’s LinkedIn URL.
middleName	string <= 255 characters The middle name of the prospect.
mobilePhones	Array of strings A list of mobile phone numbers associated with the prospect.
name	string The full name of the prospect.
nickname	string <= 255 characters The nickname of the prospect.
occupation	string <= 255 characters The occupation of the prospect (e.g. "Purchasing Manager").
openCount	integer The number of opens the prospect has made since the last touch point.
optedOut	boolean A boolean value representing whether this prospect is currently opted out of all mailings. Set this value to true to opt out the prospect; the 'opted_out' timestamp will be updated to the time of the request. Set this value to false to revert the opt at and clear the opted out timestamp.
optedOutAt	string <date-time> The date and time the prospect opted out of emails.
otherPhones	Array of strings A list of other phone numbers associated with the prospect.
personalNote1	string <= 65535 characters A custom note field related to the prospect.
personalNote2	string <= 65535 characters A second note field related to the prospect.
preferredContact	string <= 255 characters The preferred contact method for the prospect.
quoraUrl	string <= 255 characters The prospect’s Quora URL.
region	string <= 255 characters The primary geographic region of the prospect.
replyCount	integer The number of replies the prospect has made since the last touch point.
school	string <= 255 characters The school(s) the prospect has attended.
score	number <float> A custom score given to measure the quality of the lead.
sharingTeamId	string <= 255 characters The ID of the sharing team associated with this object. Access is currently in beta.
source	string <= 255 characters A custom source representing where the lead was first acquired.
specialties	string <= 65535 characters A description of the prospect’s specialties.
stackOverflowId	string <= 255 characters The prospect’s StackOverflow ID.
stackOverflowUrl	string <= 1000 characters The prospect’s StackOverflow URL.
tags	Array of strings A list of tag values associated with the account (e.g. ["Interested", "2017 Expo"]).
timeZone	string <= 255 characters The prospect’s current timezone, preferably in the IANA format (e.g. "America/LosAngeles").
timeZoneIana	string The prospect’s current IANA timezone, if available.
timeZoneInferred	string <= 255 characters The prospect’s current inferred IANA timezone, if available.
title	string <= 255 characters The title of the prospect.
touchedAt	string <date-time> The date and time the prospect was last touched.
trashedAt	string <date-time> The date a prospect was soft deleted.
twitterUrl	string <= 1000 characters The prospect’s Twitter URL.
twitterUsername	string <= 255 characters The prospect’s Twitter username.
updatedAt	string <date-time> The date and time the prospect was last updated.
voipPhones	Array of strings A list of voip phone numbers associated with the prospect.
websiteUrl1	string <= 65535 characters The URL of the prospect’s website.
websiteUrl2	string <= 65535 characters The value of the prospect’s second website URL field.
websiteUrl3	string <= 65535 characters The value of the prospect’s third website URL field.
workPhones	Array of strings A list of work phone numbers associated with the prospect.

{"addedAt": "2019-08-24T14:15:22Z",
"addressCity": "string",
"addressCountry": "string",
"addressState": "string",
"addressStreet": "string",
"addressStreet2": "string",
"addressZip": "string",
"angelListUrl": "string",
"availableAt": "2019-08-24T14:15:22Z",
"callOptedOut": true,
"callsOptStatus": "string",
"callsOptedAt": "2019-08-24T14:15:22Z",
"campaignName": "string",
"clickCount": 0,
"company": "string",
"contactHistogram": [null
],
"createdAt": "2019-08-24T14:15:22Z",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"custom25": "string",
"custom26": "string",
"custom27": "string",
"custom28": "string",
"custom29": "string",
"custom30": "string",
"custom31": "string",
"custom32": "string",
"custom33": "string",
"custom34": "string",
"custom35": "string",
"custom36": "string",
"custom37": "string",
"custom38": "string",
"custom39": "string",
"custom40": "string",
"custom41": "string",
"custom42": "string",
"custom43": "string",
"custom44": "string",
"custom45": "string",
"custom46": "string",
"custom47": "string",
"custom48": "string",
"custom49": "string",
"custom50": "string",
"custom51": "string",
"custom52": "string",
"custom53": "string",
"custom54": "string",
"custom55": "string",
"custom56": "string",
"custom57": "string",
"custom58": "string",
"custom59": "string",
"custom60": "string",
"custom61": "string",
"custom62": "string",
"custom63": "string",
"custom64": "string",
"custom65": "string",
"custom66": "string",
"custom67": "string",
"custom68": "string",
"custom69": "string",
"custom70": "string",
"custom71": "string",
"custom72": "string",
"custom73": "string",
"custom74": "string",
"custom75": "string",
"custom76": "string",
"custom77": "string",
"custom78": "string",
"custom79": "string",
"custom80": "string",
"custom81": "string",
"custom82": "string",
"custom83": "string",
"custom84": "string",
"custom85": "string",
"custom86": "string",
"custom87": "string",
"custom88": "string",
"custom89": "string",
"custom90": "string",
"custom91": "string",
"custom92": "string",
"custom93": "string",
"custom94": "string",
"custom95": "string",
"custom96": "string",
"custom97": "string",
"custom98": "string",
"custom99": "string",
"custom100": "string",
"custom101": "string",
"custom102": "string",
"custom103": "string",
"custom104": "string",
"custom105": "string",
"custom106": "string",
"custom107": "string",
"custom108": "string",
"custom109": "string",
"custom110": "string",
"custom111": "string",
"custom112": "string",
"custom113": "string",
"custom114": "string",
"custom115": "string",
"custom116": "string",
"custom117": "string",
"custom118": "string",
"custom119": "string",
"custom120": "string",
"custom121": "string",
"custom122": "string",
"custom123": "string",
"custom124": "string",
"custom125": "string",
"custom126": "string",
"custom127": "string",
"custom128": "string",
"custom129": "string",
"custom130": "string",
"custom131": "string",
"custom132": "string",
"custom133": "string",
"custom134": "string",
"custom135": "string",
"custom136": "string",
"custom137": "string",
"custom138": "string",
"custom139": "string",
"custom140": "string",
"custom141": "string",
"custom142": "string",
"custom143": "string",
"custom144": "string",
"custom145": "string",
"custom146": "string",
"custom147": "string",
"custom148": "string",
"custom149": "string",
"custom150": "string",
"dateOfBirth": "2019-08-24",
"degree": "string",
"emailOptedOut": true,
"emails": ["user@example.com"
],
"emailsOptStatus": "string",
"emailsOptedAt": "2019-08-24T14:15:22Z",
"engagedAt": "2019-08-24T14:15:22Z",
"engagedScore": 0,
"eventName": "string",
"externalId": "string",
"externalOwner": "string",
"externalSource": "string",
"facebookUrl": "string",
"firstName": "string",
"gender": "string",
"githubUrl": "string",
"githubUsername": "string",
"googlePlusUrl": "string",
"graduationDate": "2019-08-24",
"homePhones": ["string"
],
"jobStartDate": "2019-08-24",
"lastName": "string",
"linkedInConnections": 0,
"linkedInId": "string",
"linkedInSlug": "string",
"linkedInUrl": "string",
"middleName": "string",
"mobilePhones": ["string"
],
"name": "string",
"nickname": "string",
"occupation": "string",
"openCount": 0,
"optedOut": true,
"optedOutAt": "2019-08-24T14:15:22Z",
"otherPhones": ["string"
],
"personalNote1": "string",
"personalNote2": "string",
"preferredContact": "string",
"quoraUrl": "string",
"region": "string",
"replyCount": 0,
"school": "string",
"score": 0,
"sharingTeamId": "string",
"source": "string",
"specialties": "string",
"stackOverflowId": "string",
"stackOverflowUrl": "string",
"tags": ["string"
],
"timeZone": "string",
"timeZoneIana": "string",
"timeZoneInferred": "string",
"title": "string",
"touchedAt": "2019-08-24T14:15:22Z",
"trashedAt": "2019-08-24T14:15:22Z",
"twitterUrl": "string",
"twitterUsername": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"voipPhones": ["string"
],
"websiteUrl1": "string",
"websiteUrl2": "string",
"websiteUrl3": "string",
"workPhones": ["string"
]
}

Prospect Relationships

	data (object) or links (object) (account) The prospect's associated account. You can use attributes id, customId, name, named and updatedAt to filter prospects by account (e.g. filter[account][id]=X).
	Array of data (object) or links (object) (sequenceState) The non-finished sequence states where this prospect is the primary recipient. This includes states of "active", "paused", "failed", "bounced", "pending" and "disabled." You can use attributes id and state to filter prospects by activeSequenceStates (e.g. filter[activeSequenceStates][id]=X).
	Array of links (object) (batch) The batches associated with the prospect.
	Array of links (object) (call) The calls associated with the prospect. Relationship calls cannot be used as a filter.
	(user (data (object) or links (object))) The creater of the prospect. Relationship creator cannot be used as a filter.
	Array of data (object) or links (object) (emailAddress) The prospect's email addresses. Relationship emailAddresses cannot be used as a filter.
	Array of data (object) or links (object) (favorite) The prospect's favorites. Relationship favorites cannot be used as a filter.
	Array of links (object) (mailing) The mailings associated with the prospect. Relationship mailings cannot be used as a filter.
	Array of data (object) or links (object) (opportunity) The opportunities associated with the prospect. Requires the Opportunities SKU to be enabled in order to have access. Please contact support@outreach.io for more assistance. You can use only the attribute id to filter prospects by opportunities (e.g. filter[opportunities][id]=X).
	Array of data (object) or links (object) (opportunityProspectRole) The roles that associate the prospect with opportunities. Relationship opportunityProspectRoles cannot be used as a filter.
	data (object) or links (object) (user) The owner of the prospect. You can use only the attribute id to filter prospects by owner (e.g. filter[owner][id]=X).
	data (object) or links (object) (persona) The persona of the prospect, if it has one. You can use only the attribute id to filter prospects by persona (e.g. filter[persona][id]=X).
	Array of data (object) or links (object) (phoneNumber) The prospect's phone numbers Relationship phoneNumbers cannot be used as a filter.
	Array of links (object) (sequenceState) The sequence states where this prospect is the primary recipient. You can use attributes id and state to filter prospects by sequenceStates (e.g. filter[sequenceStates][id]=X).
	data (object) or links (object) (stage) The stage the prospect is in. You can use attributes id and name to filter prospects by stage (e.g. filter[stage][id]=X).
	Array of links (object) (task) The tasks associated with the prospect. Relationship tasks cannot be used as a filter.
	(user (data (object) or links (object))) The most recent updater of the prospect. Relationship updater cannot be used as a filter.

{"account": {"data": {"id": 0,
"type": "account"
}
},
"activeSequenceStates": [{"data": {"id": 0,
"type": "sequenceState"
}
}
],
"batches": [{"links": {"related": "batch"
}
}
],
"calls": [{"links": {"related": "call"
}
}
],
"creator": {"data": {"id": 0,
"type": "user"
}
},
"emailAddresses": [{"data": {"id": 0,
"type": "emailAddress"
}
}
],
"favorites": [{"data": {"id": 0,
"type": "favorite"
}
}
],
"mailings": [{"links": {"related": "mailing"
}
}
],
"opportunities": [{"data": {"id": 0,
"type": "opportunity"
}
}
],
"opportunityProspectRoles": [{"data": {"id": 0,
"type": "opportunityProspectRole"
}
}
],
"owner": {"data": {"id": 0,
"type": "user"
}
},
"persona": {"data": {"id": 0,
"type": "persona"
}
},
"phoneNumbers": [{"data": {"id": 0,
"type": "phoneNumber"
}
}
],
"sequenceStates": [{"links": {"related": "sequenceState"
}
}
],
"stage": {"data": {"id": 0,
"type": "stage"
}
},
"tasks": [{"links": {"related": "task"
}
}
],
"updater": {"data": {"id": 0,
"type": "user"
}
}
}

Prospect Resource Metadata

METADATA NAME	DESCRIPTION	QUERY PARAM
canWrite	A boolean value indicating whether the current API user has write access to this resource.	provideAuthorizationMeta
canDelete	A boolean value indicating whether the current API user has delete access to this resource.	provideAuthorizationMeta
dataConnections	The set of connections a given Prospect has to external sources.	provideDataConnections

⌵ Prospect Actions

Get a Collection of Prospects

SecuritybearerAuth and s2sAuthToken

Responses

200

422

JSON error message

get/prospects

Request samples

curl
JavaScript
Python
Go
Java

Response samples

application/vnd.api+json

{"data": [{"attributes": {"addedAt": "2019-08-24T14:15:22Z",
"addressCity": "string",
"addressCountry": "string",
"addressState": "string",
"addressStreet": "string",
"addressStreet2": "string",
"addressZip": "string",
"angelListUrl": "string",
"availableAt": "2019-08-24T14:15:22Z",
"callOptedOut": true,
"callsOptStatus": "string",
"callsOptedAt": "2019-08-24T14:15:22Z",
"campaignName": "string",
"clickCount": 0,
"company": "string",
"contactHistogram": [null
],
"createdAt": "2019-08-24T14:15:22Z",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"custom25": "string",
"custom26": "string",
"custom27": "string",
"custom28": "string",
"custom29": "string",
"custom30": "string",
"custom31": "string",
"custom32": "string",
"custom33": "string",
"custom34": "string",
"custom35": "string",
"custom36": "string",
"custom37": "string",
"custom38": "string",
"custom39": "string",
"custom40": "string",
"custom41": "string",
"custom42": "string",
"custom43": "string",
"custom44": "string",
"custom45": "string",
"custom46": "string",
"custom47": "string",
"custom48": "string",
"custom49": "string",
"custom50": "string",
"custom51": "string",
"custom52": "string",
"custom53": "string",
"custom54": "string",
"custom55": "string",
"custom56": "string",
"custom57": "string",
"custom58": "string",
"custom59": "string",
"custom60": "string",
"custom61": "string",
"custom62": "string",
"custom63": "string",
"custom64": "string",
"custom65": "string",
"custom66": "string",
"custom67": "string",
"custom68": "string",
"custom69": "string",
"custom70": "string",
"custom71": "string",
"custom72": "string",
"custom73": "string",
"custom74": "string",
"custom75": "string",
"custom76": "string",
"custom77": "string",
"custom78": "string",
"custom79": "string",
"custom80": "string",
"custom81": "string",
"custom82": "string",
"custom83": "string",
"custom84": "string",
"custom85": "string",
"custom86": "string",
"custom87": "string",
"custom88": "string",
"custom89": "string",
"custom90": "string",
"custom91": "string",
"custom92": "string",
"custom93": "string",
"custom94": "string",
"custom95": "string",
"custom96": "string",
"custom97": "string",
"custom98": "string",
"custom99": "string",
"custom100": "string",
"custom101": "string",
"custom102": "string",
"custom103": "string",
"custom104": "string",
"custom105": "string",
"custom106": "string",
"custom107": "string",
"custom108": "string",
"custom109": "string",
"custom110": "string",
"custom111": "string",
"custom112": "string",
"custom113": "string",
"custom114": "string",
"custom115": "string",
"custom116": "string",
"custom117": "string",
"custom118": "string",
"custom119": "string",
"custom120": "string",
"custom121": "string",
"custom122": "string",
"custom123": "string",
"custom124": "string",
"custom125": "string",
"custom126": "string",
"custom127": "string",
"custom128": "string",
"custom129": "string",
"custom130": "string",
"custom131": "string",
"custom132": "string",
"custom133": "string",
"custom134": "string",
"custom135": "string",
"custom136": "string",
"custom137": "string",
"custom138": "string",
"custom139": "string",
"custom140": "string",
"custom141": "string",
"custom142": "string",
"custom143": "string",
"custom144": "string",
"custom145": "string",
"custom146": "string",
"custom147": "string",
"custom148": "string",
"custom149": "string",
"custom150": "string",
"dateOfBirth": "2019-08-24",
"degree": "string",
"emailOptedOut": true,
"emails": ["user@example.com"
],
"emailsOptStatus": "string",
"emailsOptedAt": "2019-08-24T14:15:22Z",
"engagedAt": "2019-08-24T14:15:22Z",
"engagedScore": 0,
"eventName": "string",
"externalId": "string",
"externalOwner": "string",
"externalSource": "string",
"facebookUrl": "string",
"firstName": "string",
"gender": "string",
"githubUrl": "string",
"githubUsername": "string",
"googlePlusUrl": "string",
"graduationDate": "2019-08-24",
"homePhones": ["string"
],
"jobStartDate": "2019-08-24",
"lastName": "string",
"linkedInConnections": 0,
"linkedInId": "string",
"linkedInSlug": "string",
"linkedInUrl": "string",
"middleName": "string",
"mobilePhones": ["string"
],
"name": "string",
"nickname": "string",
"occupation": "string",
"openCount": 0,
"optedOut": true,
"optedOutAt": "2019-08-24T14:15:22Z",
"otherPhones": ["string"
],
"personalNote1": "string",
"personalNote2": "string",
"preferredContact": "string",
"quoraUrl": "string",
"region": "string",
"replyCount": 0,
"school": "string",
"score": 0,
"sharingTeamId": "string",
"source": "string",
"specialties": "string",
"stackOverflowId": "string",
"stackOverflowUrl": "string",
"tags": ["string"
],
"timeZone": "string",
"timeZoneIana": "string",
"timeZoneInferred": "string",
"title": "string",
"touchedAt": "2019-08-24T14:15:22Z",
"trashedAt": "2019-08-24T14:15:22Z",
"twitterUrl": "string",
"twitterUsername": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"voipPhones": ["string"
],
"websiteUrl1": "string",
"websiteUrl2": "string",
"websiteUrl3": "string",
"workPhones": ["string"
]
},
"id": 0,
"relationships": {"account": {"data": {"id": 0,
"type": "account"
}
},
"activeSequenceStates": [{"data": {"id": 0,
"type": "sequenceState"
}
}
],
"batches": [{"links": {"related": "batch"
}
}
],
"calls": [{"links": {"related": "call"
}
}
],
"creator": {"data": {"id": 0,
"type": "user"
}
},
"emailAddresses": [{"data": {"id": 0,
"type": "emailAddress"
}
}
],
"favorites": [{"data": {"id": 0,
"type": "favorite"
}
}
],
"mailings": [{"links": {"related": "mailing"
}
}
],
"opportunities": [{"data": {"id": 0,
"type": "opportunity"
}
}
],
"opportunityProspectRoles": [{"data": {"id": 0,
"type": "opportunityProspectRole"
}
}
],
"owner": {"data": {"id": 0,
"type": "user"
}
},
"persona": {"data": {"id": 0,
"type": "persona"
}
},
"phoneNumbers": [{"data": {"id": 0,
"type": "phoneNumber"
}
}
],
"sequenceStates": [{"links": {"related": "sequenceState"
}
}
],
"stage": {"data": {"id": 0,
"type": "stage"
}
},
"tasks": [{"links": {"related": "task"
}
}
],
"updater": {"data": {"id": 0,
"type": "user"
}
}
},
"type": "string"
}
]
}

Create a New Prospect

SecuritybearerAuth and s2sAuthToken

Request

Request Body schema: application/vnd.api+json
required

object

Responses

201

Created

422

JSON error message

post/prospects

Request samples

application/vnd.api+json

{"data": {"attributes": {"addedAt": "2019-08-24T14:15:22Z",
"addressCity": "string",
"addressCountry": "string",
"addressState": "string",
"addressStreet": "string",
"addressStreet2": "string",
"addressZip": "string",
"angelListUrl": "string",
"availableAt": "2019-08-24T14:15:22Z",
"callOptedOut": true,
"callsOptStatus": "string",
"callsOptedAt": "2019-08-24T14:15:22Z",
"campaignName": "string",
"clickCount": 0,
"company": "string",
"contactHistogram": [null
],
"createdAt": "2019-08-24T14:15:22Z",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"custom25": "string",
"custom26": "string",
"custom27": "string",
"custom28": "string",
"custom29": "string",
"custom30": "string",
"custom31": "string",
"custom32": "string",
"custom33": "string",
"custom34": "string",
"custom35": "string",
"custom36": "string",
"custom37": "string",
"custom38": "string",
"custom39": "string",
"custom40": "string",
"custom41": "string",
"custom42": "string",
"custom43": "string",
"custom44": "string",
"custom45": "string",
"custom46": "string",
"custom47": "string",
"custom48": "string",
"custom49": "string",
"custom50": "string",
"custom51": "string",
"custom52": "string",
"custom53": "string",
"custom54": "string",
"custom55": "string",
"custom56": "string",
"custom57": "string",
"custom58": "string",
"custom59": "string",
"custom60": "string",
"custom61": "string",
"custom62": "string",
"custom63": "string",
"custom64": "string",
"custom65": "string",
"custom66": "string",
"custom67": "string",
"custom68": "string",
"custom69": "string",
"custom70": "string",
"custom71": "string",
"custom72": "string",
"custom73": "string",
"custom74": "string",
"custom75": "string",
"custom76": "string",
"custom77": "string",
"custom78": "string",
"custom79": "string",
"custom80": "string",
"custom81": "string",
"custom82": "string",
"custom83": "string",
"custom84": "string",
"custom85": "string",
"custom86": "string",
"custom87": "string",
"custom88": "string",
"custom89": "string",
"custom90": "string",
"custom91": "string",
"custom92": "string",
"custom93": "string",
"custom94": "string",
"custom95": "string",
"custom96": "string",
"custom97": "string",
"custom98": "string",
"custom99": "string",
"custom100": "string",
"custom101": "string",
"custom102": "string",
"custom103": "string",
"custom104": "string",
"custom105": "string",
"custom106": "string",
"custom107": "string",
"custom108": "string",
"custom109": "string",
"custom110": "string",
"custom111": "string",
"custom112": "string",
"custom113": "string",
"custom114": "string",
"custom115": "string",
"custom116": "string",
"custom117": "string",
"custom118": "string",
"custom119": "string",
"custom120": "string",
"custom121": "string",
"custom122": "string",
"custom123": "string",
"custom124": "string",
"custom125": "string",
"custom126": "string",
"custom127": "string",
"custom128": "string",
"custom129": "string",
"custom130": "string",
"custom131": "string",
"custom132": "string",
"custom133": "string",
"custom134": "string",
"custom135": "string",
"custom136": "string",
"custom137": "string",
"custom138": "string",
"custom139": "string",
"custom140": "string",
"custom141": "string",
"custom142": "string",
"custom143": "string",
"custom144": "string",
"custom145": "string",
"custom146": "string",
"custom147": "string",
"custom148": "string",
"custom149": "string",
"custom150": "string",
"dateOfBirth": "2019-08-24",
"degree": "string",
"emailOptedOut": true,
"emails": ["user@example.com"
],
"emailsOptStatus": "string",
"emailsOptedAt": "2019-08-24T14:15:22Z",
"engagedAt": "2019-08-24T14:15:22Z",
"engagedScore": 0,
"eventName": "string",
"externalId": "string",
"externalOwner": "string",
"externalSource": "string",
"facebookUrl": "string",
"firstName": "string",
"gender": "string",
"githubUrl": "string",
"githubUsername": "string",
"googlePlusUrl": "string",
"graduationDate": "2019-08-24",
"homePhones": ["string"
],
"jobStartDate": "2019-08-24",
"lastName": "string",
"linkedInConnections": 0,
"linkedInId": "string",
"linkedInSlug": "string",
"linkedInUrl": "string",
"middleName": "string",
"mobilePhones": ["string"
],
"name": "string",
"nickname": "string",
"occupation": "string",
"openCount": 0,
"optedOut": true,
"optedOutAt": "2019-08-24T14:15:22Z",
"otherPhones": ["string"
],
"personalNote1": "string",
"personalNote2": "string",
"preferredContact": "string",
"quoraUrl": "string",
"region": "string",
"replyCount": 0,
"school": "string",
"score": 0,
"sharingTeamId": "string",
"source": "string",
"specialties": "string",
"stackOverflowId": "string",
"stackOverflowUrl": "string",
"tags": ["string"
],
"timeZone": "string",
"timeZoneIana": "string",
"timeZoneInferred": "string",
"title": "string",
"touchedAt": "2019-08-24T14:15:22Z",
"trashedAt": "2019-08-24T14:15:22Z",
"twitterUrl": "string",
"twitterUsername": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"voipPhones": ["string"
],
"websiteUrl1": "string",
"websiteUrl2": "string",
"websiteUrl3": "string",
"workPhones": ["string"
]
},
"relationships": {"account": {"data": {"id": 0,
"type": "account"
}
},
"activeSequenceStates": [{"data": {"id": 0,
"type": "sequenceState"
}
}
],
"batches": [{"links": {"related": "batch"
}
}
],
"calls": [{"links": {"related": "call"
}
}
],
"creator": {"data": {"id": 0,
"type": "user"
}
},
"emailAddresses": [{"data": {"id": 0,
"type": "emailAddress"
}
}
],
"favorites": [{"data": {"id": 0,
"type": "favorite"
}
}
],
"mailings": [{"links": {"related": "mailing"
}
}
],
"opportunities": [{"data": {"id": 0,
"type": "opportunity"
}
}
],
"opportunityProspectRoles": [{"data": {"id": 0,
"type": "opportunityProspectRole"
}
}
],
"owner": {"data": {"id": 0,
"type": "user"
}
},
"persona": {"data": {"id": 0,
"type": "persona"
}
},
"phoneNumbers": [{"data": {"id": 0,
"type": "phoneNumber"
}
}
],
"sequenceStates": [{"links": {"related": "sequenceState"
}
}
],
"stage": {"data": {"id": 0,
"type": "stage"
}
},
"tasks": [{"links": {"related": "task"
}
}
],
"updater": {"data": {"id": 0,
"type": "user"
}
}
},
"type": "string"
}
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"addedAt": "2019-08-24T14:15:22Z",
"addressCity": "string",
"addressCountry": "string",
"addressState": "string",
"addressStreet": "string",
"addressStreet2": "string",
"addressZip": "string",
"angelListUrl": "string",
"availableAt": "2019-08-24T14:15:22Z",
"callOptedOut": true,
"callsOptStatus": "string",
"callsOptedAt": "2019-08-24T14:15:22Z",
"campaignName": "string",
"clickCount": 0,
"company": "string",
"contactHistogram": [null
],
"createdAt": "2019-08-24T14:15:22Z",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"custom25": "string",
"custom26": "string",
"custom27": "string",
"custom28": "string",
"custom29": "string",
"custom30": "string",
"custom31": "string",
"custom32": "string",
"custom33": "string",
"custom34": "string",
"custom35": "string",
"custom36": "string",
"custom37": "string",
"custom38": "string",
"custom39": "string",
"custom40": "string",
"custom41": "string",
"custom42": "string",
"custom43": "string",
"custom44": "string",
"custom45": "string",
"custom46": "string",
"custom47": "string",
"custom48": "string",
"custom49": "string",
"custom50": "string",
"custom51": "string",
"custom52": "string",
"custom53": "string",
"custom54": "string",
"custom55": "string",
"custom56": "string",
"custom57": "string",
"custom58": "string",
"custom59": "string",
"custom60": "string",
"custom61": "string",
"custom62": "string",
"custom63": "string",
"custom64": "string",
"custom65": "string",
"custom66": "string",
"custom67": "string",
"custom68": "string",
"custom69": "string",
"custom70": "string",
"custom71": "string",
"custom72": "string",
"custom73": "string",
"custom74": "string",
"custom75": "string",
"custom76": "string",
"custom77": "string",
"custom78": "string",
"custom79": "string",
"custom80": "string",
"custom81": "string",
"custom82": "string",
"custom83": "string",
"custom84": "string",
"custom85": "string",
"custom86": "string",
"custom87": "string",
"custom88": "string",
"custom89": "string",
"custom90": "string",
"custom91": "string",
"custom92": "string",
"custom93": "string",
"custom94": "string",
"custom95": "string",
"custom96": "string",
"custom97": "string",
"custom98": "string",
"custom99": "string",
"custom100": "string",
"custom101": "string",
"custom102": "string",
"custom103": "string",
"custom104": "string",
"custom105": "string",
"custom106": "string",
"custom107": "string",
"custom108": "string",
"custom109": "string",
"custom110": "string",
"custom111": "string",
"custom112": "string",
"custom113": "string",
"custom114": "string",
"custom115": "string",
"custom116": "string",
"custom117": "string",
"custom118": "string",
"custom119": "string",
"custom120": "string",
"custom121": "string",
"custom122": "string",
"custom123": "string",
"custom124": "string",
"custom125": "string",
"custom126": "string",
"custom127": "string",
"custom128": "string",
"custom129": "string",
"custom130": "string",
"custom131": "string",
"custom132": "string",
"custom133": "string",
"custom134": "string",
"custom135": "string",
"custom136": "string",
"custom137": "string",
"custom138": "string",
"custom139": "string",
"custom140": "string",
"custom141": "string",
"custom142": "string",
"custom143": "string",
"custom144": "string",
"custom145": "string",
"custom146": "string",
"custom147": "string",
"custom148": "string",
"custom149": "string",
"custom150": "string",
"dateOfBirth": "2019-08-24",
"degree": "string",
"emailOptedOut": true,
"emails": ["user@example.com"
],
"emailsOptStatus": "string",
"emailsOptedAt": "2019-08-24T14:15:22Z",
"engagedAt": "2019-08-24T14:15:22Z",
"engagedScore": 0,
"eventName": "string",
"externalId": "string",
"externalOwner": "string",
"externalSource": "string",
"facebookUrl": "string",
"firstName": "string",
"gender": "string",
"githubUrl": "string",
"githubUsername": "string",
"googlePlusUrl": "string",
"graduationDate": "2019-08-24",
"homePhones": ["string"
],
"jobStartDate": "2019-08-24",
"lastName": "string",
"linkedInConnections": 0,
"linkedInId": "string",
"linkedInSlug": "string",
"linkedInUrl": "string",
"middleName": "string",
"mobilePhones": ["string"
],
"name": "string",
"nickname": "string",
"occupation": "string",
"openCount": 0,
"optedOut": true,
"optedOutAt": "2019-08-24T14:15:22Z",
"otherPhones": ["string"
],
"personalNote1": "string",
"personalNote2": "string",
"preferredContact": "string",
"quoraUrl": "string",
"region": "string",
"replyCount": 0,
"school": "string",
"score": 0,
"sharingTeamId": "string",
"source": "string",
"specialties": "string",
"stackOverflowId": "string",
"stackOverflowUrl": "string",
"tags": ["string"
],
"timeZone": "string",
"timeZoneIana": "string",
"timeZoneInferred": "string",
"title": "string",
"touchedAt": "2019-08-24T14:15:22Z",
"trashedAt": "2019-08-24T14:15:22Z",
"twitterUrl": "string",
"twitterUsername": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"voipPhones": ["string"
],
"websiteUrl1": "string",
"websiteUrl2": "string",
"websiteUrl3": "string",
"workPhones": ["string"
]
},
"id": 0,
"relationships": {"account": {"data": {"id": 0,
"type": "account"
}
},
"activeSequenceStates": [{"data": {"id": 0,
"type": "sequenceState"
}
}
],
"batches": [{"links": {"related": "batch"
}
}
],
"calls": [{"links": {"related": "call"
}
}
],
"creator": {"data": {"id": 0,
"type": "user"
}
},
"emailAddresses": [{"data": {"id": 0,
"type": "emailAddress"
}
}
],
"favorites": [{"data": {"id": 0,
"type": "favorite"
}
}
],
"mailings": [{"links": {"related": "mailing"
}
}
],
"opportunities": [{"data": {"id": 0,
"type": "opportunity"
}
}
],
"opportunityProspectRoles": [{"data": {"id": 0,
"type": "opportunityProspectRole"
}
}
],
"owner": {"data": {"id": 0,
"type": "user"
}
},
"persona": {"data": {"id": 0,
"type": "persona"
}
},
"phoneNumbers": [{"data": {"id": 0,
"type": "phoneNumber"
}
}
],
"sequenceStates": [{"links": {"related": "sequenceState"
}
}
],
"stage": {"data": {"id": 0,
"type": "stage"
}
},
"tasks": [{"links": {"related": "task"
}
}
],
"updater": {"data": {"id": 0,
"type": "user"
}
}
},
"type": "string"
}
}

Delete an Existing Prospect by ID

SecuritybearerAuth and s2sAuthToken

Request

path Parameters

required

integer

Responses

204

Deleted

422

JSON error message

delete/prospects/{id}

Request samples

curl
JavaScript
Python
Go
Java

Response samples

application/vnd.api+json

{"errors": [{"detail": "string",
"id": "string",
"title": "string"
}
]
}

Get a Prospect by ID

SecuritybearerAuth and s2sAuthToken

Request

path Parameters

required

integer

Responses

200

404

Not Found

get/prospects/{id}

Request samples

curl
JavaScript
Python
Go
Java

Response samples

application/vnd.api+json

{"data": {"attributes": {"addedAt": "2019-08-24T14:15:22Z",
"addressCity": "string",
"addressCountry": "string",
"addressState": "string",
"addressStreet": "string",
"addressStreet2": "string",
"addressZip": "string",
"angelListUrl": "string",
"availableAt": "2019-08-24T14:15:22Z",
"callOptedOut": true,
"callsOptStatus": "string",
"callsOptedAt": "2019-08-24T14:15:22Z",
"campaignName": "string",
"clickCount": 0,
"company": "string",
"contactHistogram": [null
],
"createdAt": "2019-08-24T14:15:22Z",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"custom25": "string",
"custom26": "string",
"custom27": "string",
"custom28": "string",
"custom29": "string",
"custom30": "string",
"custom31": "string",
"custom32": "string",
"custom33": "string",
"custom34": "string",
"custom35": "string",
"custom36": "string",
"custom37": "string",
"custom38": "string",
"custom39": "string",
"custom40": "string",
"custom41": "string",
"custom42": "string",
"custom43": "string",
"custom44": "string",
"custom45": "string",
"custom46": "string",
"custom47": "string",
"custom48": "string",
"custom49": "string",
"custom50": "string",
"custom51": "string",
"custom52": "string",
"custom53": "string",
"custom54": "string",
"custom55": "string",
"custom56": "string",
"custom57": "string",
"custom58": "string",
"custom59": "string",
"custom60": "string",
"custom61": "string",
"custom62": "string",
"custom63": "string",
"custom64": "string",
"custom65": "string",
"custom66": "string",
"custom67": "string",
"custom68": "string",
"custom69": "string",
"custom70": "string",
"custom71": "string",
"custom72": "string",
"custom73": "string",
"custom74": "string",
"custom75": "string",
"custom76": "string",
"custom77": "string",
"custom78": "string",
"custom79": "string",
"custom80": "string",
"custom81": "string",
"custom82": "string",
"custom83": "string",
"custom84": "string",
"custom85": "string",
"custom86": "string",
"custom87": "string",
"custom88": "string",
"custom89": "string",
"custom90": "string",
"custom91": "string",
"custom92": "string",
"custom93": "string",
"custom94": "string",
"custom95": "string",
"custom96": "string",
"custom97": "string",
"custom98": "string",
"custom99": "string",
"custom100": "string",
"custom101": "string",
"custom102": "string",
"custom103": "string",
"custom104": "string",
"custom105": "string",
"custom106": "string",
"custom107": "string",
"custom108": "string",
"custom109": "string",
"custom110": "string",
"custom111": "string",
"custom112": "string",
"custom113": "string",
"custom114": "string",
"custom115": "string",
"custom116": "string",
"custom117": "string",
"custom118": "string",
"custom119": "string",
"custom120": "string",
"custom121": "string",
"custom122": "string",
"custom123": "string",
"custom124": "string",
"custom125": "string",
"custom126": "string",
"custom127": "string",
"custom128": "string",
"custom129": "string",
"custom130": "string",
"custom131": "string",
"custom132": "string",
"custom133": "string",
"custom134": "string",
"custom135": "string",
"custom136": "string",
"custom137": "string",
"custom138": "string",
"custom139": "string",
"custom140": "string",
"custom141": "string",
"custom142": "string",
"custom143": "string",
"custom144": "string",
"custom145": "string",
"custom146": "string",
"custom147": "string",
"custom148": "string",
"custom149": "string",
"custom150": "string",
"dateOfBirth": "2019-08-24",
"degree": "string",
"emailOptedOut": true,
"emails": ["user@example.com"
],
"emailsOptStatus": "string",
"emailsOptedAt": "2019-08-24T14:15:22Z",
"engagedAt": "2019-08-24T14:15:22Z",
"engagedScore": 0,
"eventName": "string",
"externalId": "string",
"externalOwner": "string",
"externalSource": "string",
"facebookUrl": "string",
"firstName": "string",
"gender": "string",
"githubUrl": "string",
"githubUsername": "string",
"googlePlusUrl": "string",
"graduationDate": "2019-08-24",
"homePhones": ["string"
],
"jobStartDate": "2019-08-24",
"lastName": "string",
"linkedInConnections": 0,
"linkedInId": "string",
"linkedInSlug": "string",
"linkedInUrl": "string",
"middleName": "string",
"mobilePhones": ["string"
],
"name": "string",
"nickname": "string",
"occupation": "string",
"openCount": 0,
"optedOut": true,
"optedOutAt": "2019-08-24T14:15:22Z",
"otherPhones": ["string"
],
"personalNote1": "string",
"personalNote2": "string",
"preferredContact": "string",
"quoraUrl": "string",
"region": "string",
"replyCount": 0,
"school": "string",
"score": 0,
"sharingTeamId": "string",
"source": "string",
"specialties": "string",
"stackOverflowId": "string",
"stackOverflowUrl": "string",
"tags": ["string"
],
"timeZone": "string",
"timeZoneIana": "string",
"timeZoneInferred": "string",
"title": "string",
"touchedAt": "2019-08-24T14:15:22Z",
"trashedAt": "2019-08-24T14:15:22Z",
"twitterUrl": "string",
"twitterUsername": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"voipPhones": ["string"
],
"websiteUrl1": "string",
"websiteUrl2": "string",
"websiteUrl3": "string",
"workPhones": ["string"
]
},
"id": 0,
"relationships": {"account": {"data": {"id": 0,
"type": "account"
}
},
"activeSequenceStates": [{"data": {"id": 0,
"type": "sequenceState"
}
}
],
"batches": [{"links": {"related": "batch"
}
}
],
"calls": [{"links": {"related": "call"
}
}
],
"creator": {"data": {"id": 0,
"type": "user"
}
},
"emailAddresses": [{"data": {"id": 0,
"type": "emailAddress"
}
}
],
"favorites": [{"data": {"id": 0,
"type": "favorite"
}
}
],
"mailings": [{"links": {"related": "mailing"
}
}
],
"opportunities": [{"data": {"id": 0,
"type": "opportunity"
}
}
],
"opportunityProspectRoles": [{"data": {"id": 0,
"type": "opportunityProspectRole"
}
}
],
"owner": {"data": {"id": 0,
"type": "user"
}
},
"persona": {"data": {"id": 0,
"type": "persona"
}
},
"phoneNumbers": [{"data": {"id": 0,
"type": "phoneNumber"
}
}
],
"sequenceStates": [{"links": {"related": "sequenceState"
}
}
],
"stage": {"data": {"id": 0,
"type": "stage"
}
},
"tasks": [{"links": {"related": "task"
}
}
],
"updater": {"data": {"id": 0,
"type": "user"
}
}
},
"type": "string"
}
}

Update a Prospect

SecuritybearerAuth and s2sAuthToken

Request

path Parameters

required

integer

Request Body schema: application/vnd.api+json
required

object

Responses

200

422

JSON error message

patch/prospects/{id}

Request samples

application/vnd.api+json

{"data": {"attributes": {"addedAt": "2019-08-24T14:15:22Z",
"addressCity": "string",
"addressCountry": "string",
"addressState": "string",
"addressStreet": "string",
"addressStreet2": "string",
"addressZip": "string",
"angelListUrl": "string",
"availableAt": "2019-08-24T14:15:22Z",
"callOptedOut": true,
"callsOptStatus": "string",
"callsOptedAt": "2019-08-24T14:15:22Z",
"campaignName": "string",
"clickCount": 0,
"company": "string",
"contactHistogram": [null
],
"createdAt": "2019-08-24T14:15:22Z",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"custom25": "string",
"custom26": "string",
"custom27": "string",
"custom28": "string",
"custom29": "string",
"custom30": "string",
"custom31": "string",
"custom32": "string",
"custom33": "string",
"custom34": "string",
"custom35": "string",
"custom36": "string",
"custom37": "string",
"custom38": "string",
"custom39": "string",
"custom40": "string",
"custom41": "string",
"custom42": "string",
"custom43": "string",
"custom44": "string",
"custom45": "string",
"custom46": "string",
"custom47": "string",
"custom48": "string",
"custom49": "string",
"custom50": "string",
"custom51": "string",
"custom52": "string",
"custom53": "string",
"custom54": "string",
"custom55": "string",
"custom56": "string",
"custom57": "string",
"custom58": "string",
"custom59": "string",
"custom60": "string",
"custom61": "string",
"custom62": "string",
"custom63": "string",
"custom64": "string",
"custom65": "string",
"custom66": "string",
"custom67": "string",
"custom68": "string",
"custom69": "string",
"custom70": "string",
"custom71": "string",
"custom72": "string",
"custom73": "string",
"custom74": "string",
"custom75": "string",
"custom76": "string",
"custom77": "string",
"custom78": "string",
"custom79": "string",
"custom80": "string",
"custom81": "string",
"custom82": "string",
"custom83": "string",
"custom84": "string",
"custom85": "string",
"custom86": "string",
"custom87": "string",
"custom88": "string",
"custom89": "string",
"custom90": "string",
"custom91": "string",
"custom92": "string",
"custom93": "string",
"custom94": "string",
"custom95": "string",
"custom96": "string",
"custom97": "string",
"custom98": "string",
"custom99": "string",
"custom100": "string",
"custom101": "string",
"custom102": "string",
"custom103": "string",
"custom104": "string",
"custom105": "string",
"custom106": "string",
"custom107": "string",
"custom108": "string",
"custom109": "string",
"custom110": "string",
"custom111": "string",
"custom112": "string",
"custom113": "string",
"custom114": "string",
"custom115": "string",
"custom116": "string",
"custom117": "string",
"custom118": "string",
"custom119": "string",
"custom120": "string",
"custom121": "string",
"custom122": "string",
"custom123": "string",
"custom124": "string",
"custom125": "string",
"custom126": "string",
"custom127": "string",
"custom128": "string",
"custom129": "string",
"custom130": "string",
"custom131": "string",
"custom132": "string",
"custom133": "string",
"custom134": "string",
"custom135": "string",
"custom136": "string",
"custom137": "string",
"custom138": "string",
"custom139": "string",
"custom140": "string",
"custom141": "string",
"custom142": "string",
"custom143": "string",
"custom144": "string",
"custom145": "string",
"custom146": "string",
"custom147": "string",
"custom148": "string",
"custom149": "string",
"custom150": "string",
"dateOfBirth": "2019-08-24",
"degree": "string",
"emailOptedOut": true,
"emails": ["user@example.com"
],
"emailsOptStatus": "string",
"emailsOptedAt": "2019-08-24T14:15:22Z",
"engagedAt": "2019-08-24T14:15:22Z",
"engagedScore": 0,
"eventName": "string",
"externalId": "string",
"externalOwner": "string",
"externalSource": "string",
"facebookUrl": "string",
"firstName": "string",
"gender": "string",
"githubUrl": "string",
"githubUsername": "string",
"googlePlusUrl": "string",
"graduationDate": "2019-08-24",
"homePhones": ["string"
],
"jobStartDate": "2019-08-24",
"lastName": "string",
"linkedInConnections": 0,
"linkedInId": "string",
"linkedInSlug": "string",
"linkedInUrl": "string",
"middleName": "string",
"mobilePhones": ["string"
],
"name": "string",
"nickname": "string",
"occupation": "string",
"openCount": 0,
"optedOut": true,
"optedOutAt": "2019-08-24T14:15:22Z",
"otherPhones": ["string"
],
"personalNote1": "string",
"personalNote2": "string",
"preferredContact": "string",
"quoraUrl": "string",
"region": "string",
"replyCount": 0,
"school": "string",
"score": 0,
"sharingTeamId": "string",
"source": "string",
"specialties": "string",
"stackOverflowId": "string",
"stackOverflowUrl": "string",
"tags": ["string"
],
"timeZone": "string",
"timeZoneIana": "string",
"timeZoneInferred": "string",
"title": "string",
"touchedAt": "2019-08-24T14:15:22Z",
"trashedAt": "2019-08-24T14:15:22Z",
"twitterUrl": "string",
"twitterUsername": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"voipPhones": ["string"
],
"websiteUrl1": "string",
"websiteUrl2": "string",
"websiteUrl3": "string",
"workPhones": ["string"
]
},
"id": 0,
"relationships": {"account": {"data": {"id": 0,
"type": "account"
}
},
"activeSequenceStates": [{"data": {"id": 0,
"type": "sequenceState"
}
}
],
"batches": [{"links": {"related": "batch"
}
}
],
"calls": [{"links": {"related": "call"
}
}
],
"creator": {"data": {"id": 0,
"type": "user"
}
},
"emailAddresses": [{"data": {"id": 0,
"type": "emailAddress"
}
}
],
"favorites": [{"data": {"id": 0,
"type": "favorite"
}
}
],
"mailings": [{"links": {"related": "mailing"
}
}
],
"opportunities": [{"data": {"id": 0,
"type": "opportunity"
}
}
],
"opportunityProspectRoles": [{"data": {"id": 0,
"type": "opportunityProspectRole"
}
}
],
"owner": {"data": {"id": 0,
"type": "user"
}
},
"persona": {"data": {"id": 0,
"type": "persona"
}
},
"phoneNumbers": [{"data": {"id": 0,
"type": "phoneNumber"
}
}
],
"sequenceStates": [{"links": {"related": "sequenceState"
}
}
],
"stage": {"data": {"id": 0,
"type": "stage"
}
},
"tasks": [{"links": {"related": "task"
}
}
],
"updater": {"data": {"id": 0,
"type": "user"
}
}
},
"type": "string"
}
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"addedAt": "2019-08-24T14:15:22Z",
"addressCity": "string",
"addressCountry": "string",
"addressState": "string",
"addressStreet": "string",
"addressStreet2": "string",
"addressZip": "string",
"angelListUrl": "string",
"availableAt": "2019-08-24T14:15:22Z",
"callOptedOut": true,
"callsOptStatus": "string",
"callsOptedAt": "2019-08-24T14:15:22Z",
"campaignName": "string",
"clickCount": 0,
"company": "string",
"contactHistogram": [null
],
"createdAt": "2019-08-24T14:15:22Z",
"custom1": "string",
"custom2": "string",
"custom3": "string",
"custom4": "string",
"custom5": "string",
"custom6": "string",
"custom7": "string",
"custom8": "string",
"custom9": "string",
"custom10": "string",
"custom11": "string",
"custom12": "string",
"custom13": "string",
"custom14": "string",
"custom15": "string",
"custom16": "string",
"custom17": "string",
"custom18": "string",
"custom19": "string",
"custom20": "string",
"custom21": "string",
"custom22": "string",
"custom23": "string",
"custom24": "string",
"custom25": "string",
"custom26": "string",
"custom27": "string",
"custom28": "string",
"custom29": "string",
"custom30": "string",
"custom31": "string",
"custom32": "string",
"custom33": "string",
"custom34": "string",
"custom35": "string",
"custom36": "string",
"custom37": "string",
"custom38": "string",
"custom39": "string",
"custom40": "string",
"custom41": "string",
"custom42": "string",
"custom43": "string",
"custom44": "string",
"custom45": "string",
"custom46": "string",
"custom47": "string",
"custom48": "string",
"custom49": "string",
"custom50": "string",
"custom51": "string",
"custom52": "string",
"custom53": "string",
"custom54": "string",
"custom55": "string",
"custom56": "string",
"custom57": "string",
"custom58": "string",
"custom59": "string",
"custom60": "string",
"custom61": "string",
"custom62": "string",
"custom63": "string",
"custom64": "string",
"custom65": "string",
"custom66": "string",
"custom67": "string",
"custom68": "string",
"custom69": "string",
"custom70": "string",
"custom71": "string",
"custom72": "string",
"custom73": "string",
"custom74": "string",
"custom75": "string",
"custom76": "string",
"custom77": "string",
"custom78": "string",
"custom79": "string",
"custom80": "string",
"custom81": "string",
"custom82": "string",
"custom83": "string",
"custom84": "string",
"custom85": "string",
"custom86": "string",
"custom87": "string",
"custom88": "string",
"custom89": "string",
"custom90": "string",
"custom91": "string",
"custom92": "string",
"custom93": "string",
"custom94": "string",
"custom95": "string",
"custom96": "string",
"custom97": "string",
"custom98": "string",
"custom99": "string",
"custom100": "string",
"custom101": "string",
"custom102": "string",
"custom103": "string",
"custom104": "string",
"custom105": "string",
"custom106": "string",
"custom107": "string",
"custom108": "string",
"custom109": "string",
"custom110": "string",
"custom111": "string",
"custom112": "string",
"custom113": "string",
"custom114": "string",
"custom115": "string",
"custom116": "string",
"custom117": "string",
"custom118": "string",
"custom119": "string",
"custom120": "string",
"custom121": "string",
"custom122": "string",
"custom123": "string",
"custom124": "string",
"custom125": "string",
"custom126": "string",
"custom127": "string",
"custom128": "string",
"custom129": "string",
"custom130": "string",
"custom131": "string",
"custom132": "string",
"custom133": "string",
"custom134": "string",
"custom135": "string",
"custom136": "string",
"custom137": "string",
"custom138": "string",
"custom139": "string",
"custom140": "string",
"custom141": "string",
"custom142": "string",
"custom143": "string",
"custom144": "string",
"custom145": "string",
"custom146": "string",
"custom147": "string",
"custom148": "string",
"custom149": "string",
"custom150": "string",
"dateOfBirth": "2019-08-24",
"degree": "string",
"emailOptedOut": true,
"emails": ["user@example.com"
],
"emailsOptStatus": "string",
"emailsOptedAt": "2019-08-24T14:15:22Z",
"engagedAt": "2019-08-24T14:15:22Z",
"engagedScore": 0,
"eventName": "string",
"externalId": "string",
"externalOwner": "string",
"externalSource": "string",
"facebookUrl": "string",
"firstName": "string",
"gender": "string",
"githubUrl": "string",
"githubUsername": "string",
"googlePlusUrl": "string",
"graduationDate": "2019-08-24",
"homePhones": ["string"
],
"jobStartDate": "2019-08-24",
"lastName": "string",
"linkedInConnections": 0,
"linkedInId": "string",
"linkedInSlug": "string",
"linkedInUrl": "string",
"middleName": "string",
"mobilePhones": ["string"
],
"name": "string",
"nickname": "string",
"occupation": "string",
"openCount": 0,
"optedOut": true,
"optedOutAt": "2019-08-24T14:15:22Z",
"otherPhones": ["string"
],
"personalNote1": "string",
"personalNote2": "string",
"preferredContact": "string",
"quoraUrl": "string",
"region": "string",
"replyCount": 0,
"school": "string",
"score": 0,
"sharingTeamId": "string",
"source": "string",
"specialties": "string",
"stackOverflowId": "string",
"stackOverflowUrl": "string",
"tags": ["string"
],
"timeZone": "string",
"timeZoneIana": "string",
"timeZoneInferred": "string",
"title": "string",
"touchedAt": "2019-08-24T14:15:22Z",
"trashedAt": "2019-08-24T14:15:22Z",
"twitterUrl": "string",
"twitterUsername": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"voipPhones": ["string"
],
"websiteUrl1": "string",
"websiteUrl2": "string",
"websiteUrl3": "string",
"workPhones": ["string"
]
},
"id": 0,
"relationships": {"account": {"data": {"id": 0,
"type": "account"
}
},
"activeSequenceStates": [{"data": {"id": 0,
"type": "sequenceState"
}
}
],
"batches": [{"links": {"related": "batch"
}
}
],
"calls": [{"links": {"related": "call"
}
}
],
"creator": {"data": {"id": 0,
"type": "user"
}
},
"emailAddresses": [{"data": {"id": 0,
"type": "emailAddress"
}
}
],
"favorites": [{"data": {"id": 0,
"type": "favorite"
}
}
],
"mailings": [{"links": {"related": "mailing"
}
}
],
"opportunities": [{"data": {"id": 0,
"type": "opportunity"
}
}
],
"opportunityProspectRoles": [{"data": {"id": 0,
"type": "opportunityProspectRole"
}
}
],
"owner": {"data": {"id": 0,
"type": "user"
}
},
"persona": {"data": {"id": 0,
"type": "persona"
}
},
"phoneNumbers": [{"data": {"id": 0,
"type": "phoneNumber"
}
}
],
"sequenceStates": [{"links": {"related": "sequenceState"
}
}
],
"stage": {"data": {"id": 0,
"type": "stage"
}
},
"tasks": [{"links": {"related": "task"
}
}
],
"updater": {"data": {"id": 0,
"type": "user"
}
}
},
"type": "string"
}
}

Prospect

Prospect Relationships

Prospect Resource Metadata

⌵ Prospect Actions

Get a Collection of Prospects

Create a New Prospect

Request Body schema: application/vnd.api+jsonrequired

Delete an Existing Prospect by ID

path Parameters

Get a Prospect by ID

path Parameters

Update a Prospect

path Parameters

Request Body schema: application/vnd.api+jsonrequired

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required