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

# Read sender profile caps

> The sender profile's daily caps, read live: result.linkedin one row per outreach action type (caps, counts, switches, status, hold_till), empty with no LinkedIn account; result.mailboxes each mailbox's caps and warm-up off the mirror. With days, result.history: the caps the account ran under over those days and every time LinkedIn refused an action on its own quota ("why did the invites stop on Tuesday"). Edit with update_sender_profile_linkedin_limit or update_sender_profile_mailbox.

Contract:
- MCP tool `read_sender_profile_limits`, registry package `mcp.unibox/sender_profiles`, mount `sender-profiles`.
- Operation `action`, response envelope `action`.
- Flags: read only.



## OpenAPI

````yaml /api-reference/unibox/openapi.yaml post /api/sender-profiles/{sid}/limits
openapi: 3.0.3
info:
  title: 'GetSales public contract: gs.service.unibox'
  description: >-
    The team inbox and the AI SDR: every LinkedIn and email thread in one place
    (conversations, messages, the timeline events), the manual tasks a thread
    spawns, the sender profiles the team speaks through with their LinkedIn
    account and mailboxes, and the one agent per team with its scenarios, plans
    and runs.


    GENERATED. This document is projected from the Zod MCP tool registry in
    `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by
    hand; edit the tool definition and regenerate with `pnpm openapi:public`.


    Surface: the public `/api` contract of `gs.service.unibox`, 97 operations.
    This is the only OpenAPI document the platform publishes. Internal
    (`/internal`) and health endpoints are deliberately absent: they are not
    part of any contract, they can change without notice, and the service source
    is their only description.


    Conventions:

    - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header.

    - Every success body is an MCP envelope: `success: true` plus one typed
    `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`,
    `group_by`, `action`), and a `meta` block with `trace_id` for support.

    - Every failure is the same `McpError` envelope with a code from a fixed
    16-code taxonomy, so a client maps errors once.

    - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward
    `cursor`; `page_size: 0` returns counts only.

    - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`)
    travel as JSON text and array-valued ones repeat as `name[]=value`.

    - The MCP-only `_meta` field (usage analytics) never reaches the backend and
    is not part of this contract.
  version: '1.0'
  contact:
    name: GetSales
    url: https://getsales.io
    email: support@getsales.io
  license:
    name: Proprietary
    url: https://getsales.io/terms
servers:
  - url: https://api2.getsales.io/unibox/v1
    description: Production
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: agent_answers
    description: >-
      Registry package `mcp.unibox/agent_answers`, served on MCP mount
      `ai-sdr.training`.
  - name: agent_conversation_uploads
    description: >-
      Registry package `mcp.unibox/agent_conversation_uploads`, served on MCP
      mount `ai-sdr.training`.
  - name: agent_examples
    description: >-
      Registry package `mcp.unibox/agent_examples`, served on MCP mount
      `ai-sdr.training`.
  - name: agent_hints
    description: >-
      Registry package `mcp.unibox/agent_hints`, served on MCP mount
      `ai-sdr.training`.
  - name: agent_plans
    description: >-
      Registry package `mcp.unibox/agent_plans`, served on MCP mount
      `ai-sdr.agents`.
  - name: agent_runs
    description: >-
      Registry package `mcp.unibox/agent_runs`, served on MCP mount
      `ai-sdr.agents`.
  - name: agent_scenarios
    description: >-
      Registry package `mcp.unibox/agent_scenarios`, served on MCP mount
      `ai-sdr.agents`.
  - name: agent_source_parses
    description: >-
      Registry package `mcp.unibox/agent_source_parses`, served on MCP mount
      `ai-sdr.training`.
  - name: agent_sources
    description: >-
      Registry package `mcp.unibox/agent_sources`, served on MCP mount
      `ai-sdr.training`.
  - name: agent_tests
    description: >-
      Registry package `mcp.unibox/agent_tests`, served on MCP mount
      `ai-sdr.training`.
  - name: agents
    description: >-
      Registry package `mcp.unibox/agents`, served on MCP mount
      `workspace.team`.
  - name: conversations
    description: Registry package `mcp.unibox/conversations`, served on MCP mount `inbox`.
  - name: messages
    description: Registry package `mcp.unibox/messages`, served on MCP mount `inbox`.
  - name: sender_profile_variables
    description: >-
      Registry package `mcp.unibox/sender_profile_variables`, served on MCP
      mount `sender-profiles`.
  - name: sender_profiles
    description: >-
      Registry package `mcp.unibox/sender_profiles`, served on MCP mount
      `sender-profiles`.
  - name: tasks
    description: Registry package `mcp.unibox/tasks`, served on MCP mount `inbox`.
  - name: timeline
    description: Registry package `mcp.unibox/timeline`, served on MCP mount `inbox`.
