get
https://api.customerly.io/v2/documents
Returns a paginated list of documents for your app. The response excludes the document body
to keep the payload lightweight. Use the GET /documents/{id} endpoint to retrieve the full
document including the body.
Pagination
This endpoint uses cursor-based pagination:
per_page: Number of documents to return per page (default: 20, max: 100)cursor: The cursor value from the previous response to fetch the next page
Example pagination flow:
- First request:
GET /documents?per_page=20 - Response returns a
cursorvalue (e.g.,12345) and 20 documents - Next page:
GET /documents?per_page=20&cursor=12345 - Continue until
cursorisnull(no more documents available)
Filtering
polymorphic_folder_id: Filter documents by folder (optional)
Response
Returns a paginated response containing:
documents: Array of simplified document objects without thebodyfieldcursor: Next cursor value for pagination (null if no more documents)
Documents are ordered by document_id in descending order (newest first).
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
401Authentication required
403Permission denied
422Invalid request parameters