--- title: "List leads" method: GET path: "/lead/v2/leads" tags: ["AppResellerLeads"] --- # List leads `GET /lead/v2/leads` ## Request - Base URL: `https://marketplace.appdirect.com/api` - URL: `https://marketplace.appdirect.com/api/lead/v2/leads` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. ## Query parameters - `context` 'RESELLER' | 'REFERRAL' | 'DEVELOPER' | 'RESELLER_MANAGER' | 'PARTNER' | 'ANONYMOUS' | 'CHANNEL_ADMIN', required - `companyId` string, required - `status` 'CONVERTED' | 'DISQUALIFIED' | 'DELETED' | 'PENDING_CONVERSION_APPROVAL' | 'CONVERSION_APPROVED' | 'PENDING_SUBMISSION' | 'SUBMITTED' | 'ASSIGNED' | 'LEGACY' | 'PENDING_FOR_MANAGERS' | 'ACCEPTED_FOR_MANAGERS' - `searchText` string - `fromDate` number - `toDate` number - `sortField` 'DATE' | 'COMPANY_NAME' - `sortOrder` 'ASC' | 'DESC' - `page` integer - `size` integer ## Response `200` Success - LeadPagedReadResponse: Paged response as an array of lead objects - `page` PageMetadata, required - `number` number, required: Page number - `size` number, required: Size of the page to be returned - `totalElements` number, required: Total number of elements - `totalPages` number, required: Total number of pages - `content` LeadResponse[], required - `id` string, required: Lead ID - `partner` string, required: Marketplace partner code - `leadType` 'MANUAL' | 'PRODUCT' | 'COMPANY', required: The type of lead. Leads created manually by users have the MANUAL type. Leads created by anonymous users through profiles have the PRODUCT or COMPANY types, depending on whether they were created from product profiles or reseller company profiles respectively. - `status` 'CONVERTED' | 'DISQUALIFIED' | 'DELETED' | 'PENDING_CONVERSION_APPROVAL' | 'CONVERSION_APPROVED' | 'PENDING_SUBMISSION' | 'SUBMITTED' | 'ASSIGNED' | 'LEGACY' | 'PENDING_FOR_MANAGERS' | 'ACCEPTED_FOR_MANAGERS', required: The lead status. PENDING_FOR_MANAGERS requires SUBMITTED and PENDING_CONVERSION_APPROVAL; ACCEPTED_FOR_MANAGERS requires ASSIGNED, CONVERSION_APPROVED, CONVERTED, DELETED, DISQUALIFIED and LEGACY. - `customer` LeadCustomer, required: Information about the customer and customer company - `company` LeadCustomerCompany, required: Information about the customer's company, including address and company size - `name` string: Company Name - `street1` string: First line of street address - `street2` string: Second line of street address (suite, floor, and so on) - `city` string: City or town - `state` string: State, province, or region - `zip` string: ZIP or postal code - `country` string: The two-letter country code, in ISO 3166 format - `size` 'RANGE_1_9' | 'RANGE_10_24' | 'RANGE_25_49' | 'RANGE_50_249' | 'RANGE_250_499' | 'RANGE_500_999' | 'RANGE_1000_4999' | 'RANGE_5000_PLUS' | 'UNKNOWN': Company size, as determined by number of employees - `contact` LeadCustomerContact, required: Customer contact information - `firstName` string: First name - `lastName` string: Last name - `email` string: Email address - `phone` string: Phone number - `phoneExtension` string: Phone number extension - `createdOn` number, required: The date on which the lead was created, in UNIX Epoch milliseconds - `lastModified` number, required: The date on which the lead was last modified, in UNIX Epoch milliseconds - `customAttributes` object: Custom attributes associated with the lead - `referrer` LeadParticipant, required: Information about the person who is receiving or referring the lead - `participantType` string, required: The type of the participant involved. It can be CUSTOMER (an anonymous participant), COMPANY (a Reseller, Referral or Developer company participant) or CHANNEL (a Partner participant). - `partner` string: The partner code of the marketplace (only for CHANNEL types) - `companyId` string: The company's ID (only for COMPANY types) - `companyName` string: The company's name (only for COMPANY types) - `recipient` LeadParticipant, required: Information about the person who is receiving or referring the lead - `participantType` string, required: The type of the participant involved. It can be CUSTOMER (an anonymous participant), COMPANY (a Reseller, Referral or Developer company participant) or CHANNEL (a Partner participant). - `partner` string: The partner code of the marketplace (only for CHANNEL types) - `companyId` string: The company's ID (only for COMPANY types) - `companyName` string: The company's name (only for COMPANY types) - `reseller` LeadUser: Information about the marketplace user related to the lead - `id` string, required: User ID - `companyId` string, required: Company ID - `companyName` string: Company name - `role` string: User role (if applicable) - `notes` string: Notes attached to the lead - `creator` LeadUser: Information about the marketplace user related to the lead - `id` string, required: User ID - `companyId` string, required: Company ID - `companyName` string: Company name - `role` string: User role (if applicable) - `convertedUser` LeadUser: Information about the marketplace user related to the lead - `id` string, required: User ID - `companyId` string, required: Company ID - `companyName` string: Company name - `role` string: User role (if applicable) - `convertedCompany` LeadCompany: Information about the marketplace company related to the lead - `id` string, required: Company ID - `name` string: Company name - `result` 'OPEN' | 'LOST' | 'WON': Additional status information about CONVERTED leads - `profileCompany` LeadCompany: Information about the marketplace company related to the lead - `id` string, required: Company ID - `name` string: Company name - `profileProduct` LeadProduct: Information about the product related to a lead - `id` string, required: Product ID - `name` string, required: Product name - `provider` string: Marketplace partner code - `profileProductEdition` LeadProductEdition: Information about the product edition related to a lead - `id` string, required: Edition ID - `name` string, required: Edition name ## Other responses - `401`: Unauthorized - `404`: Not Found ## Changes - **2026-11-06** `1fc240f06971`: 1 breaking, 3 info - the response's body type changed from no type to `object` for status `200` - added the new enum value `CHANNEL_ADMIN` to the `query` request parameter `context` - added the required property `content` to the response with the `200` status - added the required property `page` to the response with the `200` status [Operation history](https://skmtc.dev/appdirect/apis/companies/changes/lead/v2/leads/get.md) --- [API](https://skmtc.dev/appdirect/apis/companies.md) - [All operations](https://skmtc.dev/appdirect/apis/companies/llms.txt) - [OpenAPI document](https://skmtc.dev/appdirect/apis/companies/revisions/1fc240f06971?raw)