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

# Weekly outreach records

> Lists the creators the shop has reached in TikTok's current outreach quota period, as TikTok records it, so it includes outreach sent outside Growi. Each record has `creatorOpenId`, `hasSentImMessage` (the shop DMed them), `hasSentInvitation` (the shop sent a target collab invite) and `isPaired` (the creator connected back). Missing flags are null (unknown), not false.

Use it to check who you've already contacted this period before spending outreach quota. TikTok offers no filter by creator or time. Page with `page` (1-based) and `pageSize` (2 to 50, default 50). `hasMore` and `total` tell you when to stop. Read live from TikTok.



## OpenAPI

````yaml api-reference/tik-tok-shop-openapi.json GET /tik_tok_shop/outreach/records
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/outreach/records:
    get:
      summary: Weekly outreach records
      description: >-
        Lists the creators the shop has reached in TikTok's current outreach
        quota period, as TikTok records it, so it includes outreach sent outside
        Growi. Each record has `creatorOpenId`, `hasSentImMessage` (the shop
        DMed them), `hasSentInvitation` (the shop sent a target collab invite)
        and `isPaired` (the creator connected back). Missing flags are null
        (unknown), not false.


        Use it to check who you've already contacted this period before spending
        outreach quota. TikTok offers no filter by creator or time. Page with
        `page` (1-based) and `pageSize` (2 to 50, default 50). `hasMore` and
        `total` tell you when to stop. Read live from TikTok.
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 10000
            default: 1
          description: 1-based page index.
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 2
            maximum: 50
            default: 50
          description: >-
            Rows per page, 2 to 50 (TikTok's doc says > 1, though its own
            example sends 1).
        - 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: One page of outreach records
          content:
            application/json:
              schema:
                type: object
                required:
                  - page
                  - pageSize
                  - hasMore
                  - records
                properties:
                  total:
                    type: integer
                    nullable: true
                    description: All records this period.
                  page:
                    type: integer
                  pageSize:
                    type: integer
                  hasMore:
                    type: boolean
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        recordId:
                          type: string
                          nullable: true
                        creatorOpenId:
                          type: string
                          nullable: true
                        hasSentImMessage:
                          type: boolean
                          nullable: true
                        hasSentInvitation:
                          type: boolean
                          nullable: true
                        isPaired:
                          type: boolean
                          nullable: true
              example:
                total: 10
                page: 1
                pageSize: 50
                hasMore: false
                records:
                  - recordId: '1234'
                    creatorOpenId: uACafQAAAABmUU2qon4R0vUYvUVS3QC6
                    hasSentImMessage: true
                    hasSentInvitation: false
                    isPaired: false
        '400':
          description: 'Invalid params: page or pageSize out of range'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '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.