Crego APIs
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
  1. Document
  • Omni
  • Document APIs
  • Storage
    • Create Storage
      POST
    • Update Storage
      PATCH
    • List Storage
      GET
    • Get Storage
      GET
    • Test Credential
      GET
  • Category
    • Create Category
      POST
    • Update Category
      PATCH
    • List Category
      GET
    • Get Category
      GET
  • Document
    • Create Document
      POST
    • Update Document
      PATCH
    • List Document
      GET
    • Delete Document
      DELETE
    • Get Document
      GET
    • Upload Files
      POST
    • Downlaod Files
      GET
    • Delete File
      DELETE
    • Get all tags
      GET
    • Inactive
      PUT
    • Reject
      PUT
    • Approve
      PUT
  • Sharing
    • Share Document
      POST
    • Preview Shared Document
      GET
    • List Shared Documents
      GET
    • Get Shared Document
      GET
    • Update Shared Document
      PATCH
    • Delete Document Share
      DELETE
  1. Document

List Document

Developing
preprod
https://preprod.api.crego.io
preprod
https://preprod.api.crego.io
GET
/documents/
Last modified:2025-05-30 07:54:36

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
expiry_date__lte
string 
optional
Expiry date less than given date
Example:
2024-01-01
expiry_date__gte
string 
optional
Expiry date greater than given date
Example:
2024-01-01
tags
string 
optional
Comma separated tags
Example:
kyc,agreements
categories
string 
optional
Comma separated category ids
created_at__range
array[string]
optional
Created date range filter
Example:
["2024-01-01,2024-02-02"]
updated_at__range
string 
optional
Updated date range filter
search
string 
optional
Search on name, path
page_size
integer 
optional
page
integer 
optional
expand
string 
optional
files, category, storage
Example:
category,storage
content_type
string 
optional
should app.model
Example:
contact.contact
object_id
string 
optional
Example:
01JVVJF3NTPY29SE2XQ7C5H0QA
storage
string 
optional
created_at_after
string 
optional
Example:
2025-05-12
created_at_before
string 
optional
Example:
2025-05-19

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://preprod.api.crego.io/documents/?content_type=contact.contact&object_id=01JVVJF3NTPY29SE2XQ7C5H0QA'

Responses

