> ## 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. # Get tenant setup > Returns the tenant's onboarding checklist state (WhatsApp, Telegram, teammates, chatbox, shortcuts) used to drive the setup/getting-started screen. ## OpenAPI ````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/setup 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.65.0 servers: - description: Production url: https://services-api.talqui.chat security: [] tags: - name: Tenants - name: Settings - name: Analytics - name: Campaigns - name: Campaigns models - name: Contacts - name: Handoff links - name: Inboxes - name: Messages - name: Notifications - name: Sessions - name: Operators - name: Plugins - name: Setup - name: Uploads paths: /v1/tenants/{tenantID}/setup: get: tags: - Setup summary: Get tenant setup description: |- Returns the tenant's onboarding checklist state (WhatsApp, Telegram, teammates, chatbox, shortcuts) used to drive the setup/getting-started screen. operationId: GetTenantSetupController parameters: - in: path name: tenantID required: true schema: description: The tenant to fetch onboarding setup state for. format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ type: string responses: '200': content: application/json: schema: additionalProperties: false properties: disabled: description: >- Whether the onboarding checklist is disabled for this tenant. type: boolean states: additionalProperties: false description: Completion state of each onboarding step. properties: chatbox: additionalProperties: false description: Chatbox/widget setup onboarding step. properties: done: description: Whether this onboarding step has been completed. type: boolean trial: description: >- Remaining trial count/quota associated with this step, if applicable. type: number required: - done - trial type: object shortcuts: additionalProperties: false description: Shortcuts setup onboarding step. properties: done: description: Whether this onboarding step has been completed. type: boolean trial: description: >- Remaining trial count/quota associated with this step, if applicable. type: number required: - done - trial type: object teammates: additionalProperties: false description: Invite teammates onboarding step. properties: done: description: Whether this onboarding step has been completed. type: boolean trial: description: >- Remaining trial count/quota associated with this step, if applicable. type: number required: - done - trial type: object telegram: additionalProperties: false description: Telegram connection onboarding step. properties: done: description: Whether this onboarding step has been completed. type: boolean trial: description: >- Remaining trial count/quota associated with this step, if applicable. type: number required: - done - trial type: object whatsapp: additionalProperties: false description: WhatsApp connection onboarding step. properties: done: description: Whether this onboarding step has been completed. type: boolean trial: description: >- Remaining trial count/quota associated with this step, if applicable. type: number required: - done - trial type: object required: - whatsapp - telegram - teammates - chatbox - shortcuts type: object required: - disabled - states type: object description: Response for status 200. '400': content: application/json: schema: properties: errors: items: oneOf: - $ref: '#/components/schemas/MissingTenantIDError' - $ref: '#/components/schemas/RequestValidationError' maxItems: 1 minItems: 1 type: array required: - errors type: object description: >- MissingTenantIDError (error_code 1001): tenantID absent from the URL. | RequestValidationError (error_code 1002): tenantID fails UUID format validation. '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): operator token rejected upstream.' '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. security: - operatorAuth: [] 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 RequestValidationError: additionalProperties: false properties: error: enum: - RequestValidationError type: string error_code: enum: - 1002 type: number fields: items: additionalProperties: false properties: allowed: type: string field: type: string received: type: string required: - field - received - allowed type: object type: array message: example: Invalid request data. type: string statusCode: enum: - 400 type: number required: - statusCode - error - error_code - message - fields 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 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 securitySchemes: operatorAuth: bearerFormat: JWT description: >- Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as `Authorization: Bearer `. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.