Management API

Under the hood there are two API's at work. The Content API and the Management API. The Management API allows operations within the context of your account. You can create new projects, update models and define new schemas. In fact, the entirety of the GraphCMS platform is produced by using the Management API and the interface is simply a UI built on top. One could build a completely bespoke interface for GraphCMS using the Management content-api.mdx

The Management API is subject to change with little to no notice and is not considered stable.

The Management API also doesn't have any of the filters that are available in the Content API. For the most in-depth documentation about the the Management API, we encourage you to use the API explorer built into GraphCMS.

Management API Explorer

See the Content API docs here

Accessing Your Management API Token

It is possible to create irreparable damage to your project using the Management API. Caution is advised.

The Management API token is not accessible from the user interface. Due to the fact that the API is not yet stabilized. If you'd like to locate it, you can find it in your localstorage under the name "managementAPIToken".

Running this code from a Chrome browser console will format the token for an auth header which can be used with a tool like GraphQL Playground or others.

copy(
  JSON.stringify(
    {
      Authorization: `Bearer ${window.localStorage.getItem(
        'managementApiToken'
      )}`,
    },
    ' ',
    4
  )
);

User Methods


Mutation Queries:

sendInvite

The information about sendInvites.

Args

email

String

projectId

ID

roleId

ID

Fields

invite

Invite

revokeInvite

The informtion about revokeInvites.

Args

id

ID

Fields

revokedInviteId

ID

acceptInvite

The information about acceptInvites.

Args

code

String

Fields

invite

Invite

Project Schema

Query:

projectTemplates

Needs Description

Fields

Mutation:

revertContentModel

Args

stageId

ID

Fields

id

ID

startedAt

DateTime

stage

IStage

createContentView

Args

name

String

description

String

modelId

ID

isPrivate

Boolean

fields

--

orderBy

OrderByInput

viewGroupId

ID

filters

JSON

Fields

createdContentView

ContentView

updateContentView

Args

id

ID

name

String

description

String

isPrivate

Boolean

fields

--

orderBy

OrderByInput

viewGroupId

ID

filters

JSON

Fields

updatedContentView

ContentView

deleteContentView

Args

id

ID

Fields

deletedContentViewId

ID

moveContentView

Args

id

ID

newViewGroupId

ID

position

Int

Fields

movedContentView

ContentView

updatedViewGroups

--

createEnumeration

Args

stageId

ID

apiId

String

displayName

String

description

String

values

--

Fields

createdEnumeration

Enumeration

deploymentStatus

IDeploymentStatus

deleteEnumeration

Args

id

ID

Fields

deletedEnumerationId

ID

deploymentStatus

IDeploymentStatus

updateEnumeration

Args

id

ID

newApiId

String

displayName

String

description

String

values

--

Fields

updatedEnumeration

Enumeration

deploymentStatus

IDeploymentStatus

affectedFields

--

createStringField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

StringField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createRichTextField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

RichTextField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createColorField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

ColorField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createLocationField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

LocationField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createDateTimeField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

DateTimeField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createIntField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

IntField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createFloatField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

FloatField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createBooleanField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

BooleanField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createJsonField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

JsonField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createEnumerationField

Args

modelId

ID

enumerationId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isUnique

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

defaultValue

String

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

EnumerationField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createAssetField

Args

modelId

ID

apiId

String

displayName

String

description

String

isRequired

Boolean

isList

Boolean

isLocalized

Boolean

isHidden

Boolean

formConfig

FieldConfigInput

tableConfig

FieldConfigInput

Fields

createdField

AssetField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

createRelationField

Args

modelId

ID

relationApiId

String

apiId

String

displayName

String

description

String

isList

Boolean

isRequired

Boolean

isLocalized

Boolean

isHidden

Boolean

onDelete

OnDelete

reverseSide

ReverseRelationSide

tableConfig

FieldConfigInput

formConfig

FieldConfigInput

Fields

