Frontify Component

Frontify is a comprehensive brand management platform that enables organizations to create, manage, and distribute brand assets, guidelines, and digital content across teams and channels, streamlining brand consistency and collaboration.

Component key: frontify

Description

Frontify is a comprehensive brand management platform that enables organizations to create, manage, and distribute brand assets, guidelines, and digital content across teams and channels, streamlining brand consistency and collaboration.

Use the Frontify Component to create, manage, and distribute brand assets, guidelines, and digital content across teams and channels, streamlining brand consistency and collaboration.

API Documentation:

This component was built using the Frontify GraphQL API Reference.

Connections

OAuth 2.0

Documentation

Go to Frontify and open the applications setting.
Add a new application with the following configuration options:
Redirect URIs: Enter https://oauth2.prismatic.io/callback for US based integrations.
1. For integrations outside the US refer to this guide to find your region’s Callback URL

Input	Notes	Example
Authorize URL string / Required authorizeUrl	The Authorization URL for Frontify.	https://my-example-domain.frontify.com/api/oauth/authorize
Base URL string / Required baseUrl	The base URL of the Frontify API. This URL should be provided by the service provider.	https://my-example-domain.frontify.com
Client ID password / Required clientId
Client Secret password / Required clientSecret
Scopes string / Required scopes	A list of scopes, combined by a space. At least `basic:read` must be specified within scopes. A full list of scopes can be found here: https://developer.frontify.com/d/XFPCrGNrXQQM/graphql-api#/access-control/scopes-p11876
State string state	The state is a parameter controlled by you and used to preserves some state objects set by the client in the Authorization request and makes it available to the client in the response.	testStateA@s432!
Token URL string / Required tokenUrl	The Token URL for Frontify.	https://my-example-domain.frontify.com/api/oauth/accesstoken

Personal Developer Token

Documentation

To generate a Personal Developer token, navigate to https://company-domain/api/developer/token in your browser.
1. Replace 'company-domain' in URL with the domain name of your company's site.
Once generated, a developer can use the token until it is manually revoked.
When creating a new token, give it a meaningful name. This is helpful if you later need to revoke a token and for you to keep track of where a given token is used.

Input	Notes	Example
Base URL string / Required baseUrl	The base URL of the Frontify API. This URL should be provided by the service provider.	https://my-example-domain.frontify.com
Token password / Required personalDeveloperToken	The personal developer token is used to authenticate with the Frontify API. This token should be provided by the service provider.

Data Sources

Select Brand

Select a Brand belonging to the current Account. | key: brandDataSource | type: picklist

Input	Notes
Frontify Connection connection / Required connection

Select Library

Select a Library belonging to a certain Brand. | key: libraryDataSource | type: picklist

Input	Notes	Example
Brand ID string / Required brandId	ID of the Brand entity.	eyJpZG...
Frontify Connection connection / Required connection

Select Library Asset

Select an Asset that belongs to a given Library. | key: libraryAssetDataSource | type: picklist

Input	Notes	Example
Frontify Connection connection / Required connection
Library ID string / Required libraryId	ID of the Library entity.	eyJpZG...

Select Workspace Project

Select a Workspace Project belonging to a certain Brand. | key: workspaceProjectDatasource | type: picklist

Input	Notes	Example
Brand ID string / Required brandId	ID of the Brand entity.	eyJpZG...
Frontify Connection connection / Required connection

Select Workspace Project Asset

Select an Asset that belongs to a given Workspace Project. | key: workspaceProjectAssetDataSource | type: picklist

Input	Notes	Example
Frontify Connection connection / Required connection
Workspace Project ID string / Required projectId	ID of the Workspace Project entity.	eyJpZG...

Actions

Create Asset

Create an Asset. | key: createAsset

Input	Default	Notes	Example
Author string author		Represents the Author of the Asset.	Photographer Name
Frontify Connection connection / Required connection
Copyright Notice text copyrightNotice		Asset copyright notice. Supports medium text length.	© 2021 My Company
Copyright Status string copyrightStatus		Asset copyright status.	UNKNOWN
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Asset description.	Some description
Directory string Value List directory		An array of strings representing the directory, if a folder does not exist, it is created. Important: Cannot be used in conjunction with parentId that is from a Folder.	My Folder
Expires At string expiresAt		Asset will expire once the defined date is reached.	2001-12-31T22:10:30.000+00:00
External ID string externalId		Asset external ID.	12345
File ID string / Required fileId		A file's Signed ID, returned by the Upload File action. For more information, see: https://developer.frontify.com/document/1367#/deep-dive/upload-file-create-asset	eyJpZG...
Parent ID string / Required parentId		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.	eyJpZG...
Skip File Metadata boolean skipFileMetadata	false	Skip file's EXIF metadata. When true, it will ignore all file metadata contents.
Tags string Value List tags		List of tags to create with the Asset.	tag1
Title string / Required title		Asset title or display name.	My Asset