paths:
  /api/sender-profiles/{sid}/limits:
    post:
      tags:
        - sender_profiles
      summary: Read sender profile caps
      description: >-
        The sender profile's daily caps, read live: result.linkedin one row per
        outreach action type (caps, counts, switches, status, hold_till), empty
        with no LinkedIn account; result.mailboxes each mailbox's caps and
        warm-up off the mirror. With days, result.history: the caps the account
        ran under over those days and every time LinkedIn refused an action on
        its own quota ("why did the invites stop on Tuesday"). Edit with
        update_sender_profile_linkedin_limit or update_sender_profile_mailbox.


        Contract:

        - MCP tool `read_sender_profile_limits`, registry package
        `mcp.unibox/sender_profiles`, mount `sender-profiles`.

        - Operation `action`, response envelope `action`.

        - Flags: read only.
      operationId: read_sender_profile_limits
      parameters:
        - name: sid
          in: path
          required: true
          description: Sender profile sid (ub_sp_…).
          schema:
            type: string
            minLength: 18
            maxLength: 18
            pattern: ^ub_sp_
            description: Sender profile sid (ub_sp_…).
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadSenderProfileLimitsRequest'
      responses:
        '200':
          description: '`action` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadSenderProfileLimitsResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    ReadSenderProfileLimitsRequest:
      type: object
      description: Request body of `read_sender_profile_limits`.
      properties:
        days:
          type: integer
          minimum: 1
          maximum: 60
          description: >-
            How many days back to read the history under the LinkedIn caps,
            today included (the LinkedIn tab draws 30): result.history comes
            back with it. Left out, the caps alone.
    ReadSenderProfileLimitsResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        operation:
          type: string
          enum:
            - action
        action:
          type: string
          description: kebab-case verb; matches the route segment.
        item:
          type: object
          nullable: true
          additionalProperties: {}
        result:
          type: object
          properties:
            linkedin:
              type: array
              items:
                type: object
                properties:
                  sid:
                    type: string
                    description: >-
                      The cap row (ln_sm_…): pass it to
                      update_sender_profile_linkedin_limit.
                  limit_type:
                    type: string
                    description: >-
                      The action the row budgets: send_connection_requests,
                      send_messages, send_inmails, visit_profiles, react_posts,
                      comment_posts, endorse_skills, and the two umbrella
                      buckets networking_general and messaging_general.
                  daily_limit:
                    type: integer
                    nullable: true
                  target_limit:
                    type: integer
                    nullable: true
                  smart_limit:
                    type: integer
                    nullable: true
                    description: The cap in force today while the automatic caps are on.
                  learned_ceiling:
                    type: integer
                    nullable: true
                    description: What the learner has worked the account up to.
                  delay_in_seconds:
                    type: integer
                    nullable: true
                  batch_size:
                    type: integer
                    nullable: true
                  done_today_count:
                    type: integer
                    nullable: true
                  done_7d_count:
                    type: integer
                    nullable: true
                  smart_limits_enabled:
                    type: boolean
                    nullable: true
                    description: >-
                      The account's switch, mirrored on every row (one per
                      account).
                  learning_enabled:
                    type: boolean
                    nullable: true
                  status:
                    type: string
                    nullable: true
                    description: The row's status, e.g. active or held.
                  hold_till:
                    type: string
                    nullable: true
                    description: >-
                      ISO 8601 UTC: nothing of this type goes out before then.
                      reset_hold lifts it.
                  linkedin_quota_hit_till:
                    type: string
                    nullable: true
                    description: 'ISO 8601 UTC: LinkedIn''s own quota refuses until then.'
                  last_reset_at:
                    type: string
                    nullable: true
                required:
                  - sid
                  - limit_type
                  - daily_limit
                  - target_limit
                  - smart_limit
                  - learned_ceiling
                  - delay_in_seconds
                  - batch_size
                  - done_today_count
                  - done_7d_count
                  - smart_limits_enabled
                  - learning_enabled
                  - status
                  - hold_till
                  - linkedin_quota_hit_till
                  - last_reset_at
              description: >-
                One row per outreach action type, read live. Empty on a sender
                profile with no LinkedIn account.
            smart_limits_enabled:
              type: boolean
              nullable: true
              description: >-
                The account-wide switch of the automatic caps (one per account);
                every row's smart_limits_enabled mirrors it. Flip it with
                update_sender_profile_linkedin_limit (smart_limits_enabled).
                null on a sender profile with no LinkedIn account, or one the
                linked workspace does not list.
            mailboxes:
              type: array
              items:
                type: object
                properties:
                  email_account_sid:
                    type: string
                  address:
                    type: string
                    nullable: true
                  status:
                    type: string
                    nullable: true
                  is_primary:
                    type: boolean
                    nullable: true
                  sending_limits:
                    type: object
                    nullable: true
                    additionalProperties: {}
                  warmup_config:
                    type: object
                    nullable: true
                    additionalProperties: {}
                required:
                  - email_account_sid
                  - address
                  - status
                  - is_primary
                  - sending_limits
                  - warmup_config
              description: >-
                Each mailbox's caps off the sender profile mirror (no
                per-mailbox counters are kept to show).
            history:
              type: object
              properties:
                linkedin_account_sid:
                  type: string
                  nullable: true
                  description: >-
                    The sender profile's LinkedIn account (ln_ac_…); null on a
                    sender profile without one, which answers no periods and no
                    hits.
                periods:
                  type: array
                  items:
                    type: object
                    properties:
                      from:
                        type: string
                        description: >-
                          ISO 8601 UTC instant the period starts at, a snapshot
                          of the account. It runs until the next period starts,
                          the last one until now.
                      warmup_score:
                        type: integer
                        nullable: true
                        description: >-
                          The account's warmup score (0..100) from that
                          snapshot, the one that set the period's caps; null
                          while the account has no score yet.
                      daily_limits:
                        type: object
                        properties:
                          send_connection_requests:
                            type: integer
                            nullable: true
                          send_messages:
                            type: integer
                            nullable: true
                          send_inmails:
                            type: integer
                            nullable: true
                        required:
                          - send_connection_requests
                          - send_messages
                          - send_inmails
                        description: >-
                          The daily cap per action type the account ran under in
                          the period; null when the account has no row for the
                          type.
                    required:
                      - from
                      - warmup_score
                      - daily_limits
                  description: >-
                    The caps the account ran under, oldest first, the first one
                    opening the window. An account is snapshotted and only then
                    ramped, so a snapshot records the caps of the period before
                    it: each period carries the next snapshot's record, the last
                    one the live rows. An account never snapshotted has one
                    period, from now, with the live caps.
                quota_hits:
                  type: array
                  items:
                    type: object
                    properties:
                      hit_at:
                        type: string
                        description: ISO 8601 UTC instant LinkedIn refused the action.
                      limit_type:
                        type: string
                        nullable: true
                        description: >-
                          The action type the refusal counts against
                          (send_connection_requests, send_inmails, …); null when
                          it could not be attributed.
                      reason:
                        type: string
                        nullable: true
                        description: 'The reason token: connection_request | inmail | other.'
                    required:
                      - hit_at
                      - limit_type
                      - reason
                  description: >-
                    Every time LinkedIn itself refused an action on its own
                    quota in the window, oldest first. A cap filling up is not
                    one.
              required:
                - linkedin_account_sid
                - periods
                - quota_hits
              description: >-
                With days: the history under the LinkedIn caps over those days,
                read live and never stored (the account's snapshots and quota
                hits); absent without days.
          required:
            - linkedin
            - smart_limits_enabled
            - mailboxes
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - operation
        - action
        - item
        - result
        - meta
    McpError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - nothing_to_update
                - not_found
                - relation_not_found
                - invalid_transition
                - limit_exceeded
                - payment_required
                - duplicate_rejected
                - conflict
                - delete_blocked
                - unauthorized
                - forbidden
                - rate_limited
                - internal_error
                - service_unavailable
                - not_implemented
            message:
              type: string
            recoverable:
              type: boolean
            suggestion:
              type: string
            field_errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: object
                  properties:
                    rule:
                      type: string
                    message:
                      type: string
                  required:
                    - rule
                    - message
            blockers:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    description: >-
                      Machine-readable blocker type (active_flow, pending_tasks,
                      …).
                  severity:
                    type: string
                    enum:
                      - hard
                      - soft
                    description: >-
                      hard = external action required; soft = acknowledge is
                      enough.
                  description:
                    type: string
                  entity_sid:
                    type: string
                    nullable: true
                  count:
                    type: integer
                  resolution:
                    type: string
                    description: 'Hard: tool name to call. Soft: code for acknowledge[].'
                  resolution_hint:
                    type: string
                required:
                  - type
                  - severity
                  - description
                  - entity_sid
                  - resolution
                  - resolution_hint
            context:
              type: object
              additionalProperties: {}
          required:
            - code
            - message
            - recoverable
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - error
  responses:
    McpClientError:
      description: >-
        MCP error envelope. `error.code` is one of validation_failed,
        nothing_to_update, not_found, relation_not_found, invalid_transition,
        limit_exceeded, payment_required, duplicate_rejected, conflict,
        delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
    McpServerError:
      description: >-
        MCP error envelope with `error.code` internal_error or
        service_unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
  securitySchemes:
    BearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token issued by gs.service.id. Its `access_identity` claim
        carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is
        authoritative.
    TeamSid:
      type: apiKey
      in: header
      name: Team-SID
      description: >-
        Team scope for tokens that do not carry one. Ignored when the token
        already names a team.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.