### installProjectWebhook

Source: https://frontify.github.io/graphql-reference/mutations/installProjectWebhook

Installs a webhook for a project. This mutation requires 'basic:write' and 'webhook:write' scopes and 'EDIT' project permission level.

```APIDOC
## installProjectWebhook

### Description
Installs a webhook for a project, sending notifications to a specified URL.

### Method
MUTATION

### Endpoint
N/A (GraphQL)

### Parameters
#### Input
- **input** (InstallProjectWebhookInput!) - Required - The input object for the mutation.
  #### Input Fields
  - **projectId** (ID!) - Required - Destination `Project` Id.
  - **notificationUrl** (Url!) - Required - `Url` to send the `ProjectWebhook` notification to.
  - **name** (String!) - Required - `ProjectWebhook` name.

### Response
#### Success Response
- **webhook** (Webhook!) - `Webhook` details.

### Scopes Required
- basic:write
- webhook:write

### Project Permissions Required
- EDIT
```

--------------------------------

### InstallProjectWebhook Type

Source: https://frontify.github.io/graphql-reference/type/InstallProjectWebhook

Represents the details of a webhook installation for a project. It includes information about the associated webhook.

```APIDOC
## InstallProjectWebhook

### Description
Represents the details of a webhook installation for a project. It includes information about the associated webhook.

### Type Fields

- **webhook** (Webhook!) - `Webhook` details.
```

--------------------------------

### InstallProjectWebhookInput

Source: https://frontify.github.io/graphql-reference/type/InstallProjectWebhookInput

Defines the structure for inputting data when installing a project webhook. It requires the destination project ID, a URL for notifications, and a name for the webhook.

```APIDOC
## InstallProjectWebhookInput

### Description
Input object type for installing a project webhook.

### Input Fields
- **projectId** (ID!) - Required - Destination `Project` Id.
- **notificationUrl** (Url!) - Required - `Url` to send the `ProjectWebhook` notification to.
- **name** (String!) - Required - `ProjectWebhook` name.
```

--------------------------------

### DateTimeRangeInput

Source: https://frontify.github.io/graphql-reference/type/DateTimeRangeInput

Represents a range with a start and end DateTime.

```APIDOC
## Input Object Type: DateTimeRangeInput

### Description
Defines a range for date and time values.

### Fields
- **from** (DateTime) - Required - The start `DateTime` of the range.
- **to** (DateTime) - Required - The end `DateTime` of the range.
```

--------------------------------

### CreateFolder

Source: https://frontify.github.io/graphql-reference/type/CreateFolder

Creates a new folder. Returns the newly created folder.

```APIDOC
## CreateFolder

### Description
Creates a new folder.

### Type Fields
- **folder** (Folder) - The newly created `Folder`.
```

--------------------------------

### MarkingTimeframeInput

Source: https://frontify.github.io/graphql-reference/type/MarkingTimeframeInput

The MarkingTimeframeInput type is used to specify a time range for a marking. It accepts start and end values as percentages of the total video length.

```APIDOC
## Input Type: MarkingTimeframeInput

### Description
Defines the start and end of a marking area as a percentage of the total video length.

### Fields
- **start** (Percent) - Optional - The start of the `Marking` area in percentage of total video length. Defaults to video start (0) when the timeframe input property is set.
- **end** (Percent) - Optional - The end of the `Marking` area in percentage of total video length. Defaults to video end (1) when the timeframe input property is set.
```

--------------------------------

### CreateFolderInput

Source: https://frontify.github.io/graphql-reference/type/CreateFolderInput

Defines the structure for creating a new folder, specifying its parent, name, and an optional description.

```APIDOC
## CreateFolderInput

### Description

Input type for creating a new folder. It requires a parent ID and a name, and optionally accepts a description.

### Input Fields

- **parentId** (ID!) - Required - The parent Id of the `Folder` creation destination. Possible identifiers are `Library`/`Workspace` or `Folder`.
- **name** (String!) - Required - `Folder` name.
- **description** (String) - Optional - `Folder` description.
```

--------------------------------

### previewUrl

Source: https://frontify.github.io/graphql-reference/type/Audio

Provides the URL for a preview of the converted audio file in MP3 format.

```APIDOC
## previewUrl

### Description
Preview `Url` of converted `Audio` file in mp3 format.

### Method
GET

### Endpoint
/assets/{id}/previewUrl

### Response
#### Success Response (200)
- **url** (Url) - The preview URL.
```

--------------------------------

### Retrieve Asset by ID

Source: https://frontify.github.io/graphql-reference/queries/asset

Fetches detailed information about a specific asset using its unique ID. This is the primary way to get asset data.

```APIDOC
## asset(id: ID!):Asset

### Description
Retrieve `Asset` details by Id.

### Arguments
#### id (ID!)
`Asset` Id.

### Fields of Asset
- **id** (ID!): `Asset` id.
- **creator** (User!): The `creator` is the `User` who created the asset on Frontify.
- **createdAt** (DateTime!): DateTime of the `Asset` creation.
- **modifier** (User): The `modifier` is the `User` who last modified the asset on Frontify.
- **modifiedAt** (DateTime): DateTime of the `Asset`'s last modification.
- **title** (String!): Title of the `Asset`.
- **description** (String): Description of the `Asset`.
- **alternativeText** (String): Alternative text for the `Asset`. Used by screen readers when the asset is not decorative.
- **attachments** ([AssetAttachment]): List of `Asset`'s `Attachments`.
- **externalId** (ID): External Id of the `Asset`.
- **tags** ([Tag]): List of `Asset`'s tags.
- **copyright** (Copyright): `Asset` copyright details.
- **availability** (DateTimeRange!): `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]): List of `Asset`'s licenses.
- **targets** ([Target]): Beta **BETA** List of `Target` items linked to `Asset`
- **metadataValues** ([MetadataValue]): Deprecated, Removal: 2026-07-01 Metadata values details. This field will be removed. Use `customMetadata` instead.
- **author** (String): Represents the Author of the `Asset`. Example: Photographer Name.
- **status** (AssetStatusType!): Represents the conversion status of the `Asset`. Example: FINISHED.
- **relatedAssets**(limit: Int = 25, page: Int = 1): AssetItems!
  Paginated list of `Asset` items related to `Asset`.
