> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.goextrovert.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Prospects

> Returns visible prospects with their campaign/list bindings and optional pagination information. Use `listId` to scope to a single list, or pass broader filter arrays for campaign-wide prospect management. This endpoint returns existing prospects only — it does not add them. To add new LinkedIn profiles, add their URLs to a prospect list (`create-list` or `add-users-to-list`).



## OpenAPI

````yaml https://api.goextrovert.com/client/v2/docs-json get /client/v2/prospects
openapi: 3.0.0
info:
  title: Extrovert Client API
  description: >-
    Public API for Extrovert platform integration. Use your API key for
    authentication.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.goextrovert.com/
    description: API Server
security: []
tags: []
paths:
  /client/v2/prospects:
    get:
      tags:
        - Prospects
      summary: List Prospects
      description: >-
        Returns visible prospects with their campaign/list bindings and optional
        pagination information. Use `listId` to scope to a single list, or pass
        broader filter arrays for campaign-wide prospect management. This
        endpoint returns existing prospects only — it does not add them. To add
        new LinkedIn profiles, add their URLs to a prospect list (`create-list`
        or `add-users-to-list`).
      operationId: ProspectsClientApiController_list
      parameters:
        - description: >-
            Optional list id shortcut to load prospects from one specific
            prospect list.
          required: false
          name: listId
          in: query
          schema:
            type: string
            format: uuid
        - description: >-
            Optional campaign ids filter. Pass an empty array to keep all
            visible campaigns.
          required: true
          name: campaignsIds
          in: query
          schema:
            type: array
        - description: Optional filter to only show important or non-important prospects.
          required: true
          name: isImportant
          in: query
          schema:
            type: boolean
        - description: Optional post-frequency filter.
          required: false
          name: postFrequency
          in: query
          schema:
            enum:
              - MORE_THAN_TWICE_PER_WEEK
              - ONE_TO_TWO_TIMES_PER_WEEK
              - ONE_TO_THREE_TIMES_PER_MONTH
              - LESS_THAN_ONCE_PER_MONTH
            type: string
        - description: >-
            Optional prospect list ids filter. Pass an empty array to keep all
            lists.
          required: true
          name: listsIds
          in: query
          schema:
            type: array
        - description: Optional sort field.
          required: false
          name: sortBy
          in: query
          schema:
            enum:
              - prospectName
              - campaignName
              - postFrequency
              - totalComments
              - lastComment
              - lastPostCheck
            type: string
        - description: Optional sort direction.
          required: false
          name: sortOrder
          in: query
          schema:
            enum:
              - ASC
              - DESC
            type: string
        - description: Optional free-text search term.
          required: false
          name: search
          in: query
          schema:
            type: string
        - description: >-
            Optional touch-point buckets filter. Pass an empty array to keep
            all.
          required: true
          name: numberOfTouchPoints
          in: query
          schema:
            type: array
        - description: >-
            Optional page size limit. Pass it explicitly for paginated list
            queries.
          examples:
            example1:
              value: 5
            example2:
              value: 25
          required: false
          name: limit
          in: query
          schema:
            maximum: 9007199254740991
            exclusiveMinimum: true
            type: integer
            minimum: 0
        - description: >-
            Optional page offset. Increase it to load the next page with the
            same filters.
          examples:
            example1:
              value: 0
            example2:
              value: 5
            example3:
              value: 25
          required: false
          name: offset
          in: query
          schema:
            minimum: 0
            maximum: 9007199254740991
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponseDto'
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientApiErrorResponseDto'
      security:
        - api-key: []
