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

# List operators

> Lists the tenant's operators — the team list — each with the role they hold
inside this tenant (`operator`/`manager`/`owner`/`superuser`) and their live
presence, or `null` when they are offline.

Membership comes from the tenant document, so `?role=managers|owners`
narrows the result to that tenant role group rather than filtering on the
operators themselves.



## OpenAPI

````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/operators
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}/operators:
    get:
      tags:
        - Operators
      summary: List operators
      description: >-
        Lists the tenant's operators — the team list — each with the role they
        hold

        inside this tenant (`operator`/`manager`/`owner`/`superuser`) and their
        live

        presence, or `null` when they are offline.


        Membership comes from the tenant document, so `?role=managers|owners`

        narrows the result to that tenant role group rather than filtering on
        the

        operators themselves.
      operationId: ListOperatorsController
      parameters:
        - in: path
          name: tenantID
          required: true
          schema:
            description: The tenant whose operators are being listed.
            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
        - in: query
          name: role
          required: false
          schema:
            description: >-
              Restricts the result to one tenant role group; omit for every
              member.
            enum:
              - managers
              - owners
            nullable: true
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    additionalProperties: false
                    properties:
                      operators:
                        description: Operators belonging to the tenant.
                        items:
                          additionalProperties: false
                          properties:
                            createdAt:
                              description: When the operator was created.
                              format: date-time
                              type: string
                            operatorEmail:
                              description: E-mail address (also the login identifier).
                              type: string
                            operatorFirstname:
                              description: Given name.
                              type: string
                            operatorID:
                              description: The operator identifier.
                              type: string
                            operatorLastname:
                              description: Family name.
                              type: string
                            operatorMeta:
                              additionalProperties: {}
                              description: Arbitrary metadata attached to the operator.
                              type: object
                            operatorPhone:
                              description: Phone number, when set.
                              nullable: true
                              type: string
                            operatorPhoto:
                              description: Avatar URL, when set.
                              nullable: true
                              type: string
                            operatorRole:
                              description: The role this operator holds inside this tenant.
                              enum:
                                - operator
                                - manager
                                - owner
                                - superuser
                              type: string
                            operatorRoles:
                              description: Platform-wide roles, e.g. `superuser`.
                              items:
                                type: string
                              type: array
                            operatorStatus:
                              additionalProperties: false
                              description: >-
                                Live presence, or `null` when the operator is
                                offline (no heartbeat in the last 600s).
                              nullable: true
                              properties:
                                createdAt:
                                  description: >-
                                    When the current presence record was first
                                    created.
                                  format: date-time
                                  type: string
                                lastHeartbeatAt:
                                  description: >-
                                    When this operator last reported a
                                    heartbeat.
                                  format: date-time
                                  type: string
                                operatorStatus:
                                  description: Current presence status of the operator.
                                  enum:
                                    - online
                                    - away
                                  type: string
                              required:
                                - operatorStatus
                                - lastHeartbeatAt
                                - createdAt
                              type: object
                            organizationID:
                              description: >-
                                The Talqui organization this operator belongs
                                to.
                              type: string
                            updatedAt:
                              description: When the operator was last updated.
                              format: date-time
                              type: string
                          required:
                            - operatorID
                            - operatorFirstname
                            - operatorLastname
                            - operatorPhoto
                            - operatorPhone
                            - operatorEmail
                            - operatorRoles
                            - operatorMeta
                            - operatorRole
                            - operatorStatus
                            - createdAt
                            - updatedAt
                          type: object
                        type: array
                    required:
                      - operators
                    type: object
                required:
                  - data
                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): params or query
            fail schema 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 does not belong to 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): tenantID does not resolve to
            a tenant.
        '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
    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
    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.