Example Payload for Create Asset

{
  "data": {
    "createAsset": {
      "job": {
        "assetId": "eyJpZGVudGl..."
      }
    }
  }
}

Create Attachment

Create a new Attachment. | key: createAttachment

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
External ID string externalId		Attachment external ID.	12345
File ID string / Required fileId		The signed ID returned by the Upload File action.	eyJpZG...
Name string / Required name		Attachment name or display name.	My Attachment
Parent ID string / Required parentId		The parent ID of the attachment. For parents of Asset type only.	eyJpZG...

Example Payload for Create Attachment

{
  "data": {
    "createAttachment": {
      "job": {
        "attachmentId": "eyJpZGVudGl..."
      }
    }
  }
}

Create Collection

Create a new Collection. Currently supported for Library type parent entities only. | key: createCollection

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Name string / Required name		Collection name.	My Collection
Parent ID string / Required parentId		ID of the parent Library entity.	eyJpZG...

Example Payload for Create Collection

{
  "data": {
    "createCollection": {
      "collection": {
        "id": "eyJpZGV..."
      }
    }
  }
}

Create Folder

Create a new Folder. | key: createFolder

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Folder description.	This is my folder.
Name string / Required name		Folder name.	My Folder
Parent ID string / Required parentId		ID of the parent.	eyJpZGVud...

Example Payload for Create Folder

{
  "data": {
    "createFolder": {
      "folder": {
        "id": "eyJpZGV..."
      }
    }
  }
}

Delete Asset

Delete an Asset. | key: deleteAsset

Input	Default	Notes	Example
Asset ID string / Required assetId		ID of the Asset to delete.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Delete Asset

{
  "data": {
    "deleteAsset": {
      "id": "eyJpZGVud..."
    }
  }
}

Delete Attachment

Delete an existing Attachment. | key: deleteAttachment

Input	Default	Notes	Example
Attachment ID string / Required attachmentId		ID of the Attachment to delete.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Delete Attachment

{
  "data": {
    "deleteAttachment": {
      "id": "eyJpZGVudGlmaWVyIjo5NDA3ODksInR5cGUiOiJhdHRhY2htZW50In0="
    }
  }
}

Delete Collection

Delete an existing Collection. | key: deleteCollection

Input	Default	Notes	Example
Collection ID string / Required collectionId		ID of the Collection to delete.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Delete Collection

{
  "data": {
    "deleteCollection": {
      "id": "eyJpZGV..."
    }
  }
}

Delete Folders

Delete existing Folders. | key: deleteFolders

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Folder IDs string / Required Value List folderIds		ID of the Folder to delete.	eyJpZGVud...

Example Payload for Delete Folders

{
  "data": {
    "deleteFolders": {
      "ids": [
        "eyJpZGV..."
      ]
    }
  }
}

Get Account ID

Retrieve current Account ID. | key: getAccountId

Input	Default	Notes
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Account ID

{
  "data": {
    "account": {
      "id": "eyJpZGVudGl..."
    }
  }
}

Get Asset

Retrieve an Asset by ID. | key: getAsset

Input	Default	Notes	Example
Asset ID string / Required assetId		ID of the Asset to retrieve.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Asset

