Skip to main content
GET
Get link-type document

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the records.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
document_id
string<shortuuid>
required

ID of the document.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A GDTI document as read from the API.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gdti
string
required

Global Document Type Identifier (AI 253), 13 to 30 digits. Unique across Closient.

document_type
enum<string>
required

Coarse classification of the document.

Available options:
CERTIFICATE,
INVOICE,
SPECIFICATION,
COMPLIANCE_REPORT,
OTHER
title
string
required

Display title of the document (max 255 characters).

organization_id
string<shortuuid>
required

UUID of the organization that owns the document.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
created
string<date-time>
required

ISO-8601 creation timestamp.

modified
string<date-time>
required

ISO-8601 last-modified timestamp.

file_url
string | null

URL of the hosted file, if one was uploaded in the dashboard. Read-only here.

external_url
string | null

Where the document lives, if hosted elsewhere.

issued_date
string<date> | null

Date the document was issued, or null.