List all leads

Sections

Changelog
Changelog

Theme switcher

LeadDyno API

This section allows users to track web traffic and effectively manage their affiliate program. By utilizing this API, users can gain valuable insights into their website traffic and enhance their affiliate marketing strategies.

Just getting started?

Check out our guide

Base URL

Production:

https://api.leaddyno.com/v1/

Language Box

Affiliates

This section allows users to manage and track affiliate relationships within their program. By utilizing this section, users can view, add, update, and remove affiliates, as well as access performance metrics and commission details. This section provides essential functionality for effectively managing affiliate partnerships and tracking the success of their referral activities.

Purchases

The Purchases section of the LeadDyno REST API allows users to retrieve detailed information about purchases made through the platform. With this functionality, users can track and manage customer transactions, gain insights into purchase patterns, and analyze sales data for informed decision-making.

Commissions

This section allows users to retrieve detailed information about the commissions earned through their affiliate marketing program. With this functionality, users can track and manage the financial aspects of their affiliate relationships, providing insight into earnings and performance metrics.

Leads

This section allows users to manage information related to potential leads or customers. Users can retrieve details about leads, update lead information, and track the status of leads within their LeadDyno account. This functionality provides essential tools for businesses looking to effectively manage and nurture their leads.

Was this section helpful?

What made this section unhelpful for you?

Create a lead

Creates a new Lead in your LeadDyno account.

Query Parameters

keystring Required

Your private key

Body Parameters

emailstring Required

The email address of the lead.

tracking_codestring

The tracking code assigned to the lead. If not provided, a unique code will be generated automatically.

Response

201
Object
Creates a new lead.

Response Attributes

idnumber
emailstring
created_atstring
updated_atstring
statusstring
custom_statusstring
first_namestring
last_namestring
address1string
address2string
citystring
statestring
zipcodestring
countrystring
latest_visitorobject

Show child attributes

urlstring
referrerstring
search_termstring
affiliatestring
campaignstring
tracking_codestring
crm_dataobject
Was this section helpful?

What made this section unhelpful for you?

POST

/leads?key=YOUR_PRIVATE_KEY

Select
1 2 3 4 5 curl --location 'https://api.leaddyno.com/v1/leads?key=YOUR_PRIVATE_KEY' \ --data-raw '{ "email": "test2024@example.com", "tracking_code": "b5fc67fa-72ea-4ec3-8635-abcdefghijkl" }'

Response

{
  "id": 2151,
  "email": "test2024@example.com",
  "created_at": "2024-09-25T20:05:13Z",
  "updated_at": "2024-09-25T20:05:13Z",
  "status": "Registered",
  "custom_status": null,
  "first_name": null,
  "last_name": null,
  "address1": null,
  "address2": null,
  "city": null,
  "state": null,
  "zipcode": null,
  "country": null,
  "latest_visitor": {
    "id": 8289,
    "tracking_code": "e4b7aa6a-74b8-4be0-9a20-abcdefghijkl"
  },
  "url": null,
  "referrer": null,
  "search_term": null,
  "affiliate": null,
  "campaign": null,
  "tracking_code": "e4b7aa6a-74b8-4be0-9a20-abcdefghijkl",
  "crm_data": {}
}
Was this section helpful?

What made this section unhelpful for you?

Retrieve a lead by ID

Fetches a lead by their unique ID.

Query Parameters

keystring

Response

200
Object

Response Attributes

idnumber
emailstring
created_atstring
updated_atstring
statusstring
custom_statusstring
first_namestring
last_namestring
address1string
address2string
citystring
statestring
zipcodestring
countrystring
latest_visitorstring
urlstring
referrerstring
search_termstring
affiliateobject

Show child attributes

campaignstring
tracking_codestring
Was this section helpful?

What made this section unhelpful for you?

GET

/leads/ID?key=YOUR_PRIVATE_KEY

Select
1 curl --location 'https://api.leaddyno.com/v1/leads/ID?key=YOUR_PRIVATE_KEY' \

Response