{
  "data": {
    "asset": {
      "id": "eyJpZGVudGlma...",
      "creator": {
        "id": "eyJpZGVudGlma...",
        "name": "John Doe",
        "email": "example@example.com"
      },
      "createdAt": "2024-09-17T23:54:57.000+00:00",
      "modifier": {
        "id": "eyJpZGVudGlma...",
        "name": "John Doe",
        "email": "example@example.com"
      },
      "modifiedAt": "2024-09-17T23:54:57.000+00:00",
      "title": "Example Asset",
      "description": "This is a sample description",
      "attachments": [],
      "externalId": null,
      "tags": [],
      "copyright": {
        "status": "UNKNOWN",
        "notice": ""
      },
      "expiresAt": null,
      "licenses": [],
      "status": "PROCESSING",
      "relatedAssets": {
        "total": 0
      },
      "comments": {
        "total": 0
      },
      "customMetadata": [],
      "location": {
        "brand": {
          "id": "eyJpZGVudGlma...",
          "name": "Example Brand"
        },
        "library": null,
        "workspaceProject": {
          "id": "eyJpZGVudGlma...",
          "name": "Sample Project: Example Cats"
        },
        "folder": null
      }
    }
  }
}

Get Assets by IDs

Retrieve a list of Assets by IDs. | key: getAssetsByIds

Input	Default	Notes	Example
Asset IDs string / Required Value List assetIds		List of Asset IDs to retrieve.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Assets by IDs

{
  "data": {
    "assets": [
      {
        "id": "eyJpZGVudGlma...",
        "creator": {
          "id": "eyJpZGVudGlma...",
          "name": "John Doe",
          "email": "example@example.com"
        },
        "createdAt": "2024-09-05T19:49:25.000+00:00",
        "modifier": {
          "id": "eyJpZGVudGlma...",
          "name": "John Doe",
          "email": "example@example.com"
        },
        "modifiedAt": "2024-09-05T19:49:27.000+00:00",
        "title": "Example Title 2",
        "description": null,
        "attachments": [
          {
            "id": "eyJpZGVudGlma...",
            "creator": {
              "id": "eyJpZGVudGlma...",
              "name": "John Doe",
              "email": "example@example.com"
            },
            "createdAt": "2024-09-17T23:42:43.000+00:00",
            "modifier": null,
            "modifiedAt": null,
            "name": "Sample Attachment 1",
            "filename": "example.png",
            "type": "",
            "externalId": null,
            "extension": "png",
            "size": 585728,
            "downloadUrl": "https://example.com/example.png"
          },
          {
            "id": "eyJpZGVudGlma...",
            "creator": {
              "id": "eyJpZGVudGlma...",
              "name": "John Doe",
              "email": "example@example.com"
            },
            "createdAt": "2024-09-18T17:20:22.000+00:00",
            "modifier": null,
            "modifiedAt": null,
            "name": "Sample Attachment 2",
            "filename": "example.png",
            "type": "",
            "externalId": "512",
            "extension": "png",
            "size": 585728,
            "downloadUrl": "https://example.com/example.png"
          }
        ],
        "externalId": null,
        "tags": [],
        "copyright": {
          "status": "UNKNOWN",
          "notice": ""
        },
        "expiresAt": null,
        "licenses": [],
        "status": "FINISHED",
        "relatedAssets": {
          "total": 0
        },
        "comments": {
          "total": 0
        },
        "customMetadata": [],
        "location": {
          "brand": {
            "id": "eyJpZGVudGlma...",
            "name": "Example Brand"
          },
          "library": {
            "id": "eyJpZGVudGlma...",
            "name": "Logos"
          },
          "workspaceProject": null,
          "folder": null
        }
      }
    ]
  }
}

Get Brand

Retrieve a Brand by its ID. | key: getBrand

Input	Default	Notes	Example
Brand ID string / Required brandId		ID of the Brand to retrieve.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Brand

{
  "data": {
    "brand": {
      "id": "eyJpZGVudGlmaWVyIjoyNjE1MDUsInR5cGUiOiJicmFuZCJ9",
      "name": "Monobrand",
      "rgbaColor": {
        "red": 130,
        "green": 95,
        "blue": 255,
        "alpha": 1
      },
      "avatar": null,
      "slug": "monobrand",
      "customMetadataProperties": []
    }
  }
}

Get Current User

Get the current User. | key: getCurrentUser

Input	Default	Notes
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Current User

{
  "data": {
    "currentUser": {
      "id": "eyJpZGV...",
      "email": "example@email.com",
      "name": "John Doe",
      "avatar": null
    }
  }
}

Get Library

Retrieve a Library by its ID. | key: getLibrary

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Library ID string / Required libraryId		ID of the Library entity.	eyJpZG...

Example Payload for Get Library

{
  "data": {
    "library": {
      "__typename": "LogoLibrary",
      "id": "eyJpZGV...",
      "name": "Logos",
      "color": null,
      "licenses": [],
      "customMetadataProperties": []
    }
  }
}

