APappdirect
AppResellerLeads

List leads

Changed on

Retrieves a list of all leads visible for a given context. You can filter the list using optional query parameters. Manual leads are visible to only those who created them. Company profile leads are visible to the Reseller that created the profile page as well as the Reseller Managers and Marketplace Managers. Product profile leads are visible to Marketplace Managers and Reseller Managers and can be configured so that the Developers who own the product profile can also see them.

get/lead/v2/leads

Request

Query parameters

context'RESELLER' | 'REFERRAL' | 'DEVELOPER' | 'RESELLER_MANAGER' | 'PARTNER' | 'ANONYMOUS' | 'CHANNEL_ADMIN' required

Supported contexts

companyIdstring required

Company ID of the user who retrieved the list

status'CONVERTED' | 'DISQUALIFIED' | 'DELETED' | 'PENDING_CONVERSION_APPROVAL' | 'CONVERSION_APPROVED' | 'PENDING_SUBMISSION' | 'SUBMITTED' | 'ASSIGNED' | 'LEGACY' | 'PENDING_FOR_MANAGERS' | 'ACCEPTED_FOR_MANAGERS'

Lead status

searchTextstring

Search text, which filters the list of leads

fromDatenumber

Date on which the lead was created (lower bound) in Unix timestamp format

toDatenumber

Date on which the lead was created (upper bound) in Unix timestamp format

sortField'DATE' | 'COMPANY_NAME'

The field by which to order the results

sortOrder'ASC' | 'DESC'

Type of ordering used (ascending or descending)

pageinteger

Page number

sizeinteger

Number of results per page

Response

Success

Example response

{
  "page": {
    "number": 12345,
    "size": 12345,
    "totalElements": 12345,
    "totalPages": 12345
  },
  "content": [
    {
      "customer": {
        "customer": {
          "company": {
            "name": "Acme",
            "street1": "1234 Main St",
            "street2": "Suite 100",
            "city": "Beverly Hills",
            "state": "CA",
            "zip": "90210",
            "country": "US",
            "size": "RANGE_1_9"
          },
          "contact": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@acme.com",
            "phone": "+14455555555"
          }
        }
      },
      "referrer": {
        "participantType": "CHANNEL",
        "partner": "APPDIRECT"
      },
      "recipient": {
        "participantType": "CHANNEL",
        "partner": "APPDIRECT"
      },
      "reseller": {
        "companyId": "386626c0-53e2-4515-ffff-4a720bb5d029",
        "companyName": "Reseller Company",
        "id": "01d75b7c-ea78-ffff-9e58-6ad217bddcbd",
        "role": "RESELLER"
      },
      "creator": {
        "companyId": "386626c0-53e2-4515-ffff-4a720bb5d029",
        "companyName": "Reseller Company",
        "id": "01d75b7c-ea78-ffff-9e58-6ad217bddcbd",
        "role": "RESELLER"
      },
      "convertedUser": {
        "companyId": "386626c0-53e2-4515-ffff-4a720bb5d029",
        "companyName": "Reseller Company",
        "id": "01d75b7c-ea78-ffff-9e58-6ad217bddcbd",
        "role": "RESELLER"
      },
      "convertedCompany": {
        "id": "386626c0-53e2-4515-ffff-4a720bb5d029",
        "name": "Reseller Company"
      },
      "profileCompany": {
        "id": "386626c0-53e2-4515-ffff-4a720bb5d029",
        "name": "Reseller Company"
      },
      "profileProduct": {
        "id": "009fd909-aaaa-4e37-bbad-701f87724bca",
        "name": "Appsome Product",
        "provider": "APPDIRECT"
      },
      "profileProductEdition": {
        "id": "d4610cd4-09d5-abcd-a769-a47666a1c311",
        "name": "Enterprise Edition"
      }
    }
  ]
}

Changes

  • 1fc240f06971Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new enum value CHANNEL_ADMIN to the query request parameter context

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status