- **revisions**(limit: Int = 25, page: Int = 1): AssetRevisionItems!
  Paginated list of `AssetRevision` items for `Asset`, newest first.
- **comments**(limit: Int = 25, page: Int = 1, query: AssetCommentQueryInput): AssetCommentItems
  Paginated list of `AssetComment` items for `Asset`.
- **currentUserPermissions** (AssetUserPermissions!): `Asset` permissions of the current `User`.
- **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.
```

--------------------------------

### CreateLicenseInput

Source: https://frontify.github.io/graphql-reference/type/CreateLicenseInput

Defines the structure for creating a new license, including project association, title, terms, and default application settings.

```APIDOC
## CreateLicenseInput

### Description
Used to define the parameters for creating a new license.

### Input Fields
#### projectId (ID!)
`Library` Id.

#### title (String!)
`License` title.

#### license (String!)
`License` terms.

#### addByDefault (Boolean = false)
Apply `License` to new assets by default.

#### requireConsensus (Boolean = false)
Require user to accept `License` terms before download.
```

--------------------------------

### createFolder Mutation

Source: https://frontify.github.io/graphql-reference/mutations/createFolder

Creates a new folder. Requires 'basic:write' scope and 'EDIT' permission on Project or Folder.

```APIDOC
## createFolder Mutation

### Description
Creates a new `Folder`. Requires `basic:write` scope to be accessible and `Project` or `Folder` permission level `EDIT`.

### Method
mutation

### Input
#### input (CreateFolderInput!)
- **parentId** (ID!) - The parent Id of the `Folder` creation destination. Possible identifiers are `Library`/`Workspace` or `Folder`.
- **name** (String!) - `Folder` name.
- **description** (String) - `Folder` description.

### Output
#### folder (Folder)
The newly created `Folder`.
```

--------------------------------

### configureProjectWebhook

Source: https://frontify.github.io/graphql-reference/mutations/configureProjectWebhook

Configures a webhook for a specific project. This is a beta feature and requires a project ID, notification URL, webhook name, and payload version. Optionally, you can subscribe to specific webhook events.

```APIDOC
## configureProjectWebhook

### Description
Configures a webhook for a specific project. This is a beta feature and requires a project ID, notification URL, webhook name, and payload version. Optionally, you can subscribe to specific webhook events.

### Method
MUTATION

### Endpoint
N/A (GraphQL)

### Parameters
#### Input
- **input** (ConfigureProjectWebhookInput!) - Required - The input object for the mutation.

### Input Fields of ConfigureProjectWebhookInput
- **projectId** (ID!) - Required - Project ID.
- **notificationUrl** (String!) - Required - Webhook notification URL.
- **name** (String!) - Required - Webhook name.
- **version** (Int!) - Required - Webhook payload version (1 or 2).
- **subscribeTo** ([AssetWebhookEvent!]) - Optional - Subscribe to specific webhook events. If not defined the webhook will subscribe to all events.

### Response
#### Success Response
- **webhook** (ProjectWebhook!) - The configured project webhook.
```

--------------------------------

### ConfigureProjectWebhook

Source: https://frontify.github.io/graphql-reference/type/ConfigureProjectWebhook

The ConfigureProjectWebhook type represents a configured project webhook. It is a beta feature.

```APIDOC
## ConfigureProjectWebhook

### Description
Represents a configured project webhook. This is a beta feature.

### Fields
- **webhook** (ProjectWebhook!) - The configured project webhook.
```

--------------------------------

### inviteProjectUser

Source: https://frontify.github.io/graphql-reference/mutations/inviteProjectUser

Invites a user to a project. Requires 'basic:write' scope and 'EDIT' project permission level. Note: This mutation is not compatible with the User Provisioning feature.

```APIDOC
## inviteProjectUser

### Description
Invites a user to a project. Requires `basic:write` scope and `Project` permission level `EDIT`. Limitations: Does not work if User Provisioning feature is enabled.

### Method
MUTATION

### Endpoint
`/graphql

### Parameters
#### Input
- **input** (InviteProjectUserInput!) - Required - The input object for the mutation.

##### Input fields of InviteProjectUserInput
- **projectId** (ID!) - Required - Id of the `Project` you want to invite `User` to.
- **email** (Email!) - Required - Email address of the `User` you would like to invite.
- **permission** (ProjectPermission!) - Optional - `Project` permission level of the `User` you are inviting. Defaults to VIEW.
- **validFrom** (DateTime) - Optional - Start `Date` for `User` access permission validity.
- **validTo** (DateTime) - Optional - End `Date` for `User` access permission validity.

### Response
#### Success Response
- **project** (Project) - The `Project` where `User` was invited to.

#### Response Example
```json
{
  "data": {
    "inviteProjectUser": {
      "project": {
        "id": "some-project-id",
        "name": "Project Name"
      }
    }
  }
}
```
```