Get Workspace Project

Retrieve a Workspace Project by its ID. | key: getWorkspaceProject

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Workspace Project ID string / Required projectId		ID of the Workspace Project entity.	eyJpZG...

Example Payload for Get Workspace Project

{
  "data": {
    "workspaceProject": {
      "id": "eyJpZGVudGlmaWVyIjo0Mzk2MDUsInR5cGUiOiJwcm9qZWN0In0=",
      "name": "Test Project: Siamese Cats",
      "color": {
        "red": 225,
        "green": 255,
        "blue": 191,
        "alpha": 1
      },
      "licenses": [],
      "collaborators": {
        "users": {
          "total": 1,
          "hasNextPage": false,
          "page": 1,
          "limit": 25,
          "items": [
            {
              "id": "eyJpZGVudGlmaWVyIjo2NjIyODcsInR5cGUiOiJ1c2VyIn0=",
              "name": "TJ Tedrow",
              "email": "components@prismatic.io"
            }
          ]
        }
      },
      "customMetadata": []
    }
  }
}

Install Webhook

Install a Webhook onto a Workspace Project or Library. | key: installWebhook

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Webhook Name string / Required name		The name of the Webhook.	My Webhook
Notification URL string / Required notificationUrl		The URL that the Webhook will send notifications to when triggered.	https://example.com/webhook
Workspace Project ID or Library ID string / Required projectId		The ID of the Workspace Project or Library to attach the Webhook to.	eyJpZGV...

Example Payload for Install Webhook

{
  "data": {
    "installProjectWebhook": {
      "webhook": {
        "id": "eyJpZGVudGlmaWVyIjo4OSwidHlwZSI6IndlYmhvb2sifQ==",
        "creator": {
          "id": "eyJpZGVudGlmaWVyIjoxMjMsInR5cGUiOiJ1c2VyIn0=",
          "email": "example@example.com",
          "name": "John Doe"
        },
        "createdAt": "2024-09-19T13:18:52.000+00:00",
        "name": "Example Webhook",
        "notificationUrl": "https://hooks.example.io/trigger/SW5zdGFuY2VGbG93Q29uZmlnOjEyMzQ1NmUyLWM1M2QtNGUzOC04ZGY3LTE2ODRjYTJmZmVkZA==",
        "secret": "AbcD123SecretKeyExample"
      }
    }
  }
}

List Asset Comments

Retrieve a list of Comments relating to a given Asset. | key: listAssetComments

Input	Default	Notes	Example
Asset ID string / Required assetId		ID of the Asset to retrieve comments for.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1
Reply Limit string replyLimit	50	The limit of how may replies to show per comment.	50

Example Payload for List Asset Comments

{
  "data": {
    "asset": {
      "id": "eyJpZGV...",
      "externalId": null,
      "comments": {
        "total": 1,
        "page": 1,
        "limit": 25,
        "hasNextPage": false,
        "items": [
          {
            "id": "eyJpZGV...",
            "creator": {
              "id": "eyJpZGV...",
              "email": "example@email.com",
              "name": "John Doe"
            },
            "createdAt": "2024-09-06T15:49:47.000+00:00",
            "modifier": null,
            "modifiedAt": null,
            "content": "Test comment \n\n",
            "mentionedUsers": [],
            "isResolved": false,
            "replies": {
              "total": 0,
              "hasNextPage": false,
              "page": 1,
              "limit": 50,
              "items": []
            },
            "marking": null
          }
        ]
      }
    }
  }
}

List Brand Libraries

Retrieve list of Libraries belonging to a Brand. For full Library details, please use the 'Get Library' action. | key: listBrandLibraries

Input	Default	Notes	Example
Brand ID string / Required brandId		ID of the Brand to retrieve Libraries for.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Brand Libraries

{
  "data": {
    "brand": {
      "id": "eyJpZGV...",
      "name": "Monobrand",
      "libraries": {
        "total": 4,
        "hasNextPage": false,
        "page": 1,
        "limit": 25,
        "items": [
          {
            "id": "eyJpZGV...",
            "name": "Logos"
          }
        ]
      }
    }
  }
}

List Brand Workspace Projects

Retrieve list of Workspace Projects belonging to a Brand. For full details, please use the 'Get Workspace Project' action. | key: listBrandWorkspaceProjects

