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

# List the tenants in the authorized partner scope.

> Returns every tenant the calling machine client is authorized for, as a flat list
ordered by position in the hierarchy.

**Notes:**
- `parent_tenant_id` and `depth` describe each tenant's place in the hierarchy;
  the roots of the caller's scope have a `parent_tenant_id` outside it.

Required headers:

- `Authorization: Bearer {token}` (requires the `pulse.read` scope)



## OpenAPI

````yaml /api/partner-api/reporting.json get /pulse/v1/partner/tenants
openapi: 3.1.1
info:
  title: 'Cyrisma New Partner API: Reporting'
  version: v1
servers:
  - url: https://{instance}.cyrisma.com/app
    description: The partner's CYRISMA instance host.
    variables:
      instance:
        default: ccnnnnnn
        description: The instance label of the tenant host issued to the partner.
security:
  - bearerAuth:
      - pulse.read
tags:
  - name: Reporting
paths:
  /pulse/v1/partner/tenants:
    get:
      tags:
        - Reporting
      summary: List the tenants in the authorized partner scope.
      description: >-
        Returns every tenant the calling machine client is authorized for, as a
        flat list

        ordered by position in the hierarchy.


        **Notes:**

        - `parent_tenant_id` and `depth` describe each tenant's place in the
        hierarchy;
          the roots of the caller's scope have a `parent_tenant_id` outside it.

        Required headers:


        - `Authorization: Bearer {token}` (requires the `pulse.read` scope)
      operationId: ListPartnerTenantsV1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerTenantListResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '503':
          description: Service Unavailable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    PartnerTenantListResponse:
      required:
        - root_tenant_id
        - items
      type: object
      properties:
        root_tenant_id:
          type: string
          format: uuid
        items:
          type: array
          items:
            $ref: '#/components/schemas/PartnerTenantRow'
    ProblemDetails:
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
    PartnerTenantRow:
      required:
        - tenant_id
        - tenant_host
        - name
        - kind
        - status
        - parent_tenant_id
        - depth
      type: object
      properties:
        tenant_id:
          type: string
          format: uuid
        tenant_host:
          type: string
        name:
          type: string
        kind:
          type: string
        status:
          type: string
        parent_tenant_id:
          type:
            - 'null'
            - string
          format: uuid
        depth:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        A Tenant Authority machine-client token from POST /v1/auth/client-token,
        carrying subject_type=machine_client and the pulse.read scope.
      scheme: bearer
      bearerFormat: JWT

````