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

# List program pay structures

> List every payscale on a Canvas program, with the ids that the two pay-structure changes accept, and the program's trial rule.



## OpenAPI

````yaml /api-reference/openapi.json get /programs/{id}/pay-structures
openapi: 3.0.4
info:
  title: Launchpoint Public API
  version: 1.0.0
  description: >-
    **Private preview.** The Launchpoint Public API is in private preview and
    available only to trusted partners we work with directly. Access is not
    self-serve. Email hi@launchpointhq.com to ask about access.


    REST API for Launchpoint brands and agencies. Use an API key in the
    `x-api-key` header to authenticate.


    ## Requirements

    - Public API access must be enabled for the company. During private preview,
    access is limited to trusted partners.

    - Create and manage API keys in Dashboard → Settings → Developer.


    ## Creator privacy

    - Responses never include creator email addresses. Creator phone numbers are
    null when no number is stored or the workspace does not have access to
    creator contact details.


    ## Rate limits

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

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

    - Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and
    `X-RateLimit-Reset`. Requests over the limit return `429`.


    ## Errors

    - Errors use `{ "error": "<message>" }` with the matching HTTP status. Some
    endpoints also include a `code`.


    ## Timestamps

    - Timestamps are Unix timestamps in milliseconds unless a field says
    otherwise.


    ## Pagination

    - Most list endpoints accept `page` and `limit` and return `{ data, page,
    total }`. Some also return `totalPages`.

    - `scope=company` is the default. A parent agency key can pass
    `scope=agency` on supported routes to include its own data and linked
    brands.
servers:
  - url: https://dashboard.launchpointhq.com/api/v1
    description: Live API server
security:
  - apiKeyAuth: []
tags:
  - name: Deals
    description: Public creator opportunities across Launchpoint
  - name: Programs
    description: Programs and campaign management
  - name: Posts
    description: Posts and social content
  - name: Analytics
    description: KPIs and performance metrics
  - name: Payouts
    description: Payouts, balances, and pending creator funds
  - name: Contracts
    description: Contracts and creator agreements
  - name: Creators
    description: Creator profiles and metrics
  - name: Applications
    description: Creator applications to Canvas programs
  - name: Messages
    description: Read and send creator messages
  - name: Onboarding
    description: 'Creator onboarding: status, messages, and proof review'
  - name: Media review
    description: >-
      Review the media creators send before they post: queue, status, approve,
      and reject
paths:
  /programs/{id}/pay-structures:
    get:
      tags:
        - Programs
      summary: List program pay structures
      description: >-
        List every payscale on a Canvas program, with the ids that the two
        pay-structure changes accept, and the program's trial rule.
      parameters:
        - $ref: '#/components/parameters/ScopeParam'
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: ID of the program
      responses:
        '200':
          description: Pay structures returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  programId:
                    type: string
                  trial:
                    nullable: true
                    description: >-
                      The trial a creator who starts on the trial payscale runs
                      now. `null` when no payscale is the trial, or when the
                      brand ends the trial by hand.
                    allOf:
                      - $ref: '#/components/schemas/TrialRule'
                      - type: object
                        properties:
                          skipTopCreators:
                            type: boolean
                            description: >-
                              Top creators start on the Default payscale and
                              skip the trial.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        isDefault:
                          type: boolean
                        isTrial:
                          type: boolean
                        fallbackPay:
                          nullable: true
                          description: >-
                            The payscale's own pay. The Default's own pay is the
                            program pay, or `null` when the program removed it.
                          allOf:
                            - $ref: '#/components/schemas/CanvasPay'
                        contentRules:
                          type: array
                          items:
                            $ref: '#/components/schemas/CanvasContentRule'
        '400':
          description: The program is not a Canvas program, or the request is invalid
        '404':
          description: No program, creator, or post was found
