API - API call to list Leads and Lead Fields

List all Leads

GET /leads

Full endpoint: https://sprinthub-api-master.sprinthub.app/leads?i=instancearrow-up-right

i = name of your instance

Body (below example in JSON)

{
    "data": {
        "total": 1134,
        "leads": [
            {
                "id": 2035,
                "fullname": "noreply-spamdigest via TeamDev",
                "email": "[email protected]"
            },
            {
```

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

apitoken

XXXXXXX

List only ONE specific Lead

GET /leads/LEAD_ID

Full endpoint: https://sprinthub-api-master.sprinthub.app/leads/2065?i=instancearrow-up-right

List ALL fields of only ONE specific Lead

GET /leads/LEAD_ID&allFields=1

Full endpoint: https://sprinthub-api-master.sprinthub.app/leads/2065?i=instancearrow-up-right&allFields=1

.

List only SOME fields of only ONE specific Lead

GET /leads/LEAD_ID&query={lead{firstname,lastname,email,mobile}}

Full endpoint: https://sprinthub-api-master.sprinthub.app/leads/2065?i=instancearrow-up-right&query={lead{firstname,lastname,email,mobile}}

.

circle-info

Because this is GRAPHQL, you will only be able to fetch specific fields from the Lead's fixed fields. To fetch customized fields, only by bringing everything with the parameter &allFields=1

Last updated

Was this helpful?