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

# List Agreements

> Getting all agreements as paginated response



## OpenAPI

````yaml /openapi.yaml get /agreements
openapi: 3.1.1
info:
  title: MijnKlantportaal API
  version: v1
servers:
  - url: https://api.mijnklantportaal.nl/v1
security:
  - APIKey: []
tags:
  - name: Agreements API
  - name: Appointments API
  - name: Customers API
  - name: Customer Groups API
  - name: Customer Invoices API
  - name: Customer Offers API
  - name: Customer Subscriptions API
  - name: Customer Subscription Packages API
  - name: Files API
  - name: File Request API
  - name: File Share API
  - name: Invoices API
  - name: Payment Links API
  - name: Punch Cards API
  - name: Tickets API
  - name: Webhooks API
paths:
  /agreements:
    get:
      tags:
        - Agreements API
      summary: List Agreements
      description: Getting all agreements as paginated response
      operationId: list-agreements
      responses:
        '200':
          description: Paginated response with agreements
          content:
            application/json:
              schema:
                type: object
                properties:
                  current_page:
                    type: integer
                    example: 1
                    description: Current page of the response
                  data:
                    type: array
                    description: Array of Agreement objects
                    items:
                      $ref: '#/components/schemas/Agreement'
                  first_page_url:
                    type: string
                    example: https://api.mijnklantportaal.nl/v1/agreements?page=1
                    description: Endpoint to go to the first page of objects
                  from:
                    type: integer
                    example: 1
                    description: Offset of the current page
                  next_page_url:
                    type: string
                    nullable: true
                    example: https://api.mijnklantportaal.nl/v1/agreements?page=2,
                    description: Endpoint to get the next batch of objects, if available
                  path:
                    type: string
                    example: https://api.mijnklantportaal.nl/v1/agreements
                    description: Current used endpoint
                  per_page:
                    type: integer
                    example: 15
                    description: Amount of object returned per page. Default is 15 objects
                  prev_page_url:
                    type: string
                    nullable: true
                    example: null
                    description: Endpoint to get the previous batch of object, if available
                  to:
                    type: integer
                    example: 15
                    description: Next offset of objects
components:
  schemas:
    Agreement:
      type: object
      description: Agreement
      properties:
        id:
          type: string
          example: agr_abc12346def678
          description: ID of the agreement, always starting with `agr_`.
        name:
          type: string
          example: Service contract
          description: Name of the agreement
        status:
          type: string
          example: sent
          description: Status of the agreement. Can be `sent` or `signed`.
        signerName:
          type: string
          example: John Doe
          description: Name of the person who signed in name of the company of the portal
        signerSignature:
          type: string
          example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAA...
          description: Base64-encoded string of the signature image
        signerSignatureHash:
          type: string
          example: PwZVOc2K5rqcpqljbM2xkzJub9FtmA307pvuoJXoiqHDuEyZB7NVqdKbb3SPXt1P
          description: >-
            Hash of the `signerSignature` in combination with the signing
            datetime to ensure integrity
        createdAt:
          type: string
          example: '2025-09-13T17:23:14+02:00'
          description: >-
            Date and time when the agreement is created in MijnKlantportaal,
            written in ATOM format.
  securitySchemes:
    APIKey:
      type: http
      scheme: bearer

````