Skip to navigation

Get DocumentPartLookupTable by ID

Beta
Get a single DocumentPartLookupTable by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

document_part_lookup_table_idstringRequired
ID of the DocumentPartLookupTable.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Query parameters

returninglist of stringsOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitlist of stringsOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK
__typenamestringOptional
columnDefinitionslist of objectsOptional
createdAtstringOptionalformat: "datetime"
idstringOptional
indentationintegerOptional
isEvaluatedbooleanOptional
isSubmittablebooleanOptional
lookupSchemaobject or nullOptional
The root schema that the table's lookup columns start from. Returns null when the schema is not a supported lookup schema type.
modifiedAtstringOptionalformat: "datetime"
modifierobject or nullOptional
namestringOptional
rowCountintegerOptional
rowsstringOptionalformat: "uri"
submissionStatusenumOptional
Allowed values:
versionMetadataobjectOptional
Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error