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

# List sites

> Retrieve all sites accessible to the authenticated user within their organizational context.

**Site Information Includes**:
- Basic site details (ID, name, description)
- Hierarchical structure and parent-child relationships
- Geographic information and location metadata
- Associated metadata for external system integration
- Creation and modification timestamps
- Active/inactive status

**Hierarchical Structure**:
Sites are organized in a tree structure supporting multi-level organizational hierarchies. Users see sites based on their permissions:
- **Owners/Managers**: All sites within the organization
- **Site-specific users**: Only assigned sites and their children
- **Collectors/Viewers**: Sites relevant to their data access scope

**Filtering Options**:
- Parent site filtering for hierarchical browsing
- Metadata-based filtering for external system integration
- Status filtering (active/inactive sites)

This endpoint supports organizational site management and is essential for multi-tenant data collection and reporting.



## OpenAPI

````yaml https://app.azalt.co/api/v1/openapi.json get /sites
openapi: 3.0.3
info:
  title: Erguvan Public API
  version: 1.0.0
servers:
  - url: https://app.azalt.co/api/v1
security: []
paths:
  /sites:
    get:
      tags:
        - Site
      summary: List sites
      description: >-
        Retrieve all sites accessible to the authenticated user within their
        organizational context.


        **Site Information Includes**:

        - Basic site details (ID, name, description)

        - Hierarchical structure and parent-child relationships

        - Geographic information and location metadata

        - Associated metadata for external system integration

        - Creation and modification timestamps

        - Active/inactive status


        **Hierarchical Structure**:

        Sites are organized in a tree structure supporting multi-level
        organizational hierarchies. Users see sites based on their permissions:

        - **Owners/Managers**: All sites within the organization

        - **Site-specific users**: Only assigned sites and their children

        - **Collectors/Viewers**: Sites relevant to their data access scope


        **Filtering Options**:

        - Parent site filtering for hierarchical browsing

        - Metadata-based filtering for external system integration

        - Status filtering (active/inactive sites)


        This endpoint supports organizational site management and is essential
        for multi-tenant data collection and reporting.
      operationId: listSites
      parameters:
        - in: query
          name: includeRoot
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    createdAt:
                      type: string
                    updatedAt:
                      type: string
                    parentSiteId:
                      type: string
                      nullable: true
                    country:
                      type: string
                      nullable: true
                    city:
                      type: string
                      nullable: true
                    address:
                      type: string
                      nullable: true
                    unLocode:
                      type: string
                      nullable: true
                    longitude:
                      type: string
                      nullable: true
                    latitude:
                      type: string
                      nullable: true
                    numberOfEmployees:
                      type: number
                      nullable: true
                    floorAreaInM2:
                      type: number
                      nullable: true
                    tags:
                      type: array
                      nullable: true
                      items:
                        type: string
                    metadata:
                      type: object
                      nullable: true
                      additionalProperties:
                        type: string
                  required:
                    - id
                    - name
                    - createdAt
                    - updatedAt
                    - parentSiteId
                    - country
                    - city
                    - address
                    - unLocode
                    - longitude
                    - latitude
                    - numberOfEmployees
                    - floorAreaInM2
                    - tags
                    - metadata
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - Authorization: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````