Input	Default	Notes	Example
Brand ID string / Required brandId		ID of the Brand to retrieve Workspace Projects for.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Brand Workspace Projects

{
  "data": {
    "brand": {
      "id": "eyJpZGV...",
      "name": "Monobrand",
      "workspaceProjects": {
        "total": 2,
        "limit": 25,
        "page": 1,
        "hasNextPage": false,
        "items": [
          {
            "id": "eyJpZGV...",
            "name": "Test Project: Siamese Cats"
          }
        ]
      }
    }
  }
}

List Brands

Retrieve Brand list for current Account. | key: listBrands

Input	Default	Notes
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for List Brands

{
  "data": {
    "brands": [
      {
        "id": "eyJpZGVudGlmaWVyIjoyNjE1MDUsInR5cGUiOiJicmFuZCJ9",
        "name": "Monobrand",
        "rgbaColor": {
          "red": 130,
          "green": 95,
          "blue": 255,
          "alpha": 1
        },
        "avatar": null,
        "slug": "monobrand",
        "customMetadataProperties": []
      }
    ]
  }
}

List Library Assets

Retrieve a list of Assets belonging to a Library. | key: listLibraryAssets

Input	Default	Notes	Example
External ID string assetExternalId		Limit the result set by the external ID of an Asset.	123456
Search Query string assetSearch		Limit the result set by the search term.	some search term
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Library ID string / Required libraryId		ID of the Library entity.	eyJpZG...
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Library Assets

{
  "data": {
    "library": {
      "id": "eyJpZGV...",
      "name": "Example Library",
      "assets": {
        "limit": 25,
        "page": 1,
        "total": 1,
        "hasNextPage": false,
        "items": [
          {
            "id": "eyJpZGV...",
            "creator": {
              "id": "eyJpZGV...",
              "name": "John Doe",
              "email": "john@example.com"
            },
            "createdAt": "2024-09-05T19:49:25.000+00:00",
            "modifier": {
              "id": "eyJpZGV...",
              "name": "John Doe",
              "email": "john@example.com"
            },
            "modifiedAt": "2024-09-05T19:49:27.000+00:00",
            "title": "example_title_1",
            "description": null,
            "attachments": [
              {
                "id": "eyJpZGV...",
                "creator": {
                  "id": "eyJpZGV...",
                  "name": "John Doe",
                  "email": "john@example.com"
                },
                "createdAt": "2024-09-17T23:42:43.000+00:00",
                "modifier": null,
                "modifiedAt": null,
                "name": "Example attachment",
                "filename": "example.png",
                "type": "",
                "externalId": null,
                "extension": "png",
                "size": 585728,
                "downloadUrl": "https://example.com/file1.png"
              }
            ],
            "externalId": null,
            "tags": [],
            "copyright": {
              "status": "UNKNOWN",
              "notice": ""
            },
            "expiresAt": null,
            "licenses": [],
            "status": "FINISHED",
            "relatedAssets": {
              "total": 0
            },
            "comments": {
              "total": 0
            },
            "customMetadata": [],
            "location": {
              "brand": {
                "id": "eyJpZGV...",
                "name": "ExampleBrand"
              },
              "library": {
                "id": "eyJpZGV...",
                "name": "Example Library"
              },
              "workspaceProject": null,
              "folder": null
            }
          }
        ]
      }
    }
  }
}

List Library Collaborators

Retrieve a list of Collaborators belonging to a Library. | key: listLibraryCollaborators

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Library ID string / Required libraryId		ID of the Library entity.	eyJpZG...
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Library Collaborators

{
  "data": {
    "library": {
      "id": "eyJpZGV...",
      "name": "Example Library",
      "collaborators": {
        "users": {
          "total": 1,
          "page": 1,
          "limit": 25,
          "hasNextPage": false,
          "items": [
            {
              "id": "eyJpZGV...",
              "email": "john@example.com",
              "name": "John Doe"
            }
          ]
        }
      }
    }
  }
}

List Library Collections

Retrieve a list of Collections belonging to a Library. | key: listLibraryCollections

Input	Default	Notes	Example
Page Size (Assets) string assetLimit	50	Assets are paginated within collections. Use this to control the nested Asset pagination.	50
Page (Assets) string assetPage	1	Assets are paginated within collections. Use this to control the nested Asset pagination.	1
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all top-level Collections records and ignore parameters like page and page size. This toggle will not affect the Asset pagination within each Collection.
Library ID string / Required libraryId		ID of the Library entity.	eyJpZG...
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Library Collections

