We're delighted to present you with the comprehensive API documentation for PEAX. This all-in-one workspace for API design offers you a clear, concise, and interactive exploration of our API functionalities.

Query for documents and their last updated timestamp

GET

https://proxy-stage.peax.ch/document-partner-service/agent-api/v1/sources/{sourceId}/accounts/{accountPeaxId}/documents/inventory

documentDocuments

This endpoint returns a maximum of 100 documents at a time.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

sourceId

string

required

accountPeaxId

string

required

Query Params

from

string

optional

string

optional

page

integer

optional

size

integer

optional

sort

array[string]

optional

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://proxy-stage.peax.ch/document-partner-service/agent-api/v1/sources//accounts//documents/inventory?from&to&page=&size=&sort=' \
--header 'Authorization: Bearer {{JWT}}'

Responses

🟢200Operation successful

application/json

Body

data

array[object (InventoryItemView) {2}]

optional

documentId

string <uuid>

optional

updatedAt

string <date-time>

optional

paging

object (PagingView)

optional

pageNo

integer <int32>

optional

pageSize

integer <int32>

optional

totalCount

integer <int64>

optional

totalPages

integer <int32>

optional

Example

{
  "data": [
    {
      "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "paging": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 0,
    "totalPages": 0
  }
}

🟢204No content

🟠400Bad request

🟠403Permission denied

🟠404Not found

🔴500Internal server error

Modified at 2024-07-24 18:19:36

Get content of a document

Confirm a document has been retrieved (v2)