--------------------------------

### WorkspaceProjectQueryInput

Source: https://frontify.github.io/graphql-reference/type/WorkspaceProjectQueryInput

Input object for filtering and sorting workspace projects.

```APIDOC
## WorkspaceProjectQueryInput

### Description
Input object for filtering and sorting workspace projects.

### Fields
- **state** (WorkspaceProjectStateFilter) - Optional - Limits the result set based on `WorkspaceProject` state. Defaults to ALL.
- **sortBy** (WorkspaceProjectQuerySort) - Optional - Sort order of the `WorkspaceProject` query result set.
```

--------------------------------

### InviteProjectUserInput

Source: https://frontify.github.io/graphql-reference/type/InviteProjectUserInput

Defines the input parameters required to invite a user to a project.

```APIDOC
## InviteProjectUserInput

### Description
This input type is used to specify the details for inviting a user to a project.

### Input Fields

- **projectId** (ID!) - Required - The ID of the `Project` to which the `User` will be invited.
- **email** (Email!) - Required - The email address of the `User` to invite.
- **permission** (ProjectPermission!) - Optional (defaults to VIEW) - The permission level for the invited `User` within the `Project`.
- **validFrom** (DateTime) - Optional - The start date for the validity of the user's access permission.
- **validTo** (DateTime) - Optional - The end date for the validity of the user's access permission.
```

--------------------------------

### CreateAsset

Source: https://frontify.github.io/graphql-reference/type/CreateAsset

Initiates the processing of a newly created asset and returns the associated job.

```APIDOC
## CreateAsset

### Description
Initiates the processing of a newly created asset and returns the associated job.

### Type
Mutation

### Fields
#### job (AssetProcessingJob!)
- **job** (AssetProcessingJob!) - Required - The newly created `Asset` processing job response.
```

--------------------------------

### CreateServiceAppInput

Source: https://frontify.github.io/graphql-reference/type/CreateServiceAppInput

Defines the input parameters required to create a new ServiceApp.

```APIDOC
## CreateServiceAppInput

### Description

Input object type for creating a ServiceApp.

### Fields

#### title (String!)

**BETA** The title for the ServiceApp.

#### scopes ([SecurityScope!]!)

**BETA** The scopes allowed for the ServiceApp.

#### description (String = null)

**BETA** The description for the ServiceApp.
```

--------------------------------

### createLicense Mutation

Source: https://frontify.github.io/graphql-reference/mutations/createLicense

Creates a new Project License. This mutation requires the `basic:write` scope and `EDIT` permission level for the Project. All mutations have a single input field named `input`.

```APIDOC
## createLicense Mutation

### Description
Creates a new `Project` `License`. Requires `basic:write` scope and `Project` permission level `EDIT`.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Request Body
- **input** (CreateLicenseInput!) - Required - The input object for creating a license.
  - **projectId** (ID!) - Required - `Library` Id.
  - **title** (String!) - Required - `License` title.
  - **license** (String!) - Required - `License` terms.
  - **addByDefault** (Boolean) - Optional - Apply `License` to new assets by default. Defaults to `false`.
  - **requireConsensus** (Boolean) - Optional - Require user to accept `License` terms before download. Defaults to `false`.

### Response
#### Success Response (200)
- **license** (License!) - `License` details.

### Request Example
```json
{
  "query": "mutation CreateNewLicense($input: CreateLicenseInput!) { createLicense(input: $input) { license { id title } } }",
  "variables": {
    "input": {
      "projectId": "your_project_id",
      "title": "MIT License",
      "license": "MIT License text...",
      "addByDefault": true
    }
  }
}
```

### Response Example
```json
{
  "data": {
    "createLicense": {
      "license": {
        "id": "generated_license_id",
        "title": "MIT License"
      }
    }
  }
}
```
```

--------------------------------

### ConfigureProjectWebhookInput

Source: https://frontify.github.io/graphql-reference/type/ConfigureProjectWebhookInput

Defines the structure for configuring project webhooks, including project ID, notification URL, webhook name, payload version, and subscribed events.

```APIDOC
## ConfigureProjectWebhookInput

### Description
Input object type for configuring project webhooks.

### Input Fields

- **projectId** (ID!) - Required - BETA Project ID.
- **notificationUrl** (String!) - Required - BETA Webhook notification URL.
- **name** (String!) - Required - BETA Webhook name.
- **version** (Int!) - Required - BETA Webhook payload version (1 or 2).
- **subscribeTo** ([AssetWebhookEvent!]) - Optional - BETA Subscribe to specific webhook events. If not defined the webhook will subscribe to all events.
```

--------------------------------

### downloadUrl

Source: https://frontify.github.io/graphql-reference/type/Audio

Retrieves a signed URL for downloading the original audio file. This is null if the asset is protected and no valid download request exists.

```APIDOC
## downloadUrl

### Description
Signed `Url` to download the original `Audio` type file. Is null if the asset is download-protected and there is no approved and still valid download request.

### Method
POST

### Endpoint
/assets/{id}/downloadUrl

### Parameters
#### Query Parameters
- **validityInDays** (Int) - Optional - The number of days the URL will be valid.
- **permanent** (Boolean) - Optional - If true, the URL will be permanent.

### Request Example
```json
{
  "query": {
    "validityInDays": 7,
    "permanent": false
  }
}
```

### Response
#### Success Response (200)
- **url** (Url) - The signed download URL.
```

