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

# List creators

> Retrieve creators associated with your company, including their email and a per-campaign
contract status map. Use this to determine which creators are active across your campaigns.

Each creator includes a `campaigns` array showing every program they are (or were) contracted
under, along with the contract status. A creator's top-level `status` is `"active"` if they
have at least one active contract, otherwise `"inactive"`.

Ghost-handle contracts are excluded.




## OpenAPI

````yaml /openapi/platform-apikey.yaml get /creators
openapi: 3.0.4
info:
  title: Sideshift Public API
  version: 1.0.0
  description: >
    REST API for Sideshift platform. Authenticate using your API key in the
    `x-api-key` header.


    This document covers the **public, API-key-authenticated** surface. The

    restricted endpoints (Jobs, Applicants, payout execution/Quick Pay) are
    gated

    to an explicit partner allowlist and are documented in the **Full Access**

    spec (`sideshift-api-private.yaml`); a non-allowlisted key calling them

    receives `403`. API-key *management* (creating/rotating keys, digest

    automations) is performed in the dashboard with a Firebase session and is
    not

    part of this API-key contract.


    ## Requirements

    - **Active Subscription Required**: API access requires an active Sideshift
      subscription. Requests from a company without one return
      `402 { "error": "Active subscription required" }`.
    - API key from Settings → Integrations


    ## Rate Limits

    - Default: **100 requests per minute** per API key.

    - Allowlisted partner accounts: **400 requests per minute**.

    - Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and
      `X-RateLimit-Reset` headers; exceeding the limit returns `429`.

    ## Errors

    - Errors are returned as `{ "error": "<message>" }` with the appropriate
    HTTP
      status (`400` invalid request, `401` invalid/missing key, `402` no active
      subscription, `403` restricted endpoint / cross-company, `404` not found,
      `429` rate limited). Some endpoints add a `code` (e.g. `LEAD_NOT_FOUND`).

    ## Timestamps

    - All timestamps are Unix timestamps in milliseconds

    - Example: `1634567890000`


    ## Pagination

    - Most list endpoints support `page` (default: 1) and `limit` (default: 25,
      max: 100) parameters and return `{ data, page, total }`. Some additionally
      return `limit` and/or `totalPages`.
    - Agency (parent) accounts can pass `scope=agency` on analytics/posts
      endpoints to aggregate across the parent agency and every subaccount.

    ## Base URL

    - Production: `https://app.sideshift.app/api/v1`
servers:
  - url: https://app.sideshift.app/api/v1
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Programs
    description: Campaign and program management
  - name: Posts
    description: Social media posts and content
  - name: Analytics
    description: Performance metrics and KPIs
  - name: Payouts
    description: Payout management including pending payouts and execution
  - name: Contracts
    description: Creator contracts and agreements
  - name: Creators
    description: Creator profiles and statistics
  - name: Invoices
    description: Create, list, and send invoices to customers
  - name: Discover
    description: Read Discover leads (brand inquiries) submitted to your agency
paths:
  /creators:
    get:
      tags:
        - Creators
      summary: List creators
      description: >
        Retrieve creators associated with your company, including their email
        and a per-campaign

        contract status map. Use this to determine which creators are active
        across your campaigns.


        Each creator includes a `campaigns` array showing every program they are
        (or were) contracted

        under, along with the contract status. A creator's top-level `status` is
        `"active"` if they

        have at least one active contract, otherwise `"inactive"`.


        Ghost-handle contracts are excluded.
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number for pagination
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: Results per page
        - in: query
          name: programId
          schema:
            type: string
          description: Filter to creators with a contract in this program
        - in: query
          name: search
          schema:
            type: string
          description: Search by creator name or email
      responses:
        '200':
          description: Successfully retrieved creators
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Creator user ID
                        name:
                          type: string
                        email:
                          type: string
                          nullable: true
                        phone:
                          type: string
                          nullable: true
                        profileImageUrl:
                          type: string
                          nullable: true
                        status:
                          type: string
                          enum:
                            - active
                            - inactive
                          description: >-
                            "active" if the creator has at least one active
                            contract
                        campaigns:
                          type: array
                          description: Contract status per campaign/program
                          items:
                            type: object
                            properties:
                              programId:
                                type: string
                              programName:
                                type: string
                                nullable: true
                              contractId:
                                type: string
                              contractStatus:
                                type: string
                                enum:
                                  - pending
                                  - active
                                  - completed
                                  - declined
                                  - cancelled
                              handles:
                                type: array
                                description: >-
                                  Social media handles associated with this
                                  contract
                                items:
                                  type: object
                                  properties:
                                    platform:
                                      type: string
                                    handle:
                                      type: string
                  page:
                    type: integer
                  total:
                    type: integer
                  totalPages:
                    type: integer
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Get yours from Settings → Integrations

````