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

# A customer's addresses: where they are billed, where their goods are delivered, and the GSTIN registered at each.

> A customer's addresses: where they are billed, where their goods are delivered, and the GSTIN registered at each.



## OpenAPI

````yaml /api-reference/openapi.json get /customer_sites
openapi: 3.0.0
info:
  description: ''
  title: >-
    The only schema PostgREST exposes. Reads are security_invoker views; writes
    are SECURITY DEFINER functions. Rebuilt wholesale on every deploy — it holds
    no data.
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - name: Signing in
  - name: Profile
  - name: My work
  - name: Sites and locations
  - name: Assets
  - name: Asset lifecycle
  - name: Asset components
  - name: Work lifecycle
  - name: Work order execution
  - name: Work sequencing
  - name: Maintenance
  - name: Inspections
  - name: Checklists
  - name: Verification
  - name: Self verification
  - name: Inventory
  - name: Inventory detail
  - name: Parts demand
  - name: Procurement
  - name: Vendors and contracts
  - name: Contracts
  - name: Amendments
  - name: Vendor spend forecast
  - name: Workforce
  - name: Workforce detail
  - name: Capacity
  - name: Dispatch
  - name: Shutdown
  - name: Permits
  - name: Tools
  - name: Tools on jobs
  - name: Bookings
  - name: Booking bills
  - name: Calibration history
  - name: Reliability
  - name: Sensors and meters
  - name: Readers
  - name: Trackers
  - name: Real-time location
  - name: Feeds
  - name: Energy
  - name: IT assets
  - name: IT asset software
  - name: IT asset topology
  - name: Map
  - name: Floor plans
  - name: Labels
  - name: Lost and found
  - name: Visitors
  - name: Root cause analysis
  - name: Costing
  - name: Finance
  - name: E-way bills
  - name: E-way bill filing
  - name: Budgets
  - name: Capex plans
  - name: FF&E plans
  - name: Documents
  - name: Document control
  - name: Document folders
  - name: Document tree
  - name: Knowledge
  - name: Reports
  - name: Dashboards
  - name: Extracts
  - name: Data exports
  - name: Audit center
  - name: Audit feed
  - name: Activity
  - name: Conversations
  - name: Notifications
  - name: Date reminders
  - name: Channels
  - name: Search
  - name: Copilot
  - name: Import
  - name: Bulk jobs
  - name: File exchange
  - name: Filing exceptions
  - name: Files
  - name: Sync
  - name: Support
  - name: API keys
  - name: Webhooks
  - name: MCP connections
  - name: MCP sign-in
  - name: SCIM provisioning
  - name: Directory sync
  - name: Security streams
  - name: Single sign-on
  - name: Two-factor sign-in
  - name: Admin
  - name: Access
  - name: Lookups
  - name: Read models
  - name: Reference
  - name: Reference columns
  - name: Reference entry
  - name: List views
  - name: Mapping
  - name: Numbering
  - name: Branding
  - name: Custom fields
  - name: Form studio
  - name: Workflows
  - name: Workflow studio
  - name: Rules
  - name: Statuses and transitions
  - name: Currencies and locales
  - name: Today
  - name: Work configuration
  - name: Asset configuration
  - name: Inventory configuration
  - name: Tool configuration
  - name: Workforce configuration
  - name: Vendor and contract configuration
  - name: Document configuration
  - name: Inspection configuration
  - name: Sites, locations and the organisation
  - name: Setup
  - name: Features
  - name: Billing
  - name: Licence
  - name: Welcome
  - name: Tray
  - name: Tenant switch
  - name: Release
  - name: Telegram
  - name: Inbound mail
  - name: Platform
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /customer_sites:
    get:
      tags:
        - Vendors and contracts
      summary: >-
        A customer's addresses: where they are billed, where their goods are
        delivered, and the GSTIN registered at each.
      description: >-
        A customer's addresses: where they are billed, where their goods are
        delivered, and the GSTIN registered at each.
      parameters:
        - $ref: '#/components/parameters/rowFilter.customer_sites.id'
        - $ref: '#/components/parameters/rowFilter.customer_sites.customer_id'
        - $ref: '#/components/parameters/rowFilter.customer_sites.code'
        - $ref: '#/components/parameters/rowFilter.customer_sites.name'
        - $ref: '#/components/parameters/rowFilter.customer_sites.address_line1'
        - $ref: '#/components/parameters/rowFilter.customer_sites.address_line2'
        - $ref: '#/components/parameters/rowFilter.customer_sites.city'
        - $ref: '#/components/parameters/rowFilter.customer_sites.postal_code'
        - $ref: '#/components/parameters/rowFilter.customer_sites.state_province_id'
        - $ref: '#/components/parameters/rowFilter.customer_sites.state_province'
        - $ref: '#/components/parameters/rowFilter.customer_sites.gst_state_code'
        - $ref: '#/components/parameters/rowFilter.customer_sites.country_id'
        - $ref: '#/components/parameters/rowFilter.customer_sites.country'
        - $ref: '#/components/parameters/rowFilter.customer_sites.access_notes'
        - $ref: '#/components/parameters/rowFilter.customer_sites.contact_phone'
        - $ref: '#/components/parameters/rowFilter.customer_sites.is_delivery_address'
        - $ref: '#/components/parameters/rowFilter.customer_sites.is_billing_address'
        - $ref: '#/components/parameters/rowFilter.customer_sites.gstin'
        - $ref: '#/components/parameters/rowFilter.customer_sites.is_active'
        - $ref: '#/components/parameters/rowFilter.customer_sites.one_line'
        - $ref: '#/components/parameters/select'
        - $ref: '#/components/parameters/order'
        - $ref: '#/components/parameters/range'
        - $ref: '#/components/parameters/rangeUnit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/preferCount'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/customer_sites'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/customer_sites'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/customer_sites'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/customer_sites'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.customer_sites.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.customer_sites.customer_id:
      in: query
      name: customer_id
      required: false
      schema:
        type: string
    rowFilter.customer_sites.code:
      in: query
      name: code
      required: false
      schema:
        type: string
    rowFilter.customer_sites.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.customer_sites.address_line1:
      in: query
      name: address_line1
      required: false
      schema:
        type: string
    rowFilter.customer_sites.address_line2:
      in: query
      name: address_line2
      required: false
      schema:
        type: string
    rowFilter.customer_sites.city:
      in: query
      name: city
      required: false
      schema:
        type: string
    rowFilter.customer_sites.postal_code:
      in: query
      name: postal_code
      required: false
      schema:
        type: string
    rowFilter.customer_sites.state_province_id:
      in: query
      name: state_province_id
      required: false
      schema:
        type: string
    rowFilter.customer_sites.state_province:
      in: query
      name: state_province
      required: false
      schema:
        type: string
    rowFilter.customer_sites.gst_state_code:
      in: query
      name: gst_state_code
      required: false
      schema:
        type: string
    rowFilter.customer_sites.country_id:
      in: query
      name: country_id
      required: false
      schema:
        type: string
    rowFilter.customer_sites.country:
      in: query
      name: country
      required: false
      schema:
        type: string
    rowFilter.customer_sites.access_notes:
      in: query
      name: access_notes
      required: false
      schema:
        type: string
    rowFilter.customer_sites.contact_phone:
      in: query
      name: contact_phone
      required: false
      schema:
        type: string
    rowFilter.customer_sites.is_delivery_address:
      in: query
      name: is_delivery_address
      required: false
      schema:
        type: string
    rowFilter.customer_sites.is_billing_address:
      in: query
      name: is_billing_address
      required: false
      schema:
        type: string
    rowFilter.customer_sites.gstin:
      in: query
      name: gstin
      required: false
      schema:
        type: string
    rowFilter.customer_sites.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.customer_sites.one_line:
      in: query
      name: one_line
      required: false
      schema:
        type: string
    select:
      description: Filtering Columns
      in: query
      name: select
      required: false
      schema:
        type: string
    order:
      description: Ordering
      in: query
      name: order
      required: false
      schema:
        type: string
    range:
      description: Limiting and Pagination
      in: header
      name: Range
      required: false
      schema:
        type: string
    rangeUnit:
      description: Limiting and Pagination
      in: header
      name: Range-Unit
      required: false
      schema:
        default: items
        type: string
    offset:
      description: Limiting and Pagination
      in: query
      name: offset
      required: false
      schema:
        type: string
    limit:
      description: Limiting and Pagination
      in: query
      name: limit
      required: false
      schema:
        type: string
    preferCount:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - count=none
        type: string
  schemas:
    customer_sites:
      description: >-
        A customer's addresses: where they are billed, where their goods are
        delivered, and the GSTIN registered at each.
      properties:
        access_notes:
          format: text
          type: string
        address_line1:
          format: character varying
          maxLength: 200
          type: string
        address_line2:
          format: character varying
          maxLength: 200
          type: string
        city:
          format: character varying
          maxLength: 120
          type: string
        code:
          format: character varying
          maxLength: 60
          type: string
        contact_phone:
          format: character varying
          maxLength: 40
          type: string
        country:
          format: character varying
          maxLength: 150
          type: string
        country_id:
          format: uuid
          type: string
        customer_id:
          format: uuid
          type: string
        gst_state_code:
          format: character varying
          maxLength: 2
          type: string
        gstin:
          format: character varying
          maxLength: 15
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_active:
          format: boolean
          type: boolean
        is_billing_address:
          format: boolean
          type: boolean
        is_delivery_address:
          format: boolean
          type: boolean
        name:
          format: character varying
          maxLength: 200
          type: string
        one_line:
          format: text
          type: string
        postal_code:
          format: character varying
          maxLength: 30
          type: string
        state_province:
          format: character varying
          maxLength: 150
          type: string
        state_province_id:
          format: uuid
          type: string
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.