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

> Returns the workspaces you can reach, with counts. `activeId` is the workspace the API key belongs to.



## OpenAPI

````yaml /openapi.json get /workspace/list
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:
  /workspace/list:
    get:
      tags:
        - Workspaces
      summary: List workspaces
      description: >-
        Returns the workspaces you can reach, with counts. `activeId` is the
        workspace the API key belongs to.
      operationId: workspaces.list
      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
                    required:
                      - workspaces
                      - activeId
                    properties:
                      workspaces:
                        type: array
                        items:
                          $ref: '#/components/schemas/WorkspaceSummary'
                      activeId:
                        type:
                          - string
                          - 'null'
                        description: The workspace the request acts in.
                        examples:
                          - 16a8d98f-70b1-45c7-aba0-c638be37a1f2
                  error:
                    type: 'null'
                    description: Always `null` on success.
              example:
                status: true
                data:
                  workspaces:
                    - workspaceId: 16a8d98f-70b1-45c7-aba0-c638be37a1f2
                      name: Acme Growth
                      logoUrl: null
                      ownerName: Dana Whitfield
                      role: owner
                      permissions: null
                      accounts: 3
                      campaigns: 5
                      leadLists: 8
                      members: 2
                  activeId: 16a8d98f-70b1-45c7-aba0-c638be37a1f2
                error: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PlanRequired'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    WorkspaceSummary:
      type: object
      required:
        - workspaceId
        - name
        - logoUrl
        - ownerName
        - role
        - permissions
        - accounts
        - campaigns
        - leadLists
        - members
      properties:
        workspaceId:
          type: string
          description: The workspace ID.
          examples:
            - 16a8d98f-70b1-45c7-aba0-c638be37a1f2
        name:
          type: string
          description: The workspace name.
          examples:
            - Acme Growth
        logoUrl:
          type:
            - string
            - 'null'
          description: Link to the workspace logo. `null` when none is set.
          examples:
            - null
        ownerName:
          type:
            - string
            - 'null'
          description: The name of the workspace owner.
          examples:
            - Dana Whitfield
        role:
          type: string
          enum:
            - owner
            - admin
            - member
          description: Your role in the workspace. Always `owner` with an API key.
          examples:
            - owner
        permissions:
          type:
            - object
            - 'null'
          description: 'Access per section: `none`, `limited` or `full`.'
          properties:
            dashboard:
              type: string
              enum:
                - none
                - limited
                - full
            campaigns:
              type: string
              enum:
                - none
                - limited
                - full
            templates:
              type: string
              enum:
                - none
                - limited
                - full
            leads:
              type: string
              enum:
                - none
                - limited
                - full
            inbox:
              type: string
              enum:
                - none
                - limited
                - full
            pipeline:
              type: string
              enum:
                - none
                - limited
                - full
            agents:
              type: string
              enum:
                - none
                - limited
                - full
            accounts:
              type: string
              enum:
                - none
                - limited
                - full
            members:
              type: string
              enum:
                - none
                - limited
                - full
            billing:
              type: string
              enum:
                - none
                - limited
                - full
        accounts:
          type: integer
          description: Connected accounts.
          examples:
            - 3
        campaigns:
          type: integer
          description: Campaigns.
          examples:
            - 5
        leadLists:
          type: integer
          description: Lead lists.
          examples:
            - 8
        members:
          type: integer
          description: People in the workspace, the owner included.
          examples:
            - 2
    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.