{
  "id": 2150,
  "email": "lead-2024@example.com",
  "created_at": "2024-09-24T03:01:12Z",
  "updated_at": "2024-09-24T03:01:12Z",
  "status": "Registered",
  "custom_status": "",
  "first_name": "Firstname",
  "last_name": "Lastname",
  "address1": null,
  "address2": null,
  "city": null,
  "state": null,
  "zipcode": null,
  "country": null,
  "latest_visitor": null,
  "url": null,
  "referrer": null,
  "search_term": null,
  "affiliate": {
    "id": 17171,
    "email": "affiliate@example.com"
  },
  "campaign": null,
  "tracking_code": null
}
Was this section helpful?

What made this section unhelpful for you?

Retrieve a lead by email

Fetches a lead using their email address.

Query Parameters

keystring Required

Your private key

emailstring Required

The email address of the lead to retrieve.

Response

200
Object
Returns the lead with the given email address.

Response Attributes

idnumber
emailstring
created_atstring
updated_atstring
statusstring
custom_statusstring
first_namestring
last_namestring
address1string
address2string
citystring
statestring
zipcodestring
countrystring
latest_visitorstring
urlstring
referrerstring
search_termstring
affiliateobject

Show child attributes

campaignstring
tracking_codestring
crm_dataobject
Was this section helpful?

What made this section unhelpful for you?

GET

/leads/by_email?key=YOUR_PRIVATE_KEY&email=<lead-email@example.com>

Select
1 curl --location 'https://api.leaddyno.com/v1/leads/by_email?key=YOUR_PRIVATE_KEY&email=%3Clead-email%40example.com%3E' \

Response

{
  "id": 2150,
  "email": "lead-2024@example.com",
  "created_at": "2024-09-24T03:01:12Z",
  "updated_at": "2024-09-24T03:01:12Z",
  "status": "Registered",
  "custom_status": "",
  "first_name": "Firstname",
  "last_name": "Lastname",
  "address1": null,
  "address2": null,
  "city": null,
  "state": null,
  "zipcode": null,
  "country": null,
  "latest_visitor": null,
  "url": null,
  "referrer": null,
  "search_term": null,
  "affiliate": {
    "id": 17171,
    "email": "affiliate@example.com"
  },
  "campaign": null,
  "tracking_code": null,
  "crm_data": {}
}
Was this section helpful?

What made this section unhelpful for you?

Retrieve total lead count

Retrieves the total number of leads captured within the LeadDyno platform.

Query Parameters

keystring Required

Your private key

Response

200
Object

Response Attributes

countnumber
Was this section helpful?

What made this section unhelpful for you?

GET

/count?key=YOUR_PRIVATE_KEY

Select
1 curl --location 'https://api.leaddyno.com/v1/count?key=YOUR_PRIVATE_KEY' \

Response

{
  "count": 737
}
Was this section helpful?

What made this section unhelpful for you?

Retrieve purchases for a lead

Retrieve a paginated list of purchases linked to a specific lead. Users can opt to include detailed information about the line items (SKUs) for each purchase. Each page contains up to 100 records.

Query Parameters

keystring Required

Your private key

pageinteger (int32)

The page number for pagination. Defaults to 1, with 100 records per page.

include_line_itemsboolean

If set to true, detailed information about the line items (SKUs) for the purchase is included. Default value is false.

Response

200
Object
Returns a paginated list of purchases associated with the lead. Optionally includes line items.

Response Attributes

idnumber
created_atstring
updated_atstring
cancelledboolean
currencystring
purchase_codestring
notestring
purchase_amountstring
commission_amount_overridestring
cancellationstring
leadobject

Show child attributes

affiliateobject

Show child attributes

planobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/leads/ID/purchases?key=YOUR_PRIVATE_KEY&page=1&include_line_items=false

Select
1 curl --location 'https://api.leaddyno.com/v1/leads/ID/purchases?key=YOUR_PRIVATE_KEY&page=1&include_line_items=false' \

Response

