> ## 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 lead lists > Returns the lead lists in your workspace, newest first. The read-only system lists come back in `systemLists` on the first page. ## OpenAPI ````yaml /openapi.json get /leads 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: get: tags: - Lead lists summary: List lead lists description: >- Returns the lead lists in your workspace, newest first. The read-only system lists come back in `systemLists` on the first page. operationId: leads.list parameters: - name: search in: query required: false description: Text to look for in the list name. schema: type: string - name: status in: query required: false description: Only lists whose import is in this state. Defaults to `all`. schema: type: string enum: - all - pending - syncing - completed - paused - stopped - failed - name: platform in: query required: false description: Only lists on this network. Defaults to `all`. schema: type: string enum: - all - x - linkedin - name: favorite in: query required: false description: Set to `true` to return only favorite lists. schema: type: boolean - name: page in: query required: false description: >- The page to return, starting at 1. A page past the end returns the last page. Defaults to `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 required: - items - page - limit - total - totalPages - systemLists properties: items: type: array items: $ref: '#/components/schemas/LeadList' page: type: integer description: The page returned. examples: - 1 limit: type: integer description: The page size used. examples: - 50 total: type: integer description: How many lists match, across all pages. examples: - 3 totalPages: type: integer description: How many pages there are. examples: - 1 systemLists: type: array description: >- Read-only system lists. Only returned on the first page; empty on the others. items: $ref: '#/components/schemas/SystemLeadList' error: type: 'null' description: Always `null` on success. example: status: true data: items: - id: 3f1c2a9e-7b4d-4e2a-9c1f-5d8e6a7b9c0d name: SaaS founders status: completed platform: linkedin profiles: 812 reachable: 640 totalCount: 1200 syncError: null favorite: false createdAt: '2026-10-05T08:12:00.000Z' syncBatch: 1 page: 1 limit: 50 total: 1 totalPages: 1 systemLists: - id: x-database name: X Database description: Search our prospect database of public profiles on X. platform: x readOnly: true key: x_database profiles: 0 reachable: null error: null '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PlanRequired' '500': $ref: '#/components/responses/ServerError' security: - bearerAuth: [] components: schemas: LeadList: type: object description: A list of people you collected to message. required: - createdAt - favorite - id - name - platform - profiles - reachable - status - syncBatch - syncError - totalCount properties: id: type: string description: The lead list ID. examples: - 3f1c2a9e-7b4d-4e2a-9c1f-5d8e6a7b9c0d name: type: string description: The list name. examples: - SaaS founders status: type: string enum: - pending - syncing - completed - paused - stopped - failed description: Where the import that fills the list stands. examples: - completed platform: $ref: '#/components/schemas/Platform' profiles: type: integer description: How many profiles are in the list. examples: - 812 reachable: type: integer description: How many of those profiles you can send a direct message to. examples: - 640 totalCount: type: - integer - 'null' description: >- The total at the source when it is known, for example everyone who liked a post. This is the source's total, not the size of the list. `null` when it is not known. examples: - 1200 syncError: type: - string - 'null' description: Why the import failed. `null` when it did not. examples: - null favorite: type: boolean description: Whether the list is marked as a favorite. examples: - false createdAt: type: string format: date-time description: When the list was created, in ISO 8601 UTC. examples: - '2026-10-05T08:12:00.000Z' syncBatch: type: integer description: How many times the list has been filled. SystemLeadList: type: object description: A read-only list that ships with ReachHunt, such as the X Database. additionalProperties: true required: - id - name - description - platform - readOnly - key - profiles - reachable properties: id: type: string description: The system list ID. examples: - x-database name: type: string description: The list name. examples: - X Database description: type: string description: What the list contains. examples: - Search our prospect database of public profiles on X. platform: $ref: '#/components/schemas/Platform' readOnly: type: boolean description: Always `true`. System lists cannot be changed. examples: - true key: type: string description: A stable name for the list. profiles: type: integer description: How many profiles it has. reachable: type: - integer - 'null' description: How many you can message. `null` until it is known. Platform: type: string enum: - x - linkedin description: The network the item belongs to. examples: - linkedin 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.