Skip to main content
GET
Lister les prospects

Authorizations

Authorization
string
header
required

Token API généré depuis votre espace de travail Setteo.

Query Parameters

name
string

Recherche partielle, insensible à la casse, dans le nom complet.

Maximum string length: 255
email
string

Recherche partielle, insensible à la casse, dans l’adresse e-mail.

Maximum string length: 255
phone
string

Recherche partielle, insensible à la casse, dans le numéro de téléphone.

Maximum string length: 255
username
string

Recherche partielle, insensible à la casse, dans le nom d’utilisateur.

Maximum string length: 255
tag_ids[]
integer[]

Filtre les prospects associés à au moins un des tags indiqués. Répétez le paramètre avec la syntaxe tag_ids[]=1&tag_ids[]=2. Chaque identifiant doit être unique et appartenir au tenant.

exclude_tag_ids[]
integer[]

Exclut les prospects associés à au moins un des tags indiqués. Chaque identifiant doit être unique et appartenir au tenant.

last_inbound_after
string<date-time>

Inclut les prospects dont le dernier message entrant est postérieur ou égal à cette date.

last_inbound_before
string<date-time>

Inclut les prospects dont le dernier message entrant est antérieur ou égal à cette date.

last_outbound_after
string<date-time>

Inclut les prospects dont le dernier message sortant est postérieur ou égal à cette date.

last_outbound_before
string<date-time>

Inclut les prospects dont le dernier message sortant est antérieur ou égal à cette date.

source
enum<string>

Filtre par source exacte.

Available options:
webhook,
instagram,
whatsapp,
import,
api,
iclosed,
calendly
warmth
enum<string>

Filtre par niveau d’intérêt exact.

Available options:
cold,
warm,
hot
pipeline_stage
enum<string>

Filtre par étape exacte du pipeline.

Available options:
new,
contacted,
engaged,
qualified,
call_booked,
won,
lost
is_optout
enum<integer>

Filtre par statut de désinscription : 1 pour les prospects désinscrits, 0 pour les prospects inscrits.

Available options:
0,
1
occupation_status
enum<string>

Filtre par situation professionnelle exacte.

Available options:
employee,
self_employed,
business_owner,
student,
retired,
unemployed,
other
maturity_level
enum<string>

Filtre par niveau de maturité exact.

Available options:
beginner,
intermediate,
advanced
engagement_level
enum<string>

Filtre par niveau d’engagement exact.

Available options:
low,
medium,
high
is_lost
enum<integer>

Filtre par statut de perte : 1 pour les prospects perdus, 0 pour les autres.

Available options:
0,
1
lost_reason
enum<string>

Filtre par motif de perte exact.

Available options:
not_interested,
no_financing,
price_objection,
wrong_timing,
unresponsive,
already_handled,
invalid_lead,
other
age_min
integer

Inclut les prospects dont l’âge est supérieur ou égal à cette valeur, borne comprise. Les prospects sans âge renseigné sont exclus.

Required range: x >= 0
age_max
integer

Inclut les prospects dont l’âge est inférieur ou égal à cette valeur, borne comprise. Cette valeur doit être supérieure ou égale à age_min.

Required range: x >= 0
profile_extracted_after
string<date-time>

Inclut les prospects dont le profil a été analysé à cette date ou après. Les prospects jamais analysés sont exclus.

profile_extracted_before
string<date-time>

Inclut les prospects dont le profil a été analysé à cette date ou avant. Les prospects jamais analysés sont exclus.

created_from
string<date>

Inclut les prospects créés à partir de cette date (YYYY-MM-DD), borne comprise.

created_until
string<date>

Inclut les prospects créés jusqu’à cette date (YYYY-MM-DD), borne comprise. Cette date doit être postérieure ou égale à created_from.

cursor
string

Valeur de meta.next_cursor ou meta.prev_cursor reçue dans la réponse précédente. Renvoyez-la sans la modifier pour charger les résultats suivants ou précédents.

per_page
integer
default:25

Nombre de résultats retournés.

Required range: 10 <= x <= 100

Response

Liste paginée de prospects.

data
object[]
required
meta
object
required