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

# List users

> Everyone in your workspace: the main account and every team member. Deleted users are not listed. A user's id is the same id as owner.id on activities, so every signal owner resolves to a user here.



## OpenAPI

````yaml https://app.stairoids.com/api/docs/public get /public/v1/users
openapi: 3.0.1
info:
  title: Stairoids API
  description: The Next Generation API
  version: '1.0'
servers:
  - url: https://app.stairoids.com/api
    description: Stairoids public API
security:
  - ApiKeyAuth: []
tags:
  - name: Public API - Funnel
    description: Funnel stages, distribution, and pipeline trend metrics.
  - name: Public API - Attribution
    description: Traffic sources, campaigns, and the accounts they drove.
  - name: Public API - Lead Scores
    description: Signal details and per-person scores.
  - name: Public API - Activity
    description: Per-person and general (cross-company) signal feeds.
  - name: Public API - LinkedIn Ads
    description: LinkedIn ad campaigns, posts, likes, and company engagement.
  - name: Public API - Employees
    description: Employees (people) at a company, and employee labels.
  - name: Public API - Reference
    description: Your users, ICPs, personas, labels, account lists, and signal categories.
  - name: Public API - Companies
    description: Search, look up, and read activity for scored companies.
  - name: Public API - Opportunities
    description: Your best outreach opportunities right now.
