Endpoints for managing a team's document library files

List all document library files

v1	GET	https://id.amiqus.co/api/team/documents
v2	GET	https://id.amiqus.co/api/v2/documents

“List all document library files” endpoint has been replaced with “Documents → List all documents”

Request:

Added

• optional expandable property attachment
• enabled - returns a list of a team's enabled document library files (i.e. not in "draft" status).

Response:

Added

• object with type of paginated_list
• data.*.object with type of document
• is_enabled

Changed

• attachment_id is replaced with data.*.object with type of attachment (where property is expanded) or attachment (which will contain the attachment’s id as an integer).

Removed

• status
• active
• file

Note: The endpoint List all enabled document library files has been deprecated and replaced by an optional query property enabled mentioned above. This will return a filtered list of the team’s enabled document library files.

Below are examples of responses:

v1

{
    "data": [
        {
            "id": 1,
            "name": "Guide",
            "description": "Guides for Team",
            "active": true,
            "status": "Live",
            "created_at": "2023-08-23T15:30:59+00:00",
            "created_by": null,
            "updated_at": "2023-08-23T15:32:38+00:00",
            "updated_by": "David Adams",
            "attachment_id": 1,
            "file": {
                "av_status": "CLEAN",
                "original": "Team Guides docs.pdf",
                "type": "application/pdf",
                "size": 7234303
            },
            "links": {
                "download": "https://amiqusid.test/team/attachments/1"
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 25,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

v2

{
    "object": "paginated_list",
    "data": [
        {
            "object": "document",
            "id": 1,
            "name": "Guide",
            "description": "Guides for Team",
            "is_enabled": true,
            "attachment": 1,
            "created_at": "2023-08-23T15:30:59Z",
            "updated_at": "2023-08-23T15:32:38Z"
        }
    ],
    "total": 1,
    "count": 1,
    "limit": 25,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}

INFO

📌 Please refer to List all documents for more information.