{
  "data": {
    "library": {
      "id": "eyJpZGV...",
      "name": "Logos",
      "collections": {
        "total": 1,
        "page": 1,
        "limit": 25,
        "hasNextPage": false,
        "items": [
          {
            "id": "eyJpZGV...",
            "name": "Main Logos",
            "assets": {
              "total": 4,
              "page": 1,
              "limit": 25,
              "hasNextPage": false,
              "items": [
                {
                  "id": "eyJpZGV..."
                }
              ]
            }
          }
        ]
      }
    }
  }
}

List Library Folders

Retrieve a list of the top-level folders in a Library. To browse further, use the Raw Request action. | key: listLibraryFolders

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Library ID string / Required libraryId		ID of the Library entity.	eyJpZG...
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Library Folders

{
  "data": {
    "library": {
      "id": "eyJpZGV...",
      "name": "Logos",
      "browse": {
        "folders": {
          "limit": 25,
          "page": 1,
          "hasNextPage": false,
          "total": 0,
          "items": []
        }
      }
    }
  }
}

Retrieve a list of assets that relate to a specific Asset. | key: listRelatedAssets

Input	Default	Notes	Example
Asset ID string / Required assetId		ID of the Asset to retrieve related assets for.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Related Assets

{
  "data": {
    "asset": {
      "id": "eyJpZGV...",
      "externalId": null,
      "relatedAssets": {
        "total": 0,
        "hasNextPage": false,
        "page": 1,
        "limit": 25,
        "items": []
      }
    }
  }
}

List User Groups

Retrieve UserGroups list for the current Account. | key: listUserGroups

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all UserGroups and ignore parameters like page and page size. This toggle will not affect the User pagination within each UserGroup.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1
Page (users) string userPage	1	For paging through users belonging to a userGroup.	1
Limit (user pages) string userPageLimit	25	How many records to show per page of users.	25

Example Payload for List User Groups

{
  "data": {
    "account": {
      "id": "eyJpZGVudGlmaWVyIjoyNjczMDcsInR5cGUiOiJhY2NvdW50In0=",
      "userGroups": {
        "total": 0,
        "page": 1,
        "limit": 25,
        "hasNextPage": false,
        "items": []
      }
    }
  }
}

List Users

Retrieve Users list for the current Account. | key: listUsers

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Users

{
  "data": {
    "account": {
      "users": {
        "total": 1,
        "page": 1,
        "limit": 25,
        "hasNextPage": false,
        "items": [
          {
            "id": "eyJpZGVudGlmaWVyIjo2NjIyODcsInR5cGUiOiJ1c2VyIn0=",
            "email": "components@prismatic.io",
            "name": "TJ Tedrow",
            "avatar": null
          }
        ]
      }
    }
  }
}

List Webhooks

Retrieve WebhookItems related to current Account. | key: listWebhooks

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1

Example Payload for List Webhooks

{
  "data": {
    "webhooks": {
      "total": 1,
      "page": 1,
      "limit": 25,
      "hasNextPage": false,
      "items": [
        {
          "id": "abc123...",
          "creator": {
            "id": "user456...",
            "name": "John Doe",
            "email": "john.doe@example.com"
          },
          "createdAt": "2024-09-19T13:18:52.000+00:00",
          "name": "Sample Webhook",
          "notificationUrl": "https://example.com/trigger/webhook...",
          "secret": "sampleSecretKey...",
          "__typename": "ProjectWebhook",
          "project": {
            "id": "proj789..."
          }
        }
      ]
    }
  }
}

List Workspace Project Assets

Retrieve a list of Assets belonging to a Workspace Project. | key: listWorkspaceProjectAssets

Input	Default	Notes	Example
External ID string assetExternalId		Limit the result set by the external ID of an Asset.	123456
Search Query string assetSearch		Limit the result set by the search term.	some search term
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1
Workspace Project ID string / Required projectId		ID of the Workspace Project entity.	eyJpZG...

Example Payload for List Workspace Project Assets

