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

# List company statuses

> Retrieve all deal flow statuses/stages for an account.
Results are ordered by rank (pipeline order), then by creation date.




## OpenAPI

````yaml openapi.json get /accounts/{account_id}/company-statuses
openapi: 3.1.0
info:
  title: Roulette API
  version: 1.0.0
  description: >
    The Roulette API provides programmatic access to manage your VC deal flow,

    companies, contacts, and related data.


    ## Authentication


    All API requests require authentication using a Bearer token. Include your
    API key

    in the `Authorization` header:


    ```

    Authorization: Bearer YOUR_API_KEY

    ```


    You can generate API keys from your account settings in the Roulette
    dashboard.


    ## Rate Limiting


    API requests are rate limited to ensure fair usage. Current limits:

    - 1000 requests per minute per API key

    - 100 requests per second per API key


    Rate limit headers are included in all responses:

    - `X-RateLimit-Limit`: Maximum requests per window

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when the window resets


    ## Pagination


    List endpoints support cursor-based pagination using the following query
    parameters:

    - `page`: Page number (default: 1)

    - `limit`: Items per page (default: 25, max: 100)


    Paginated responses include pagination metadata:

    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "limit": 25,
        "has_next": true,
        "has_prev": false
      }
    }

    ```


    **Note**: For performance reasons, total counts (`total`, `total_pages`) are
    not included.

    Use `has_next` and `has_prev` to determine if more pages exist.


    ## Errors


    The API uses standard HTTP status codes and returns errors in a consistent
    format:


    ```json

    {
      "success": false,
      "error": "Human readable error message",
      "data": null
    }

    ```


    Common status codes:

    - `400` Bad Request - Invalid parameters or request body

    - `401` Unauthorized - Missing or invalid API key

    - `403` Forbidden - Valid API key but insufficient permissions

    - `404` Not Found - Resource not found

    - `429` Too Many Requests - Rate limit exceeded

    - `500` Internal Server Error - Server-side error
  termsOfService: https://www.useroulette.com/terms
  contact:
    name: Roulette API Support
    email: support@useroulette.com
    url: https://www.useroulette.com/support
  license:
    name: Proprietary
    url: https://www.useroulette.com/license
servers:
  - url: https://www.useroulette.com/api/v1
    description: Production server
  - url: http://localhost:3000/api/v1
    description: Local development server
security:
  - BearerAuth: []
tags:
  - name: Companies
    description: >
      Manage companies in your deal flow pipeline. Companies represent potential

      investment opportunities with associated pitch decks, contacts, and
      metadata.
  - name: Company Statuses
    description: |
      Manage deal flow stages/statuses for organizing companies through your
      investment pipeline (e.g., "Initial Review", "Due Diligence", "Closed").
  - name: Company Settings
    description: |
      Configure custom fields and settings for company tracking.
  - name: Contacts
    description: |
      Manage contacts associated with companies, including founders, executives,
      and other key personnel.
  - name: Form Submissions
    description: |
      Access form submissions from integrated platforms like Tally.
  - name: Emails
    description: |
      Manage emails linked to companies and contacts.
  - name: Meeting Minutes
    description: |
      Store and retrieve meeting notes and minutes related to companies.
  - name: Shared Links
    description: |
      Create and manage secure shareable links for company portfolios.
  - name: Integrations
    description: |
      Configure third-party integrations (Tally, Specter, etc.).
  - name: Investor Dashboard
    description: |
      Configure and manage investor-facing portfolio dashboards.
  - name: Dashboard
    description: |
      Access aggregated dashboard data and analytics.
  - name: Team Members
    description: |
      View team members and their roles within your account.
  - name: Short URLs
    description: |
      Create shortened URLs with optional password protection.
paths:
  /accounts/{account_id}/company-statuses:
    get:
      tags:
        - Company Statuses
      summary: List company statuses
      description: |
        Retrieve all deal flow statuses/stages for an account.
        Results are ordered by rank (pipeline order), then by creation date.
      operationId: listCompanyStatuses
      parameters:
        - $ref: '#/components/parameters/AccountIdParam'
      responses:
        '200':
          description: List of company statuses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyStatusListResponse'
              example:
                success: true
                data:
                  - id: uuid-1
                    account_id: account-uuid
                    name: Initial Review
                    color: '#6B7280'
                    rank: 1
                    is_default: true
                    created_at: '2024-01-01T00:00:00Z'
                  - id: uuid-2
                    account_id: account-uuid
                    name: Due Diligence
                    color: '#3B82F6'
                    rank: 2
                    is_default: false
                    created_at: '2024-01-01T00:00:00Z'
                  - id: uuid-3
                    account_id: account-uuid
                    name: Partner Meeting
                    color: '#8B5CF6'
                    rank: 3
                    is_default: false
                    created_at: '2024-01-01T00:00:00Z'
                  - id: uuid-4
                    account_id: account-uuid
                    name: Term Sheet
                    color: '#10B981'
                    rank: 4
                    is_default: false
                    created_at: '2024-01-01T00:00:00Z'
                  - id: uuid-5
                    account_id: account-uuid
                    name: Passed
                    color: '#EF4444'
                    rank: 5
                    is_default: false
                    created_at: '2024-01-01T00:00:00Z'
                authType: api_key
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  parameters:
    AccountIdParam:
      name: account_id
      in: path
      required: true
      description: The unique identifier of the account/team
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    CompanyStatusListResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompanyStatus'
        authType:
          type: string
          enum:
            - api_key
            - session
            - jwt
    CompanyStatus:
      type: object
      description: Deal flow pipeline status
      properties:
        id:
          type: string
          format: uuid
        status_text:
          type: string
          description: Display name of the status
          example: Initial Review
        color:
          type: string
          description: Hex color code
          example: '#3B82F6'
        rank:
          type: integer
          description: Order in pipeline (lower = earlier)
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: Human-readable error message
          example: Invalid request body
        data:
          type: 'null'
          example: null
        authType:
          type: string
          enum:
            - api_key
            - session
          example: api_key
  responses:
    UnauthorizedError:
      description: Unauthorized - missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Invalid or expired API key
            data: null
    NotFoundError:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Resource not found
            data: null
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |
        API key authentication. Generate keys from your account settings.

        Include in header: `Authorization: Bearer YOUR_API_KEY`

````