--------------------------------

### thumbnailUrl

Source: https://frontify.github.io/graphql-reference/type/Audio

Provides a URL for a custom or system-generated thumbnail of the audio asset.

```APIDOC
## thumbnailUrl

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

### Method
GET

### Endpoint
/assets/{id}/thumbnailUrl

### Response
#### Success Response (200)
- **url** (Url) - The thumbnail URL.
```

--------------------------------

### GuidelinePageBlockAssetSetting

Source: https://frontify.github.io/graphql-reference/type/GuidelinePageBlockAssetSetting

Represents the settings for a Guideline Page Block Asset.

```APIDOC
## Object Type: GuidelinePageBlockAssetSetting

### Description
No description provided in the source.

### Fields

*   **settingName**: String!
    **BETA** The name of the `GuidelinePageBlockAssetSetting`.

*   **assets** (page: Int = 1, limit: Int = 25): GuidelinePageBlockAssetItems
    **BETA** A list of `GuidelinePageBlockAsset` referenced by this `GuidelinePageBlockAssetSetting`.

    #### Parameters

    ##### Query Parameters

    *   **page** (Int) - Optional - The page number for the assets list. Defaults to 1.
    *   **limit** (Int) - Optional - The number of assets to retrieve per page. Defaults to 25.

### Last updated
29-06-2026 13:35
```

--------------------------------

### CreateWorkspaceProjectInput

Source: https://frontify.github.io/graphql-reference/type/CreateWorkspaceProjectInput

Defines the input structure for creating a new workspace project. It requires the brand ID and the project name.

```APIDOC
## CreateWorkspaceProjectInput

### Description

Input object type for creating a workspace project.

### Input Fields

- **brandId** (ID!) - Required - Id of the `Brand` where `Project` should be inserted.
- **name** (String!) - Required - `Workspace` type `Project` name.
```

--------------------------------

### CreateCollection

Source: https://frontify.github.io/graphql-reference/type/CreateCollection

Creates a new collection. It returns the details of the newly created collection.

```APIDOC
## CreateCollection

### Description
Creates a new collection.

### Type Fields
- **collection** (Collection!) - Required - The newly created `Collection` details.
```

--------------------------------

### AssetQueryInput

Source: https://frontify.github.io/graphql-reference/type/AssetQueryInput

Defines the input parameters for querying assets, allowing filtering, sorting, and searching.

```APIDOC
## AssetQueryInput

### Description
Input type for querying assets, enabling filtering by various criteria.

### Fields
- **filter** (AssetQueryFilterInput) - Use filters to reduce the set of matched `Asset` items by complex filtering.
- **inFolder** (AssetQueryInFolderInput) - Limit the result set to a specific `Folder` of this `Library`.
- **sortBy** (AssetQueryFilterSortType) - Sort set of the matched `AssetItems`.
- **externalId** (ID) - Limit the result set by the externalId of an `Asset`.
- **search** (String) - Limit the result set by the search term.
- **types** ([AssetType]) - Limit the result set by the `Asset` types.
```

--------------------------------

### CreateAssetInput

Source: https://frontify.github.io/graphql-reference/type/CreateAssetInput

Defines the structure for creating a new asset, specifying its properties and relationships.

```APIDOC
## CreateAssetInput

Input Fields

- **fileId** (ID!) - Required - File Id. Signed Id returned in `uploadFile`.
- **title** (String!) - Required - `Asset` title or display name.
- **alternativeText** (String) - Optional - Alternative text for the `Asset`. Used by screen readers when the asset is not decorative.
- **isDecorative** (Boolean) - Optional - BETA Indicates whether the `Asset` is decorative and not meant to be read by screen readers. If true, alternative text is ignored.
- **description** (String) - Optional - `Asset` description. Defaults to "".
- **externalId** (ID) - Optional - `Asset` external Id.
- **copyright** (CreateCopyrightInput) - Optional - Add `Asset` copyright details.
- **tags** ([TagInput]) - Optional - List of tags to create with `Asset`.
- **skipFileMetadata** (Boolean) - Optional - Skip file's EXIF metadata. When true, it will ignore all file metadata contents. Defaults to `false`.
- **directory** ([String]) - Optional - An array of strings representing the directory, if a folder does not exist, it is created. Example: ["My Folder", "Sub-Folder"] will create the necessary folders if they do not yet exist and place the `Asset` in it. Important: Cannot be used in conjunction with `parentId` that is from a `Folder`.
- **parentId** (ID) - Optional - The parent Id, where the `Asset` should be located in. Should either be a `Library`, `WorkspaceProject` or `Folder` Id. Important: Cannot be used in conjunction with `directory` if the Id is from a `Folder`.
- **availability** (DateTimeRangeInput) - Optional - `Asset` will become available only during the interval. When undefined or `null` the `Asset` will be immediately and indefinitely available.
- **expiresAt** (DateTime) - Optional - `Asset` will expire once the defined date is reached.
- **author** (String) - Optional - Represents the Author of the `Asset`. Example: Photographer Name. Defaults to "".
- **previewBackgroundColor** (RgbaColorInput) - Optional - BETA Background color of the `Asset` preview.
```

--------------------------------

### project(id: ID!): Project

Source: https://frontify.github.io/graphql-reference/queries/project

Retrieves Project details by Id. This field is deprecated and will be removed. Use `library` or `workspaceProject` instead.

