Skip to main content
GET
/
agreements
List Agreements
curl --request GET \
  --url https://api.mijnklantportaal.nl/v1/agreements \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 1,
  "data": [
    {
      "id": "agr_abc12346def678",
      "name": "Service contract",
      "status": "sent",
      "signerName": "John Doe",
      "signerSignature": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAA...",
      "signerSignatureHash": "PwZVOc2K5rqcpqljbM2xkzJub9FtmA307pvuoJXoiqHDuEyZB7NVqdKbb3SPXt1P",
      "createdAt": "2025-09-13T17:23:14+02:00"
    }
  ],
  "first_page_url": "https://api.mijnklantportaal.nl/v1/agreements?page=1",
  "from": 1,
  "next_page_url": "https://api.mijnklantportaal.nl/v1/agreements?page=2,",
  "path": "https://api.mijnklantportaal.nl/v1/agreements",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Paginated response with agreements

​
current_page
integer

Current page of the response

Example:

1

​
data
object[]

Array of Agreement objects

​
first_page_url
string

Endpoint to go to the first page of objects

Example:

"https://api.mijnklantportaal.nl/v1/agreements?page=1"

​
from
integer

Offset of the current page

Example:

1

​
next_page_url
string | null

Endpoint to get the next batch of objects, if available

Example:

"https://api.mijnklantportaal.nl/v1/agreements?page=2,"

​
path
string

Current used endpoint

Example:

"https://api.mijnklantportaal.nl/v1/agreements"

​
per_page
integer

Amount of object returned per page. Default is 15 objects

Example:

15

​
prev_page_url
string | null

Endpoint to get the previous batch of object, if available

Example:

null

​
to
integer

Next offset of objects

Example:

15