GET
/
workspace
/
prospects
Get prospects with statistics
curl --request GET \
  --url https://api.goextrovert.com/client/v1/workspace/prospects \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "data": {
    "list": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174002",
        "fullName": "John Doe",
        "campaignId": "123e4567-e89b-12d3-a456-426614174001",
        "campaignName": "Q1 Outreach Campaign",
        "listId": "123e4567-e89b-12d3-a456-426614174000",
        "listName": "Enterprise Leads",
        "createdAt": "2024-01-15T10:30:00.000Z",
        "postsFetched": 42,
        "oldestFetchedPost": "2023-12-01T08:00:00.000Z",
        "newestFetchedPost": "2024-01-14T16:45:00.000Z",
        "directComments": 5,
        "recentDirectCommentDate": "2024-01-14T14:30:00.000Z",
        "indirectComments": 3,
        "recentIndirectCommentDate": "2024-01-13T11:20:00.000Z",
        "likes": 15
      }
    ]
  },
  "message": "Operation completed successfully",
  "statusCode": 200
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Query Parameters

​
campaignId
string
required

UUID of the campaign to retrieve prospects from. To get this ID: 1. Open your campaign in Extrovert web app, 2. Copy the URL from your browser, 3. Extract the first UUID from the URL. Example: https://app.goextrovert.com/dashboard/campaign/main/{campaignId}/target-user - The campaign ID is the first UUID in the URL.

Example:

"123e4567-e89b-12d3-a456-426614174001"

​
listId
string

UUID of a specific prospect list to filter results. If not provided, returns prospects from all lists in the campaign. To get this ID: 1. Open your prospect list in Extrovert web app, 2. Copy the URL from your browser, 3. Extract the second UUID from the URL. Example: https://app.goextrovert.com/dashboard/campaign/main/{campaignId}/target-user/{prospectListId} - The prospect list ID is the second UUID in the URL.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

200
application/json

Successfully retrieved prospects with statistics

The response is of type object.