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

# Store creators

> One row per creator enrollment on your Shopify (or custom website) store: discount code, affiliate link, commission rate and the commission paid, unpaid and pending in the range. Amounts are formatted in your currency.



## OpenAPI

````yaml GET /shopify/store_creators
openapi: 3.0.1
info:
  title: Growi API
  description: >-
    API documentation for Growi platform, showcasing the public tracking event
    endpoint
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /shopify/store_creators:
    get:
      summary: Store creators
      description: >-
        One row per creator enrollment on your Shopify (or custom website)
        store: discount code, affiliate link, commission rate and the commission
        paid, unpaid and pending in the range. Amounts are formatted in your
        currency.
      parameters:
        - name: organization_id
          in: query
          required: false
          description: >-
            Read one of your child brands instead of the organization that owns
            the key. Any id that is not one of your brands answers 404.
          schema:
            type: integer
        - name: start_date
          in: query
          required: false
          description: 'Sales from this day, YYYY-MM-DD. Default: all time.'
          schema:
            type: string
            format: date
        - name: end_date
          in: query
          required: false
          description: Sales through this day, YYYY-MM-DD.
          schema:
            type: string
            format: date
        - name: platform
          in: query
          required: false
          description: shopify (default) or your custom website store.
          schema:
            type: string
            enum:
              - shopify
              - website
        - name: campaign_id
          in: query
          required: false
          description: Only this campaign of your organization.
          schema:
            type: integer
        - name: campaign_scope
          in: query
          required: false
          description: >-
            all (default), ambassador programs, or social campaigns and
            contracts.
          schema:
            type: string
            enum:
              - ambassador
              - social
              - all
        - name: creator_id
          in: query
          required: false
          description: Only this creator (Growi user id).
          schema:
            type: integer
        - name: status
          in: query
          required: false
          description: Enrollment status. Default active.
          schema:
            type: string
            enum:
              - active
              - completed
              - removed
              - all
        - name: search
          in: query
          required: false
          description: Creator name or email, or `tag:CODE` for a discount code.
          schema:
            type: string
        - name: paid_status
          in: query
          required: false
          description: Only creators with commission in this state.
          schema:
            type: string
            enum:
              - unpaid
              - paid
              - paid_externally
              - pending
              - all
        - name: include_heavy_data
          in: query
          required: false
          description: >-
            Also return revenue_generated, click_count and unique_link_clicks
            (slower).
          schema:
            type: boolean
        - name: sort_by
          in: query
          required: false
          description: Sort by an amount or traffic column.
          schema:
            type: string
            enum:
              - unpaid
              - revenue
              - paid
              - paid_externally
              - pending
              - page_views
              - unique_clicks
        - name: sort_direction
          in: query
          required: false
          description: desc (default) or asc.
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: page
          in: query
          required: false
          description: Page number, from 1.
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Rows per page, 1-100. Default 20.
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                          nullable: true
                        avatar_url:
                          type: string
                          nullable: true
                        user_id:
                          type: integer
                        campaign_id:
                          type: integer
                        campaign_name:
                          type: string
                        commission_rate:
                          type: number
                          nullable: true
                        status:
                          type: string
                        paid_amount:
                          type: string
                        paid_externally_amount:
                          type: string
                        unpaid_amount:
                          type: string
                        pending_amount:
                          type: string
                        active_discount_code:
                          type: string
                          nullable: true
                        store_unique_tag:
                          type: string
                          nullable: true
                        store_affiliate_link:
                          type: string
                          nullable: true
                      additionalProperties: true
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      row_count:
                        type: integer
                      page_count:
                        type: integer
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            `organization_id` isn't an active child brand of your organization,
            or the record doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Invalid or missing params. `error` says which
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limited: 2 seconds between calls and an hourly cap per API key.
            See `Retry-After` and the `X-RateLimit-*` headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiError:
      type: object
      properties:
        error:
          type: string
          description: What went wrong
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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