Documents

Retrieve A Document By Id

Get document

get/v1/document/{document_id}

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/document/{document_id}
  • Auth: API key in header X-Imobzi-Secret

Path parameters

document_idstring required

Response

Successful Response

ignore_short_urlboolean nullable

If true, disables automatic short URL generation for the document

sourcestring nullable

Origin or platform of the document creation (e.g., CRM, automation). Required for documents created via API

document_typestring nullable

Type of the document, such as contract, lease, or inspection. Required for documents created via API

statusstring nullable

Current status of the document (e.g., pending, signed, canceled). Required for documents created via API

namestring required

Name or title of the document

sign_in_orderboolean nullable

If true, signers must sign in the defined order

sharedboolean nullable

If true, the document will be shared with the involved parties

invoice_keyunknown
inspection_idstring nullable

ID of the inspection linked to this document

digital_inspectionboolean nullable

Indicates whether the document is related to a digital inspection

commentstring nullable

Internal comments or notes about the document

signer_digitalstring nullable

Email or identifier of the digital signer, if applicable

Changes

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