Skip to main content

Objects: Organization & users

GraphQL object types for organizations, teams, users, invitations, and personal access tokens in the Amplience GraphQL Management API.

Organizations, plans & credits
Link copied!

Organization
Link copied!

Implements: Node

FieldTypeDescription
idID!The ID of the object
userPermissions[OrganizationPermission!]!
nameStringOrganization name
labelStringOrganization label
invitationsInvitationConnection
Args: before: String, after: String, first: Int, last: Int
membersUserConnection
Args: before: String, after: String, first: Int, last: Int
creditBalanceCreditBalance
creditTransactionReportCreditTransactionReport
Args: input: CreditTransactionReportFilterInput
entitlements[Entitlement]
plans[Plan]
cmsHubs[CMSHub!]!
personalAccessTokenRequests[PersonalAccessTokenRequest!]!
teams[Team!]!
virtualStagingEnvironmentsVirtualStagingEnvironment
Connection!
Only VSEs that have been created with an organizationId will be listed here. This generally applies to newly created VSEs only since October 2025.
Args: before: String, after: String, first: Int, last: Int
previewKeysPreviewKeyConnection!
Args: before: String, after: String, first: Int, last: Int

CreditBalance
Link copied!

FieldTypeDescription
balanceBigInteger
creditAllowanceBigInteger
organizationOrganization
quotaPeriodString

CreditTransactionReport
Link copied!

FieldTypeDescription
reportURLString

Entitlement
Link copied!

FieldTypeDescription
organizationOrganization!
nameString!
labelString!
typeEntitlementValueType!
valueEntitlementValue!

Plan
Link copied!

FieldTypeDescription
organizationOrganization!
nameString!
entitlements[Entitlement!]!

Provider
Link copied!

FieldTypeDescription
labelString!
imageFileString!

Teams, users & invitations
Link copied!

Team
Link copied!

Implements: Node

FieldTypeDescription
idID!The ID of the object
assignedOrganizationRoles[OrganizationRolesTeamAssignment!]Team's organization roles
assignedCMSHubRoles[CMSHubRolesTeamAssignment!]Team's CMS Hub roles
assignedCMSRepositoryRoles[CMSRepositoryRolesTeamAssignment!]Team's CMS Repository roles
organizationOrganization!Organization that this team belongs to
labelString!Team label
createdDateDateTime!Date team was created
updatedDateDateTime!Date team was last updated
createdByUser!The user that created the team
updatedByUser!The user that last updated the team
isOnboardingBoolean!Automatically add new users to this team on their first login if no specific team is assigned via an invite.
membersTeamMembersConnection!
Args: before: String, after: String, first: Int, last: Int

User
Link copied!

Implements: Node

FieldTypeDescription
idID!
mediaHubsMediaHubConnection
Args: before: String, after: String, first: Int, last: Int
videoTranscodingProfilesVideoTranscodingProfile
Connection
emailStringMember's email address
pictureStringMember's avatar
nameStringMember's name
loginDateTimeStringMember's last Login timestamp
isSSOStringHas member logged in via SSO
orgIdString
organizationsOrganizationConnection!
Args: before: String, after: String, first: Int, last: Int
personalAccessTokens[PersonalAccessToken!]!
personalAccessTokenRequests[PersonalAccessTokenRequest!]!
assignedOrganizationRoles[OrganizationRolesUserAssignment!]User's organization roles
assignedCMSHubRoles[CMSHubRolesUserAssignment!]User's CMS Hub roles
assignedCMSRepositoryRoles[CMSRepositoryRolesUserAssignment!]User's CMS Repository roles
teams[Team!]!
Args: organizationId: ID

Invitation
Link copied!

Implements: Node

FieldTypeDescription
idID!The ID of the object
inviteeStringUsers email address
assignedOrganizationRoles[OrganizationRoles!]Invitation's organization roles
assignedCMSHubRoles[CMSHubRoles!]Invitation's CMS Hub roles
assignedCMSRepositoryRoles[CMSRepositoryRoles!]Invitation's CMS Repository roles
teams[Team!]Teams to be assigned to the user

Role assignments
Link copied!

OrganizationRoles
Link copied!

FieldTypeDescription
organizationIdID!ID of the Organization that these role assignments correspond to
roles[OrganizationRole!]!List of organization roles assigned to this user

OrganizationRolesTeamAssignment
Link copied!

FieldTypeDescription
organizationIdID!ID of the Organization that these role assignments correspond to
teamIdID!ID of the Team that these role assignments correspond to
lastModifiedDateTime!The Last Modified date
roles[OrganizationRole!]!List of organization roles assigned to this Team

OrganizationRolesUserAssignment
Link copied!

FieldTypeDescription
organizationIdID!ID of the Organization that these role assignments correspond to
userIdID!ID of the User that these role assignments correspond to
roles[OrganizationRole!]!List of organization roles assigned to this user

Personal access tokens
Link copied!

PersonalAccessToken
Link copied!

Implements: Node

FieldTypeDescription
idID!
nameString!
tokenString!
createdDateDateTime!
lastUsedDateDateTime
userUser!
organizationOrganization!

PersonalAccessTokenRequest
Link copied!

FieldTypeDescription
idID!
nameString!
tokenString!
createdDateDateTime!
lastUsedDateDateTime
requestedByUser!
organizationOrganization!

UpdatePersonalAccessTokenResponse
Link copied!

FieldTypeDescription
userString!
idID!