Sign in

v1

latestOpenAPI 3.0.02026-07-14135106116.2 KB
inboxes

Get paginated list of documents in the inbox

Permission required: view_list

get/inboxes/{inbox_id}/paginated

Query parameters

pageinteger

Page number to fetch

per_pageinteger

Results per page

start_receive_datestring date-time
end_receive_datestring date-time
order_bystring

comma seperated list of fields to order by

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

pageinteger

Current page number

per_pageinteger

Number of results per page

totalinteger

Total number of results

Example response

[
  {
    "results": [
      {
        "escalate": {
          "by": "abcdef123456789abcdef123"
        },
        "inbox": "abcdef123456789abcdef123",
        "lock": {
          "by": "abcdef123456789abcdef123"
        },
        "opened_by": [
          {
            "by": "abcdef123456789abcdef123"
          }
        ],
        "reject": {
          "by": "abcdef123456789abcdef123"
        },
        "submitted": {
          "by": "abcdef123456789abcdef123"
        }
      }
    ]
  }
]