createdField

RelationField

createdContentViewColumns

--

deploymentStatus

IDeploymentStatus

updateField

Args

id

ID

apiId

String

displayName

String

description

String

isList

Boolean

isRequired

Boolean

defaultValue

String

isUnique

Boolean

isLocalized

Boolean

isHidden

Boolean

tableConfig

FieldConfigUpdateInput

formConfig

FieldConfigUpdateInput

Fields

updatedField

IField

updatedContentViewColumns

--

deploymentStatus

IDeploymentStatus

fieldSetPrimary

Args

id

ID

Fields

updatedField

IField

moveField

Args

id

ID

newPosition

Int

Fields

movedFields

--

contentViewColumns

--

deleteField

Args

id

ID

Fields

deletedFieldId

ID

deletedContentViewColumnIds

--

deploymentStatus

IDeploymentStatus

createModel

Args

stageId

ID

apiId

String

displayName

String

description

String

Fields

createdModel

Model

contentViews

--

deploymentStatus

IDeploymentStatus

updateModel

Args

id

ID

newApiId

String

displayName

String

description

String

Fields

updatedModel

Model

contentViews

--

deploymentStatus

IDeploymentStatus

deleteModel

Args

id

ID

Fields

deletedModelId

ID

deletedContentViewIds

--

deploymentStatus

IDeploymentStatus

forceStageDeploy

Args

stageId

ID

force

Boolean

setStageStatusPending

Boolean

dryRun

Boolean

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

displayName

String

description

String

revision

Int

endpoint

String

contentModel

ContentModel

contentView

ContentView

contentViews

--

deploymentStatus

IDeploymentStatus

region

Region

assetConfig

IAssetConfig

parent

IStage

metrics

Metrics

webhook

Webhook

webhooks

--

permanentAuthTokens

--

systemTokens

--

defaultPermissions

StageDefaultPermission

authToken

String

cloneStage

Args

parent

ID

name

String

displayName

String

description

String

region

String

customAssetConfiguration

AssetConfiguration

includeContent

Boolean

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

displayName

String

description

String

revision

Int

endpoint

String

contentModel

ContentModel

contentView

ContentView

contentViews

--

deploymentStatus

IDeploymentStatus

region

Region

assetConfig

IAssetConfig

parent

IStage

metrics

Metrics

webhook

Webhook

webhooks

--

permanentAuthTokens

--

systemTokens

--

defaultPermissions

StageDefaultPermission

authToken

String

syncStage

Args

destinationStageId

ID

revisions

Int

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

displayName

String

description

String

revision

Int

endpoint

String

contentModel

ContentModel

contentView

ContentView

contentViews

--

deploymentStatus

IDeploymentStatus

region

Region

assetConfig

IAssetConfig

parent

IStage

metrics

Metrics

webhook

Webhook

webhooks

--

permanentAuthTokens

--

systemTokens

--

defaultPermissions

StageDefaultPermission

authToken

String

deleteStage

Args

stageId

ID

Fields

deletedStageId

ID

updateStageDefaultPermissions

Args

stageId

ID

defaultPermissions

StageDefaultPermissionInput

setStageStatusPending

Boolean

Fields

updatedStage

IStage

deploymentStatus

IDeploymentStatus

rollbackStage

Args

stageId

ID

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

displayName

String

description

String

revision

Int

endpoint

String

contentModel

ContentModel

contentView

ContentView

contentViews

--

deploymentStatus

IDeploymentStatus

region

Region

assetConfig

IAssetConfig

parent

IStage

metrics

Metrics

webhook

Webhook

webhooks

--

permanentAuthTokens

--

systemTokens

--

defaultPermissions

StageDefaultPermission

authToken

String

cancelImportContent

Args

stageId

ID

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

displayName

String

description

String

revision

Int

endpoint

String

contentModel

ContentModel

contentView

ContentView

contentViews

--

deploymentStatus

IDeploymentStatus

