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

# Get a program

> Gets a program by ID, with its name, currency, website, cookie duration and payout terms.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/programs/{id}
openapi: 3.1.0
info:
  title: Tolt Public API
  version: 2.0.0
servers:
  - url: https://platform.tolt.dev
    description: Development
security:
  - bearerAuth: []
paths:
  /v2/programs/{id}:
    get:
      tags:
        - Programs
      summary: Get a program
      description: >-
        Gets a program by ID, with its name, currency, website, cookie duration
        and payout terms.
      operationId: getProgram
      parameters:
        - schema:
            type: string
            example: prg_T6z8aRW3XCmvFWP972RKxpAd
          required: true
          name: id
          in: path
      responses:
        '200':
          description: The requested program
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Request successful
                  data:
                    $ref: '#/components/schemas/Program'
                required:
                  - success
                  - message
                  - data
              example:
                success: true
                message: Successfully fetched program
                data:
                  id: prg_T6z8aRW3XCmvFWP972RKxpAd
                  name: Acme Affiliates
                  product_name: Acme
                  type: public
                  status: active
                  currency_code: usd
                  cookie_duration: 30
                  payout_term: '30'
                  minimum_payout: 5000
                  website_url: https://example.com
                  subdomain: acme
                  created_at: '2026-10-01T12:00:00Z'
                  updated_at: '2026-10-01T12:00:00Z'
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                success: false
                message: Unauthorized
                code: unauthorized
                doc_url: https://docs.tolt.com/errors#unauthorized
        '404':
          description: Program not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                success: false
                message: Program not found
                code: not_found
                doc_url: https://docs.tolt.com/errors#not_found
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Program:
      type: object
      properties:
        id:
          type: string
          example: prg_T6z8aRW3XCmvFWP972RKxpAd
        name:
          type:
            - string
            - 'null'
          example: Acme Affiliates
        product_name:
          type:
            - string
            - 'null'
          example: Acme
        type:
          type:
            - string
            - 'null'
          example: public
        status:
          type:
            - string
            - 'null'
          example: active
        currency_code:
          type:
            - string
            - 'null'
          example: usd
        cookie_duration:
          type:
            - number
            - 'null'
          example: 30
        payout_term:
          type:
            - string
            - 'null'
          example: '30'
        minimum_payout:
          type:
            - number
            - 'null'
          example: 5000
        website_url:
          type:
            - string
            - 'null'
          example: https://example.com
        subdomain:
          type:
            - string
            - 'null'
          example: acme
        created_at:
          type: string
          format: date-time
          example: '2026-10-01T12:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-10-01T12:00:00Z'
      required:
        - id
        - name
        - product_name
        - type
        - status
        - currency_code
        - cookie_duration
        - payout_term
        - minimum_payout
        - website_url
        - subdomain
        - created_at
        - updated_at
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: Human-readable explanation. May change; branch on code instead.
        code:
          type: string
          enum:
            - bad_request
            - validation_error
            - invalid_reference
            - invalid_cursor
            - unauthorized
            - forbidden
            - not_found
            - conflict
            - already_exists
            - commission_paid
            - commission_frozen
            - transaction_refunded
            - commission_exists
            - rate_limited
            - payload_too_large
            - internal_error
          description: Stable machine-readable error code.
          example: not_found
        doc_url:
          type: string
          example: https://docs.tolt.com/errors#not_found
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
            required:
              - field
              - message
          description: >-
            One entry per offending field. Present on validation_error and
            invalid_reference.
      required:
        - success
        - message
        - code
        - doc_url
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix time, in seconds, when the window resets.
      schema:
        type: integer
    Retry-After:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    PayloadTooLarge:
      description: Request body exceeds 1 MB
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Request body exceeds 1 MB
            code: payload_too_large
            doc_url: https://docs.tolt.com/errors#payload_too_large
    RateLimited:
      description: The API key exceeded its rate limit
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Too many requests. Retry after the window resets.
            code: rate_limited
            doc_url: https://docs.tolt.com/errors#rate_limited
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Tolt API key sent as a bearer token.

````

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