```APIDOC
## project(id: ID!): Project

### Description
Retrieves `Project` details by Id. This field will be removed. Use `library` or `workspaceProject` instead.

### Arguments
#### id (ID!)
`Project` Id.

### Deprecated
This field is deprecated and will be removed. Use `library` or `workspaceProject` instead.
```

--------------------------------

### GuidelinePageBlockAsset

Source: https://frontify.github.io/graphql-reference/type/GuidelinePageBlockAsset

Represents an asset on a guideline page, providing a preview URL with optional dimensions.

```APIDOC
## GuidelinePageBlockAsset

### Description
Represents an asset on a guideline page, providing a preview URL with optional dimensions.

### Type Fields

- **previewUrl**(width: Int, height: Int): Url!
  - BETA Preview `Url` which has optional `width` and `height` arguments.

### Response Example
```json
{
  "data": {
    "guidelinePageBlockAsset": {
      "previewUrl": "https://example.com/preview.jpg"
    }
  }
}
```
```

--------------------------------

### CreateBrand

Source: https://frontify.github.io/graphql-reference/type/CreateBrand

Creates a new brand. This mutation returns the newly created `Brand` object.

```APIDOC
## CreateBrand

### Description
Creates a new brand. This mutation returns the newly created `Brand` object.

### Type
Mutation

### Fields
- **brand** (Brand!) - The newly created `Brand`.

### Last updated
29-06-2026 13:35
```

--------------------------------

### createServiceApp Mutation

Source: https://frontify.github.io/graphql-reference/mutations/createServiceApp

Creates a ServiceApp following the ClientCredentials flow. All mutations have exactly one input field called `input` with a unique input and return type. This is useful to write mutations with variables, so there is always one single variable per mutation. This makes it easier to use and reuse them.

```APIDOC
## createServiceApp Mutation

### Description
Creates a ServiceApp following the ClientCredentials flow.

### Method
MUTATION

### Endpoint
N/A (GraphQL)

### Parameters
#### Input
- **input** (CreateServiceAppInput!) - Required - The input object for the mutation.

##### Fields of CreateServiceAppInput
- **title** (String!) - Required - The title for the ServiceApp.
- **scopes** ([SecurityScope!]!) - Required - The scopes allowed for the ServiceApp.
- **description** (String) - Optional - The description for the ServiceApp.

### Response
#### Success Response
- **createServiceApp** (CreateServiceApp) - The result of the mutation.

##### Fields of CreateServiceApp
- **serviceApp** (ServiceApp!) - The created ServiceApp.
- **secret** (String!) - The secret tied to the ServiceApp.
- **message** (String!) - Disclaimer message.
```

--------------------------------

### GuidelineItems

Source: https://frontify.github.io/graphql-reference/type/GuidelineItems

Represents a paginated list of Guideline objects. It provides metadata about the pagination such as total results, current page, and whether a next page exists.

```APIDOC
## GuidelineItems

### Description
This is a paginated list, containing items of type `Guideline`. It includes fields for total results, current page, results per page, and a flag indicating if a next page is available.

### Type Fields

- **total** (Int!): Total amount of results.
- **page** (Int!): Current page number.
- **limit** (Int!): Number of results per page.
- **hasNextPage** (Boolean!): Indicates if a next page is available or not.
- **items** ([Guideline]): List of `Guideline` type projects.
```

--------------------------------

### PublishMarketplaceAppInput

Source: https://frontify.github.io/graphql-reference/type/PublishMarketplaceAppInput

Defines the structure for publishing a marketplace app, including app ID, release notes, and availability.

```APIDOC
## PublishMarketplaceAppInput

### Description

Input object type for publishing a marketplace app.

### Input Fields

- **appId** (String!) - Required - The marketplace app ID to publish.
- **releaseNotes** (String!) - Required - Release notes for this version.
- **availability** (MarketplaceAppAvailability) - Optional - The marketplace app availability.
```

--------------------------------

### CreateBrandInput

Source: https://frontify.github.io/graphql-reference/type/CreateBrandInput

Represents the input structure for creating a new brand, including its name and color.

```APIDOC
## CreateBrandInput

Input object type for creating a brand.

### Input Fields

- **name** (String!) - Required - `Brand` name.
- **color** (RgbaColorInput) - Optional - `Brand` color. When not provided, a default color will be used.
```

--------------------------------

### UpdateGuidelinePageBlockSettings

Source: https://frontify.github.io/graphql-reference/type/UpdateGuidelinePageBlockSettings

Represents the settings for updating a guideline page block. This object is part of the GraphQL API and is marked as BETA.

```APIDOC
## UpdateGuidelinePageBlockSettings

### Description
No description provided.

### Fields
- **block** (GuidelinePageBlock!) - Required - The `GuidelinePageBlock` which settings were updated.

### Beta
This feature is currently in BETA.
```

--------------------------------

### AddAssetLicenseInput

Source: https://frontify.github.io/graphql-reference/type/AddAssetLicenseInput

Represents the input for adding a license to an asset, requiring both the asset ID and the license ID.

```APIDOC
## AddAssetLicenseInput

### Description
Input object type for adding a license to an asset.

### Input Fields
- **assetId** (ID!) - Required - `Asset` Id.
- **licenseId** (ID!) - Required - `License` Id.
```

--------------------------------

### CreateCopyrightInput

Source: https://frontify.github.io/graphql-reference/type/CreateCopyrightInput

Defines the structure for creating or updating copyright information for an asset. It allows specifying the copyright status and a textual notice.