region

Region

assetConfig

IAssetConfig

parent

IStage

metrics

Metrics

webhook

Webhook

webhooks

--

permanentAuthTokens

--

systemTokens

--

defaultPermissions

StageDefaultPermission

authToken

String

deploySchema

Args

stageId

ID

schema

String

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

displayName

String

description

String

revision

Int

endpoint

String

contentModel

ContentModel

contentView

ContentView

contentViews

--

deploymentStatus

IDeploymentStatus

region

Region

assetConfig

IAssetConfig

parent

IStage

metrics

Metrics

webhook

Webhook

webhooks

--

permanentAuthTokens

--

systemTokens

--

defaultPermissions

StageDefaultPermission

authToken

String

importContent

Args

templateId

ID

intoStageId

ID

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

displayName

String

description

String

revision

Int

endpoint

String

contentModel

ContentModel

contentView

ContentView

contentViews

--

deploymentStatus

IDeploymentStatus

region

Region

assetConfig

IAssetConfig

parent

IStage

metrics

Metrics

webhook

Webhook

webhooks

--

permanentAuthTokens

--

systemTokens

--

defaultPermissions

StageDefaultPermission

authToken

String

Project Settings

Mutation:

createSystemToken

Needs Description

Args

stageId

ID

name

String

description

String

grants

--

setStageStatusPending

Boolean

Fields

createdSystemToken

SystemToken

deploymentStatus

IDeploymentStatus

updateSystemToken

Needs Description

Args

id

ID

name

String

description

String

grants

--

setStageStatusPending

Boolean

Fields

updatedSystemToken

SystemToken

deploymentStatus

IDeploymentStatus

deleteSystemToken

Needs Description

Args

id

ID

setStageStatusPending

Boolean

Fields

deletedSystemTokenId

ID

deploymentStatus

IDeploymentStatus

createViewGroup

Needs Description

Args

name

String

description

String

type

ViewGroupContentType

stageId

ID

isPrivate

Boolean

Fields

createdViewGroup

ViewGroup

updateViewGroup

Needs Description

Args

id

ID

name

String

description

String

Fields

updatedViewGroup

ViewGroup

deleteViewGroup

Needs Description

Args

id

ID

Fields

deletedViewGroupId

ID

moveViewGroup

Needs Description

Args

id

ID

newPosition

Int

Fields

movedViewGroups

--

createWebhook

Needs Description

Args

stageId

ID

name

String

description

String

url

String

headers

JSON

isActive

Boolean

type

WebhookType

scope

WebhookScope

setStageStatusPending

Boolean

Fields

createdWebhook

Webhook

deploymentStatus

IDeploymentStatus

updateWebhook

Needs Description

Args

webhookId

ID

name

String

description

String

headers

JSON

url

String

isActive

Boolean

scope

WebhookScope

setStageStatusPending

Boolean

Fields

updatedWebhook

Webhook

deploymentStatus

IDeploymentStatus

deleteWebhook

Needs Description

Args

webhookId

ID

setStageStatusPending

Boolean

Fields

deletedWebhookId

ID

deploymentStatus

IDeploymentStatus

createPermanentAuthToken

Needs Description

Args

stageId

ID

name

String

description

String

scope

PermanentAuthTokenScope

filters

EntityFilterWhereInput

setStageStatusPending

Boolean

Fields

createdPermanentAuthToken

PermanentAuthToken

deploymentStatus

IDeploymentStatus

updatePermanentAuthToken

Needs Description

Args

id

ID

name

String

description

String

scope

PermanentAuthTokenScope

filters

EntityFilterWhereInput

setStageStatusPending

Boolean

Fields

updatedPermanentAuthToken

PermanentAuthToken

deploymentStatus

IDeploymentStatus

deletePermanentAuthToken

Needs Description

Args

id

ID

setStageStatusPending

Boolean

Fields

deletedPermanentAuthTokenId

ID

