Skip to main content

List Affiliate Partner Prospects

GET 
/prospects

Retrieves affiliate partner prospects for the authenticated client. The endpoint provides an asynchronous prospect discovery mechanism where the system processes and returns potential affiliate partners based on the authenticated client's business profile.

Query Parameters:

  • more: Set to true to request a new prospect discovery job
  • customerDescription: Description of the client's business (max 255 chars, used when creating a new job)
  • productCategories: Product categories the client sells (max 255 chars, used when creating a new job)
  • page: Page number for pagination (default: 1)
  • limit: Items per page for pagination (default: 10, max: 100)

Response Scenarios:

  1. Job Processing (PENDING): Returns status "in_progress" with HTTP 200
  2. New Job Created: Returns status "in_progress" with HTTP 202
  3. Prospects Available (SUCCESS): Returns array of prospects with HTTP 200
  4. Previous Job Failed: Returns failure status with retry instructions, HTTP 200

Request​

Responses​

Prospects available or job in progress