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

# Creator profile

> Returns one creator's profile as this shop sees them. Look up by exactly one of `openId` or `username` (with or without @; an old handle still finds the creator).

`creator` and `marketplaceStats` are platform-wide: ids, usernames, followers and profile URL, plus TikTok's 30-day fulfillment rate, median video views, GMV and video count as last seen (null if never captured). `sales` is the creator's affiliate GMV for this shop, as `lifetime` and `last28Days` (UTC days). `content` counts the creator's posts for this shop with views, likes and comments. `samples` and `showcase` count relationships by state, and `segments` lists the segments the creator is in.

`breakdown=true` adds GMV by content type and the top 10 products. If that part takes too long, `breakdownStatus` is `timeout` and the totals still stand. A creator Growi has no data on returns `found: false`. Served from Growi's synced data, so recent days can lag (`sweptThrough`).



## OpenAPI

````yaml api-reference/tik-tok-shop-openapi.json GET /tik_tok_shop/creators/profile
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/creators/profile:
    get:
      summary: Creator profile
      description: >-
        Returns one creator's profile as this shop sees them. Look up by exactly
        one of `openId` or `username` (with or without @; an old handle still
        finds the creator).


        `creator` and `marketplaceStats` are platform-wide: ids, usernames,
        followers and profile URL, plus TikTok's 30-day fulfillment rate, median
        video views, GMV and video count as last seen (null if never captured).
        `sales` is the creator's affiliate GMV for this shop, as `lifetime` and
        `last28Days` (UTC days). `content` counts the creator's posts for this
        shop with views, likes and comments. `samples` and `showcase` count
        relationships by state, and `segments` lists the segments the creator is
        in.


        `breakdown=true` adds GMV by content type and the top 10 products. If
        that part takes too long, `breakdownStatus` is `timeout` and the totals
        still stand. A creator Growi has no data on returns `found: false`.
        Served from Growi's synced data, so recent days can lag
        (`sweptThrough`).
      parameters:
        - name: openId
          in: query
          required: false
          schema:
            type: string
          description: The creator's open id. Pass exactly one of openId or username.
        - name: username
          in: query
          required: false
          schema:
            type: string
          description: >-
            The creator's TikTok handle, with or without @. Pass exactly one of
            openId or username.
        - name: breakdown
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
          description: >-
            true adds GMV by content type and the top 10 products, read from the
            order lines (bounded, fails soft).
        - 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: >-
            { lookup, found, creator: { openId, oecId, username,
            previousUsernames, nickname, avatarUrl, followerCount, secUid,
            profileUrl, firstSeenAt, lastSeenAt } | null, marketplaceStats: {
            fulfillmentRate, medianVideoViews, gmvAmount, gmvCurrency,
            videoCount } | null, sales: { currency, usernames, lifetime: {
            gmvGross, orders, itemsSold, commissionEstimated, firstSaleDay,
            lastOrderAt }, last28Days: { from, to, gmvGross, orders, itemsSold,
            commissionEstimated }, breakdown: { byContentType: [{ contentType,
            gmvGross, orders, itemsSold }], topProducts: [{ productId, title,
            gmvGross, orders, itemsSold }] } | null, breakdownStatus }, content:
            { videos, lives, views, likes, comments, lastPostedAt }, samples: {
            total, byState }, showcase: { total, byState }, segments: [{
            segmentId, name }], sweptThrough, note }.
          content:
            application/json:
              example:
                lookup:
                  username: creator_one
                found: true
                creator:
                  openId: uACafQAAAABexampleOpenId0000000
                  oecId: '7494000000000000301'
                  username: creator_one
                  previousUsernames:
                    - creator_one_old
                  nickname: Creator One
                  avatarUrl: null
                  followerCount: 48200
                  secUid: MS4wLjABAAAAexampleSecUid000000000000000000000000
                  profileUrl: https://www.tiktok.com/@creator_one
                  firstSeenAt: '2026-01-02T10:00:00.000Z'
                  lastSeenAt: '2026-03-01T08:30:00.000Z'
                marketplaceStats:
                  fulfillmentRate: 96.5
                  medianVideoViews: 1800
                  gmvAmount: '4520.10'
                  gmvCurrency: USD
                  videoCount: 140
                sales:
                  currency: USD
                  usernames:
                    - creator_one
                    - creator_one_old
                  lifetime:
                    gmvGross: 1830.5
                    orders: 61
                    itemsSold: 70
                    commissionEstimated: 274.58
                    firstSaleDay: '2026-01-05'
                    lastOrderAt: '2026-02-28T21:14:00.000Z'
                  last28Days:
                    from: '2026-02-02'
                    to: '2026-03-01'
                    gmvGross: 420
                    orders: 14
                    itemsSold: 15
                    commissionEstimated: 63
                  breakdown: null
                  breakdownStatus: not_requested
                content:
                  videos: 9
                  lives: 1
                  views: 152000
                  likes: 8400
                  comments: 310
                  lastPostedAt: '2026-02-27T18:00:00.000Z'
                samples:
                  total: 3
                  byState:
                    content_fulfilled: 2
                    sample_shipped: 1
                showcase:
                  total: 1
                  byState:
                    added_to_showcase: 1
                segments:
                  - segmentId: seg_example_1
                    name: Top sellers
                sweptThrough: '2026-03-01T06:00:00.000Z'
                note: >-
                  Everything here comes from rows the gateway already holds, not
                  a live TikTok call.
        '400':
          description: >-
            Invalid params: neither or both of openId and username, an empty
            username (such as a bare @), or a breakdown flag other than true or
            false
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '401':
          description: Missing or invalid API key
          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`
          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.