```APIDOC
## CreateCopyrightInput

### Description

Input object type for creating copyright information.

### Input Fields

- **status** (CopyrightStatus!) - Required - `Asset` copyright status. Defaults to UNKNOWN.
- **notice** (String) - Optional - `Asset` copyright notice. Supports medium text length. Defaults to "".
```

--------------------------------

### GuidelinePageBlockAssetSettingItems

Source: https://frontify.github.io/graphql-reference/type/GuidelinePageBlockAssetSettingItems

Represents a paginated list of GuidelinePageBlockAssetSetting items. This type provides fields to manage and access paginated results.

```APIDOC
## GuidelinePageBlockAssetSettingItems

### Description
This is a paginated list, containing items of type `GuidelinePageBlockAssetSetting`. It provides fields for total results, current page, results per page, and whether a next page is available.

### Type Fields

- **total** (Int!) - Total amount of results.
- **page** (Int!) - Current page number.
- **limit** (Int!) - Number of results per page.
- **hasNextPage** (Boolean!) - Indicates if a next page is available or not.
- **items** ([GuidelinePageBlockAssetSetting!]!) - List of `GuidelinePageBlockAssetSetting` items. (Beta)
```

--------------------------------

### LibraryRootFolder.assets

Source: https://frontify.github.io/graphql-reference/type/LibraryRootFolder

Retrieves the AssetItems list for the Library/Workspace.

```APIDOC
## LibraryRootFolder.assets

### Description
Retrieves the AssetItems list for the Library/Workspace.

### Type
AssetItems!

### Arguments
* **limit** (Int) - Optional - Defaults to 25.
* **page** (Int) - Optional - Defaults to 1.
* **query** (FolderAssetQueryInput) - Optional - Used to filter assets.
```

--------------------------------

### FolderAssetQueryInput

Source: https://frontify.github.io/graphql-reference/type/FolderAssetQueryInput

The FolderAssetQueryInput type allows for specifying sorting preferences when querying assets within a folder. It is currently in Beta.

```APIDOC
## FolderAssetQueryInput

### Description
Input type for querying assets within a folder, with options for sorting.

### Fields
#### sortBy (AssetQueryFilterSortType)
Beta
Sort order of matched results.
```

--------------------------------

### CreateExternalAssetInput

Source: https://frontify.github.io/graphql-reference/type/CreateExternalAssetInput

Defines the structure for inputting data when creating a new external asset. It includes mandatory fields like projectId, url, and title, along with optional fields for description, dimensions, interaction settings, external ID, copyright, directory, expiry date, and author.

```APIDOC
## CreateExternalAssetInput

### Description
Input object type for creating an external asset.

### Input Fields
- **projectId** (ID!) - Required - Destination `Project` Id.
- **url** (Url!) - Required - External `Asset` `Url`.
- **title** (String!) - Required - External `Asset` title or display name.
- **description** (String) - Optional - External `Asset` description. Defaults to "".
- **width** (Int) - Optional - External `Asset` fixed width.
- **height** (Int) - Optional - External `Asset` fixed height.
- **allowInteractions** (Boolean) - Optional - External `Asset` allow interactions. Defaults to `true`.
- **externalId** (ID) - Optional - External `Asset` external Id.
- **copyright** (CreateCopyrightInput) - Optional - External `Asset` copyright details.
- **directory** (["String"]) - Optional - External `Asset` destination folder. Folders will be created if they don't exist. Defaults to `[]`.
- **expiresAt** (DateTime) - Optional - Expiry Date. External `Asset` will expire once the defined date is reached.
- **author** (String) - Optional - Represents the Author of the External `Asset`. Defaults to "".
```

--------------------------------

### createAsset Mutation

Source: https://frontify.github.io/graphql-reference/mutations/createAsset

Creates a new `Asset` with specified details. This mutation requires `basic:write` scope and `EDIT` permission level on the `Project`. It accepts a single input object `CreateAssetInput` and returns a `CreateAsset` object containing the processing job details.

```APIDOC
## createAsset Mutation

### Description
Creates a new `Asset` with specified details. This mutation requires `basic:write` scope and `EDIT` permission level on the `Project`. It accepts a single input object `CreateAssetInput` and returns a `CreateAsset` object containing the processing job details.

### Method
`POST` (Assumed for GraphQL mutations)

### Endpoint
`/graphql` (Assumed endpoint for GraphQL API)

### Parameters
#### Input Object
- **input** (CreateAssetInput!) - Required - The input object for creating an asset.

### Input Fields of CreateAssetInput
- **fileId** (ID!) - Required - File Id. Signed Id returned in `uploadFile`.
- **title** (String!) - Required - `Asset` title or display name.
- **alternativeText** (String) - Optional - Alternative text for the `Asset`. Used by screen readers when the asset is not decorative.
- **isDecorative** (Boolean) - Optional - BETA: Indicates whether the `Asset` is decorative and not meant to be read by screen readers. If true, alternative text is ignored.
- **description** (String) - Optional - `Asset` description. Defaults to "".
- **externalId** (ID) - Optional - `Asset` external Id.
- **copyright** (CreateCopyrightInput) - Optional - Add `Asset` copyright details.
- **tags** ( [TagInput] ) - Optional - List of tags to create with `Asset`.
- **skipFileMetadata** (Boolean) - Optional - Skip file's EXIF metadata. When true, it will ignore all file metadata contents. Defaults to `false`.
- **directory** ( [String] ) - Optional - An array of strings representing the directory, if a folder does not exist, it is created. Example: ["My Folder", "Sub-Folder"] will create the necessary folders if they do not yet exist and place the `Asset` in it. Important: Cannot be used in conjunction with `parentId` that is from a `Folder`.
- **parentId** (ID) - Optional - The parent Id, where the `Asset` should be located in. Should either be a `Library`, `WorkspaceProject` or `Folder` Id. Important: Cannot be used in conjunction with `directory` if the Id is from a `Folder`.
- **availability** (DateTimeRangeInput) - Optional - `Asset` will become available only during the interval. When undefined or `null` the `Asset` will be immediately and indefinitely available.
- **expiresAt** (DateTime) - Optional - `Asset` will expire once the defined date is reached.
- **author** (String) - Optional - Represents the Author of the `Asset`. Example: Photographer Name. Defaults to "".
- **previewBackgroundColor** (RgbaColorInput) - Optional - BETA: Background color of the `Asset` preview.

### Response
#### Success Response
- **job** (AssetProcessingJob!) - The newly created `Asset` processing job response.

### Request Example
```json
{
  "query": "mutation CreateNewAsset($input: CreateAssetInput!) { createAsset(input: $input) { job { id status } } }",
  "variables": {
    "input": {
      "fileId": "some-file-id",
      "title": "My New Asset",
      "description": "This is a sample asset.",
      "directory": ["My Folder", "Images"]
    }
  }
}
```

### Response Example
```json
{
  "data": {
    "createAsset": {
      "job": {
        "id": "asset-processing-job-id",
        "status": "PENDING"
      }
    }
  }
}
```
```

