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

# List groups

> Lists partner groups. Filter by program or by the default group, and page with cursors.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/groups
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/groups:
    get:
      tags:
        - Groups
      summary: List groups
      description: >-
        Lists partner groups. Filter by program or by the default group, and
        page with cursors.
      operationId: listGroups
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
            description: How many rows to return in one page.
          required: false
          description: How many rows to return in one page.
          name: limit
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
            description: >-
              Ranking direction: desc puts the most recently created or updated
              rows first.
          required: false
          description: >-
            Ranking direction: desc puts the most recently created or updated
            rows first.
          name: order
          in: query
        - schema:
            type: string
            enum:
              - created_at
              - updated_at
            default: created_at
            description: >-
              Timestamp to order and page by: created_at follows creation order,
              updated_at follows each item's most recent change.
          required: false
          description: >-
            Timestamp to order and page by: created_at follows creation order,
            updated_at follows each item's most recent change.
          name: sort
          in: query
        - schema:
            type: string
            description: >-
              Continue after a position: the next_cursor of a previous page, or
              an item id when sorting by created_at. Cannot be combined with
              ending_before.
          required: false
          description: >-
            Continue after a position: the next_cursor of a previous page, or an
            item id when sorting by created_at. Cannot be combined with
            ending_before.
          name: starting_after
          in: query
        - schema:
            type: string
            description: >-
              Page backward from a position: the prev_cursor of a previous page,
              or an item id when sorting by created_at. Cannot be combined with
              starting_after.
          required: false
          description: >-
            Page backward from a position: the prev_cursor of a previous page,
            or an item id when sorting by created_at. Cannot be combined with
            starting_after.
          name: ending_before
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Start of a window on when items were created: items created at
              this time or later are included, for example 2026-01-01T00:00:00Z.
              Leave it out for no lower bound.
          required: false
          description: >-
            Start of a window on when items were created: items created at this
            time or later are included, for example 2026-01-01T00:00:00Z. Leave
            it out for no lower bound.
          name: created_after
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              End of a window on when items were created: only items created
              before this time are included. Leave it out for no upper bound.
          required: false
          description: >-
            End of a window on when items were created: only items created
            before this time are included. Leave it out for no upper bound.
          name: created_before
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Only items last changed at or after this moment; with
              sort=updated_at, use it to fetch what changed since a previous
              sync.
          required: false
          description: >-
            Only items last changed at or after this moment; with
            sort=updated_at, use it to fetch what changed since a previous sync.
          name: updated_after
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Only items last changed before this moment; pair it with
              updated_after to fetch what changed in a period.
          required: false
          description: >-
            Only items last changed before this moment; pair it with
            updated_after to fetch what changed in a period.
          name: updated_before
          in: query
        - schema:
            type: string
            description: >-
              Limit to one program, by its id (prg_...) as returned when listing
              programs.
          required: false
          description: >-
            Limit to one program, by its id (prg_...) as returned when listing
            programs.
          name: program_id
          in: query
        - schema:
            type: string
            maxLength: 255
            description: >-
              Text matched anywhere in the group's name, description or public
              key, ignoring case.
          required: false
          description: >-
            Text matched anywhere in the group's name, description or public
            key, ignoring case.
          name: search
          in: query
        - schema:
            type: boolean
            description: >-
              true lists only default groups, where new partners are placed
              unless another group is chosen; false lists the others.
          required: false
          description: >-
            true lists only default groups, where new partners are placed unless
            another group is chosen; false lists the others.
          name: default
          in: query
      responses:
        '200':
          description: A page of groups
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Request successful
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
                  has_more:
                    type: boolean
                    example: false
                  next_cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Opaque cursor marking the last item on this page. Pass it
                      as starting_after to continue. Null when the page is
                      empty.
                  prev_cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Opaque cursor marking the first item on this page. Pass it
                      as ending_before to page backward. Null when the page is
                      empty.
                required:
                  - success
                  - message
                  - data
                  - has_more
                  - next_cursor
                  - prev_cursor
              example:
                success: true
                message: Successfully fetched groups
                data:
                  - id: grp_TibToy5qnvmQX4isfvpXi3z3
                    name: VIP
                    description: Standard affiliate commission rates
                    program_id: prg_T6z8aRW3XCmvFWP972RKxpAd
                    is_default: false
                    public_key: null
                    website_url: https://example.com
                    is_private: false
                    allow_manual_lead_submission: false
                    minimum_payout: 5000
                    created_at: '2026-10-19T10:15:19.228Z'
                    updated_at: '2026-10-19T10:15:19.228Z'
                  - id: grp_zUQ8Pt281MsbNDApmDPN3Y2a
                    name: Default
                    description: Standard affiliate commission rates
                    program_id: prg_T6z8aRW3XCmvFWP972RKxpAd
                    is_default: true
                    public_key: null
                    website_url: https://example.com
                    is_private: false
                    allow_manual_lead_submission: false
                    minimum_payout: 5000
                    created_at: '2026-10-01T12:00:00Z'
                    updated_at: '2026-10-01T12:00:00Z'
                has_more: false
                next_cursor: >-
                  cur_WyJjcmVhdGVkX2F0IiwiMjAyNi0xMC0wMSAxMjowMDowMCswMCIsImdycF96VVE4UHQyODFNc2JOREFwbURQTjNZMmEiXQ
                prev_cursor: >-
                  cur_WyJjcmVhdGVkX2F0IiwiMjAyNi0xMC0xOSAxMDoxNToxOS4yMjgrMDAiLCJncnBfVGliVG95NXFudm1RWDRpc2Z2cFhpM3ozIl0
          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'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                success: false
                message: 'starting_after: malformed cursor'
                code: invalid_cursor
                doc_url: https://docs.tolt.com/errors#invalid_cursor
                errors:
                  - field: starting_after
                    message: malformed cursor
          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
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Group:
      type: object
      properties:
        id:
          type: string
          example: grp_zUQ8Pt281MsbNDApmDPN3Y2a
        name:
          type:
            - string
            - 'null'
          example: Default
        description:
          type:
            - string
            - 'null'
          example: Standard affiliate commission rates
        program_id:
          type:
            - string
            - 'null'
          example: prg_T6z8aRW3XCmvFWP972RKxpAd
        is_default:
          type:
            - boolean
            - 'null'
          example: true
        public_key:
          type:
            - string
            - 'null'
          example: null
        website_url:
          type:
            - string
            - 'null'
          example: https://example.com
        is_private:
          type:
            - boolean
            - 'null'
          example: false
        allow_manual_lead_submission:
          type:
            - boolean
            - 'null'
          example: false
        minimum_payout:
          type:
            - number
            - 'null'
          example: 5000
        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
        - description
        - program_id
        - is_default
        - public_key
        - website_url
        - is_private
        - allow_manual_lead_submission
        - minimum_payout
        - 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.