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

# Get apiutilitiesv0contractinstrument configurationpaginated

> Returns instrument configurations in a paginated fashion. Use the `page`
and `size` query parameters to control the subset of data returned. The
response includes navigation metadata (`currentPage`, `totalPages`,
`pageSize`, `totalElements`).




## OpenAPI

````yaml /registry/apis/open-api-specs/utility.yaml get /api/utilities/v0/contract/instrument-configuration/paginated
openapi: 3.0.0
info:
  title: Utilities API
  description: Exposes technical information and contract data of the Utility App
  version: 2.2.0
servers:
  - url: https://api.utilities.digitalasset.com
    description: MainNet
  - url: https://api.utilities.digitalasset-staging.com
    description: TestNet
  - url: https://api.utilities.digitalasset-dev.com
    description: DevNet
  - url: http://localhost:8080
    description: Local
security: []
tags:
  - name: utility
paths:
  /api/utilities/v0/contract/instrument-configuration/paginated:
    get:
      tags:
        - operator
      description: |
        Returns instrument configurations in a paginated fashion. Use the `page`
        and `size` query parameters to control the subset of data returned. The
        response includes navigation metadata (`currentPage`, `totalPages`,
        `pageSize`, `totalElements`).
      operationId: getPaginatedInstrumentConfigurations
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: string
            default: '1'
          description: >-
            The 1-based page number to return, as a positive integer. Defaults
            to 1.
        - name: size
          in: query
          required: false
          schema:
            type: string
            default: '20'
          description: >-
            The number of instrument configurations per page, as an integer
            between 1 and 100. Defaults to 20.
      responses:
        '200':
          description: Returns a page of instrument configurations
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetPaginatedInstrumentConfigurationsResponse
        '400':
          description: Invalid pagination parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Operator party is not available
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GetPaginatedInstrumentConfigurationsResponse:
      type: object
      required:
        - instrumentConfigurations
        - currentPage
        - totalPages
        - pageSize
        - totalElements
      properties:
        instrumentConfigurations:
          type: array
          description: The instrument configurations for the requested page
          items:
            $ref: '#/components/schemas/InstrumentConfiguration'
        currentPage:
          type: integer
          format: int32
          description: The 1-based index of the returned page
        totalPages:
          type: integer
          format: int32
          description: The total number of pages available for the current page size
        pageSize:
          type: integer
          format: int32
          description: The maximum number of instrument configurations per page
        totalElements:
          type: integer
          format: int32
          description: The total number of instrument configurations across all pages
    Error:
      type: object
      description: >-
        A problem occurred with processing the request. For instance:
        syntactically invalid JSON body, missing required fields, etc.
      required:
        - error
        - error_description
      properties:
        error:
          description: An error code, e.g. invalid_token
          type: string
          default: unknown_error
        error_description:
          description: A description of the error
          type: string
          default: Something went wrong
    InstrumentConfiguration:
      type: object
      required:
        - contract
        - payload
      properties:
        contract:
          $ref: '#/components/schemas/ContractMeta'
        payload:
          $ref: '#/components/schemas/InstrumentConfigurationPayload'
    ContractMeta:
      type: object
      required:
        - contractId
        - templateId
      properties:
        createdAt:
          type: string
          format: date-time
        contractId:
          type: string
        templateId:
          type: string
        synchronizerId:
          type: string
          description: >-
            Preferred synchronizer identifier for disclosed contracts and
            contract metadata.
        domainId:
          type: string
          deprecated: true
          description: Deprecated alias of synchronizerId kept for backward compatibility.
    InstrumentConfigurationPayload:
      type: object
      required:
        - operator
        - provider
        - registrar
        - defaultIdentifier
        - additionalIdentifiers
        - issuerRequirements
        - holderRequirements
      properties:
        operator:
          type: string
          description: The operator party id
        provider:
          type: string
          description: The provider party id
        registrar:
          type: string
          description: The registrar party id
        defaultIdentifier:
          $ref: '#/components/schemas/InstrumentIdentifier'
        additionalIdentifiers:
          type: array
          description: Additional instrument identifiers
          items:
            $ref: '#/components/schemas/InstrumentIdentifier'
        issuerRequirements:
          type: array
          description: Credential requirements to mint/burn a given asset
          items:
            $ref: '#/components/schemas/PartyCredentialRequirement'
        holderRequirements:
          type: array
          description: Credential requirements to transfer/lock/unlock a given asset
          items:
            $ref: '#/components/schemas/PartyCredentialRequirement'
        checkBlockList:
          type: boolean
          description: >
            Whether the admin's blocklist is checked for this instrument:

            `true` means enabled; `false` or `null` means disabled. `null`
            (unset) is kept

            distinct from `false` as `null` permits downgrading the contract to
            an earlier

            package version.
        forceTransferEnabled:
          type: object
          description: >
            Whether holdings of the instrument can be force-transferred by the
            registrar:

            `{}` (the Daml `ForceTransfer` record) means enabled; `null` means
            disabled. It is an

            `object` type to facilitate future enhancements that can be
            supported as non-breaking.
    InstrumentIdentifier:
      type: object
      required:
        - source
        - id
        - scheme
      properties:
        source:
          description: The entity that originally created or issued the identifier.
          type: string
        id:
          description: The identifier for the instrument
          type: string
        scheme:
          description: The scheme or standard used for the identifier.
          type: string
    PartyCredentialRequirement:
      type: object
      required:
        - issuer
        - requiredClaims
      properties:
        issuer:
          type: string
          description: Required issuer of the credential
        requiredClaims:
          type: string
          description: >-
            Required (property, value) pairs that the holder has to have claims
            for as a subject
          items:
            $ref: '#/components/schemas/CredentialClaim'
    CredentialClaim:
      type: object
      required:
        - property
        - value
      properties:
        property:
          type: string
          description: The property of the claim
        value:
          type: string
          description: The value of the claim

````