paths:
  /public/v1/users:
    get:
      tags:
        - Public API - Reference
      summary: List users
      description: >-
        Everyone in your workspace: the main account and every team member.
        Deleted users are not listed. A user's id is the same id as owner.id on
        activities, so every signal owner resolves to a user here.
      operationId: getPublicUsers
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PublicUserDTO'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                oneOf:
                  - $ref: '#/components/schemas/CustomError'
                  - $ref: '#/components/schemas/CommunityError'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CommunityError'
        '402':
          description: Payment Required
          content:
            '*/*':
              schema:
                oneOf:
                  - $ref: '#/components/schemas/InsufficientCreditsError'
                  - $ref: '#/components/schemas/PlanLimitError'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                oneOf:
                  - $ref: '#/components/schemas/CommunityError'
                  - $ref: '#/components/schemas/AgencyLimitError'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CommunityError'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CommunityError'
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CommunityError'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomError'
components:
  schemas:
    PublicUserDTO:
      type: object
      properties:
        id:
          type: integer
          description: User id. The same id as owner.id on activities.
          format: int64
          example: 30
        name:
          type: string
          description: >-
            Display name (organization name for the main account, otherwise
            first + last).
          example: Stairoids
        firstName:
          type: string
          description: First name.
          nullable: true
          example: Thomas
        lastName:
          type: string
          description: Last name.
          nullable: true
          example: Berrens
        email:
          type: string
          description: Login email address.
          example: thomas@stairoids.com
        organization:
          type: boolean
          description: >-
            True for the workspace's main account. It owns the company-level
            signals (website visits, ads, campaigns); team members own the
            signals from their personal LinkedIn.
        linkedinConnected:
          type: boolean
          description: >-
            Whether LinkedIn is connected: the company-page account for the main
            account, a personal LinkedIn account for a team member.
      description: 'A user in your workspace: the main account or a team member.'
    CustomError:
      type: object
      properties:
        errorType:
          type: string
          enum:
            - EMAIL_ALREADY_EXISTS
            - INVALID_EMAIL
            - UNAUTHORIZED
            - UNEXPECTED_ERROR
            - WRONG_PASSWORD
            - STILL_GENERATING
            - MISSING_HEADERS
            - USER_NOT_FOUND
            - WEAK_PASSWORD
            - VALIDATION_ERROR
            - NOT_FOUND
            - PLAN_LIMIT_EXCEEDED
            - INSUFFICIENT_CREDITS
            - FEATURE_NOT_AVAILABLE
            - PAYMENT_ERROR
            - ACTIVE_SUBSCRIPTION_EXISTS
            - AGENCY_LIMIT_EXCEEDED
            - PAYMENT_METHOD_REQUIRED
            - BILLED_BY_AGENCY
            - PAYMENT_AUTHENTICATION_REQUIRED
            - PLAN_BELOW_RECOMMENDED
            - PLAN_NOT_ALLOWED
            - TRIAL_NOT_ELIGIBLE
            - INVALID_2FA_CODE
            - EXPIRED_2FA_CHALLENGE
            - TURNSTILE_FAILED
            - TAKEOVER_NOT_AVAILABLE
            - TAKEOVER_BLOCKED_OPEN_INVOICE
            - UNLINK_BLOCKED_ACTIVE_BILLING
    CommunityError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    InsufficientCreditsError:
      type: object
      properties:
        errorType:
          type: string
          enum:
            - EMAIL_ALREADY_EXISTS
            - INVALID_EMAIL
            - UNAUTHORIZED
            - UNEXPECTED_ERROR
            - WRONG_PASSWORD
            - STILL_GENERATING
            - MISSING_HEADERS
            - USER_NOT_FOUND
            - WEAK_PASSWORD
            - VALIDATION_ERROR
            - NOT_FOUND
            - PLAN_LIMIT_EXCEEDED
            - INSUFFICIENT_CREDITS
            - FEATURE_NOT_AVAILABLE
            - PAYMENT_ERROR
            - ACTIVE_SUBSCRIPTION_EXISTS
            - AGENCY_LIMIT_EXCEEDED
            - PAYMENT_METHOD_REQUIRED
            - BILLED_BY_AGENCY
            - PAYMENT_AUTHENTICATION_REQUIRED
            - PLAN_BELOW_RECOMMENDED
            - PLAN_NOT_ALLOWED
            - TRIAL_NOT_ELIGIBLE
            - INVALID_2FA_CODE
            - EXPIRED_2FA_CHALLENGE
            - TURNSTILE_FAILED
            - TAKEOVER_NOT_AVAILABLE
            - TAKEOVER_BLOCKED_OPEN_INVOICE
            - UNLINK_BLOCKED_ACTIVE_BILLING
        required:
          type: integer
          format: int32
        available:
          type: integer
          format: int32
        message:
          type: string
    PlanLimitError:
      type: object
      properties:
        errorType:
          type: string
          enum:
            - EMAIL_ALREADY_EXISTS
            - INVALID_EMAIL
            - UNAUTHORIZED
            - UNEXPECTED_ERROR
            - WRONG_PASSWORD
            - STILL_GENERATING
            - MISSING_HEADERS
            - USER_NOT_FOUND
            - WEAK_PASSWORD
            - VALIDATION_ERROR
            - NOT_FOUND
            - PLAN_LIMIT_EXCEEDED
            - INSUFFICIENT_CREDITS
            - FEATURE_NOT_AVAILABLE
            - PAYMENT_ERROR
            - ACTIVE_SUBSCRIPTION_EXISTS
            - AGENCY_LIMIT_EXCEEDED
            - PAYMENT_METHOD_REQUIRED
            - BILLED_BY_AGENCY
            - PAYMENT_AUTHENTICATION_REQUIRED
            - PLAN_BELOW_RECOMMENDED
            - PLAN_NOT_ALLOWED
            - TRIAL_NOT_ELIGIBLE
            - INVALID_2FA_CODE
            - EXPIRED_2FA_CHALLENGE
            - TURNSTILE_FAILED
            - TAKEOVER_NOT_AVAILABLE
            - TAKEOVER_BLOCKED_OPEN_INVOICE
            - UNLINK_BLOCKED_ACTIVE_BILLING
        category:
          type: string
        currentUsage:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        addOnSlug:
          type: string
        planSlug:
          type: string
        addOnPriceMonthly:
          type: integer
          format: int32
        upgradePlanSlug:
          type: string
        upgradePlanName:
          type: string
        upgradePlanPriceMonthly:
          type: integer
          format: int32
    AgencyLimitError:
      type: object
      properties:
        errorType:
          type: string
          enum:
            - EMAIL_ALREADY_EXISTS
            - INVALID_EMAIL
            - UNAUTHORIZED
            - UNEXPECTED_ERROR
            - WRONG_PASSWORD
            - STILL_GENERATING
            - MISSING_HEADERS
            - USER_NOT_FOUND
            - WEAK_PASSWORD
            - VALIDATION_ERROR
            - NOT_FOUND
            - PLAN_LIMIT_EXCEEDED
            - INSUFFICIENT_CREDITS
            - FEATURE_NOT_AVAILABLE
            - PAYMENT_ERROR
            - ACTIVE_SUBSCRIPTION_EXISTS
            - AGENCY_LIMIT_EXCEEDED
            - PAYMENT_METHOD_REQUIRED
            - BILLED_BY_AGENCY
            - PAYMENT_AUTHENTICATION_REQUIRED
            - PLAN_BELOW_RECOMMENDED
            - PLAN_NOT_ALLOWED
            - TRIAL_NOT_ELIGIBLE
            - INVALID_2FA_CODE
            - EXPIRED_2FA_CHALLENGE
            - TURNSTILE_FAILED
            - TAKEOVER_NOT_AVAILABLE
            - TAKEOVER_BLOCKED_OPEN_INVOICE
            - UNLINK_BLOCKED_ACTIVE_BILLING
        category:
          type: string
        currentUsage:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Your organization's public API key.
      name: X-Api-Key
      in: header

````