--------------------------------

### publishMarketplaceApp

Source: https://frontify.github.io/graphql-reference/mutations/publishMarketplaceApp

Publishes a marketplace app with the specified release notes and availability.

```APIDOC
## publishMarketplaceApp

### Description
Publish a marketplace app with the specified release notes and availability.

### Method

Mutation

### Input
#### PublishMarketplaceAppInput
- **appId** (String!) - The marketplace app ID to publish.
- **releaseNotes** (String!) - Release notes for this version.
- **availability** (MarketplaceAppAvailability) - The marketplace app availability. Defaults to null.

### Return Type
#### PublishMarketplaceApp
- **id** (String!) - The ID of the published marketplace app.
```

--------------------------------

### serviceApps

Source: https://frontify.github.io/graphql-reference/queries/serviceApps

Retrieves a list of account-bound ServiceApps. Supports pagination with limit and page arguments.

```APIDOC
## serviceApps

### Description
Retrieve the account-bound ServiceApps.

### Method
Query

### Endpoint
N/A (GraphQL)

### Arguments
#### Query Arguments
- **limit** (Int) - Optional - The maximum number of results to return per page. Defaults to 25.
- **page** (Int) - Optional - The page number to retrieve. Defaults to 1.

### Fields of ServiceAppItems
- **items** ([ServiceApp]!) - A list of ServiceApp objects.
- **total** (Int!) - The total number of results available.
- **page** (Int!) - The current page number.
- **limit** (Int!) - The number of results per page.
- **hasNextPage** (Boolean!) - Indicates if there is a next page of results.
```

--------------------------------

### createBrand Mutation

Source: https://frontify.github.io/graphql-reference/mutations/createBrand

Creates a new brand with the specified name and color. This mutation requires the `basic:write` scope and `EDIT` Account permission level. It accepts a single input object `CreateBrandInput` and returns the newly created `Brand` object.

```APIDOC
## createBrand Mutation

### Description
Creates a new brand with the specified name and color. This mutation requires the `basic:write` scope and `EDIT` Account permission level. It accepts a single input object `CreateBrandInput` and returns the newly created `Brand` object.

### Method
`mutation`

### Input
#### `input`: CreateBrandInput!
- **name** (`String!`) - Required - `Brand` name.
- **color** (`RgbaColorInput`) - Optional - `Brand` color. When not provided, a default color will be used.

### Output
#### `createBrand`
- **brand**: `Brand!` - The newly created `Brand`.

### Example
```graphql
mutation CreateNewBrand($input: CreateBrandInput!) {
  createBrand(input: $input) {
    brand {
      id
      name
      color
    }
  }
}

# Variables:
# {
#   "input": {
#     "name": "New Brand Name",
#     "color": {
#       "r": 255,
#       "g": 0,
#       "b": 0,
#       "a": 1
#     }
#   }
# }
```
```

--------------------------------

### updateGuidelinePageBlockSettings

Source: https://frontify.github.io/graphql-reference/mutations/updateGuidelinePageBlockSettings

Updates the settings of a `GuidelinePageBlock` in the specified language. Only fields provided in the input are modified.

```APIDOC
## updateGuidelinePageBlockSettings

### Description
Updates the settings of a `GuidelinePageBlock` in the specified language. Only fields provided in the input are modified.

### Method
MUTATION

### Endpoint
N/A (GraphQL Mutation)

### Parameters
#### Input
- **input** (UpdateGuidelinePageBlockSettingsInput!) - Required - The input object for the mutation.

### Input Fields of UpdateGuidelinePageBlockSettingsInput
- **id** (ID!) - Required - The `id` of the `GuidelinePageBlock` which should be modified.
- **language** (LanguageCode) - Optional - The `language` in which the settings of the `GuidelinePageBlock` should be updated. It is optional and when not provided, the settings will be updated in the main language.
- **settings** (JsonObject!) - Required - The `settings` of the `GuidelinePageBlock` which should be updated. The settings must be provided as a JSON string.

### Request Example
```json
{
  "mutation": "mutation UpdateBlockSettings($id: ID!, $settings: JsonObject!) { updateGuidelinePageBlockSettings(input: { id: $id, settings: $settings }) { block { id } } }",
  "variables": {
    "id": "some-guideline-block-id",
    "settings": "{\"someSetting\": \"newValue\"}"
  }
}
```

### Response
#### Success Response
- **block** (GuidelinePageBlock!) - The `GuidelinePageBlock` which settings were updated.

#### Response Example
```json
{
  "data": {
    "updateGuidelinePageBlockSettings": {
      "block": {
        "id": "some-guideline-block-id"
      }
    }
  }
}
```
```