deploymentStatus

IDeploymentStatus

addPermissionsToRole

Needs Description

Args

roleId

ID

permissions

--

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

isDefault

Boolean

name

String

description

String

permissions

--

removePermissionsFromRole

Needs Description

Args

roleId

ID

permissions

--

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

isDefault

Boolean

name

String

description

String

permissions

--

createRole

Needs Description

Args

projectId

ID

name

String

description

String

permissions

--

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

isDefault

Boolean

name

String

description

String

permissions

--

updateRole

Needs Description

Args

id

ID

name

String

description

String

permissions

--

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

isDefault

Boolean

name

String

description

String

permissions

--

deleteRole

Needs Description

Args

id

ID

Fields

deletedId

ID

updateUserRole

Needs Description

Args

roleId

ID

userId

ID

projectId

ID

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

profile

Profile

role

Role

removeMember

Needs Description

Args

id

ID

projectId

ID

Fields

removedMemberId

ID

Account

Query:

metaInfo

Needs Description

Fields

serverVersion

String

viewer

Needs Description

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

profile

Profile

projects

--

plans

--

legacyProjects

--

project

Project

paymentAccounts

--

paymentAccount

PaymentAccount

regions

--

pendingInvites

--

Mutation:

startTrial

Needs Description

Args

projectId

ID

planId

ID

Fields

project

Project

leaveTrial

Needs Description

Args

projectId

ID

Fields

project

Project

createProject

Needs Description

Args

region

String

name

String

description

String

customAssetConfiguration

AssetConfiguration

templateOptions

TemplateOptionsInput

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

description

String

picture

String

subscription

PaymentSubscription

role

Role

existingRoles

--

stages

--

writableStage

IStage

stage

IStage

members

--

quotas

Quota

lifecycle

Lifecycle

inTrial

Boolean

trialExpiresIn

DateTime

invites

--

updateProject

Needs Description

Args

id

ID

name

String

description

String

picture

String

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

description

String

picture

String

subscription

PaymentSubscription

role

Role

existingRoles

--

stages

--

writableStage

IStage

stage

IStage

members

--

quotas

Quota

lifecycle

Lifecycle

inTrial

Boolean

trialExpiresIn

DateTime

invites

--

deleteProject

Needs Description

Args

id

ID

Fields

deletedProjectId

ID

leaveProject

Needs Description

Args

id

ID

Fields

leftProjectId

ID

cloneProject

Needs Description

Args

id

ID

name

String

description

String

region

String

includeContent

Boolean

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

name

String

description

String

picture

String

subscription

PaymentSubscription

role

Role

existingRoles

--

stages

--

writableStage

IStage

stage

IStage

members

--

quotas

Quota

lifecycle

Lifecycle

inTrial

Boolean

trialExpiresIn

DateTime

invites

--

deleteAccount

Needs Description

Fields

deletedUserId

ID

updateProfile

Needs Description

Args

name

String

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

profile

Profile

projects

--

plans

--

legacyProjects

--

project

Project

paymentAccounts

--

paymentAccount

PaymentAccount

regions

--

pendingInvites

--

setUserAnalytics

Needs Description

Args

landingPage

String

conversionPage

String

referrer

String

gclid

String

utmSource

String

utmMedium

String

utmCampaign

String

utmTerm

String

utmContent

String

Fields

id

ID

createdAt

DateTime

updatedAt

DateTime

landingPage

String

conversionPage

String

referrer

String

gclid

String

utmSource

String

utmMedium

String

utmCampaign

String

utmTerm

String

utmContent

String

Billing

Mutation:

closePaymentAccount

Needs Description

Args

id

ID

Fields

paymentAccount

PaymentAccount

reopenPaymentAccount

Needs Description

Args

id

ID

Fields

paymentAccount

PaymentAccount

switchPaymentSubscription

Needs Description

Args

planName

String

subscriptionId

ID

Fields

subscription

PaymentSubscription