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

# Inbox group counts

> Returns how many conversations sit in each of the shop's TikTok inbox groups, read live from TikTok. Groups come through as TikTok names them; the documented ones are `UNREAD`, `UNREPLIED`, `STARRED` and `ARCHIVED`. A group TikTok leaves out is left out here too, not reported as 0. Works for any shop connected through TikTok's official API.



## OpenAPI

````yaml api-reference/tik-tok-shop-openapi.json GET /tik_tok_shop/conversations/group_counts
openapi: 3.0.3
info:
  title: 'Growi API: TikTok Shop'
  version: 1.0.0
  description: >-
    Generated by scripts/gen_tik_tok_shop.rb from Growi's TikTok Shop route
    table.
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /tik_tok_shop/conversations/group_counts:
    get:
      summary: Inbox group counts
      description: >-
        Returns how many conversations sit in each of the shop's TikTok inbox
        groups, read live from TikTok. Groups come through as TikTok names them;
        the documented ones are `UNREAD`, `UNREPLIED`, `STARRED` and `ARCHIVED`.
        A group TikTok leaves out is left out here too, not reported as 0. Works
        for any shop connected through TikTok's official API.
      parameters:
        - name: organization_id
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Use the TikTok Shop of this child brand (organization id) of your
            API key's organization
      responses:
        '200':
          description: Counts per group
          content:
            application/json:
              schema:
                type: object
                required:
                  - groupCounts
                properties:
                  groupCounts:
                    type: array
                    items:
                      type: object
                      required:
                        - groupType
                        - count
                      properties:
                        groupType:
                          type: string
                          description: >-
                            TikTok's group name, e.g. UNREAD, UNREPLIED,
                            STARRED, ARCHIVED.
                        count:
                          type: integer
              example:
                groupCounts:
                  - groupType: UNREAD
                    count: 10
                  - groupType: UNREPLIED
                    count: 4
                  - groupType: STARRED
                    count: 2
                  - groupType: ARCHIVED
                    count: 31
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '403':
          description: >-
            The shop's TikTok authorization doesn't include this data (`code:
            scope_not_granted`), so the seller has to re-authorize the shop
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '404':
          description: >-
            `organization_id` isn't an active child brand of your organization,
            or the record you asked for doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '422':
          description: >-
            No TikTok Shop is connected for this organization. A parent
            organization whose shops sit on its child brands has to pass
            `organization_id`. Also returned when the shop isn't connected
            through TikTok's official API (`code: unsupported_on_web_only_shop`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '429':
          description: >-
            Rate limited: one call every 2 seconds and an hourly cap per API
            key. See `Retry-After` and the `X-RateLimit-*` headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '502':
          description: >-
            TikTok refused or failed. `error` is a fixed message and `code`
            names the failure when there is one
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
components:
  schemas:
    TikTokShopError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong
        code:
          type: string
          description: Machine-readable reason, when there is one
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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