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

# Get Sender Details

> Get usage, commitments, and campaign assignments for one sender.

**CLI:**

```bash theme={null}
puffle sender detail --id <id>
```

## Overview

Return one sender's operational detail: the account row, today's usage, projected commitments, mapped campaigns, and sender-scoped campaign prospect status breakdowns.

Use [List Senders](/api-reference/senders/list-senders) first to get the sender ID.

## AI agent notes

Call [List Senders](/api-reference/senders/list-senders) first unless you already have the sender account ID. Campaign-capable readiness is channel-specific: LinkedIn senders need `connected`; email senders need `active` for non-admin campaign traffic.

Campaign arrays can be empty when the sender is connected but not assigned anywhere. Use [Get Sender Schedule](/api-reference/senders/get-account-schedule) when you need the future commitment map for this sender.


## OpenAPI

````yaml get /api/senders/{id}
openapi: 3.0.3
info:
  title: Puffle API
  version: 1.0.0
  description: >-
    HTTP API for the Puffle GTM platform - Feed and Lead Finder search
    preparation, campaign-backed Outbound execution, Puffle Agent runs, sender
    management, and Unibox reply workflows. Designed for operation by both
    humans and autonomous AI agents. Agents should start at the [Agent
    Playbook](/guides/agent-playbook) which prescribes a workspace-context check
    (`GET /api/context`) and core user journeys with exact call ordering.
  contact:
    name: Puffle Support
    url: https://puffle.ai
servers:
  - url: https://app.puffle.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Campaigns
    description: >-
      Campaign-backed Outbound execution. These endpoints manage draft,
      launching, active, paused, and completed Outbound runs with sequence
      nodes, contacts, and sender accounts.
  - name: Accounts
    description: Signed-in user account, settings, and workspace context endpoints.
  - name: Billing
    description: Billing customer portal and account billing endpoints.
  - name: Senders
    description: >-
      Connected sender accounts, email inboxes, sending domains, DNS
      verification, warmup, and sender capacity.
  - name: Socials
    description: >-
      Read connected LinkedIn and X accounts, review current and archived posts,
      and reconcile publication status. Creating, editing, scheduling,
      publishing, OAuth connection, analytics, and mentions remain
      dashboard-managed workflows and are not part of the public Bearer-token
      API.
