Catalogs · Frontify GraphQL

Query

catalog

Open full page ↗Raw SDL

Retrieve a Catalog by its id.

Beta

Returns

Catalog

Arguments

id:ID!RequiredBeta: Catalog id.

Response fields

1 selected

Toggle fields to tailor the query and response.

Example

query Catalog {
  catalog(
    id: 
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "catalog": {
      "__typename": "Catalog",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Query

catalogSelection

Open full page ↗Raw SDL

Retrieve a CatalogSelection by its id.

Beta

Returns

CatalogSelection

Arguments

id:ID!RequiredBeta: CatalogSelection id.

Response fields

1 selected

Toggle fields to tailor the query and response.

Example

query CatalogSelection {
  catalogSelection(
    id: 
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "catalogSelection": {
      "__typename": "CatalogSelection",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

clearCatalogColumn

Open full page ↗Raw SDL

Clears all CatalogCell values of a CatalogColumn.

Beta

Returns

ClearCatalogColumn

Arguments

input:ClearCatalogColumnInput!RequiredBeta: ClearCatalogColumnInputType input argument.; Requiredid: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

columnCatalogColumn!
- nameString!
- idID!
- positionInt!

Example

mutation ClearCatalogColumn {
  clearCatalogColumn(
    input: {
      id: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "clearCatalogColumn": {
      "__typename": "ClearCatalogColumn"
    }
  }
}

Mutation

clearCatalogRow

Open full page ↗Raw SDL

Clears all CatalogCell values of a CatalogRow.

Beta

Returns

ClearCatalogRow

Arguments

input:ClearCatalogRowInput!RequiredBeta: ClearCatalogRowInputType input argument.; Requiredid: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation ClearCatalogRow {
  clearCatalogRow(
    input: {
      id: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "clearCatalogRow": {
      "__typename": "ClearCatalogRow"
    }
  }
}

Mutation

createCatalog

Open full page ↗Raw SDL

Creates a new Catalog.

Beta

Returns

CreateCatalog

Arguments

input:CreateCatalogInput!RequiredBeta: CreateCatalogInputType input argument.; Requiredname: String!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation CreateCatalog {
  createCatalog(
    input: {
      name: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createCatalog": {
      "__typename": "CreateCatalog"
    }
  }
}

Mutation

createCatalogColumn

Open full page ↗Raw SDL

Creates a new CatalogColumn.

Beta

Returns

CreateCatalogColumn

Arguments

input:CreateCatalogColumnInput!RequiredBeta: CreateCatalogColumnInputType input argument.; Optionaltext: CreateCatalogTextColumnInput, link: CreateCatalogLinkColumnInput

Response fields

0 selected

Toggle fields to tailor the query and response.

columnCatalogColumn!
- nameString!
- idID!
- positionInt!

Example

mutation CreateCatalogColumn {
  createCatalogColumn(
    input: {
      
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createCatalogColumn": {
      "__typename": "CreateCatalogColumn"
    }
  }
}

Mutation

createCatalogRow

Open full page ↗Raw SDL

Creates a new CatalogRow.

Beta

Returns

CreateCatalogRow

Arguments

input:CreateCatalogRowInput!RequiredBeta: CreateCatalogRowInputType input argument.; RequiredcatalogId: ID!, position: Int!; Optionalcells: [CreateCatalogRowCellInput!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation CreateCatalogRow {
  createCatalogRow(
    input: {
      catalogId: 
      position: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createCatalogRow": {
      "__typename": "CreateCatalogRow"
    }
  }
}

Mutation

duplicateCatalogColumn

Open full page ↗Raw SDL

Duplicates a CatalogColumn with its CatalogCell values.

Beta

Returns

DuplicateCatalogColumn

Arguments

input:DuplicateCatalogColumnInput!RequiredBeta: DuplicateCatalogColumnInputType input argument.; Requiredid: ID!, name: String!

Response fields

0 selected

Toggle fields to tailor the query and response.

columnCatalogColumn!
- nameString!
- idID!
- positionInt!

Example

mutation DuplicateCatalogColumn {
  duplicateCatalogColumn(
    input: {
      id: 
      name: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "duplicateCatalogColumn": {
      "__typename": "DuplicateCatalogColumn"
    }
  }
}

Mutation

duplicateCatalogRow

Open full page ↗Raw SDL

Duplicates a CatalogRow with its CatalogCell values.

Beta

Returns

DuplicateCatalogRow

Arguments

input:DuplicateCatalogRowInput!RequiredBeta: DuplicateCatalogRowInputType input argument.; Requiredid: ID!; OptionalprimaryKeyValue: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation DuplicateCatalogRow {
  duplicateCatalogRow(
    input: {
      id: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "duplicateCatalogRow": {
      "__typename": "DuplicateCatalogRow"
    }
  }
}

Mutation

ingestCatalogRows

Open full page ↗Raw SDL

Ingests rows into a Catalog using an upsert approach.

Beta

Returns

IngestCatalogRows

Arguments

input:IngestCatalogRowsInput!RequiredBeta: IngestCatalogRowsInputType input argument.; RequiredcatalogId: ID!, columnIds: [ID!]!, rowValues: [[[String!]!]!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

createdInt!
skippedInt!
updatedInt!

Example

mutation IngestCatalogRows {
  ingestCatalogRows(
    input: {
      catalogId: 
      columnIds: []
      rowValues: [[[]]]
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "ingestCatalogRows": {
      "__typename": "IngestCatalogRows"
    }
  }
}

Mutation

moveCatalogColumn

Open full page ↗Raw SDL

Moves a CatalogColumn to a new position.

Beta

Returns

MoveCatalogColumn

Arguments

input:MoveCatalogColumnInput!RequiredBeta: MoveCatalogColumnInputType input argument.; Requiredid: ID!, position: Int!

Response fields

0 selected

Toggle fields to tailor the query and response.

columnCatalogColumn!
- nameString!
- idID!
- positionInt!

Example

mutation MoveCatalogColumn {
  moveCatalogColumn(
    input: {
      id: 
      position: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "moveCatalogColumn": {
      "__typename": "MoveCatalogColumn"
    }
  }
}

Mutation

moveCatalogRow

Open full page ↗Raw SDL

Moves a CatalogRow to a new position.

Beta

Returns

MoveCatalogRow

Arguments

input:MoveCatalogRowInput!RequiredBeta: MoveCatalogRowInputType input argument.; Requiredid: ID!, position: Int!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation MoveCatalogRow {
  moveCatalogRow(
    input: {
      id: 
      position: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "moveCatalogRow": {
      "__typename": "MoveCatalogRow"
    }
  }
}

Mutation

removeCatalog

Open full page ↗Raw SDL

Removes a Catalog.

Beta

Returns

RemoveCatalog

Arguments

input:RemoveCatalogInput!RequiredBeta: RemoveCatalogInputType input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation RemoveCatalog {
  removeCatalog(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "removeCatalog": {
      "__typename": "RemoveCatalog",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

removeCatalogColumns

Open full page ↗Raw SDL

Removes multiple CatalogColumns in a single operation.

Beta

Returns

RemoveCatalogColumns

Arguments

input:RemoveCatalogColumnsInput!RequiredBeta: RemoveCatalogColumnsInputType input argument.; Requiredids: [ID!]!; Optionalmode: CatalogColumnRemovalMode

Response fields

0 selected

Toggle fields to tailor the query and response.

… on RemoveCatalogColumnsSuccessful
- ids[ID!]!
… on RemoveCatalogColumnsBlocked
- blockedColumns[CatalogColumnUsage!]!
  - reasons[CatalogColumnUsageReason!]!
  - columnCatalogColumn!
    - idID!

Example

mutation RemoveCatalogColumns {
  removeCatalogColumns(
    input: {
      ids: []
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeCatalogColumns": {
      "__typename": "RemoveCatalogColumnsSuccessful"
    }
  }
}

Mutation

removeCatalogRows

Open full page ↗Raw SDL

Removes multiple CatalogRows.

Beta

Returns

RemoveCatalogRows

Arguments

input:RemoveCatalogRowsInput!RequiredBeta: RemoveCatalogRowsInputType input argument.; Requiredids: [ID!]!; Optionalmode: CatalogRowRemovalMode

Response fields

0 selected

Toggle fields to tailor the query and response.

… on RemoveCatalogRowsSuccessful
- ids[ID!]!
… on RemoveCatalogRowsBlocked
- blockedRows[CatalogRowUsage!]!
  - reasons[CatalogRowUsageReason!]!
  - rowCatalogRow!
    - idID!

Example

mutation RemoveCatalogRows {
  removeCatalogRows(
    input: {
      ids: []
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeCatalogRows": {
      "__typename": "RemoveCatalogRowsSuccessful"
    }
  }
}

Mutation

setCatalogCells

Open full page ↗Raw SDL

Sets multiple CatalogCell values. Each entry specifies either a text or a link cell. All cells must belong to the same catalog.

Beta

Returns

SetCatalogCells

Arguments

input:SetCatalogCellsInput!RequiredBeta: SetCatalogCellsInputType input argument.; Requiredcells: [SetCatalogCellInput!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation SetCatalogCells {
  setCatalogCells(
    input: {
      cells: [{
        
        
      }
      ]
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "setCatalogCells": {
      "__typename": "SetCatalogCells"
    }
  }
}

Mutation

setCatalogColumnAsPrimary

Open full page ↗Raw SDL

Sets a CatalogColumn as the primary key column for its Catalog.

Beta

Returns

SetCatalogColumnAsPrimary

Arguments

input:SetCatalogColumnAsPrimaryInput!RequiredBeta: SetCatalogColumnAsPrimaryInputType input argument.; Requiredid: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

columnCatalogColumn!
- nameString!
- idID!
- positionInt!

Example

mutation SetCatalogColumnAsPrimary {
  setCatalogColumnAsPrimary(
    input: {
      id: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "setCatalogColumnAsPrimary": {
      "__typename": "SetCatalogColumnAsPrimary"
    }
  }
}

Mutation

updateCatalog

Open full page ↗Raw SDL

Updates an existing Catalog.

Beta

Returns

UpdateCatalog

Arguments

input:UpdateCatalogInput!RequiredBeta: UpdateCatalogInputType input argument.; Requiredid: ID!, data: UpdateCatalogDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateCatalog {
  updateCatalog(
    input: {
      id: 
      data: {
        name: 
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateCatalog": {
      "__typename": "UpdateCatalog"
    }
  }
}

Mutation

updateCatalogColumn

Open full page ↗Raw SDL

Updates a CatalogColumn.

Beta

Returns

UpdateCatalogColumn

Arguments

input:UpdateCatalogColumnInput!RequiredBeta: UpdateCatalogColumnInputType input argument.; Requiredid: ID!, data: UpdateCatalogColumnDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

columnCatalogColumn!
- nameString!
- idID!
- positionInt!

Example

mutation UpdateCatalogColumn {
  updateCatalogColumn(
    input: {
      id: 
      data: {
        name: 
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateCatalogColumn": {
      "__typename": "UpdateCatalogColumn"
    }
  }
}