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

# Read tenant

> Reads one tenant, with its full settings — what the app loads for the
tenant it is opening. Same tenant shape as `GET /v1/tenants`, which stays
the call for listing them.

Tenant-scoped: the caller must work in `:tenantID`. Superusers are exempt
from that scope, as on every other tenant route.



## OpenAPI

````yaml /api/services-api.yaml get /v1/tenants/{tenantID}
openapi: 3.0.3
info:
  description: >-
    Talqui is an omnichannel customer service platform that unifies
    conversations from WhatsApp, Instagram, Telegram, and many other channels
    into a single attendant panel, alongside a broader ecosystem of plugins and
    integrations. This API gives developers programmatic access to Talqui's
    services layer, exposing the operations needed to read and manage tenants,
    conversations, plugins, and related resources that power that platform.


    Authentication is available on behalf of an Operator (the default for this
    API), a Plugin Connection, or a Plugin — see the [Talqui authentication
    guide](https://docs.talqui.chat/guides/introduction/authentication/) for how
    each token is obtained and when to use it.


    Need help or have questions not covered here? Reach out to
    support@talqui.com.
  license:
    name: ISC
    url: https://opensource.org/license/isc-license-txt
  title: Talqui - Services API
  version: 0.69.1
servers:
  - description: Production
    url: https://services-api.talqui.chat
security: []
tags:
  - name: Tenants
  - name: Settings
  - name: Analytics/Reports
  - name: Analytics
  - name: Campaigns
  - name: Campaigns/Models
  - name: Contacts
  - name: Contacts/Imports
  - name: Handoff links
  - name: Inboxes
  - name: Messages
  - name: Notifications
  - name: Sessions
  - name: Operators/Shortcuts
  - name: Operators
  - name: Plugins
  - name: Setup
  - name: Uploads
paths:
  /v1/tenants/{tenantID}:
    get:
      tags:
        - Tenants
      summary: Read tenant
      description: >-
        Reads one tenant, with its full settings — what the app loads for the

        tenant it is opening. Same tenant shape as `GET /v1/tenants`, which
        stays

        the call for listing them.


        Tenant-scoped: the caller must work in `:tenantID`. Superusers are
        exempt

        from that scope, as on every other tenant route.
      operationId: ReadTenantController
      parameters:
        - in: path
          name: tenantID
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    additionalProperties: false
                    properties:
                      tenant:
                        additionalProperties: false
                        description: The requested tenant.
                        properties:
                          createdAt:
                            description: When the tenant was created.
                            format: date-time
                            type: string
                          createdBy:
                            description: Operator who created the tenant.
                            type: string
                          lastSignInAt:
                            description: When somebody last signed in to this tenant.
                            format: date-time
                            nullable: true
                            type: string
                          organizationID:
                            description: The Talqui organization this tenant belongs to.
                            type: string
                          ownerID:
                            description: The operator who owns the tenant.
                            type: string
                          subscriptionID:
                            description: Billing subscription, when the tenant has one.
                            nullable: true
                            type: string
                          tenantDescription:
                            description: Free-text description.
                            type: string
                          tenantID:
                            description: The tenant identifier.
                            type: string
                          tenantLogo:
                            description: Logo URL, when set.
                            nullable: true
                            type: string
                          tenantMeta:
                            additionalProperties: {}
                            description: Arbitrary metadata attached to the tenant.
                            type: object
                          tenantName:
                            description: Display name.
                            type: string
                          tenantOperatorRoles:
                            additionalProperties: false
                            description: Role groups inside the tenant.
                            properties:
                              managers:
                                description: >-
                                  Operators holding the manager role in this
                                  tenant.
                                items:
                                  type: string
                                type: array
                              owners:
                                description: >-
                                  Operators holding the owner role in this
                                  tenant.
                                items:
                                  type: string
                                type: array
                            required:
                              - owners
                              - managers
                            type: object
                          tenantOperatorsIDs:
                            description: Every operator who is a member of this tenant.
                            items:
                              type: string
                            type: array
                          tenantSettings:
                            additionalProperties: {}
                            description: >-
                              Tenant configuration bag: sessions, routing,
                              messages, business hours and inbox visibility.
                            type: object
                          tenantWebsite:
                            description: The tenant public website.
                            type: string
                          updatedAt:
                            description: When the tenant was last updated.
                            format: date-time
                            type: string
                          updatedBy:
                            description: Operator who last updated the tenant.
                            type: string
                        required:
                          - tenantID
                          - organizationID
                          - tenantName
                          - tenantDescription
                          - tenantWebsite
                          - tenantLogo
                          - tenantOperatorsIDs
                          - tenantOperatorRoles
                          - tenantMeta
                          - ownerID
                          - createdAt
                          - updatedAt
                        type: object
                    required:
                      - tenant
                    type: object
                required:
                  - data
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/MissingTenantIDError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingTenantIDError (error_code 1001): tenantID absent from the
            URL.
        '401':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnauthorizedError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'UnauthorizedError (error_code 1003): missing/invalid operator token.'
        '403':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/ForbiddenError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            ForbiddenError (error_code 1004): the caller does not work in this
            tenant.
        '404':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/TenantNotFoundError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            TenantNotFoundError (error_code 1062): no live tenant has this
            tenantID.
        '500':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnknownError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            UnknownError (error_code 5999): Unexpected internal error not
            otherwise documented for this endpoint.
components:
  schemas:
    MissingTenantIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingTenantIDError
          type: string
        error_code:
          enum:
            - 1001
          type: number
        message:
          example: tenantID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    UnauthorizedError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnauthorizedError
          type: string
        error_code:
          enum:
            - 1003
          type: number
        message:
          example: You are not authorized to perform this request.
          type: string
        statusCode:
          enum:
            - 401
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    ForbiddenError:
      additionalProperties: false
      properties:
        error:
          enum:
            - ForbiddenError
          type: string
        error_code:
          enum:
            - 1004
          type: number
        message:
          example: You do not have access to this resource.
          type: string
        statusCode:
          enum:
            - 403
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    TenantNotFoundError:
      additionalProperties: false
      properties:
        error:
          enum:
            - TenantNotFoundError
          type: string
        error_code:
          enum:
            - 1062
          type: number
        message:
          example: Tenant not found.
          type: string
        statusCode:
          enum:
            - 404
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    UnknownError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnknownError
          type: string
        error_code:
          enum:
            - 5999
          type: number
        message:
          example: For some unknown reason your request has not succeeded.
          type: string
        statusCode:
          enum:
            - 500
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object

````

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