> ## 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 asset categories

> Asset categories with how many assets carry each and how many are under each, for scope pickers and filters.

site_ids says where the class exists — empty means everywhere, not nowhere, and a category inherits
the rule of the nearest category above it that states one.



## OpenAPI

````yaml /api-reference/integration.json get /asset_categories
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:
  /asset_categories:
    get:
      tags:
        - Assets
      summary: List asset categories
      description: >-
        Asset categories with how many assets carry each and how many are under
        each, for scope pickers and filters.


        site_ids says where the class exists — empty means everywhere, not
        nowhere, and a category inherits

        the rule of the nearest category above it that states one.
      parameters:
        - $ref: '#/components/parameters/rowFilter.asset_categories.id'
        - $ref: '#/components/parameters/rowFilter.asset_categories.code'
        - $ref: '#/components/parameters/rowFilter.asset_categories.name'
        - $ref: '#/components/parameters/rowFilter.asset_categories.path'
        - $ref: '#/components/parameters/rowFilter.asset_categories.parent_id'
        - $ref: '#/components/parameters/rowFilter.asset_categories.parent_code'
        - $ref: '#/components/parameters/rowFilter.asset_categories.parent_name'
        - $ref: '#/components/parameters/rowFilter.asset_categories.depth'
        - $ref: '#/components/parameters/rowFilter.asset_categories.is_active'
        - $ref: '#/components/parameters/rowFilter.asset_categories.asset_count'
        - $ref: >-
            #/components/parameters/rowFilter.asset_categories.asset_count_in_branch
        - $ref: '#/components/parameters/rowFilter.asset_categories.site_ids'
        - $ref: '#/components/parameters/rowFilter.asset_categories.takes_filing'
        - $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/asset_categories'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/asset_categories'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/asset_categories'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/asset_categories'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.asset_categories.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.asset_categories.code:
      in: query
      name: code
      required: false
      schema:
        type: string
    rowFilter.asset_categories.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.asset_categories.path:
      in: query
      name: path
      required: false
      schema:
        type: string
    rowFilter.asset_categories.parent_id:
      in: query
      name: parent_id
      required: false
      schema:
        type: string
    rowFilter.asset_categories.parent_code:
      in: query
      name: parent_code
      required: false
      schema:
        type: string
    rowFilter.asset_categories.parent_name:
      in: query
      name: parent_name
      required: false
      schema:
        type: string
    rowFilter.asset_categories.depth:
      in: query
      name: depth
      required: false
      schema:
        type: string
    rowFilter.asset_categories.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.asset_categories.asset_count:
      in: query
      name: asset_count
      required: false
      schema:
        type: string
    rowFilter.asset_categories.asset_count_in_branch:
      in: query
      name: asset_count_in_branch
      required: false
      schema:
        type: string
    rowFilter.asset_categories.site_ids:
      in: query
      name: site_ids
      required: false
      schema:
        type: string
    rowFilter.asset_categories.takes_filing:
      in: query
      name: takes_filing
      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:
    asset_categories:
      description: >-
        Asset categories with how many assets carry each and how many are under
        each, for scope pickers
             and filters.

        site_ids says where the class exists — empty means everywhere, not
        nowhere, and a category inherits

        the rule of the nearest category above it that states one.
      properties:
        asset_count:
          format: bigint
          type: integer
        asset_count_in_branch:
          format: bigint
          type: integer
        code:
          format: character varying
          maxLength: 60
          type: string
        depth:
          format: smallint
          type: integer
        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
        parent_code:
          format: character varying
          maxLength: 60
          type: string
        parent_id:
          description: >-
            Note:

            This is a Foreign Key to `asset_categories.id`.<fk
            table='asset_categories' column='id'/>
          format: uuid
          type: string
        parent_name:
          format: character varying
          maxLength: 200
          type: string
        path:
          format: text
          type: string
        site_ids:
          format: uuid[]
          items:
            type: string
          type: array
        takes_filing:
          format: boolean
          type: boolean
      type: object

````

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