paths:
  /api/senders/{id}:
    get:
      tags:
        - Senders
      summary: Get Sender Details
      description: >-
        Return a single sender account with today's usage, projected
        commitments, campaign assignments, and sender-scoped campaign prospect
        status breakdowns. Use this after `listSenders` when an agent or UI
        needs one sender's operational detail without calling dashboard-owned
        APIs.
      operationId: getSenderDetails
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Account UUID.
      responses:
        '200':
          description: >-
            Sender details and usage. Campaign arrays are empty when the sender
            is not attached to any campaigns.
          content:
            application/json:
              schema:
                type: object
                properties:
                  account:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      user_id:
                        type: string
                        format: uuid
                      type:
                        type: string
                        enum:
                          - linkedin
                          - email
                          - reddit
                          - github
                          - x
                        description: >-
                          Channel this account is connected for. `linkedin`
                          accounts send connection requests and messages;
                          `email` accounts send email; `reddit`, `github`, and
                          `x` represent connected social identities for
                          search/result actions. Launch outbound campaigns
                          currently use only email and LinkedIn senders.
                      display_name:
                        type: string
                        nullable: true
                      status:
                        type: string
                        enum:
                          - connected
                          - disconnected
                          - credentials_required
                          - error
                          - pending
                          - warming
                          - active
                          - banned
                          - suspended
                        description: >-
                          Readiness of the account. LinkedIn: `connected` /
                          `disconnected` / `credentials_required` (OAuth
                          expired) / `error`. Email: `pending` (provisioning) /
                          `warming` (health ramp) / `active` (safe to send) /
                          `banned` / `suspended` / `error`. Reddit, GitHub, and
                          X: `pending` (awaiting consent) / `connected` (ready)
                          / `disconnected` / `error`. Campaign traffic requires
                          `connected` for LinkedIn and `active` for email unless
                          the caller is an admin, who may also use `warming`
                          email accounts.
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      provider_account_id:
                        description: >-
                          Provider account id for connected social senders. Null
                          for email accounts.
                        type: string
                        nullable: true
                      profile_url:
                        description: >-
                          LinkedIn profile URL for the connected person. Null
                          for email.
                        type: string
                        nullable: true
                      is_premium:
                        description: >-
                          LinkedIn: account has a Premium or Sales Navigator
                          subscription. Drives higher weekly limits. Null for
                          email.
                        type: boolean
                        nullable: true
                      has_sales_navigator:
                        type: boolean
                        nullable: true
                      weekly_connection_limit:
                        description: >-
                          LinkedIn: per-account ceiling on connection requests
                          per rolling 7-day window. Null for email.
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        nullable: true
                      weekly_message_limit:
                        description: >-
                          LinkedIn: per-account ceiling on messages per rolling
                          7-day window. Null for email.
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        nullable: true
                      email_address:
                        description: >-
                          Email address this account sends from. Null for
                          LinkedIn.
                        type: string
                        nullable: true
                      domain_id:
                        type: string
                        format: uuid
                        nullable: true
                      agentmail_inbox_id:
                        description: >-
                          Backing inbox ID for this email account. Null for
                          LinkedIn.
                        type: string
                        nullable: true
                      instantly_account_id:
                        type: string
                        nullable: true
                      warmup_status:
                        type: string
                        enum:
                          - not_started
                          - disabled
                          - warming
                          - warmed
                          - active
                          - ready
                          - banned
                          - suspended
                        nullable: true
                      first_name:
                        type: string
                        nullable: true
                      last_name:
                        type: string
                        nullable: true
                      signature:
                        type: string
                        nullable: true
                      daily_limit:
                        description: >-
                          Email: max sends per day through this account. Null
                          for LinkedIn (which uses `weekly_connection_limit` /
                          `weekly_message_limit` instead).
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        nullable: true
                      instantly_tag_id:
                        type: string
                        nullable: true
                      instantly_warmup_tag_id:
                        type: string
                        nullable: true
                      email_domains:
                        description: >-
                          Joined email_domains row when the account is attached
                          to a managed sending domain. Null for LinkedIn
                          accounts and email accounts on shared infrastructure.
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                          domain:
                            type: string
                          status:
                            type: string
                            description: >-
                              Domain verification state (e.g. `pending`,
                              `verified`). Email sends require a `verified`
                              domain.
                        required:
                          - id
                          - domain
                          - status
                        additionalProperties: false
                        nullable: true
                      weekly_stats:
                        type: object
                        properties:
                          connections_sent:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          messages_sent:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                        required:
                          - connections_sent
                          - messages_sent
                        additionalProperties: false
                        description: >-
                          Rolling 7-day LinkedIn activity from
                          `account_daily_stats`. Present when
                          `include_stats=true`.
                      limits:
                        type: object
                        properties:
                          weekly_connection_limit:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          weekly_message_limit:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          max_connection_limit:
                            type: integer
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                            minimum: 0
                          max_message_limit:
                            type: integer
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                            minimum: 0
                          recommended_connection_limit:
                            type: integer
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                            minimum: 0
                          recommended_message_limit:
                            type: integer
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                            minimum: 0
                        required:
                          - weekly_connection_limit
                          - weekly_message_limit
                          - max_connection_limit
                          - max_message_limit
                          - recommended_connection_limit
                          - recommended_message_limit
                        additionalProperties: false
                        description: >-
                          Effective weekly sender limits plus max/recommended
                          metadata. Present when `include_stats=true`.
                      daily_stats:
                        type: object
                        properties:
                          sent:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          daily_limit:
                            type: integer
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                            minimum: 0
                        required:
                          - sent
                          - daily_limit
                        additionalProperties: false
                        description: >-
                          Email sends recorded today and the effective sender
                          daily cap. Present for email accounts when
                          `include_stats=true`.
                      stats:
                        type: object
                        properties:
                          today_sent:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          today_committed:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                        required:
                          - today_sent
                          - today_committed
                        additionalProperties: false
                    required:
                      - id
                      - user_id
                      - type
                      - display_name
                      - status
                      - created_at
                      - updated_at
                      - provider_account_id
                      - profile_url
                      - is_premium
                      - has_sales_navigator
                      - weekly_connection_limit
                      - weekly_message_limit
                      - email_address
                      - domain_id
                      - agentmail_inbox_id
                      - instantly_account_id
                      - warmup_status
                      - first_name
                      - last_name
                      - signature
                      - daily_limit
                      - instantly_tag_id
                      - instantly_warmup_tag_id
                      - stats
                    additionalProperties: false
                  campaigns:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                        status:
                          type: string
                        daily_limit:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          nullable: true
                        type:
                          type: string
                          enum:
                            - linkedin
                            - email
                        stats:
                          type: object
                          additionalProperties:
                            type: number
                          nullable: true
                        operating_hours:
                          type: object
                          additionalProperties: {}
                          nullable: true
                        sequence_nodes:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                              type:
                                type: string
                            required:
                              - id
                              - type
                            additionalProperties: false
                      required:
                        - id
                        - name
                        - status
                        - daily_limit
                        - type
                        - stats
                      additionalProperties: false
                  mappings:
                    type: array
                    items:
                      type: object
                      properties:
                        campaign_id:
                          type: string
                          format: uuid
                        account_id:
                          type: string
                          format: uuid
                      required:
                        - campaign_id
                        - account_id
                      additionalProperties: false
                  campaignStatsByStatus:
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties:
                        type: number
                  campaignSenderStatsByStatus:
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties:
                        type: number
                  campaignSenderTodayStatsByStatus:
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties:
                        type: number
                  campaignActiveProspectsCount:
                    type: object
                    additionalProperties:
                      type: number
                required:
                  - account
                  - campaigns
                  - mappings
                  - campaignStatsByStatus
                  - campaignSenderStatsByStatus
                  - campaignSenderTodayStatsByStatus
                  - campaignActiveProspectsCount
                additionalProperties: false
              examples:
                default:
                  value:
                    account:
                      id: aaaa1111-1111-1111-1111-111111111111
                      user_id: u1111111-1111-1111-1111-111111111111
                      type: email
                      display_name: Sarah at Acme
                      status: active
                      created_at: '2026-04-20T10:00:00Z'
                      updated_at: '2026-04-21T09:00:00Z'
                      provider_account_id: null
                      profile_url: null
                      is_premium: null
                      has_sales_navigator: null
                      weekly_connection_limit: null
                      weekly_message_limit: null
                      email_address: sarah@acme.com
                      domain_id: dddd1111-1111-1111-1111-111111111111
                      agentmail_inbox_id: inbox_abc123
                      instantly_account_id: null
                      warmup_status: active
                      first_name: Sarah
                      last_name: Chen
                      signature: |-
                        Best,
                        Sarah
                      daily_limit: 50
                      instantly_tag_id: null
                      instantly_warmup_tag_id: null
                      stats:
                        today_sent: 8
                        today_committed: 12
                    campaigns:
                      - id: cccc1111-1111-1111-1111-111111111111
                        name: Founder outbound
                        status: active
                        daily_limit: 100
                        type: email
                        stats: null
                        operating_hours: null
                        sequence_nodes: []
                    mappings:
                      - campaign_id: cccc1111-1111-1111-1111-111111111111
                        account_id: aaaa1111-1111-1111-1111-111111111111
                    campaignStatsByStatus:
                      cccc1111-1111-1111-1111-111111111111:
                        contacted: 20
                    campaignSenderStatsByStatus:
                      cccc1111-1111-1111-1111-111111111111:aaaa1111-1111-1111-1111-111111111111:
                        contacted: 20
                    campaignSenderTodayStatsByStatus: {}
                    campaignActiveProspectsCount:
                      cccc1111-1111-1111-1111-111111111111: 20
        '401':
          description: Missing or invalid Bearer token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
              examples:
                default:
                  value:
                    error: Unauthorized
        '404':
          description: Sender doesn't exist or isn't owned by the caller.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
              examples:
                default:
                  value:
                    error: Sender not found
        '500':
          description: Database lookup failed or unexpected server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
              examples:
                default:
                  value:
                    error: Internal server error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: pk_live_...

````