{
  "data": {
    "workspaceProject": {
      "id": "eyJpZG...==",
      "name": "Example Project: Dogs",
      "assets": {
        "limit": 25,
        "page": 1,
        "total": 1,
        "hasNextPage": false,
        "items": [
          {
            "id": "eyJpZG...==",
            "creator": {
              "id": "eyJpZG...==",
              "name": "John Doe",
              "email": "john.doe@example.com"
            },
            "createdAt": "2024-09-17T23:36:00.000+00:00",
            "modifier": {
              "id": "eyJpZG...==",
              "name": "John Doe",
              "email": "john.doe@example.com"
            },
            "modifiedAt": "2024-09-19T10:49:21.000+00:00",
            "title": "Sample Asset",
            "description": "Sample description",
            "attachments": [],
            "externalId": null,
            "tags": [],
            "copyright": {
              "status": "UNKNOWN",
              "notice": ""
            },
            "expiresAt": null,
            "licenses": [],
            "status": "FINISHED",
            "relatedAssets": {
              "total": 0
            },
            "comments": {
              "total": 0
            },
            "customMetadata": [],
            "location": {
              "brand": {
                "id": "eyJpZG...==",
                "name": "ExampleBrand"
              },
              "library": null,
              "workspaceProject": {
                "id": "eyJpZG...==",
                "name": "Example Project: Dogs"
              },
              "folder": {
                "id": "eyJpZG...==",
                "name": "Sample Folder"
              }
            }
          }
        ]
      }
    }
  }
}

List Workspace Project Folders

Retrieve a list of the top-level folders in a Workspace Project. To browse further, use the Raw Request action. | key: listWorkspaceProjectFolders

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all records and ignore parameters like page and page size.
Page Size string limit	25	How many items to show per page.	25
Page string page	1	Page number	1
Workspace Project ID string / Required projectId		ID of the Workspace Project entity.	eyJpZG...

Example Payload for List Workspace Project Folders

{
  "data": {
    "workspaceProject": {
      "id": "eyJpZGV...",
      "name": "Test Project",
      "browse": {
        "folders": {
          "limit": 25,
          "page": 1,
          "hasNextPage": false,
          "total": 1,
          "items": [
            {
              "id": "eyJpZGV...",
              "name": "A Parent Folder",
              "creator": {
                "id": "eyJpZGV...",
                "name": "John Doe",
                "email": "example@email.com"
              },
              "createdAt": "2024-09-06T13:18:00.000+00:00",
              "modifier": null,
              "modifiedAt": null,
              "breadcrumbs": [],
              "folders": {
                "total": 0
              }
            }
          ]
        }
      }
    }
  }
}

Move Assets

Move existing Asset item(s) to the given Library, Workspace or Folder destination. Only moves within the same Library/Workspace are supported by this operation. | key: moveAssets

Input	Default	Notes	Example
Asset IDs string / Required Value List assetIds		IDs of the Assets to move.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Destination ID string / Required destinationId		Only allows Library, Workspace, or Folder IDs.	eyJpZG...

Example Payload for Move Assets

{
  "data": {
    "moveAssets": {
      "assets": [
        {
          "id": "eyJpZGV..."
        }
      ]
    }
  }
}

Move Folders

Move existing Folder item(s) to the given Library, Workspace or Folder destination. Only moves within the same Library/Workspace are supported by this operation. | key: moveFolders

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Destination ID string / Required destinationId		Only allows Library, Workspace, or Folder IDs.	eyJpZGVud...
Folder IDs string / Required Value List folderIds		ID of the Folder items to move.	eyJpZGVud...

Example Payload for Move Folders

{
  "data": {
    "moveFolders": {
      "ids": [
        "eyJpZGV..."
      ]
    }
  }
}

Raw GraphQL Request

Send a raw GraphQL request to Frontify. | key: rawRequest

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Query or Mutation code / Required query		Provide a query or mutation for the GraphQL request.
GraphQL Variables string Key Value List variableMap		These should match the variables of your query or mutation.	{"key":"libraryId","value":"eyJpZGVudGl..."}

Uninstall Webhook

Uninstall a Webhook. | key: uninstallWebhook

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Webhook ID string / Required webhookId		The ID of the Webhook to uninstall.	eyJpZGV...

Example Payload for Uninstall Webhook

{
  "data": {
    "uninstallWebhook": {
      "webhook": {
        "id": "eyJpZGV..."
      }
    }
  }
}

Update Asset

Update an existing Asset. | key: updateAsset

