Skip to main content
GET
/
file-shares
List File Shares
curl --request GET \
  --url https://api.mijnklantportaal.nl/v1/file-shares \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 1,
  "data": [
    {
      "id": "fss_abc12345678",
      "sharedWithCustomerId": "cst_abc12345678",
      "sharedContent": [
        "<any>"
      ],
      "createdAt": "2024-04-29T21:00:00+02:00",
      "links": {
        "customer": {
          "href": "https://api.mijnklantportaal.nl/v1/customers/cst_abc12345def678",
          "type": "<string>"
        },
        "publicShare": {
          "href": "<string>",
          "type": "<string>"
        }
      }
    }
  ],
  "first_page_url": "https://api.mijnklantportaal.nl/v1/file-shares?page=1",
  "from": 1,
  "next_page_url": "https://api.mijnklantportaal.nl/v1/file-shares?page=2,",
  "path": "https://api.mijnklantportaal.nl/v1/file-shares",
  "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 File Shares

​
current_page
integer

Current page of the response

Example:

1

​
data
object[]

Array of File Share objects

​
first_page_url
string

Endpoint to go to the first page of objects

Example:

"https://api.mijnklantportaal.nl/v1/file-shares?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/file-shares?page=2,"

​
path
string

Current used endpoint

Example:

"https://api.mijnklantportaal.nl/v1/file-shares"

​
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

⌘I