Sign in
Contracts

Fetch All Document Type

Fetch All Document Types Available

Request

Parameters

FieldDescriptionDefault
pagePage number (optional)0

Pagination Options

  • page: Page number (starting from 0)
  • page_size: Number of items per page

Response

The response is a DocumentSubTypeSearchResponse object with the following structure:

{
    "data": [
        {
            "id": "string",
            "name": "string",
            "type": "DocumentType(Enum)",
            "slug": "string",
            "page": "string",
            "updated_at": "string"
        }
    ],
    "total": "integer",
    "page": "integer",
    "page_size": "integer"
}

Field Descriptions

Root Level

FieldDescription
dataList of document types
totalTotal number of document types
pageCurrent page number
page_sizeNumber of items per page

Document Type Object (within data array)

FieldDescription
idID of the document type
nameName of the document type
typeDocumentType (Enum)
slugDocument slug
pageID of the contract page
updated_atLast updated time

Notes

  • The page parameter in the request is zero-indexed, meaning the first page is 0.
  • The DocumentType field is an Enum. Refer to your API documentation for possible values.
  • The exact nature of input and output may vary based on specific system requirements and configurations.
get/v2/document-type

Query parameters

pageinteger
page_sizeinteger

Headers

authorizationstring required

The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer    access_token" (excluding the quotes). For example: <br /> Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY

The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer    access_token" (excluding the quotes). For example: <br /> Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY

Response

Successful Response

totalinteger required
pageinteger required
page_sizeinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.