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

# Company Contacts

> Get a paginated list of contacts associated with a specific company.

For detailed information about the filtering system and available operators, 
refer to the [Filter System Documentation](/filters).

## Available Filters
### String Filters
- `first_name`: Contact first name
- `last_name`: Contact last name
- `email`: Contact email
- `phone`: Contact phone number
- `status`: Contact status
- `company.name`: Company name

### DateTime Filters
- `created_at`: When the contact was created
- `updated_at`: When the contact was last updated




## OpenAPI

````yaml /api-reference/build.yaml get /companies/{companyId}/contacts
openapi: 3.0.0
info:
  title: Luminous API
  version: 1.0.0
  description: API documentation for Luminous
servers:
  - url: https://{companyName}.api.joinluminous.com/external/api/v1
    variables:
      companyName:
        default: companyName
        description: Your company-specific subdomain
security: []
tags:
  - name: Products
    description: Get and manage products
  - name: Pricing
    description: Manage price schedules, levels, and customizations
  - name: BOMs
    description: Manage Bills of Materials (BOMs)
  - name: Labels
    description: Label rendering via Labelary ZPL service
  - name: Companies
    description: Manage business accounts and their associated data
  - name: Contacts
    description: Manage contact information for individuals
  - name: Suppliers
    description: Manage suppliers (factories) — vendors used on purchase orders
  - name: Supplier SKUs
    description: Manage per-supplier SKU and unit-cost overrides for products
  - name: Locations
    description: Manage warehouses and locations
  - name: Inventory
    description: Get and adjust product stock levels
  - name: Lots
    description: Create, update, and delete product lots (batches)
  - name: Transfer Orders
    description: Manage transfer orders
  - name: Fulfillment Orders
    description: Manage fulfillment orders and picklists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Receiving Reports
    description: Manage receiving reports
  - name: Payment Obligations
    description: Manage payment obligations for purchase orders
  - name: Sales Orders
    description: Manage sales orders and sales order shipments
  - name: Purgatory
    description: >-
      Inspect and resolve non-posted sales orders in the purgatory staging
      workflow
  - name: PickFlow Shipping
    description: >-
      Provider-agnostic shipping rates, services, packages, and label purchase
      for PickFlow
  - name: Cycle Counts
    description: >-
      Create, drive, and post PickFlow cycle counts — batches, per-warehouse
      sessions, and CSV import/export
  - name: Print Stations
    description: List paired print stations and enqueue print jobs to them
  - name: Invoices
    description: Get and manage invoices
  - name: Work Orders
    description: >-
      Manage work orders — production lifecycle, steps, materials, links,
      shipments, and comments
  - name: Production Batches
    description: Group and manage work orders as production batches
  - name: Bills
    description: >-
      Accounts payable bill management, payments, attachments, allocations, and
      variance
  - name: Prepayments
    description: Manage vendor prepayments and applications
  - name: Vendor Credits
    description: Manage vendor credits and applications
  - name: Vendor Returns
    description: Manage vendor returns and credit generation
  - name: Customer Returns
    description: Manage customer returns (sales returns), receiving, and restock behavior
  - name: Stock Snapshot
    description: Point-in-time stock snapshots with export support
  - name: Consumption
    description: Consumption reports and exports
  - name: Inventory Aging
    description: Cost-layer-based inventory aging reports
  - name: Bills Reports
    description: Accounts payable bills aging reports
  - name: Forecast
    description: Materialized forecast data
  - name: Reports
    description: Close the books, inventory discrepancy, transaction COGS, and EDI reports
  - name: Tags
    description: Add/remove tags across various resources
  - name: Custom Fields
    description: Get and set custom fields across various resources
  - name: Currency
    description: Currency configuration, exchange rates, and conversion
  - name: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
