Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.
Get the Follow-ups card for a lead
GET
/api/v1/follow-ups/by-lead/{leadId}
const url = 'https://api.pitch2sale.com/api/v1/follow-ups/by-lead/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.pitch2sale.com/api/v1/follow-ups/by-lead/example \ --header 'Authorization: Bearer <token>'The lead’s open or snoozed card, or null when there is none or you may not see it. Another rep’s draft is never returned.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”leadId
required
string
Responses
Section titled “Responses”The card or null
Media typeapplication/json
object
item
required
Any of:
object
id
required
string
status
required
string
lead
required
object
id
required
string
name
required
string
avatar_url
required
string | null
reason_kind
required
string
reason_text
required
string
layer
required
string
suggested_channel
required
string
primary_action
required
string
compliance
required
draft
required
own
required
boolean
send_uncertain
required
boolean
attempt_number
required
number
due_since
required
string
snoozed_until
required
string | null
null
Example
{ "item": { "layer": "A", "draft_channel": "email", "compliance": { "mode": "send" } }}Validation failed
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Authentication required or token invalid
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Role permission or token scope missing; OAuth app tokens are not accepted on this route
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Rate limit exceeded
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}