[
  {
    "id": 903,
    "created_at": "2024-08-27T12:36:01Z",
    "updated_at": "2024-09-06T17:19:27Z",
    "cancelled": false,
    "currency": "USD",
    "purchase_code": "9123467012302978503",
    "note": null,
    "purchase_amount": "403.4",
    "commission_amount_override": null,
    "cancellation": null,
    "lead": {
      "id": 1587,
      "email": "lead@example.com"
    },
    "affiliate": {
      "id": 17167,
      "email": "ld-preview-affiliate@leaddyno.com"
    },
    "plan": {
      "id": 30,
      "code": "default"
    }
  },
  {
    "id": 902,
    "created_at": "2024-08-27T03:14:10Z",
    "updated_at": "2024-09-06T17:15:07Z",
    "cancelled": false,
    "currency": "USD",
    "purchase_code": "76267123491450542",
    "note": null,
    "purchase_amount": "470.16",
    "commission_amount_override": null,
    "cancellation": null,
    "lead": {
      "id": 1587,
      "email": "lead@example.com"
    },
    "affiliate": {
      "id": 17167,
      "email": "ld-preview-affiliate@leaddyno.com"
    },
    "plan": {
      "id": 30,
      "code": "default"
    }
  }
]
Was this section helpful?

What made this section unhelpful for you?

List all leads

Returns a paginated list of all leads. Leads are returned in descending order by creation date, with the most recent leads appearing first. Use the page parameter to navigate through the results. Each page contains up to 100 records.

Query Parameters

keystring Required

Your private key

pageinteger (int32)

The page number to retrieve leads for pagination. Defaults to 1, with 100 records displayed per page.

Response

200
Object
Returns a paginated list of leads, 100 per page.

Response Attributes

idnumber

The unique identifier of the lead to retrieve.

emailstring

The email address of the lead.

created_atstring

The date and time when the lead was created.

updated_atstring

The date and time when the lead was last updated.

statusstring

The status of the lead.

custom_statusstring

The custom status of the lead.

first_namestring

The first name of the lead.

last_namestring

The last name of the lead.

address1string

The address line 1 of the lead.

address2string

The address line 2 of the lead.

citystring

The city of the lead.

statestring

The state of the lead.

zipcodestring

The zip code of the lead.

countrystring

The country of the lead.

latest_visitorstring

The latest visitor related to the lead.

urlstring

The URL related to the lead.

referrerstring

The referrer of the lead.

search_termstring

The search term associated with the lead.

affiliateobject

The affiliate associated with the lead.

Show child attributes

campaignstring

The campaign associated with the lead.

tracking_codestring

The tracking code related to the lead.

crm_dataobject

The CRM data associated with the lead.

last_referralstring

The last referral date of the lead.

Was this section helpful?

What made this section unhelpful for you?

GET

/leads?key=YOUR_PRIVATE_KEY&page=1

Select
1 curl --location 'https://api.leaddyno.com/v1/leads?key=YOUR_PRIVATE_KEY&page=1' \

Response

[
  {
    "id": 2150,
    "email": "lead-2024@example.com",
    "created_at": "2024-09-24T03:01:12Z",
    "updated_at": "2024-09-24T03:01:12Z",
    "status": "Registered",
    "custom_status": "",
    "first_name": "Firstname",
    "last_name": "Lastname",
    "address1": null,
    "address2": null,
    "city": null,
    "state": null,
    "zipcode": null,
    "country": null,
    "latest_visitor": null,
    "url": null,
    "referrer": null,
    "search_term": null,
    "affiliate": {
      "id": 17171,
      "email": "affiliate@example.com"
    },
    "campaign": null,
    "tracking_code": null,
    "crm_data": {}
  },
  "2022-05-19T18:01:24Z"
]
Was this section helpful?

What made this section unhelpful for you?

Update a lead

Updates the details of an existing lead. You can modify the lead’s email, first name, last name, and other relevant information using this endpoint.

Query Parameters

keystring Required

Your private key

Body Parameters

emailstring Required

The email address of the lead.

first_namestring

The first name of the lead.

last_namestring

The last name of the lead.

custom_statusstring

The custom status for the lead.

affiliatestring

The email address of the affiliate to associate with the lead.

Response

200
Object
Allows updating a lead's email, first name, last name, and custom status.

Response Attributes

idnumber
emailstring
created_atstring
updated_atstring
statusstring
custom_statusstring
first_namestring
last_namestring
address1string
address2string
citystring
statestring
zipcodestring
countrystring
latest_visitorobject

