> ## 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.

# List accounts

> Returns the X and LinkedIn accounts connected to your workspace, newest first. Not paged.



## OpenAPI

````yaml /openapi.json get /accounts
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:
    get:
      tags:
        - Accounts
      summary: List accounts
      description: >-
        Returns the X and LinkedIn accounts connected to your workspace, newest
        first. Not paged.
      operationId: accounts.list
      parameters:
        - name: platform
          in: query
          required: false
          description: Only accounts on this network.
          schema:
            type: string
            enum:
              - x
              - linkedin
      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: array
                    items:
                      $ref: '#/components/schemas/Account'
                  error:
                    type: 'null'
                    description: Always `null` on success.
              example:
                status: true
                data:
                  - id: 4f1c9a2e-6b7d-4c3a-9e51-0a8b7c6d5e4f
                    workspaceId: 9a1d2c3b-4e5f-4a6b-8c7d-0e1f2a3b4c5d
                    platform: x
                    platformId: '1566123362161725440'
                    handle: acmecorp
                    status: connected
                    needsReauth: false
                    profile:
                      username: acmecorp
                      name: Acme Corp
                      avatar: https://example.com/avatars/acme.jpg
                      url: https://x.com/acmecorp
                      followers: 5400
                      following: 210
                    connectedAt: '2026-09-01T09:00:00.000Z'
                    throttledUntil: null
                    tokenExpiresAt: null
                    warmup:
                      active: true
                      speed: slow
                      totalDays: 28
                      day: 6
                      progressPercent: 21
                      startedAt: '2026-10-12T09:00:00.000Z'
                error: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PlanRequired'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    Account:
      type: object
      description: >-
        An X or LinkedIn account connected to the workspace. Messages are sent
        from one.
      additionalProperties: true
      required:
        - id
        - workspaceId
        - platform
        - platformId
        - handle
        - status
        - needsReauth
        - profile
        - connectedAt
        - throttledUntil
        - tokenExpiresAt
        - warmup
      properties:
        id:
          type: string
          description: The account ID. Conversations carry it as `accountId`.
          examples:
            - 4f1c9a2e-6b7d-4c3a-9e51-0a8b7c6d5e4f
        workspaceId:
          type: string
          description: The workspace it belongs to.
          examples:
            - 9a1d2c3b-4e5f-4a6b-8c7d-0e1f2a3b4c5d
        platform:
          $ref: '#/components/schemas/Platform'
        platformId:
          type:
            - string
            - 'null'
          description: The ID the network gives the account.
          examples:
            - '1566123362161725440'
        handle:
          type:
            - string
            - 'null'
          description: The username, without a prefix.
          examples:
            - acmecorp
        status:
          type: string
          enum:
            - connected
            - needs_reauth
          description: >-
            `needs_reauth` when the account must be connected again in ReachHunt
            before it can send.
          examples:
            - connected
        needsReauth:
          type: boolean
          description: '`true` when `status` is `needs_reauth`.'
          examples:
            - false
        profile:
          type:
            - object
            - 'null'
          description: The profile on the network.
          additionalProperties: true
          properties:
            username:
              type:
                - string
                - 'null'
              examples:
                - acmecorp
            name:
              type:
                - string
                - 'null'
              examples:
                - Acme Corp
            avatar:
              type:
                - string
                - 'null'
              examples:
                - https://example.com/avatars/acme.jpg
            url:
              type:
                - string
                - 'null'
              examples:
                - https://x.com/acmecorp
            followers:
              type:
                - integer
                - 'null'
              examples:
                - 5400
            following:
              type:
                - integer
                - 'null'
              examples:
                - 210
            banner:
              type:
                - string
                - 'null'
              description: Link to the banner image.
            description:
              type:
                - string
                - 'null'
              description: The bio or about text.
            headline:
              type:
                - string
                - 'null'
              description: The profile headline. LinkedIn only.
            location:
              type:
                - string
                - 'null'
              description: The location on the profile.
            connections:
              type:
                - integer
                - 'null'
              description: Connection count. LinkedIn only.
            tweets:
              type:
                - integer
                - 'null'
              description: Post count. X only.
            verified:
              type: string
              enum:
                - blue
                - gold
                - none
              description: The verification badge.
            isVerified:
              type: boolean
            isBlueVerified:
              type: boolean
            verifiedType:
              type:
                - string
                - 'null'
              description: The kind of badge the network reports.
            isPremium:
              type:
                - boolean
                - 'null'
              description: Whether the account has a paid plan on the network.
            canDm:
              type:
                - boolean
                - 'null'
              description: Whether the account can send direct messages.
            createdAt:
              type:
                - string
                - 'null'
              description: When the account was created on the network.
        connectedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When it was connected, in ISO 8601 UTC.
          examples:
            - '2026-09-01T09:00:00.000Z'
        throttledUntil:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Sending is paused until this time to keep the account safe. `null`
            when it is not paused.
          examples:
            - null
        tokenExpiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the account's sign-in expires, in ISO 8601 UTC. `null` when it
            does not expire.
        warmup:
          $ref: '#/components/schemas/Warmup'
    Platform:
      type: string
      enum:
        - x
        - linkedin
      description: The network the item belongs to.
      examples:
        - linkedin
    Warmup:
      type: object
      description: Warm-up raises the limits step by step on a new account.
      required:
        - active
        - speed
        - totalDays
        - day
        - progressPercent
        - startedAt
      properties:
        active:
          type: boolean
          description: Whether the account is warming up now.
          examples:
            - true
        speed:
          type: string
          enum:
            - fast
            - medium
            - slow
          description: How fast the limits rise.
          examples:
            - slow
        totalDays:
          type: integer
          description: How many days the warm-up takes.
          examples:
            - 28
        day:
          type: integer
          description: The current day of the warm-up.
          examples:
            - 6
        progressPercent:
          type: integer
          description: How far the warm-up is, from 0 to 100.
          examples:
            - 21
        startedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the warm-up started, in ISO 8601 UTC.
          examples:
            - '2026-10-12T09:00:00.000Z'
    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.
  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.
  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.