Input	Default	Notes	Example
Asset ID string / Required assetId		ID of the Asset to update.	eyJpZG...
Author string author		Represents the Author of the Asset.	Photographer Name
Frontify Connection connection / Required connection
Copyright Notice text copyrightNotice		Asset copyright notice. Supports medium text length.	© 2021 My Company
Copyright Status string copyrightStatus		Asset copyright status.	UNKNOWN
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Asset description.	Some description
Expires At string expiresAt		Asset will expire once the defined date is reached.	2001-12-31T22:10:30.000+00:00
File Name string filename		Asset filename, including extension.	my-file.jpg
Title string title		Asset title or display name.	My Asset

Example Payload for Update Asset

{
  "data": {
    "updateAsset": {
      "asset": {
        "id": "eyJpZGVudGlmaWVyIjoxMDEzOTI0MSwidHlwZSI6ImFzc2V0In0="
      }
    }
  }
}

Update Collection

Update an existing Collection. | key: updateCollection

Input	Default	Notes	Example
Collection ID string / Required collectionId		ID of the Collection to update.	eyJpZG...
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Name string / Required name		Collection name.	My Collection

Example Payload for Update Collection

{
  "data": {
    "updateCollection": {
      "collection": {
        "id": "eyJpZGV..."
      }
    }
  }
}

Update Folder

Update an existing Folder. | key: updateFolder

Input	Default	Notes	Example
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Folder description.	This is my folder.
Folder ID string / Required folderId		ID of the Folder to update.	eyJpZGVud...
Name string name		Folder name.	My Folder

Example Payload for Update Folder

{
  "data": {
    "updateFolder": {
      "folder": {
        "id": "eyJpZGV..."
      }
    }
  }
}

Upload File

Upload a new file. | key: uploadFile

Input	Default	Notes	Example
Chunk Size string chunkSize		File chunk size in bytes. Value must be integer between 5MB and 1GB.	104857600
Frontify Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
File Name string / Required filename		File name.	my-file.jpg
Size string / Required size		File size in bytes.	104857600

Example Payload for Upload File

{
  "data": {
    "uploadFile": {
      "id": "eyJpZGVudGl...",
      "urls": [
        "https://s3.amazonaws.com/frontify-cloud-files-us/frontify/file..."
      ]
    }
  }
}

Frontify is a comprehensive brand management platform that enables organizations to create, manage, and distribute brand assets, guidelines, and digital content across teams and channels, streamlining brand consistency and collaboration.

Description​

API Documentation:​

Connections​

OAuth 2.0​

Personal Developer Token​

Data Sources​

Select Brand​

Select Library​

Select Library Asset​

Select Workspace Project​

Select Workspace Project Asset​

Actions​

Create Asset​

Create Attachment​

Create Collection​

Create Folder​

Delete Asset​

Delete Attachment​

Delete Collection​

Delete Folders​

Get Account ID​

Get Asset​

Get Assets by IDs​

Get Brand​

Get Current User​

Get Library​

Get Workspace Project​

Install Webhook​

List Asset Comments​

List Brand Libraries​

List Brand Workspace Projects​

List Brands​

List Library Assets​

List Library Collaborators​

List Library Collections​

List Library Folders​

List Related Assets​

List User Groups​

List Users​

List Webhooks​

List Workspace Project Assets​

List Workspace Project Folders​

Move Assets​

Move Folders​

Raw GraphQL Request​

Uninstall Webhook​

Update Asset​

Update Collection​

Update Folder​

Upload File​

Description

API Documentation:

Connections

OAuth 2.0

Personal Developer Token

Data Sources

Select Brand

Select Library

Select Library Asset

Select Workspace Project

Select Workspace Project Asset

Actions

Create Asset

Create Attachment

Create Collection

Create Folder

Delete Asset

Delete Attachment

Delete Collection

Delete Folders

Get Account ID

Get Asset

Get Assets by IDs

Get Brand

Get Current User

Get Library

Get Workspace Project

Install Webhook

List Asset Comments

List Brand Libraries

List Brand Workspace Projects

List Brands

List Library Assets

List Library Collaborators

List Library Collections

List Library Folders

List Related Assets

List User Groups

List Users

List Webhooks

List Workspace Project Assets

List Workspace Project Folders

Move Assets

Move Folders

Raw GraphQL Request

Uninstall Webhook

Update Asset

Update Collection

Update Folder

Upload File