🟢200Success
application/json
Body
count
integer 
required
total_pages
integer 
required
current_page
integer 
required
has_previous
boolean 
required
has_next
boolean 
required
previous_page
null 
required
next_page
null 
required
results
array[object (Document) {18}] 
required
id
string 
required
category
string 
required
tenant_id
string 
required
created_by
string 
required
updated_by
string 
required
created_at
string 
required
updated_at
string 
required
tags
array[string]
optional
refs
object 
optional
name
string 
required
path
string 
optional
description
string 
optional
expiry_date
string 
optional
is_encrypted
boolean 
optional
comment
string 
optional
storage
string 
required
content_type
string 
optional
app_lable.model_name
object_id
string 
optional
Example
{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "01JP4NRYY8QMHZRAXR8NPVK6TK",
            "files": [
                {
                    "id": "01JP4QN8Q2B5WRWMMZXFP10NMT",
                    "tenant_id": "203f386d-5068-4a82-b17a-0c0655fe84be",
                    "created_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "updated_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "created_at": "2025-03-12T14:01:10.585782Z",
                    "updated_at": "2025-03-12T14:01:10.585804Z",
                    "storage_key": "loan/AUMQueryReport-12-03-2025-12.42PM.xlsx",
                    "file_name": "AUMQueryReport-12-03-2025-12.42PM.xlsx",
                    "file_extension": ".xlsx",
                    "size": 5442,
                    "document": "01JP4NRYY8QMHZRAXR8NPVK6TK"
                },
                {
                    "id": "01JP5012KKTWPXYJC44ZKMZSP3",
                    "tenant_id": "203f386d-5068-4a82-b17a-0c0655fe84be",
                    "created_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "updated_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "created_at": "2025-03-12T16:27:26.148945Z",
                    "updated_at": "2025-03-12T16:27:26.148964Z",
                    "storage_key": "loan/Daily_POS-20-01-2025-10.28AM.xlsx",
                    "file_name": "Daily_POS-20-01-2025-10.28AM.xlsx",
                    "file_extension": ".xlsx",
                    "size": 4854,
                    "document": "01JP4NRYY8QMHZRAXR8NPVK6TK"
                },
                {
                    "id": "01JP710XZQJJKEY7GAPQF88D37",
                    "tenant_id": "203f386d-5068-4a82-b17a-0c0655fe84be",
                    "created_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "updated_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "created_at": "2025-03-13T11:23:18.857994Z",
                    "updated_at": "2025-03-13T11:23:18.858017Z",
                    "storage_key": "loan/Customer_Portfolio_report-11-01-2025-02.16PM.xlsx",
                    "file_name": "Customer_Portfolio_report-11-01-2025-02.16PM.xlsx",
                    "file_extension": ".xlsx",
                    "size": 14715,
                    "document": "01JP4NRYY8QMHZRAXR8NPVK6TK"
                },
                {
                    "id": "01JP710YVR3MWCX4F5B0VQE4FR",
                    "tenant_id": "203f386d-5068-4a82-b17a-0c0655fe84be",
                    "created_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "updated_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "created_at": "2025-03-13T11:23:19.736634Z",
                    "updated_at": "2025-03-13T11:23:19.736650Z",
                    "storage_key": "loan/CoLender.xlsx",
                    "file_name": "CoLender.xlsx",
                    "file_extension": ".xlsx",
                    "size": 5645,
                    "document": "01JP4NRYY8QMHZRAXR8NPVK6TK"
                },
                {
                    "id": "01JP710ZQQWFAAQYWAXJ74K4S7",
                    "tenant_id": "203f386d-5068-4a82-b17a-0c0655fe84be",
                    "created_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "updated_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
                    "created_at": "2025-03-13T11:23:20.631945Z",
                    "updated_at": "2025-03-13T11:23:20.631961Z",
                    "storage_key": "loan/Originator_sheet.xlsx",
                    "file_name": "Originator_sheet.xlsx",
                    "file_extension": ".xlsx",
                    "size": 5607,
                    "document": "01JP4NRYY8QMHZRAXR8NPVK6TK"
                }
            ],
            "category": "Property",
            "tenant_id": "203f386d-5068-4a82-b17a-0c0655fe84be",
            "created_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
            "updated_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
            "created_at": "2025-03-12T13:28:14.496397Z",
            "updated_at": "2025-03-12T13:28:14.496420Z",
            "owner": "0d17a44c-9589-4534-807a-7c9e95002e10",
            "tags": [
                "finance",
                "loan"
            ],
            "name": "Loan Agreement",
            "path": "loan",
            "description": "for loan agreement document",
            "expiry_date": "2025-03-14",
            "is_encrypted": false,
            "refs": {},
            "comment": "",
            "storage": "01JP4N5K28G23CSWQZ5VE3PWFC"
        },
        {
            "id": "01JP6ZJR38DDGYCQTP22296AAZ",
            "files": [],
            "category": "Property",
            "tenant_id": "203f386d-5068-4a82-b17a-0c0655fe84be",
            "created_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
            "updated_by": "0d17a44c-9589-4534-807a-7c9e95002e10",
            "created_at": "2025-03-13T10:58:05.504641Z",
            "updated_at": "2025-03-13T10:58:05.504671Z",
            "owner": "0d17a44c-9589-4534-807a-7c9e95002e10",
            "tags": [
                "registery"
            ],
            "name": "Registery",
            "path": "loan",
            "description": "this is for registery",
            "expiry_date": "2025-03-14",
            "is_encrypted": false,
            "refs": {},
            "comment": "",
            "storage": "01JP4N5K28G23CSWQZ5VE3PWFC"
        }
    ]
}
Modified at 2025-05-30 07:54:36
Previous
Update Document
Next
Delete Document
Built with