Logo of FrontifyDeveloper PortalArrow to the right
GraphQL Reference
Object Type

Document

No description
Implemented Interfaces

An Interface is an abstract type that includes a certain set of fields that a type must include to implement the interface.

NodeInterface is the base for all types.

AssetInterface for Asset returnable types.

Type Fields
id:ID!

Asset id.

creator:User!

The User who created the Asset.

createdAt:DateTime!

DateTime of the Asset creation.

modifier:User

The User who last modified the Asset.

modifiedAt:DateTime

DateTime of the Asset last modification.

title:String!

Title of the Asset.

description:String

Description of the Asset.

attachments:[AssetAttachment]

Attachment items linked to Asset.

externalId:ID

External Id of the Asset.

tags:[Tag]

List of Tag items linked to Asset

metadataValues:[MetadataValue]
Deprecated, Removal: 2025-01-01

MetadataValue items linked to Asset. This field will be removed. Use customMetadata instead.

externalProducts:[ExternalProduct]
Deprecated, Removal: 2025-01-01

ExternalProduct items linked to Asset. This field will be removed.

copyright:Copyright

Asset copyright details.

availability:DateTimeRange!
Beta

BETA Asset will be available only during the defined DateTime range.When null it represents an unspecified start and/or open-ended date.

expiresAt:DateTime

Asset available until date.

licenses:[License]

License items linked to Asset.

author:String

Represents the Author of the Asset. Example: Photographer Name.

Represents the conversion status of the Asset. Example: FINISHED.

relatedAssets(
limit: Int = 25
page: Int = 1

Paginated list of Asset items related to Asset.

comments(
limit: Int = 25
page: Int = 1

Paginated list of AssetComment items for Asset.

currentUserPermissions:AssetUserPermissions!

Current User Asset permissions.

customMetadata:[CustomMetadata!]!

List of CustomMetadataProperty items and values associated to Asset.

workflowTask:WorkflowTask
Beta

BETA The WorkflowTask this Asset is linked to.

location:AssetLocation!

Location of the Asset.

previewBackgroundColor:RgbaColor
Beta

BETA Background color of the Asset preview.

filename:String

Original filename of the Asset File.

size:BigInt

Size of the Asset File in bytes.

extension:String!

Extension of the Asset File.

previewUrl(
width: Int
height: Int
page: Int
): Url!

Preview Url which has optional width, height and page arguments. If parameters are not specified, a Url without any parameters will be returned.

thumbnailUrl:Url

Provides a Url for the custom user defined thumbnail or a system generated one when possible.

downloadUrl(
validityInDays: Int
permanent: Boolean
): Url

Signed Url to download the original Document type file.

focalPoint:[Float]

Document focal point position. Example: [0.4803, 0.4340].

width:Int!

Document width in pixels.

height:Int!

Document height in pixels.

pageCount:Int

Document total number of pages.