API Reference

List prospects in an audience

GET/v1/accounts/{accountGroupId}/audiences/{audienceId}/prospects

Prospect scope

Returned prospect objects are scoped to the audience. Use the prospect signals endpoint when you need signal results for a returned prospect.

Integration notes

Permissions

audiences:read for audience reads and navigation, audiences:write for audience or folder mutations, and prospects:read for listing prospects in an audience.

Pagination

Audience and prospect lists use cursor and limit. Navigation returns grouped folders and ungrouped audiences in one structure.

Parameters

accountGroupIdPath

Type: string

Account group ID that scopes the request.

Required

audienceIdPath

Type: string

Audience ID that identifies the list or folder target.

Required

cursorQuery

Type: string

Opaque pagination cursor returned by the previous page.

Optional

limitQuery

Type: number

Maximum number of items to return in this page.

Optional

Request body

This endpoint does not define a request body.

Responses

200

Paginated prospects

Schema: AudienceProspectListSuccessResponse

400

Request validation failed

Schema: ValidationErrorResponse

401

Invalid or missing API key

Schema: ErrorResponse

403

Missing required permission

Schema: ErrorResponse

404

Resource not found

Schema: ErrorResponse

409

Audience is still being populated by an active prospecting job (AUDIENCE_NOT_READY)

Schema: ErrorResponse

429

Rate limit exceeded

Schema: ErrorResponse

500

Internal server error

Schema: ErrorResponse

502

Upstream service error

Schema: ErrorResponse

Response examples

200 Example JSONAudienceProspectListSuccessResponse

{
    "success": true,
    "data": {
        "items": [
            {
                "id": "507f1f77bcf86cd799439011",
                "firstName": "Avery Stone",
                "lastName": "Avery Stone",
                "name": "Avery Stone",
                "headline": "string",
                "about": "string",
                "photoUrl": "https://example.com/resource",
                "linkedinUrl": "https://example.com/resource",
                "publicIdentifier": "string",
                "company": {
                    "name": "Avery Stone",
                    "linkedinIdentifier": "string",
                    "linkedinUrl": "https://example.com/resource",
                    "industry": "string",
                    "website": "https://example.com/resource",
                    "size": "string",
                    "location": "string",
                    "about": "string",
                    "logoUrl": "https://example.com/resource",
                    "founded": "string",
                    "type": "string",
                    "specialties": "string",
                    "followerCount": 25,
                    "tagline": "string"
                },
                "title": "string",
                "location": {
                    "text": "string",
                    "countryCode": "string"
                },
                "emails": [
                    {
                        "email": "person@example.com",
                        "deliverable": "string",
                        "qualityScore": "string"
                    }
                ],
                "premium": true,
                "isOpenProfile": true,
                "connectionStatus": "active",
                "chatStatus": "active"
            }
        ],
        "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTI4VDE1OjMwOjAwLjAwMFoifQ",
        "hasMore": true
    },
    "error": null,
    "traceId": "507f1f77bcf86cd799439011"
}

400 Example JSONValidationErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

401 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

403 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

404 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

409 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

429 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

500 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

502 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}