> ## Documentation Index > Fetch the complete documentation index at: https://docs.sendler.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Lead > Read a campaign lead and its profile/contact details. Requires `leads:read`. Use the lead ID returned by [List Campaign Leads](https://docs.sendler.ai/api-reference/endpoint/get-leads.md). The lead must belong to this workspace. The endpoint accepts the `full` query option. See the generated response schema for supported profile, contact, outreach and custom-field data. Do not assume a provider profile ID or LinkedIn URL is the campaign lead's ID. ## OpenAPI ````yaml GET /v1/leads/{id} openapi: 3.0.0 info: title: SendPilot External API description: > # SendPilot External API v1 Public API for integrating with SendPilot programmatically. ## Authentication Requests authenticate with a workspace API key in the `X-API-Key` header: ``` X-API-Key: sp_live_your_api_key_here ``` `Authorization: Bearer sp_live_...` (or `sp_test_...`) is also accepted. Prefer one header; `X-API-Key` takes precedence. Clerk OAuth tokens for MCP connection URLs are not public REST API keys. A key only reaches what its scopes and creator's current workspace permissions allow. Each operation lists the scopes it needs in `x-sp-scopes`. Use `GET /v1/me` to inspect the effective permissions and subscription state. ## Rate Limits - **Per API Key**: 300 requests/minute - **Per Workspace**: 50,000 requests/day Responses that reach the rate limiter include these headers; early authentication failures may not: - `X-RateLimit-Limit`: Max requests per minute - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Epoch timestamp when limit resets ## LinkedIn Sender Limits When using messaging endpoints, these headers show account limits: - `X-LinkedIn-Messages-Remaining`: Messages left today - `X-LinkedIn-Connections-Remaining`: Connection requests left today - `X-LinkedIn-Quota-Reset-At`: When daily limits reset ## Retries Send an `Idempotency-Key` header on POST and PATCH requests. A retry with the same key within 24 hours returns the first result (with `Idempotent-Replayed: true`) instead of acting twice. The same key with a different request answers 422 `IDEMPOTENCY_KEY_REUSED`; a retry while the first request still runs answers 409 `IDEMPOTENCY_IN_PROGRESS`. Once execution is attempted, its response (including errors) is retained. If a process stops or result storage fails after the attempt, the durable record blocks another execution for the replay window and returns 409 `IDEMPOTENCY_IN_PROGRESS` or `IDEMPOTENCY_REPLAY_UNAVAILABLE`. Check the operation's status before using a new key: an uncertain outcome may already have acted. Requests refused before execution is claimed, such as authentication or rate-limit refusals, can be retried with the same key. ## Webhooks Configure webhooks in the SendPilot app to receive real-time events: - `lead.tag.updated` - `lead.updated` - `message.sent` - `reply.received` - `connection_request.sent` - `connection_request.accepted` - `campaign.started` - `campaign.paused` - `campaign.resumed` - `campaign.finished` ## Error Codes Errors return a JSON body. Use the machine-readable `code` when supplied; validation messages can be arrays, and some legacy errors omit `code`. A typical error is: ```json { "statusCode": 400, "error": "Bad Request", "code": "SPECIFIC_ERROR_CODE", "message": "Human-readable description" } ``` version: '1.0' contact: name: SendPilot Support url: https://sendpilot.ai email: support@sendpilot.ai servers: - url: https://api.sendpilot.ai security: [] tags: [] paths: /v1/leads/{id}: get: tags: - External API - Leads summary: Get lead details description: >- Get detailed information about a specific lead. Use ?full=true for all fields including dynamic data. operationId: leads.get parameters: - name: id required: true in: path description: Lead ID schema: type: string - name: full required: false in: query description: >- true (or 1) for all fields: contact data, profile details and custom fields schema: type: boolean responses: '200': description: Lead details (use ?full=true for full data) content: application/json: schema: $ref: '#/components/schemas/LeadFullDto' '404': description: Lead not found security: - api-key: [] components: schemas: LeadFullDto: type: object properties: id: type: string description: Lead ID linkedinUrl: type: string description: LinkedIn URL firstName: type: string description: First name lastName: type: string description: Last name company: type: string description: Company title: type: string description: Title status: $ref: '#/components/schemas/LeadStatus' customLeadStatus: type: string description: Custom lead status campaignId: type: string description: Campaign ID the lead belongs to senderId: type: string description: >- LinkedIn sender assigned to this lead (use as senderId for /v1/inbox/send); null until the campaign assigns one nullable: true createdAt: format: date-time type: string description: When the lead was added email: type: string description: Email address location: type: string description: Location industry: type: string description: Industry about: type: string description: About/bio website: type: string description: Website profilePictureUrl: type: string description: Profile picture URL isPremium: type: boolean description: Is premium LinkedIn account isOpenProfile: type: boolean description: Is open profile connectionCount: type: number description: Connection count followerCount: type: number description: Follower count data: type: object description: All dynamic lead data including custom fields additionalProperties: true updatedAt: format: date-time type: string description: When the lead was last updated required: - id - linkedinUrl - status - customLeadStatus - campaignId - createdAt - updatedAt LeadStatus: type: string description: Lead status enum: - PENDING - PROCESSING - MESSAGE_SENT - CONNECTION_SENT - CONNECTION_ACCEPTED - CONNECTION_ALREADY_SENT - REPLY_RECEIVED - FOLLOWUP_SENT - BLOCKED - PROFILE_UNREACHABLE - RATE_LIMITED - FAILED - SUCCESS - UNSUBSCRIBED - IRRELEVANT - SKIPPED - DONE - MEETING_BOOKED - OPPORTUNITY - LIKED_POST - MESSAGE_SCHEDULED - CONNECTION_SCHEDULED - LIKE_POST_SCHEDULED - VIEW_PROFILE_SCHEDULED - CONNECTED - CONNECTION_WITHDRAWN - WITHDRAWAL_SCHEDULED - WITHDRAWAL_NOT_POSSIBLE - NOT_CONNECTED - ICP_MATCH - ICP_NOT_MATCH - PROFILE_VIEWED - STARTED - STOPPED - WAITING securitySchemes: api-key: type: apiKey in: header name: X-API-Key description: 'API key for authentication (prefix: sp_live_ or sp_test_)' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.