Show child attributes

urlstring
referrerstring
search_termstring
affiliatestring
campaignstring
tracking_codestring
crm_dataobject
Was this section helpful?

What made this section unhelpful for you?

PUT

/leads/ID?key=YOUR_PRIVATE_KEY

Select
1 2 3 4 5 6 7 8 curl --location --request PUT 'https://api.leaddyno.com/v1/leads/ID?key=YOUR_PRIVATE_KEY' \ --data-raw '{ "email": "test2024@example.com", "first_name": "John", "last_name": "Example", "custom_status": "party_rockin", "affiliate": null }'

Response

{
  "id": 2151,
  "email": "test2024@example.com",
  "created_at": "2024-09-25T20:05:13Z",
  "updated_at": "2024-09-25T20:05:13Z",
  "status": "Registered",
  "custom_status": "party_rockin",
  "first_name": "John",
  "last_name": "Example",
  "address1": null,
  "address2": null,
  "city": null,
  "state": null,
  "zipcode": null,
  "country": null,
  "latest_visitor": {
    "id": 8289,
    "tracking_code": "e4b7aa6a-74b8-4be0-9a20-abcdefghijkl"
  },
  "url": null,
  "referrer": null,
  "search_term": null,
  "affiliate": null,
  "campaign": null,
  "tracking_code": "e4b7aa6a-74b8-4be0-9a20-abcdefghijkl",
  "crm_data": {}
}
Was this section helpful?

What made this section unhelpful for you?

Cancel all purchases for a lead

Cancel all purchases associated with the given lead.

Query Parameters

keystring Required

Your private key

sourcestring

A user-defined string indicating the origin or reason for the cancellation.

effective_datestring (date)

The effective date of the cancellation. Defaults to the current date and time if not provided.

cancellation_codestring

A custom cancellation code. If not provided, a system-generated code will be assigned.

Response

200
Object
Cancels all purchases associated with the given lead.

Response Attributes

idnumber
created_atstring
updated_atstring
cancelledboolean
currencystring
purchase_codestring
notestring
purchase_amountstring
commission_amount_overridestring
cancellationobject

Show child attributes

leadobject

Show child attributes

affiliateobject

Show child attributes

planobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

DELETE

/leads/ID/purchases?key=YOUR_PRIVATE_KEY&source=&effective_date=&cancellation_code=

Select
1 curl --location --request DELETE 'https://api.leaddyno.com/v1/leads/ID/purchases?key=YOUR_PRIVATE_KEY' \

Response

[
  {
    "id": 1104,
    "created_at": "2024-10-07T03:00:00Z",
    "updated_at": "2024-10-16T16:52:51Z",
    "cancelled": true,
    "currency": "USD",
    "purchase_code": "0b01832c-cd02-4120-a698-1c2cd752f123",
    "note": null,
    "purchase_amount": "123.5",
    "commission_amount_override": null,
    "cancellation": {
      "id": 29,
      "cancellation_code": "eee9b192-f42a-4063-8423-1a0dca56b123",
      "effective_date": "2024-10-16T16:52:51Z",
      "source": null
    },
    "lead": {
      "id": 2152,
      "email": "lead@email.com"
    },
    "affiliate": {
      "id": 17175,
      "email": "affiliate@email.com"
    },
    "plan": {
      "id": 30,
      "code": "default"
    }
  }
]
Was this section helpful?

What made this section unhelpful for you?

Visitors

This section allows users to manage and retrieve data related to website visitors, whether they were referred by affiliates or arrived organically. You can use these endpoints to track the journey and behavior of visitors across your website, helping to analyze performance and conversions.

Campaigns

This section allows users to manage and track their marketing campaigns efficiently. With this functionality, users can create, monitor, and analyze the performance of their campaigns to optimize their marketing efforts and drive better results.

Custom Fields

The Custom Fields section allows users to define and manage custom fields within the LeadDyno. By utilizing this section, users can customize their data structures and collect specific information tailored to their business needs. This section empowers users to enhance the flexibility and functionality of their LeadDyno integration.

Sub IDs

This section allows users to retrieve detailed information about the affiliate links, Sub IDS.