Skip to main content
GET
/
v1
/
order
/
leads
Get all leads
curl --request GET \
  --url https://affilate.adscrush.com/api/v1/order/leads \
  --header 'API_KEY: <api-key>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "campaignId": "<string>",
    "userId": "<string>",
    "ip": "<string>",
    "address": "<string>",
    "state": "<string>",
    "region": "<string>",
    "country": "<string>",
    "status": "OnHold"
  }
]

Authorizations

​
API_KEY
string
header
required

Your API key. Include this key in the API_KEY header when making requests to endpoints that require authentication. You can find your API key in the 'Profile' tab on the website.

​
Authorization
string
header
required

Your Bearer Token. Include this token in the 'Authorization' header as Bearer <your_token> when making requests to endpoints that require user authentication. You can view and manage your Bearer Token in the 'Profile' tab on the website.

Response

Successful response

​
id
string
required

The unique identifier for the lead.

​
name
string
required

The name of the lead.

​
phone
string
required

The phone number of the lead.

​
createdAt
string<date-time>
required

The timestamp indicating when the lead was created.

​
updatedAt
string<date-time>
required

The timestamp indicating when the lead was last updated.

​
campaignId
string
required

The identifier of the campaign associated with the lead.

​
userId
string
required

The identifier of the user associated with the lead.

​
ip
string

The IP address associated with the lead.

​
address
string

The address of the lead.

​
state
string

The state associated with the lead.

​
region
string

The region associated with the lead.

​
country
string

The country associated with the lead.

​
status
enum<string>

The status of the lead (e.g., OnHold, InProgress).

Available options:
OnHold,
Trashed,
Paid,
Approved