components:
  schemas:
    ListResponseDto:
      type: object
      properties:
        status:
          type: string
          description: Response status
          enum:
            - success
        data:
          type: object
          properties:
            users:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Prospect id
                    example: 8d256aa6-9b12-49a7-93ee-bf41634b5b60
                  updatedAt:
                    type: string
                    description: Prospect update timestamp
                    example: '2025-06-30T14:02:07.456Z'
                  createdAt:
                    type: string
                    description: Prospect creation timestamp
                    example: '2025-06-30T14:02:07.456Z'
                  linkedInProfile:
                    description: LinkedIn profile details, if available
                    type: object
                    properties:
                      id:
                        type: string
                        description: LinkedIn profile entity id
                      updatedAt:
                        type: string
                        description: LinkedIn profile update timestamp
                        example: '2025-06-30T14:02:07.456Z'
                      createdAt:
                        type: string
                        description: LinkedIn profile creation timestamp
                        example: '2025-06-30T14:02:07.456Z'
                      name:
                        type: string
                        description: Prospect full name from LinkedIn
                      headline:
                        type: string
                        description: Prospect LinkedIn headline
                      avatarUrl:
                        description: Avatar image URL, if available
                        type: string
                      linkedInUrl:
                        type: string
                        description: Public LinkedIn profile URL
                    required:
                      - id
                      - updatedAt
                      - createdAt
                      - name
                      - headline
                      - linkedInUrl
                  list:
                    description: >-
                      Reference to the prospect list this prospect currently
                      belongs to — `id` plus `name`.
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Entity ID
                        example: 8d256aa6-9b12-49a7-93ee-bf41634b5b60
                      name:
                        type: string
                        description: Entity name
                      description:
                        description: Optional extra description, if available
                        type: string
                    required:
                      - id
                      - name
                  lastNewPostsObtainFinishDate:
                    description: Latest new-post fetch finish date, if available
                    type: string
                    example: '2025-06-30T14:02:07.456Z'
                  lastPostsFetchStatus:
                    type: string
                    description: >-
                      Status of the last attempt to fetch new posts for this
                      prospect. Common values: `success`, `requested` (queued),
                      `no_new_post_found`, `gologin_error`,
                      `crashed_or_cancelled`, `user_logged_out`,
                      `unknown_error`. Use together with
                      `lastNewPostsObtainFinishDate` to gauge fetch health.
                  isDeleted:
                    type: boolean
                    description: Whether the prospect is deleted
                  isImportant:
                    type: boolean
                    description: Whether the prospect is marked as important
                  type:
                    type: string
                    description: >-
                      Prospect kind. `LEAD` — a prospect the user added to
                      engage with directly; `RECENTLY_LIKED_RELATED_USER` — an
                      indirect prospect (someone the LEAD recently engaged
                      with), surfaced by the indirect-engagement feature when
                      `isIndirectEngagementEnabled` is on. Drives which actions
                      are available on the prospect.
                  parentTargetUser:
                    description: >-
                      For indirect prospects (`type ===
                      RECENTLY_LIKED_RELATED_USER`): reference to the original
                      LEAD prospect that engaged with this person. Exposes only
                      `id`, `type`, and `linkedInProfile` for navigation; fetch
                      the full parent record separately by its `id`. Missing for
                      direct LEADs.
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Parent prospect id
                      type:
                        type: string
                        description: >-
                          Parent prospect kind — same value space as the
                          top-level `type` field.
                      linkedInProfile:
                        description: LinkedIn profile of the parent prospect, if available
                        type: object
                        properties:
                          id:
                            type: string
                            description: LinkedIn profile entity id
                          updatedAt:
                            type: string
                            description: LinkedIn profile update timestamp
                            example: '2025-06-30T14:02:07.456Z'
                          createdAt:
                            type: string
                            description: LinkedIn profile creation timestamp
                            example: '2025-06-30T14:02:07.456Z'
                          name:
                            type: string
                            description: Prospect full name from LinkedIn
                          headline:
                            type: string
                            description: Prospect LinkedIn headline
                          avatarUrl:
                            description: Avatar image URL, if available
                            type: string
                          linkedInUrl:
                            type: string
                            description: Public LinkedIn profile URL
                        required:
                          - id
                          - updatedAt
                          - createdAt
                          - name
                          - headline
                          - linkedInUrl
                    required:
                      - id
                      - type
                  statistics:
                    description: Lightweight engagement statistics, if available
                    type: object
                    properties:
                      totalPostsCount:
                        type: number
                        description: >-
                          Total direct posts (posts the prospect authored
                          themselves) fetched so far.
                      oldestPostDate:
                        description: Oldest fetched direct post date, if available.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      newestPostDate:
                        description: Newest fetched direct post date, if available.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      answeredPostsCount:
                        type: number
                        description: >-
                          Number of direct comments already posted by the
                          campaign owner under the prospect's own posts.
                      pendingPostsAnswersCount:
                        type: number
                        description: >-
                          Number of direct comments approved and queued to be
                          posted to LinkedIn (not yet sent).
                      oldestPostAnswerDate:
                        description: Oldest direct comment date, if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      newestPostAnswerDate:
                        description: Newest direct comment date, if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      postsLikesCount:
                        type: number
                        description: >-
                          Likes the campaign owner placed on the prospect's own
                          posts.
                      weeklyPostFrequency:
                        type: number
                        description: >-
                          Average weekly posting frequency of the prospect
                          (their own posts).
                      lastNewSuccessPostsObtainFinishDate:
                        description: Last successful post sync finish date, if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      indirectPostsLikesCount:
                        type: number
                        description: >-
                          Likes the campaign owner placed on indirect posts
                          (posts from people the prospect engages with).
                      indirectOldestResponseCommentDate:
                        description: >-
                          Oldest indirect-comment date (comment under an
                          indirect post), if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      indirectNewestResponseCommentDate:
                        description: >-
                          Newest indirect-comment date (comment under an
                          indirect post), if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      indirectAnsweredPostsCount:
                        type: number
                        description: >-
                          Number of indirect comments already posted (comments
                          under indirect posts).
                      indirectPendingResponseCommentsCount:
                        type: number
                        description: >-
                          Number of indirect comments approved and queued to be
                          posted to LinkedIn (not yet sent).
                      lastNewSuccessPostsTotalCount:
                        type: number
                        description: >-
                          Number of new posts fetched during the last successful
                          post-fetch run.
                      totalIndirectPostActivitiesCount:
                        type: number
                        description: >-
                          Total indirect posts (posts from people the prospect
                          engages with) fetched so far.
                      weeklyIndirectPostActivityFrequency:
                        type: number
                        description: Average weekly frequency of indirect post activities.
                      newestPostReactionDate:
                        description: >-
                          Newest date of any reaction/like by the prospect on a
                          post, if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      totalAnsweredPostsCount:
                        type: number
                        description: >-
                          Total comments already posted by the campaign owner
                          (direct + indirect).
                      totalOldestResponseCommentDate:
                        description: >-
                          Oldest comment date across all activity (direct +
                          indirect), if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      totalNewestResponseCommentDate:
                        description: >-
                          Newest comment date across all activity (direct +
                          indirect), if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                    required:
                      - totalPostsCount
                      - answeredPostsCount
                      - pendingPostsAnswersCount
                      - postsLikesCount
                      - weeklyPostFrequency
                      - indirectPostsLikesCount
                      - indirectAnsweredPostsCount
                      - indirectPendingResponseCommentsCount
                      - lastNewSuccessPostsTotalCount
                      - totalIndirectPostActivitiesCount
                      - weeklyIndirectPostActivityFrequency
                      - totalAnsweredPostsCount
                  campaign:
                    description: Reference to the parent campaign — `id` plus `name`.
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Entity ID
                        example: 8d256aa6-9b12-49a7-93ee-bf41634b5b60
                      name:
                        type: string
                        description: Entity name
                      description:
                        description: Optional extra description, if available
                        type: string
                    required:
                      - id
                      - name
                  sharedBy:
                    description: Team member who shared this prospect, if applicable
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Entity ID
                        example: 8d256aa6-9b12-49a7-93ee-bf41634b5b60
                      name:
                        type: string
                        description: Entity name
                      description:
                        description: Optional extra description, if available
                        type: string
                    required:
                      - id
                      - name
                  user:
                    description: >-
                      Reference to the user who owns this prospect — `id` plus
                      `name`. Missing if not available.
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Entity ID
                        example: 8d256aa6-9b12-49a7-93ee-bf41634b5b60
                      name:
                        type: string
                        description: Entity name
                      description:
                        description: Optional extra description, if available
                        type: string
                    required:
                      - id
                      - name
                  userConnection:
                    description: LinkedIn connection data, if available
                    type: object
                    properties:
                      id:
                        type: string
                        description: Connection entity id
                      updatedAt:
                        type: string
                        description: Connection update timestamp
                        example: '2025-06-30T14:02:07.456Z'
                      createdAt:
                        type: string
                        description: Connection creation timestamp
                        example: '2025-06-30T14:02:07.456Z'
                      userId:
                        type: string
                        format: uuid
                        description: Team member id that owns the connection
                      prospectLinkedInProfileId:
                        type: string
                        description: LinkedIn profile id for the prospect
                      status:
                        type: string
                        description: Current connection status
                      connectedDate:
                        description: Date when the connection was established, if available
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      wasConnectionRequestSuccessfulAttemptMade:
                        type: boolean
                        description: >-
                          Whether Extrovert has successfully sent a connection
                          request to this prospect. If `false` and `status` is
                          `CONNECTED`, the connection was already in place
                          before Extrovert started tracking it.
                      connectionRequestSuccessfulAttemptMadeDate:
                        description: >-
                          Date when Extrovert successfully sent the connection
                          request, if any.
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                      latestDmHistoryMessageDate:
                        description: Latest synced DM history message date, if available
                        type: string
                        example: '2025-06-30T14:02:07.456Z'
                    required:
                      - id
                      - updatedAt
                      - createdAt
                      - userId
                      - prospectLinkedInProfileId
                      - status
                      - wasConnectionRequestSuccessfulAttemptMade
                required:
                  - id
                  - updatedAt
                  - createdAt
                  - lastPostsFetchStatus
                  - isDeleted
                  - isImportant
                  - type
              description: Prospect items
            pagination:
              description: Pagination information, if returned by the backend
              type: object
              properties:
                limit:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                  description: Page size limit
                offset:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                  description: Current page offset
                total:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                  description: Total number of available records
              required:
                - limit
                - offset
                - total
          description: Prospects response with optional pagination
        message:
          type: string
          description: Success message
          example: Operation completed successfully
      required:
        - status
        - data
        - message
    ClientApiErrorResponseDto:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: error
          enum:
            - error
        data:
          type: object
          description: Response data
          example: null
        message:
          type: string
          description: Error message
          example: An error occurred while processing the request
      required:
        - status
        - data
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````