API Reference

List Sales Navigator lead lists

GET/v1/accounts/{accountGroupId}/sales-navigator/lead-lists

Lead-list source IDs

Use lead-list IDs from this endpoint when starting a sales_navigator prospecting job with leadListId.

Integration notes

Permissions

prospecting:read for source and job reads, prospects:read for provider-id lookup, and prospecting:write for starting or cancelling jobs.

Async

POST /prospecting returns 202 Accepted with a job id. Poll GET /prospecting/{jobId} and cancel with POST /prospecting/{jobId}/cancel when needed.

Parameters

accountGroupIdPath

Type: string

Account group ID that scopes the request.

Required

Request body

This endpoint does not define a request body.

Responses

200

Lead lists

Schema: SalesNavigatorListSuccessResponse

401

Invalid or missing API key

Schema: ErrorResponse

403

Missing required permission

Schema: ErrorResponse

429

Rate limit exceeded

Schema: ErrorResponse

500

Internal server error

Schema: ErrorResponse

502

Upstream service error

Schema: ErrorResponse

Response examples

200 Example JSONSalesNavigatorListSuccessResponse

{
    "success": true,
    "data": {
        "items": [
            {
                "id": "507f1f77bcf86cd799439011",
                "name": "Avery Stone"
            }
        ]
    },
    "error": null,
    "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"
}

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"
}