List Document

GET

/api/documents

Refers to any file containing details on maintenance, operation, and asset management, including manuals, records, and reports.

Filtering

filter[name]=HelloFromMakiniAPI

filter[name:contains]=Makini

filter[name:startsWith]=Hello

filter[name:startsWith]=API

filter[createdAt:gt]=2023-11-07

filter[createdAt:gteq]=2023-11-07

filter[createdAt:lt]=2023-11-07

filter[createdAt:lted]=2023-11-07

Filter matching

filterMatch=any // OR

filterMatch=all // AND

Sorting

sort[createdAt]=1 // DESC

sort[createdAt]=0 // ASC

Request

Authorization

Query Params

Responses

🟢200

application/json

Successful operation

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/documents?filter&page&sort&per_page'

Response Example

{
    "data": [
        {
            "key": "06000356072332",
            "entityKeys": "[]",
            "name": "string",
            "url": "string",
            "type": "string",
            "contentType": "string",
            "description": "Recusandae quo aspernatur velit.",
            "notes": "string",
            "createdAt": "1998-11-12T08:36:28Z",
            "updatedAt": "2015-11-30T11:51:20Z"
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "from": 0,
        "last_page": 0,
        "path": "string",
        "per_page": 0,
        "to": 0,
        "total": 0
    }
}

Modified at 2026-03-19 15:49:21

Update a Customer

Create a Document