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

# Get one tenant and its sub-tenants from the authorized partner scope.

> Returns `tenantId` plus every tenant beneath it in the hierarchy, narrowed from the
caller's full authorized scope.

**Notes:**
- `tenantId` must be inside the caller's authorized scope; anything else returns 403,
  whether or not the tenant exists.

Required headers:

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



## OpenAPI

````yaml /api/partner-api/reporting.json get /pulse/v1/partner/tenants/{tenantId}
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/{tenantId}:
    get:
      tags:
        - Reporting
      summary: Get one tenant and its sub-tenants from the authorized partner scope.
      description: >-
        Returns `tenantId` plus every tenant beneath it in the hierarchy,
        narrowed from the

        caller's full authorized scope.


        **Notes:**

        - `tenantId` must be inside the caller's authorized scope; anything else
        returns 403,
          whether or not the tenant exists.

        Required headers:


        - `Authorization: Bearer {token}` (requires the `pulse.read` scope)
      operationId: GetPartnerTenantV1
      parameters:
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      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

````