Skip to content

Get Affiliate Leads

Retrieves a list of leads for an affiliate.

Endpoint

bash
GET https://api.exmp.com/v1/affiliates/leads

Query Parameters

ParameterTypeDescription
pageSizenumberNumber of items per page
pageNumbernumberPage number
startDatestringStart date in YYYY-MM-DD format
endDatestringEnd date in YYYY-MM-DD format
sortBystringField to sort by. Allowed values: createdAt, updatedAt. Defaults to createdAt
sortOrderstringSort direction. Allowed values: asc, desc. Defaults to desc

Headers

  • x-apiKey: your-api-key

Example Request

bash
curl --location 'https://api.exmp.com/v1/affiliates/leads?pageSize=50&pageNumber=1&startDate=2025-03-25&endDate=2025-05-30&sortBy=updatedAt&sortOrder=asc' \
--header 'x-apiKey: {x-apiKey token}'

Notes

  • The response will be paginated based on the pageSize parameter
  • Dates should be provided in YYYY-MM-DD format
  • The API will return leads within the specified date range
  • sortBy and sortOrder are optional; omitting them returns the newest leads first (createdAt descending)

Released under the MIT License.