components:
  parameters:
    ScopeParam:
      in: query
      name: scope
      required: false
      schema:
        type: string
        enum:
          - company
          - agency
        default: company
      description: >-
        Choose the data scope. `company` (default) limits results to the API key
        company's data. `agency` includes the parent agency and its linked
        brands. `scope=agency` requires a parent agency key; other keys receive
        `403`.
  schemas:
    TrialRule:
      type: object
      description: How a trial is decided.
      properties:
        limit:
          type: object
          description: >-
            How long the trial runs: a number of days from its start, or a
            number of videos.
          properties:
            kind:
              type: string
              enum:
                - days
                - posts
            count:
              type: integer
        goal:
          description: What the creator must reach to pass.
          oneOf:
            - type: object
              title: Views
              properties:
                kind:
                  type: string
                  enum:
                    - views
                targetViews:
                  type: integer
                  description: Views each passing video must reach.
                passingVideoCount:
                  type: integer
                  description: Distinct videos that must reach `targetViews`.
            - type: object
              title: Custom field
              properties:
                kind:
                  type: string
                  enum:
                    - creator_field
                fieldId:
                  type: string
                  description: >-
                    The brand custom field id, as in `customFields[].id` on `GET
                    /creators`.
                fieldName:
                  type: string
                minValue:
                  type: number
                  description: Value the field must reach.
        failureAction:
          type: string
          enum:
            - remove
            - keep
          description: >-
            When the goal is missed: `remove` takes the creator off the program;
            `keep` keeps them on trial pay, and later posts can still pass.
        nextPayscaleId:
          type: string
          nullable: true
          description: >-
            The payscale the creator moves to on passing, from `GET
            /programs/{id}/pay-structures`. `null` is the program Default.
    CanvasPay:
      type: object
      properties:
        payoutType:
          type: string
          enum:
            - view_bonus
            - cpm
            - flat_fee
        platformPayoutMode:
          type: string
          enum:
            - per_post
            - highest_platform
        viewTrackingDays:
          type: integer
        trialCutoff:
          type: object
          properties:
            views:
              type: integer
            posts:
              type: integer
            days:
              type: integer
            enabled:
              type: boolean
        perCreatorCap:
          type: object
          properties:
            enabled:
              type: boolean
            capCents:
              type: integer
            periodDays:
              type: integer
        inactivityCutoff:
          type: object
          properties:
            enabled:
              type: boolean
            days:
              type: integer
        baseRateDisabled:
          type: boolean
        tiers:
          type: array
          items:
            type: object
            properties:
              viewsThreshold:
                type: integer
              bonusCents:
                type: integer
        cpmCents:
          type: integer
        minViews:
          type: integer
        maxViews:
          type: integer
        flatFeeCents:
          type: integer
        amountCents:
          type: integer
        flatFee:
          type: object
          properties:
            enabled:
              type: boolean
            flatFeeCents:
              type: integer
            minViews:
              type: integer
        monthlyInput:
          type: object
          properties:
            budgetCents:
              type: integer
            postsPerMonth:
              type: integer
            videosPerMonth:
              type: integer
        perPlatform:
          type: object
          additionalProperties:
            type: object
            properties:
              payoutType:
                type: string
                enum:
                  - excluded
                  - view_bonus
                  - cpm
                  - flat_fee
              excluded:
                type: boolean
              flatFeeCents:
                type: integer
              tiers:
                type: array
                items:
                  type: object
                  properties:
                    viewsThreshold:
                      type: integer
                    bonusCents:
                      type: integer
              cpmCents:
                type: integer
              minViews:
                type: integer
              maxViews:
                type: integer
              flatFee:
                type: object
              amountCents:
                type: integer
              monthlyInput:
                type: object
              baseRateDisabled:
                type: boolean
    CanvasContentRule:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        matcher:
          type: object
          properties:
            kind:
              type: string
              enum:
                - content
                - lifetime_views
            description:
              type: string
            thresholdViews:
              type: integer
        pay:
          $ref: '#/components/schemas/CanvasPay'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key created in Dashboard → Settings → Developer

````

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