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

# List sites

> Sites the caller can see, with the company and business unit above each.

For pickers, filters and the site switcher.



## OpenAPI

````yaml /api-reference/integration.json get /sites
openapi: 3.0.0
info:
  description: >-
    The calls an integration needs first. Every endpoint the application uses is
    in the complete reference.
  title: Asset Infinity integration API
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - description: >-
      Exchange an API key, or an email and password, for a short-lived session
      token, and send it as `Authorization: Bearer <token>` on every other call.
    name: Signing in
  - description: >-
      Where assets are and work happens. A location belongs to a site and may
      sit inside another location.
    name: Sites and locations
  - description: >-
      The asset register: read it, add to it, correct it, move an asset between
      sites and locations, and change its status.
    name: Assets
  - description: >-
      Report a problem. A request is triaged by a person, who turns it into a
      work order or turns it down.
    name: Work requests
  - description: >-
      Raise a job, give it to somebody, move it through the organisation's
      statuses, complete it and close it.
    name: Work orders
  - description: >-
      Send readings in. A meter reading brings the meter forward and raises any
      maintenance the usage has made due. A sensor reading can open or clear an
      alert.
    name: Meters and sensors
  - description: >-
      The part catalogue and what is on the shelf in each store, and the three
      movements an outside system most often records: a delivery in, an issue
      out and a correction.
    name: Parts and stock
  - description: >-
      Have the product call your system when something happens, instead of
      asking it on a timer.
    name: Webhooks
  - description: >-
      The calls behind every register that has no call of its own, answers to
      the organisation's own fields, and the two calls that answer what to send.
      `list_options` returns the ids a field accepts. `describe_call` returns
      the fields any call takes.
    name: Any record
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /sites:
    get:
      tags:
        - Sites and locations
      summary: List sites
      description: |-
        Sites the caller can see, with the company and business unit above each.

        For pickers, filters and the site switcher.
      parameters:
        - $ref: '#/components/parameters/rowFilter.sites.id'
        - $ref: '#/components/parameters/rowFilter.sites.code'
        - $ref: '#/components/parameters/rowFilter.sites.name'
        - $ref: '#/components/parameters/rowFilter.sites.timezone'
        - $ref: '#/components/parameters/rowFilter.sites.is_active'
        - $ref: '#/components/parameters/rowFilter.sites.company_id'
        - $ref: '#/components/parameters/rowFilter.sites.company_name'
        - $ref: '#/components/parameters/rowFilter.sites.business_unit_id'
        - $ref: '#/components/parameters/rowFilter.sites.business_unit_name'
        - $ref: '#/components/parameters/rowFilter.sites.business_unit_parent_id'
        - $ref: '#/components/parameters/rowFilter.sites.business_unit_parent_name'
        - $ref: '#/components/parameters/rowFilter.sites.asset_count'
        - $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/sites'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/sites'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/sites'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/sites'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.sites.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.sites.code:
      in: query
      name: code
      required: false
      schema:
        type: string
    rowFilter.sites.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.sites.timezone:
      in: query
      name: timezone
      required: false
      schema:
        type: string
    rowFilter.sites.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.sites.company_id:
      in: query
      name: company_id
      required: false
      schema:
        type: string
    rowFilter.sites.company_name:
      in: query
      name: company_name
      required: false
      schema:
        type: string
    rowFilter.sites.business_unit_id:
      in: query
      name: business_unit_id
      required: false
      schema:
        type: string
    rowFilter.sites.business_unit_name:
      in: query
      name: business_unit_name
      required: false
      schema:
        type: string
    rowFilter.sites.business_unit_parent_id:
      in: query
      name: business_unit_parent_id
      required: false
      schema:
        type: string
    rowFilter.sites.business_unit_parent_name:
      in: query
      name: business_unit_parent_name
      required: false
      schema:
        type: string
    rowFilter.sites.asset_count:
      in: query
      name: asset_count
      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:
    sites:
      description: |-
        Sites the caller can see, with the company and business unit above each.

        For pickers, filters and the site switcher.
      properties:
        asset_count:
          format: bigint
          type: integer
        business_unit_id:
          description: >-
            Note:

            This is a Foreign Key to `business_units.id`.<fk
            table='business_units' column='id'/>
          format: uuid
          type: string
        business_unit_name:
          format: character varying
          maxLength: 200
          type: string
        business_unit_parent_id:
          description: >-
            Note:

            This is a Foreign Key to `business_units.id`.<fk
            table='business_units' column='id'/>
          format: uuid
          type: string
        business_unit_parent_name:
          format: character varying
          maxLength: 200
          type: string
        code:
          format: character varying
          maxLength: 50
          type: string
        company_id:
          description: >-
            Note:

            This is a Foreign Key to `depreciation_packs.company_id`.<fk
            table='depreciation_packs' column='company_id'/>
          format: uuid
          type: string
        company_name:
          format: character varying
          maxLength: 200
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_active:
          format: boolean
          type: boolean
        name:
          format: character varying
          maxLength: 200
          type: string
        timezone:
          format: character varying
          maxLength: 100
          type: string
      type: object

````

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