v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Fetch the document forms of your company

get/v2/documents/forms

Query parameters

statusstring required

Specify the status of the document form that you are fetching. Allowed values are 'published', 'deactivated'.

per_pageinteger

The number of records per page.

page_nointeger

The current page number

Response

200

per_pageinteger
page_nointeger
totalinteger

Example response

{
  "forms": [
    {
      "form": {
        "id": 156,
        "updated_at": "2021-09-29T00:45:20Z",
        "editable": true,
        "created_at": "2021-09-29T00:45:20Z",
        "category": "Bill of lading",
        "created_by": {
          "id": 417,
          "first_name": "John",
          "last_name": "Doe"
        },
        "modified_by": {
          "id": 417,
          "first_name": "John",
          "last_name": "Doe"
        }
      }
    }
  ],
  "per_page": 50,
  "page_no": 1,
  "total": 1
}