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

# Get limits summary

> Returns the sending limits and pace of every connected account, and what they can send together.



## OpenAPI

````yaml /openapi.json get /accounts/limits/summary
openapi: 3.1.0
info:
  title: ReachHunt API
  version: 1.0.0
  description: >-
    The ReachHunt API gives your own apps and scripts programmatic access to
    your workspace: accounts, campaigns, lead lists, conversations, messages,
    tags and statuses.


    Send your API key in the `Authorization` header: `Authorization: Bearer
    YOUR_API_KEY`. The key decides the workspace, so no path or parameter names
    one.


    Every response has the same envelope: `{ "status": true, "data": ...,
    "error": null }`.
servers:
  - url: https://api.reachhunt.ai/api/v1
    description: Production
security: []
tags:
  - name: Workspaces
    description: Your workspace and the people in it.
  - name: Accounts
    description: The X and LinkedIn accounts you connected.
  - name: Analytics
    description: Activity over time.
  - name: Credits
    description: AI credits and how they were used.
  - name: Campaigns
    description: Outreach that messages your leads step by step.
  - name: Agents
    description: AI agents that reply to your leads.
  - name: Tags
    description: Labels you put on conversations.
  - name: Statuses
    description: Pipeline stages you put conversations in.
  - name: Leads
    description: The people in your lead lists.
  - name: Lead lists
    description: Lists of people you collect to message.
  - name: Conversations
    description: The conversations in your inbox.
  - name: Messages
    description: The messages in a conversation.
  - name: Conversation details
    description: Your team's record of the person in a conversation.
  - name: Internal notes
    description: Notes only your team sees.
  - name: Scheduled messages
    description: Messages set to send later.
  - name: Templates
    description: Saved messages you can reuse.
  - name: Webhook events
    description: What each event sends.
paths:
  /accounts/limits/summary:
    get:
      tags:
        - Accounts
      summary: Get limits summary
      description: >-
        Returns the sending limits and pace of every connected account, and what
        they can send together.
      operationId: accounts.limitsSummary
      responses:
        '200':
          description: 'OK. Check `status`: errors the API handles itself also return 200.'
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                  - error
                properties:
                  status:
                    type: boolean
                    description: '`true` when the request succeeded.'
                  data:
                    type: object
                    properties:
                      mode:
                        type: string
                        description: How sending limits are applied.
                      accounts:
                        type: array
                        items:
                          type: object
                          properties:
                            accountId:
                              type: string
                              description: The connected account.
                            handle:
                              type: string
                              description: The username, without a prefix.
                            platform:
                              type: string
                              description: 'The network: `x` or `linkedin`.'
                            status:
                              type: string
                              description: The current state.
                            warmup:
                              type: object
                              properties:
                                active:
                                  type: boolean
                                speed:
                                  type: string
                                totalDays:
                                  type: integer
                                day:
                                  type: integer
                                startedAt:
                                  type: string
                                  format: date-time
                                  description: When it started, in ISO 8601 UTC.
                                progressPercent:
                                  type: integer
                                  description: How far it is, from 0 to 100.
                              required:
                                - active
                                - speed
                                - totalDays
                                - day
                                - startedAt
                                - progressPercent
                              description: Where the warm-up stands.
                            throttle:
                              type:
                                - object
                                - 'null'
                              description: >-
                                Set when sending is paused to keep the account
                                safe. `null` otherwise.
                            rate:
                              type: object
                              properties:
                                maxPerHour:
                                  type: integer
                                startPerHour:
                                  type: integer
                                warmupCeiling:
                                  type: integer
                                cap:
                                  type:
                                    - integer
                                    - 'null'
                                capUntil:
                                  type:
                                    - string
                                    - 'null'
                                capReason:
                                  type:
                                    - string
                                    - 'null'
                                ceiling:
                                  type: integer
                                usedHour:
                                  type: integer
                                remainingHour:
                                  type: integer
                                nextSlotAt:
                                  type:
                                    - string
                                    - 'null'
                                  format: date-time
                                reachesMaxAt:
                                  type: string
                                  format: date-time
                                usedToday:
                                  type: integer
                                dailyBackstop:
                                  type: integer
                              required:
                                - maxPerHour
                                - startPerHour
                                - warmupCeiling
                                - cap
                                - capUntil
                                - capReason
                                - ceiling
                                - usedHour
                                - remainingHour
                                - nextSlotAt
                                - reachesMaxAt
                                - usedToday
                                - dailyBackstop
                              description: Hourly sending pace.
                            hold:
                              type:
                                - object
                                - 'null'
                              description: Set when sending is on hold. `null` otherwise.
                          required:
                            - accountId
                            - handle
                            - platform
                            - status
                            - warmup
                            - throttle
                            - rate
                            - hold
                      capacity:
                        type: object
                        properties:
                          accounts:
                            type: integer
                          connectionRequestsToday:
                            type: integer
                          connectionRequestsPerWeek:
                            type: integer
                          directMessagesToday:
                            type: integer
                          x:
                            type: object
                            properties:
                              accounts:
                                type: integer
                              sendsPerHour:
                                type: integer
                              remainingThisHour:
                                type: integer
                            required:
                              - accounts
                              - sendsPerHour
                              - remainingThisHour
                        required:
                          - accounts
                          - connectionRequestsToday
                          - connectionRequestsPerWeek
                          - directMessagesToday
                          - x
                        description: What your accounts can send.
                    required:
                      - mode
                      - accounts
                      - capacity
                  error:
                    type: 'null'
                    description: Always `null` on success.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PlanRequired'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  responses:
    Unauthorized:
      description: The API key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'
          example:
            status: false
            data: null
            error: Not authenticated
    PlanRequired:
      description: The workspace has no active plan, or its trial has ended.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'
          example:
            status: false
            data: null
            error: Your free trial has ended. Pick a plan to continue.
    ServerError:
      description: Something failed on our side. Try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'
          example:
            status: false
            data: null
            error: Something went wrong. Please try again.
  schemas:
    Failure:
      type: object
      required:
        - status
        - data
        - error
      properties:
        status:
          type: boolean
          description: Always `false` for an error.
        data:
          type: 'null'
          description: Always `null` for an error.
        error:
          type: string
          description: What went wrong, in plain words.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: Bearer
      description: >-
        Your API key, sent as `Authorization: Bearer YOUR_API_KEY`. Create one
        in **Settings → API**.
      x-default: Bearer YOUR_API_KEY

````

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