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

# Get tenant



## OpenAPI

````yaml get /v1/tenants/{id}
openapi: 3.0.0
info:
  title: Auth APIs Specification
  description: Section for description
  version: '1.0'
  contact: {}
servers:
  - url: https://staging.api.us.aptlydone.com/auth
  - url: https://staging.api.eu.aptlydone.com/auth
  - url: https://api.us.aptlydone.com/auth
  - url: https://api.eu.aptlydone.com/auth
security: []
tags: []
paths:
  /v1/tenants/{id}:
    get:
      tags:
        - tenants
      summary: Get tenant
      operationId: TenantController_getTenant_v1
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Tenant fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResponseDtoResponse'
      security:
        - accessToken: []
components:
  schemas:
    TenantResponseDtoResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP Status code
          example: 200
        timestamp:
          type: string
          description: Timestamp of the response
          example: '2026-01-12T09:10:12.337Z'
        message:
          type: string
          description: Response message
          example: Success
        data:
          description: Response data
          allOf:
            - $ref: '#/components/schemas/TenantResponseDto'
      required:
        - statusCode
        - timestamp
        - message
        - data
    TenantResponseDto:
      type: object
      properties:
        id:
          type: string
          example: 422a6005-4223-47cb-abfe-e33130174349
          description: Tenant ID
        aptlyAccountId:
          type: string
          example: '1122345'
          description: Tenant ID in Aptly
          maxLength: 7
        tenantIdDescope:
          type: string
          example: tenant-v69xtvg7
          description: Tenant ID in Descope
          maxLength: 30
        tenantName:
          type: string
          example: Ebert, Corwin and Schmidt
          description: Tenant name
          maxLength: 100
        tenantCode:
          type: string
          example: LBIE42
          description: Tenant code
          maxLength: 100
        authType:
          type: string
          example: SSO
          description: Authentication type
          maxLength: 5
        isSsoEnabled:
          type: boolean
          example: false
          description: SSO enabled status
        domains:
          example:
            - monumental-gazebo.info
            - smug-pile.biz
          description: Allowed domains
          items:
            type: array
          type: array
        website:
          type: string
          example: https://any-operating.info/
          description: Website URL
          maxLength: 100
        companyName:
          type: string
          example: Beer LLC
          description: Company name
          maxLength: 100
        taxId:
          type: string
          example: '97363380'
          description: Tax ID
          maxLength: 100
        address:
          description: Company address
          allOf:
            - $ref: '#/components/schemas/AddressDto'
        country:
          type: string
          example: India
          description: Country
          maxLength: 20
        organization:
          type: string
          example: mindshare
          description: Organization
          maxLength: 15
        region:
          type: string
          example: RW
          description: Region
          maxLength: 10
        dateFormat:
          type: string
          example: MM/DD/YYYY
          description: Date format
          default: MM/DD/YYYY
        baseCurrency:
          type: string
          example: USD
          description: Base currency
          maxLength: 25
        isMultiCurrencyAllowed:
          type: boolean
          example: true
          description: Multi-currency support status
          default: false
        defaultTimezone:
          type: string
          example: UTC-5
          description: Default timezone
          maxLength: 20
        companyLogoFile:
          type: string
          example: https://picsum.photos/seed/auPKZ8/900/550
          description: Logo file URL for company
        dashboardLogoFile:
          type: string
          example: https://picsum.photos/seed/QxIyc4VC/3108/1029
          description: Logo file URL for dashboard
        billingEmailAddress:
          type: string
          example: Oswaldo.Lesch5@hotmail.com
          description: Billing email address
        stateCode:
          type: string
          example: SA
          description: State Code
        countryCode:
          type: string
          example: US
          description: Country code
        isActive:
          type: boolean
          example: true
          description: Active status
          default: true
        isDeleted:
          type: boolean
          example: false
          description: Deleted status
          default: false
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - ONBOARDING
            - DELETED
          example: ACTIVE
          description: Tenant status
        createdOn:
          format: date-time
          type: string
          example: '2025-12-28T09:11:50.334Z'
          description: Creation timestamp
          default: now()
        createdBy:
          type: string
          example: 5d431e94-ae0b-4661-8974-1ded3509dd3a
          description: Created by user UUID
        updatedOn:
          format: date-time
          type: string
          example: '2026-01-12T05:03:33.766Z'
          description: Last update timestamp
          default: now()
        updatedBy:
          type: string
          example: 089e0a7f-f2fb-41f6-84f7-f30375ab15b1
          description: Last updated by user UUID
        currencyRates:
          example:
            - currency: EUR
              rate: '0.91'
            - currency: JPY
              rate: '146.98'
          description: Currency rate information
          type: array
          items:
            $ref: '#/components/schemas/CurrencyRateDto'
        globalNotificationToggle:
          type: boolean
          example: true
          description: Master toggle for all notifications
          default: false
      required:
        - id
        - domains
        - baseCurrency
        - isActive
        - isDeleted
        - createdOn
        - updatedOn
        - globalNotificationToggle
    AddressDto:
      type: object
      properties:
        line1:
          type: string
          maxLength: 100
          example: 4484 Meta Spur
          description: Primary street address
        line2:
          type: string
          maxLength: 100
          example: Apt. 145
          description: Secondary address information (suite, unit, etc.)
        city:
          type: string
          maxLength: 50
          example: Port Garettview
          description: City name
        state:
          type: string
          maxLength: 50
          example: New Mexico
          description: State or province name
        zipCode:
          type: string
          maxLength: 20
          example: 03479-0243
          description: Postal or ZIP code
    CurrencyRateDto:
      type: object
      properties:
        currency:
          type: string
          example: Euro
          description: Currency
        currencyCode:
          type: string
          example: EUR
          description: Currency code
        rate:
          type: number
          example: 0.85
          description: Exchange rate value
      required:
        - currency
        - currencyCode
        - rate
  securitySchemes:
    accessToken:
      scheme: bearer
      bearerFormat: JWT
      type: http

````