Endpoints for managing a team's document upload templates

List all document upload templates (and List all enabled document upload templates)

v1	GET	https://id.amiqus.co/api/team/templates?type=document
v2	GET	https://id.amiqus.co/api/v2/templates/documents

“List all document upload templates” endpoint has been replaced by “Templates → List all document templates” endpoint, which lists all document templates. The url has changed see above.

Request:

Added

• optional query property enabled (boolean).

Response:

Added

• object of type paginated_list
• is_enabled
• created_at

Changed

• data.*.object of type document_template (contains an array of objects, so that all properties are nested within this).

Removed

• status
• updated_by
• type

Note: The new filtering option by enabled and the new is_enabled property replaces the List all enabled document upload templates endpoint.

Below are examples of responses:

v1

{
    "data": [
        {
            "id": 1,
            "name": "Id facere dolor sed.",
            "description": "Quasi non magnam.",
            "content": "Qui architecto impedit sit doloremque odit nemo. Sit nobis facere excepturi eligendi. Qui rem magni suscipit voluptatem.\n\nVoluptas quia sapiente dolorum maxime repellat pariatur. Aperiam excepturi esse eos sed est sed. Esse impedit aut qui sapiente ducimus non. Voluptate dicta fugiat laudantium nemo ut occaecati. Debitis sed et qui labore et praesentium.",
            "status": {
                "value": 0,
                "label": "Draft"
            },
            "type": {
                "value": "document",
                "label": "checks.upload.label"
            },
            "created_at": "2023-08-17T11:57:18+00:00",
            "created_by": null,
            "updated_at": "2023-08-17T11:57:18+00:00",
            "updated_by": "Henry Watson"
        },
        {
            "id": 2,
            "name": "Deleniti corrupti ipsam inventore.",
            "description": "Facere vitae molestiae.",
            "content": "Ut consequatur corporis molestiae eligendi qui. Asperiores hic saepe molestiae tempora alias harum qui. Commodi officia asperiores consequatur similique. Sint et quam facere rem fuga iusto in. Voluptatum fuga quo quis ut sed esse.\n\nAspernatur dolore id iure rerum. Eum hic expedita nulla animi aliquam est omnis consectetur. Rerum excepturi voluptas a laborum in impedit explicabo.",
            "status": {
                "value": 0,
                "label": "Draft"
            },
            "type": {
                "value": "document",
                "label": "checks.upload.label"
            },
            "created_at": "2023-08-17T11:57:18+00:00",
            "created_by": null,
            "updated_at": "2023-08-17T11:57:18+00:00",
            "updated_by": "Henry Watson"
        },
        {
            "id": 3,
            "name": "Sunt accusamus aliquam quia.",
            "description": "Alias et corrupti.",
            "content": "Sit distinctio tempora sunt omnis. Sunt illum vitae in quae voluptates impedit. Magnam tenetur ea unde et debitis eos minima.\n\nAccusamus alias iste accusantium quo ea. Illum nemo consequuntur deserunt adipisci. Quia amet molestias ut autem deleniti. Qui earum eum delectus facilis voluptas eaque voluptatem.\n\nDolores voluptas mollitia nihil ea beatae. Occaecati expedita molestiae vero atque quia expedita. Quia corporis alias voluptatem ut. Autem corrupti consequatur veritatis reprehenderit est rem hic.",
            "status": {
                "value": 1,
                "label": "Live"
            },
            "type": {
                "value": "document",
                "label": "checks.upload.label"
            },
            "created_at": "2023-08-17T11:57:18+00:00",
            "created_by": null,
            "updated_at": "2023-08-17T11:57:18+00:00",
            "updated_by": "Henry Watson"
        },
        {
            "id": 4,
            "name": "Porro ducimus voluptates.",
            "description": "Voluptatem dignissimos pariatur qui.",
            "content": "Blanditiis quas laudantium consequatur tempore quae facere qui. Beatae eos voluptate expedita amet repellendus. Velit perspiciatis laboriosam culpa ipsa eos.",
            "status": {
                "value": 1,
                "label": "Live"
            },
            "type": {
                "value": "document",
                "label": "checks.upload.label"
            },
            "created_at": "2023-08-17T11:57:18+00:00",
            "created_by": null,
            "updated_at": "2023-08-17T11:57:18+00:00",
            "updated_by": "Henry Watson"
        }
    ],
    "meta": {
        "pagination": {
            "total": 4,
            "count": 4,
            "per_page": 25,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

v2

{
    "object": "paginated_list",
    "data": [
        {
            "object": "document_template",
            "id": 1,
            "name": "Id facere dolor sed.",
            "description": "Quasi non magnam.",
            "content": "Qui architecto impedit sit doloremque odit nemo. Sit nobis facere excepturi eligendi. Qui rem magni suscipit voluptatem.\n\nVoluptas quia sapiente dolorum maxime repellat pariatur. Aperiam excepturi esse eos sed est sed. Esse impedit aut qui sapiente ducimus non. Voluptate dicta fugiat laudantium nemo ut occaecati. Debitis sed et qui labore et praesentium.",
            "is_enabled": false,
            "created_at": "2023-08-17T11:57:18Z",
            "updated_at": "2023-08-17T11:57:18Z"
        },
        {
            "object": "document_template",
            "id": 2,
            "name": "Deleniti corrupti ipsam inventore.",
            "description": "Facere vitae molestiae.",
            "content": "Ut consequatur corporis molestiae eligendi qui. Asperiores hic saepe molestiae tempora alias harum qui. Commodi officia asperiores consequatur similique. Sint et quam facere rem fuga iusto in. Voluptatum fuga quo quis ut sed esse.\n\nAspernatur dolore id iure rerum. Eum hic expedita nulla animi aliquam est omnis consectetur. Rerum excepturi voluptas a laborum in impedit explicabo.",
            "is_enabled": false,
            "created_at": "2023-08-17T11:57:18Z",
            "updated_at": "2023-08-17T11:57:18Z"
        },
        {
            "object": "document_template",
            "id": 3,
            "name": "Sunt accusamus aliquam quia.",
            "description": "Alias et corrupti.",
            "content": "Sit distinctio tempora sunt omnis. Sunt illum vitae in quae voluptates impedit. Magnam tenetur ea unde et debitis eos minima.\n\nAccusamus alias iste accusantium quo ea. Illum nemo consequuntur deserunt adipisci. Quia amet molestias ut autem deleniti. Qui earum eum delectus facilis voluptas eaque voluptatem.\n\nDolores voluptas mollitia nihil ea beatae. Occaecati expedita molestiae vero atque quia expedita. Quia corporis alias voluptatem ut. Autem corrupti consequatur veritatis reprehenderit est rem hic.",
            "is_enabled": true,
            "created_at": "2023-08-17T11:57:18Z",
            "updated_at": "2023-08-17T11:57:18Z"
        },
        {
            "object": "document_template",
            "id": 4,
            "name": "Porro ducimus voluptates.",
            "description": "Voluptatem dignissimos pariatur qui.",
            "content": "Blanditiis quas laudantium consequatur tempore quae facere qui. Beatae eos voluptate expedita amet repellendus. Velit perspiciatis laboriosam culpa ipsa eos.",
            "is_enabled": true,
            "created_at": "2023-08-17T11:57:18Z",
            "updated_at": "2023-08-17T11:57:18Z"
        }
    ],
    "total": 4,
    "count": 4,
    "limit": 25,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}

INFO

📌 Please refer to List all document templates for more information.