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

> Retrieve a paginated list of companies in your deal flow pipeline.
Supports filtering, sorting, and full-text search.

**Note**: Pagination uses cursor-based `has_next`/`has_prev` for performance.
Total counts are not provided to optimize response times.




## OpenAPI

````yaml openapi.json get /companies
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:
  /companies:
    get:
      tags:
        - Companies
      summary: List companies
      description: >
        Retrieve a paginated list of companies in your deal flow pipeline.

        Supports filtering, sorting, and full-text search.


        **Note**: Pagination uses cursor-based `has_next`/`has_prev` for
        performance.

        Total counts are not provided to optimize response times.
      operationId: listCompanies
      parameters:
        - $ref: '#/components/parameters/PageParam'
        - $ref: '#/components/parameters/LimitParam'
        - $ref: '#/components/parameters/SortByParam'
        - $ref: '#/components/parameters/SortOrderParam'
        - $ref: '#/components/parameters/SearchParam'
        - name: visibility
          in: query
          required: false
          description: Filter by visibility level
          schema:
            type: string
            enum:
              - private
              - shared
              - team
        - name: source
          in: query
          required: false
          description: Filter by source
          schema:
            type: string
            enum:
              - manual
              - email
              - form
              - referral
              - website
              - event
              - other
        - name: company_status_id
          in: query
          required: false
          description: Filter by status ID. Use 'no_status' for companies without a status.
          schema:
            type: string
        - name: include_pdf_url
          in: query
          required: false
          description: Include signed download URLs for pitch deck PDFs
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyListResponse'
              example:
                success: true
                data:
                  companies:
                    - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                      account_id: 11111111-2222-3333-4444-555555555555
                      name: Acme Technologies
                      deck_link: https://docsend.com/view/example123
                      visibility: team
                      source: form
                      company_status_id: null
                      notes: Met at TechCrunch Disrupt 2024
                      created_at: '2024-01-15T10:30:00.000000+00:00'
                      updated_at: '2024-01-15T12:45:00.000000+00:00'
                      created_by: user-uuid-1234
                      updated_by: user-uuid-1234
                      assignees: []
                      company_status: null
                      metadata:
                        founders:
                          - name: Jane Smith
                            email: jane@example.com
                            title: CEO/Co-Founder
                            linkedin_profile: https://www.linkedin.com/in/example/
                        ai_analysis: >-
                          B2B SaaS platform for enterprise workflow
                          automation...
                        analyzed_at: '2024-01-15T12:45:00.000Z'
                        user_preferences:
                          - type: text
                            field: Website
                            value: https://example.com
                            options: []
                            show_in_table: true
                  pagination:
                    page: 1
                    limit: 25
                    has_next: true
                    has_prev: false
                authType: api_key
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    PageParam:
      name: page
      in: query
      required: false
      description: Page number for pagination (starts at 1)
      schema:
        type: integer
        minimum: 1
        default: 1
      example: 1
    LimitParam:
      name: limit
      in: query
      required: false
      description: Number of items per page (max 100)
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
    SortByParam:
      name: sort_by
      in: query
      required: false
      description: Field to sort results by
      schema:
        type: string
        enum:
          - created_at
          - updated_at
          - name
        default: created_at
      example: created_at
    SortOrderParam:
      name: sort_order
      in: query
      required: false
      description: Sort direction
      schema:
        type: string
        enum:
          - asc
          - desc
        default: desc
      example: desc
    SearchParam:
      name: search
      in: query
      required: false
      description: Full-text search query
      schema:
        type: string
        minLength: 1
        maxLength: 500
      example: acme
  schemas:
    CompanyListResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          required:
            - companies
            - pagination
          properties:
            companies:
              type: array
              items:
                $ref: '#/components/schemas/Company'
            pagination:
              $ref: '#/components/schemas/CursorPagination'
        authType:
          type: string
          enum:
            - api_key
            - session
          description: Authentication method used for this request
    Company:
      type: object
      required:
        - id
        - account_id
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the company
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        account_id:
          type: string
          format: uuid
          description: Account/team this company belongs to
          example: 11111111-2222-3333-4444-555555555555
        name:
          type: string
          description: Company name
          example: Acme Technologies
          maxLength: 255
        deck_link:
          type: string
          format: uri
          nullable: true
          description: URL to the pitch deck (external link or storage URL)
          example: https://docsend.com/view/example123
        deck_storage_path:
          type: string
          nullable: true
          description: Internal storage path for uploaded pitch deck
          example: companies/7c9e6679/deck.pdf
        visibility:
          type: string
          enum:
            - private
            - shared
            - team
          description: |
            Visibility level:
            - `private`: Only visible to the creator
            - `shared`: Visible to specific users via company_shared_access
            - `team`: Visible to all team members
          default: team
          example: team
        source:
          type: string
          enum:
            - manual
            - email
            - form
            - referral
            - website
            - event
            - other
          nullable: true
          description: How the company was added to the pipeline
          example: form
        source_content:
          type: string
          nullable: true
          description: |
            Raw source content when company was created from a form submission.
            Contains the original form field data in a serialized format.
          example: >-
            0:
            {"key":"question_wbB2ze","type":"INPUT_EMAIL","label":"Email","value":"founder@company.com"}
        notes:
          type: string
          nullable: true
          description: Internal notes about the company (not visible to the company)
          example: Met at TechCrunch Disrupt. Strong technical team.
        company_status_id:
          type: string
          format: uuid
          nullable: true
          description: Current deal flow status ID
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        company_status:
          nullable: true
          description: Embedded company status object (when joined)
          allOf:
            - $ref: '#/components/schemas/CompanyStatus'
        metadata:
          $ref: '#/components/schemas/CompanyMetadata'
        metadata_search_text:
          type: string
          nullable: true
          description: Flattened metadata for full-text search (auto-generated)
        assignees:
          type: array
          description: List of team members assigned to this company
          items:
            $ref: '#/components/schemas/Assignee'
          default: []
        created_by:
          type: string
          format: uuid
          nullable: true
          description: User ID who created this company record
          example: user-uuid-1234
        updated_by:
          type: string
          format: uuid
          nullable: true
          description: User ID who last updated this company record
          example: user-uuid-1234
        created_at:
          type: string
          format: date-time
          description: When the company was created
          example: '2024-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          description: When the company was last updated
          example: '2024-01-15T12:45:00Z'
    CursorPagination:
      type: object
      description: |
        Cursor-based pagination for optimal performance.
        Does not include total counts to avoid expensive database queries.
      required:
        - page
        - limit
        - has_next
        - has_prev
      properties:
        page:
          type: integer
          description: Current page number
          example: 1
        limit:
          type: integer
          description: Number of items per page
          example: 25
        has_next:
          type: boolean
          description: Whether there are more results after this page
          example: true
        has_prev:
          type: boolean
          description: Whether there are results before this page
          example: false
    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
    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)
    CompanyMetadata:
      type: object
      description: >
        Custom metadata for the company. Contains AI-extracted data, founder
        info,

        and user-configurable custom fields.
      properties:
        founders:
          type: array
          description: >-
            Founder/team member information (typically AI-extracted from pitch
            deck)
          items:
            $ref: '#/components/schemas/Founder'
        ai_analysis:
          type: string
          nullable: true
          description: AI-generated company description/summary
          example: >-
            B2B SaaS platform providing enterprise workflow automation with
            AI-powered document processing.
        analyzed_at:
          type: string
          format: date-time
          nullable: true
          description: When the AI analysis was performed
          example: '2024-01-15T12:45:00Z'
        user_preferences:
          type: array
          description: Custom fields configured by the account for tracking company data
          items:
            $ref: '#/components/schemas/UserPreference'
      additionalProperties: true
    Assignee:
      type: object
      description: Team member assigned to a company
      properties:
        id:
          type: string
          format: uuid
          description: User ID of the assignee
        name:
          type: string
          nullable: true
          description: Display name
        email:
          type: string
          format: email
          nullable: true
          description: Email address
        picture_url:
          type: string
          format: uri
          nullable: true
          description: Profile picture URL
    Founder:
      type: object
      description: Information about a company founder or team member
      properties:
        name:
          type: string
          description: Full name
          example: Jane Smith
        email:
          type: string
          format: email
          nullable: true
          description: Email address
          example: jane@example.com
        phone:
          type: string
          nullable: true
          description: Phone number
          example: +1-555-123-4567
        title:
          type: string
          nullable: true
          description: Job title/role
          example: CEO/Co-Founder
        background:
          type: string
          nullable: true
          description: Professional background summary
          example: Former engineer at Google, 10 years in enterprise software
        linkedin_profile:
          type: string
          format: uri
          nullable: true
          description: LinkedIn profile URL
          example: https://www.linkedin.com/in/example/
    UserPreference:
      type: object
      description: |
        Custom field for tracking company data. Supports multiple field types:
        - `text`: Free-form text input
        - `boolean`: True/false toggle
        - `select`: Single selection from predefined options
      required:
        - type
        - field
      properties:
        type:
          type: string
          enum:
            - text
            - boolean
            - select
          description: Field type
          example: select
        field:
          type: string
          description: Field name/label
          example: Industry
        value:
          oneOf:
            - type: string
            - type: boolean
            - type: 'null'
          description: Current value (type depends on field type)
          example: AI/ML
        options:
          type: array
          items:
            type: string
          description: Available options (for select fields)
          example:
            - SaaS
            - Fintech
            - AI/ML
            - Developer Tools
        show_in_table:
          type: boolean
          description: Whether this field is displayed in the companies table view
          default: false
          example: true
  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
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Internal server error
            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`

````