paths:
  /companies/{companyId}/contacts:
    get:
      tags:
        - Companies
        - Contacts
      summary: Company Contacts
      description: >
        Get a paginated list of contacts associated with a specific company.


        For detailed information about the filtering system and available
        operators, 

        refer to the [Filter System Documentation](/filters).


        ## Available Filters

        ### String Filters

        - `first_name`: Contact first name

        - `last_name`: Contact last name

        - `email`: Contact email

        - `phone`: Contact phone number

        - `status`: Contact status

        - `company.name`: Company name


        ### DateTime Filters

        - `created_at`: When the contact was created

        - `updated_at`: When the contact was last updated
      operationId: getCompanyContacts
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the company
        - name: page
          in: query
          schema:
            type: integer
            default: 1
            minimum: 1
          description: Page number for pagination (starts at 1)
        - name: limit
          in: query
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 100
          description: Number of items per page (max 100)
        - in: query
          name: first_name
          schema:
            type: string
          description: Filter by contact first name
        - in: query
          name: last_name
          schema:
            type: string
          description: Filter by contact last name
        - in: query
          name: email
          schema:
            type: string
          description: Filter by contact email
        - in: query
          name: phone
          schema:
            type: string
          description: Filter by contact phone number
        - in: query
          name: status
          schema:
            type: string
          description: Filter by contact status
        - in: query
          name: company.name
          schema:
            type: string
          description: Filter by company name
        - in: query
          name: created_at
          schema:
            type: string
            format: date-time
          description: Filter by creation date
        - in: query
          name: updated_at
          schema:
            type: string
            format: date-time
          description: Filter by last update date
      responses:
        '200':
          description: A list of company contacts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the contact
                          example: '789123'
                        created_at:
                          type: string
                          format: date-time
                          description: When the contact was created
                          example: '2023-03-15T14:30:00Z'
                        updated_at:
                          type: string
                          format: date-time
                          description: When the contact was last updated
                          example: '2023-03-15T14:30:00Z'
                        status:
                          type: string
                          description: Current status of the contact
                          example: active
                        first_name:
                          type: string
                          description: Contact's first name
                          example: John
                        last_name:
                          type: string
                          description: Contact's last name
                          example: Smith
                        email:
                          type: string
                          format: email
                          description: Contact's email address
                          example: john.smith@acmecorp.com
                        phone:
                          type: string
                          description: Contact's primary phone number
                          example: 555-987-6543
                        phone_2:
                          type: string
                          description: Contact's secondary phone number
                          example: 555-555-5555
                        full_name:
                          type: string
                          description: Contact's full name
                          example: John Smith
                        company_id:
                          type: string
                          description: ID of the company this contact belongs to
                          example: '123456'
                        company:
                          type: object
                          description: Company information for this contact
                          properties:
                            id:
                              type: string
                              example: '123456'
                            name:
                              type: string
                              example: Acme Corporation
                        is_primary:
                          type: boolean
                          description: Whether this is the primary contact for the company
                          example: true
                        receive_quotation_pdf:
                          type: boolean
                          description: Whether the contact should receive quotation PDFs
                          example: false
                        receive_purchase_order_pdf:
                          type: boolean
                          description: >-
                            Whether the contact should receive purchase order
                            PDFs
                          example: false
                        receive_purchase_order_invoice_pdf:
                          type: boolean
                          description: >-
                            Whether the contact should receive purchase order
                            invoice PDFs
                          example: false
                        has_portal_login:
                          type: boolean
                          description: >-
                            True when the contact has a linked B2B client portal
                            login
                          example: false
                        companies:
                          type: array
                          description: Companies associated with this contact (when loaded)
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                                nullable: true
                              is_primary:
                                type: boolean
                              receive_quotation_pdf:
                                type: boolean
                              receive_purchase_order_pdf:
                                type: boolean
                              receive_purchase_order_invoice_pdf:
                                type: boolean
                        tags:
                          type: array
                          description: Tags associated with the contact
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              description:
                                type: string
                                nullable: true
                              icon:
                                type: string
                                nullable: true
                              color:
                                type: string
                                nullable: true
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        description: The current page number
                        example: 1
                      from:
                        type: integer
                        description: The starting index of the paginated results
                        example: 1
                      last_page:
                        type: integer
                        description: The last page number
                        example: 5
                      per_page:
                        type: integer
                        description: Number of items per page
                        example: 10
                      to:
                        type: integer
                        description: The ending index of the paginated results
                        example: 10
                      total:
                        type: integer
                        description: Total number of items across all pages
                        example: 50
        '401':
          description: Authentication credentials were missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
                  message:
                    type: string
                    example: Authentication credentials are missing or invalid
                  status_code:
                    type: integer
                    example: 401
        '403':
          description: You do not have permission to perform this action
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Forbidden
                  message:
                    type: string
                    example: You do not have permission to access this resource
                  status_code:
                    type: integer
                    example: 403
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
                  message:
                    type: string
                    example: The requested resource could not be found
                  status_code:
                    type: integer
                    example: 404
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using a bearer token. To create a token, navigate to
        /settings/api-tokens and click Create API Token.

````