--------------------------------

### createCollection Mutation

Source: https://frontify.github.io/graphql-reference/mutations/createCollection

Creates a new Collection for a specified parent entity (e.g., Library). Requires `basic:write` scope and `EDIT` permission for Collections.

```APIDOC
## createCollection Mutation

### Description
Creates a new `Collection` for a specified parent entity. This mutation is currently only supported for `Library` type parent entities.

### Method
`mutation`

### Endpoint
`/graphql`

### Parameters
#### Input
- **input** (CreateCollectionInput!) - Required - Input object for creating a collection.
  - **parentId** (ID!) - Required - The ID of the parent entity (e.g., Library) where the new Collection will be created.
  - **name** (String!) - Required - The name for the new Collection.

### Request Example
```json
{
  "query": "mutation ($input: CreateCollectionInput!) { createCollection(input: $input) { collection { id name } } }",
  "variables": {
    "input": {
      "parentId": "your_parent_id",
      "name": "New Collection Name"
    }
  }
}
```

### Response
#### Success Response (200 OK)
- **collection** (Collection!) - The details of the newly created Collection.
  - **id** (ID!) - The unique identifier of the created Collection.
  - **name** (String!) - The name of the created Collection.

#### Response Example
```json
{
  "data": {
    "createCollection": {
      "collection": {
        "id": "new_collection_id",
        "name": "New Collection Name"
      }
    }
  }
}
```
```

--------------------------------

### workspaceProject

Source: https://frontify.github.io/graphql-reference/queries/workspaceProject

Retrieve `WorkspaceProject` details by Id. This query allows fetching comprehensive information about a specific workspace project.

```APIDOC
## workspaceProject(id: ID!): Workspace

### Description
Retrieve `WorkspaceProject` details by Id.

### Method
Query

### Endpoint
`/graphql`

### Parameters
#### Query Parameters
- **id** (ID!) - Required - `Workspace` Id.

### Response
#### Success Response (200)
- **id** (ID!) - `Library`/`Workspace` Id.
- **name** (String!) - `Library`/`Workspace` name.
- **color** (RgbaColor) - `Library`/`Workspace` color.
- **assetCount** (Int) - Deprecated. Amount of `Assets` contained in the `Library`/`Workspace`. Use `assets.total` instead.
- **assets** (AssetItems!) - Search or list `Assets` in the `Library`/`Workspace`.
  - **limit** (Int) - Optional - Defaults to 25.
  - **page** (Int) - Optional - Defaults to 1.
  - **query** (AssetQueryInput) - Optional.
- **licenses** ([License]) - `Library`/`Workspace` `License` items list.
- **metadataFields** ([MetadataField]) - Deprecated. `Library`/`Workspace` `MetadataField` items list. Use `customMetadataProperties` instead.
- **workflow** (Workflow!) - Beta. The `Workflow` belonging to the given `Library`/`Workspace`.
- **browse** (WorkspaceRootFolder!) - Browse the `Workspace`'s `SubFolderItems` and `AssetItems`.
- **collaborators** (WorkspaceCollaborators) - `Workspace` collaborators.
- **currentUserPermissions** (WorkspaceUserPermissions!) - `Workspace` permissions of the current `User`.
- **isArchived** (Boolean!) - Beta. `Workspace` state.
- **customMetadata** (CustomMetadata!) - List of `CustomMetadataProperty` items and values associated to `Workspace`.
```

--------------------------------

### CreateCollectionInput

Source: https://frontify.github.io/graphql-reference/type/CreateCollectionInput

Defines the input structure for creating a new collection. It requires the parent ID and the desired name for the collection.

```APIDOC
## CreateCollectionInput

### Description
Input object type for creating a new collection.

### Input Fields
- **parentId** (ID!) - Required - Id of the parent where you wish to create a new `Collection`. Currently supported for `Library` type parent entities only.
- **name** (String!) - Required - Name of the `Collection`.
```

--------------------------------

### syncAssetTags

Source: https://frontify.github.io/graphql-reference/mutations/syncAssetTags

Synchronizes tags for a given asset. This mutation requires the `basic:write` scope and `EDIT` permission level for the asset.

```APIDOC
## syncAssetTags

### Description
Synchronizes tags for a given asset. Requires `basic:write` scope and `Asset` permission level `EDIT`.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Input
- **input** (SyncAssetTagsInput!) - Required - Input object for the mutation.

### Input Fields of SyncAssetTagsInput
- **id** (ID!) - Required - The ID of the Asset.
- **tags** (TagInput) - Optional - The tags to synchronize for the Asset.

### Response
#### Success Response
- **asset** (Asset) - Details of the updated Asset.

### Response Example
```json
{
  "data": {
    "syncAssetTags": {
      "asset": {
        "id": "some-asset-id",
        "tags": [
          {
            "name": "tag1",
            "id": "tag-id-1"
          }
        ]
      }
    }
  }
}
```
```