> ## Documentation Index > Fetch the complete documentation index at: https://docs.reachhunt.ai/llms.txt > Use this file to discover all available pages before exploring further. # List leads > Returns the people in a lead list. ## OpenAPI ````yaml /openapi.json get /leads/{leadListId}/prospects openapi: 3.1.0 info: title: ReachHunt API version: 1.0.0 description: >- The ReachHunt API gives your own apps and scripts programmatic access to your workspace: accounts, campaigns, lead lists, conversations, messages, tags and statuses. Send your API key in the `Authorization` header: `Authorization: Bearer YOUR_API_KEY`. The key decides the workspace, so no path or parameter names one. Every response has the same envelope: `{ "status": true, "data": ..., "error": null }`. servers: - url: https://api.reachhunt.ai/api/v1 description: Production security: [] tags: - name: Workspaces description: Your workspace and the people in it. - name: Accounts description: The X and LinkedIn accounts you connected. - name: Analytics description: Activity over time. - name: Credits description: AI credits and how they were used. - name: Campaigns description: Outreach that messages your leads step by step. - name: Agents description: AI agents that reply to your leads. - name: Tags description: Labels you put on conversations. - name: Statuses description: Pipeline stages you put conversations in. - name: Leads description: The people in your lead lists. - name: Lead lists description: Lists of people you collect to message. - name: Conversations description: The conversations in your inbox. - name: Messages description: The messages in a conversation. - name: Conversation details description: Your team's record of the person in a conversation. - name: Internal notes description: Notes only your team sees. - name: Scheduled messages description: Messages set to send later. - name: Templates description: Saved messages you can reuse. - name: Webhook events description: What each event sends. paths: /leads/{leadListId}/prospects: get: tags: - Lead lists summary: List leads description: Returns the people in a lead list. operationId: leadLists.listLeads parameters: - name: leadListId in: path required: true description: The lead list ID. schema: type: string - name: search in: query required: false description: Text to look for in the name, handle or headline. schema: type: string - name: label in: query required: false description: Only leads with this tag ID. Repeat for several. schema: type: array items: type: string - name: page in: query required: false description: The page to return, starting at 1. schema: type: integer minimum: 1 - name: limit in: query required: false description: How many items to return, from 1 to 100. Defaults to 50. schema: type: integer minimum: 1 maximum: 100 responses: '200': description: 'OK. Check `status`: errors the API handles itself also return 200.' content: application/json: schema: type: object required: - status - data - error properties: status: type: boolean description: '`true` when the request succeeded.' data: type: object properties: items: type: array items: $ref: '#/components/schemas/Lead' page: type: integer description: The page returned. limit: type: integer description: The page size used. total: type: integer description: How many match, across all pages. totalPages: type: integer description: How many pages there are. summary: type: object properties: status: type: string description: The current state. profiles: type: integer description: How many profiles are in the list. reachable: type: integer description: >- How many of those you can send a direct message to. totalCount: type: integer description: >- The total at the source when known. Not the size of the list. syncBatch: type: integer description: How many times the list has been filled. syncError: type: - string - 'null' description: Why the import failed. `null` when it did not. platform: type: string description: 'The network: `x` or `linkedin`.' required: - status - profiles - reachable - totalCount - syncBatch - syncError - platform description: Totals for the whole list. filter: type: object properties: matched: type: integer description: How many match the filters. reachable: type: integer description: >- How many of those you can send a direct message to. required: - matched - reachable description: Counts for the current filters. required: - items - page - limit - total - totalPages - summary - filter error: type: 'null' description: Always `null` on success. '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PlanRequired' '500': $ref: '#/components/responses/ServerError' security: - bearerAuth: [] components: schemas: Lead: type: object properties: canDm: type: - boolean - 'null' description: Whether you can send a direct message. `null` when it is not known. followers: type: - integer - 'null' description: Follower count, when the network shares it. following: type: - integer - 'null' description: Accounts followed, when the network shares it. tweets: type: - integer - 'null' createdAt: type: - string - 'null' format: date-time description: When it was created, in ISO 8601 UTC. verified: type: - string - 'null' isVerified: type: boolean isBlueVerified: type: - boolean - 'null' profileType: type: - string - 'null' degree: type: - integer - 'null' isPremium: type: boolean headline: type: string description: The profile headline. LinkedIn only. currentCompany: type: - string - 'null' industry: type: - string - 'null' positions: type: array items: {} careerStartedOn: type: - string - 'null' experience: type: - object - 'null' seniority: type: - string - 'null' education: type: array items: {} skills: type: array items: {} languages: type: array items: {} certifications: type: array items: {} id: type: string description: The ID. platform: $ref: '#/components/schemas/Platform' leadListId: type: string description: The lead list it was added through. accountId: type: - string - 'null' description: The connected account. origin: type: - object - 'null' leadListIds: type: array items: type: string description: Every lead list it is in. description: Every lead list it is in. accountIds: type: array items: {} description: The accounts that send for it. origins: type: array items: {} favorite: type: boolean description: Whether it is marked as a favorite. statusId: type: - string - 'null' description: The status it is in. `null` when it has none. valuation: type: - number - 'null' description: The deal value. `null` when none is set. hasNote: type: boolean description: Whether the lead has a note. labels: type: array items: $ref: '#/components/schemas/Tag' description: The tags on this lead. platformId: type: string description: The ID the network gives this person. handle: type: string description: The username, without a prefix. name: type: string description: The name. avatarUrl: type: - string - 'null' description: Link to the photo. coverUrl: type: - string - 'null' bio: type: string description: The bio on the profile. location: type: - string - 'null' description: The location on the profile. profileUrl: type: string description: Link to the profile on the network. websiteUrl: type: - string - 'null' required: - canDm - followers - following - tweets - createdAt - verified - isVerified - isBlueVerified - profileType - degree - isPremium - headline - currentCompany - industry - positions - careerStartedOn - experience - seniority - education - skills - languages - certifications - id - platform - leadListId - accountId - origin - leadListIds - accountIds - origins - favorite - statusId - valuation - hasNote - labels - platformId - handle - name - avatarUrl - coverUrl - bio - location - profileUrl - websiteUrl description: A person in a lead list. additionalProperties: true Platform: type: string enum: - x - linkedin description: The network the item belongs to. examples: - linkedin Tag: type: object description: A label you can put on a conversation. required: - id - label - color properties: id: type: string description: The tag ID. examples: - 7c1f0c52-6d1a-4a49-9a63-2b3c4d5e6f70 label: type: string description: The tag name, up to 24 characters. examples: - Hot lead color: type: string description: The tag color as a lowercase six-digit hex value. examples: - '#e24c5d' Failure: type: object required: - status - data - error properties: status: type: boolean description: Always `false` for an error. data: type: 'null' description: Always `null` for an error. error: type: string description: What went wrong, in plain words. responses: Unauthorized: description: The API key is missing or not valid. content: application/json: schema: $ref: '#/components/schemas/Failure' example: status: false data: null error: Not authenticated PlanRequired: description: The workspace has no active plan, or its trial has ended. content: application/json: schema: $ref: '#/components/schemas/Failure' example: status: false data: null error: Your free trial has ended. Pick a plan to continue. ServerError: description: Something failed on our side. Try again. content: application/json: schema: $ref: '#/components/schemas/Failure' example: status: false data: null error: Something went wrong. Please try again. securitySchemes: bearerAuth: type: http scheme: Bearer description: >- Your API key, sent as `Authorization: Bearer YOUR_API_KEY`. Create one in **Settings → API**. x-default: Bearer YOUR_API_KEY ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.