Administrate Developers

Core GraphQL API Reference

Upcoming changes · Download schema

Types

Query

Root Query Type

accountAssociationTypes : AccountAssociationTypeConnection!

Fetches a list of Account Association Types

Argument Type Description
filters = [] [AccountAssociationTypeFieldGraphFilter]
order = "__EMPTY__" AccountAssociationTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountAssociationTypeFieldGraphOrder]
accounts : AccountConnection!

Fetches a page of Accounts

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
achievementNumberSequences : AchievementNumberSequenceConnection!

Fetches a page of configured Sequences for issuing Achievement certificates

Argument Type Description
filters = [] [AchievementNumberSequenceFieldGraphFilter]
order = "__EMPTY__" AchievementNumberSequenceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementNumberSequenceFieldGraphOrder]
achievementTypes : AchievementTypeConnection!

Fetches a list of Achievement Types

Argument Type Description
filters = [] [AchievementTypeFieldGraphFilter]
order = "__EMPTY__" AchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementTypeFieldGraphOrder]
achievements : AchievementConnection!

Fetches a list of Achievements

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
addresses : AddressConnection!

Fetches a list of postal addresses

Argument Type Description
filters = [] [AddressFieldGraphFilter]
order = "__EMPTY__" AddressFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AddressFieldGraphOrder]
aggregateAvailability : AggregatedAvailability

Returns the aggregated availability for a given course for a given length based on a start date

Argument Type Description
courseTemplateId ID!

The Course Template ID to get availability for
learningPathId ID!

The Learning Path ID to get availability for
duration Int!

The length of the event in half hour time grains (i.e. 2 hours = 4)
startDate Date!

The Start Date to start the aggregation from
days Int!

The amount of days to calculate this aggregation for
workplaceId ID

The (Optional) Workplace ID to get availability for
authorizedApplications : AuthorizedApplications!

Returns Authorized Client Credentials

automatorSettings : AutomatorSettings!

Fetches Administrate Automator Settings

bookables : BookableConnection!

Query a list of Bookables

Argument Type Description
filters = [] [BookableFieldGraphFilter]
order = "__EMPTY__" BookableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BookableFieldGraphOrder]
search String
brands : BrandConnection!

Fetches a list of Brands

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
calendar : CalendarableConnection!

Returns a list of items suitable for Calendar views, such as Events, sessions, resource and instructors bookings etc.

Argument Type Description
filters = [] [CalendarableFieldGraphFilter]
order = "__EMPTY__" CalendarableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CalendarableFieldGraphOrder]
calendarEntries : CalendarEntryConnection!

Fetches a list of Calendar Entries

Argument Type Description
filters = [] [CalendarEntryFieldGraphFilter]
order = "__EMPTY__" CalendarEntryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CalendarEntryFieldGraphOrder]
calendarIntegrationSettings : CalendarIntegrationSettings!

Fetches Calendar Integration Settings

cancellationReasons : CancellationReasonConnection!

Fetches a list of Cancellation Reasons

Argument Type Description
filters = [] [CancellationReasonFieldGraphFilter]
order = "__EMPTY__" CancellationReasonFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CancellationReasonFieldGraphOrder]
cancellationRequests : CancellationRequestConnection!

Fetches a list of Cancellation Requests

Argument Type Description
filters = [] [CancellationRequestFieldGraphFilter]
order = "__EMPTY__" CancellationRequestFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CancellationRequestFieldGraphOrder]
catalogue : CatalogueItemConnection!

Query a Catalogue of Items to Sell

Argument Type Description
filters = [] [CatalogueItemFieldGraphFilter]
order = "__EMPTY__" CatalogueItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CatalogueItemFieldGraphOrder]
search String
customFieldFilters [CustomFieldFilter]
certificateTemplates : CertificateTemplateConnection!

Fetches a list of Certificate Templates

Argument Type Description
filters = [] [CertificateTemplateFieldGraphFilter]
order = "__EMPTY__" CertificateTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CertificateTemplateFieldGraphOrder]
certificateTypes : CertificateTypeConnection!

Fetches a list of Certificate Types

Argument Type Description
filters = [] [CertificateTypeFieldGraphFilter]
order = "__EMPTY__" CertificateTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CertificateTypeFieldGraphOrder]
communicationTemplates : CommunicationTemplateConnection!

Fetches a list of Communication Templates Entities

Argument Type Description
filters = [] [CommunicationTemplateFieldGraphFilter]
order = "__EMPTY__" CommunicationTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CommunicationTemplateFieldGraphOrder]
communications : CommunicationConnection!

Fetches a list of Communications, combining trigger communications and manually composed (ad hoc) emails

Argument Type Description
filters = [] [CommunicationFieldGraphFilter]
order = "__EMPTY__" CommunicationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CommunicationFieldGraphOrder]
companies : CompanyConnection!

Fetches a page of Companies

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
contactBookings : ContactBookingConnection!

Fetches a page of Contact bookings, for example: Instructor bookings, holidays, external calendar events etc.

Argument Type Description
filters = [] [ContactBookingFieldGraphFilter]
order = "__EMPTY__" ContactBookingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactBookingFieldGraphOrder]
contactConflicts : [ContactWithConflicts!]!

Fetches a list of conflicts with sessions of trainings grouped by Contact

Argument Type Description
rangeStartDate Date!
rangeEndDate Date!
contactStats : ContactStatConnection!

Fetches a page of Contact statistics such as booking count

Argument Type Description
filters = [] [ContactStatFieldGraphFilter]
order = "__EMPTY__" ContactStatFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactStatFieldGraphOrder]
customFieldFilters [CustomFieldFilter]
contacts : ContactConnection!

Fetches a page of Contacts

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
customFieldFilters [CustomFieldFilter]
content : ContentConnection!

Fetches a list of content on events

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
countries : [Country!]!

Returns a list of Countries

countryByCode : Country

Returns a Country given its Country Code or ID

Argument Type Description
code String!

the Country Code or ID to search for
courseAvailability : CourseAvailabilityResponse!

Finds concrete ways to run one Course Event within an optional date horizon.

Argument Type Description
input CourseAvailabilityInput!

Course, Location, capacity, horizon, and result limit
courseLevels : CourseLevelConnection!

Fetches a list of the available Course Levels

Argument Type Description
filters = [] [CourseLevelFieldGraphFilter]
order = "__EMPTY__" CourseLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseLevelFieldGraphOrder]
courseTemplates : CourseTemplateConnection!

Fetches a page of Course Templates

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
creditNotes : CreditNoteConnection!

Fetches a list of the available Credit Notes

Argument Type Description
filters = [] [CreditNoteFieldGraphFilter]
order = "__EMPTY__" CreditNoteFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CreditNoteFieldGraphOrder]
currencies : CurrencyConnection!

Fetches a list of the available Currencies

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
customFieldFilterTypeMappings : [CustomFieldFilterTypeMapping!]!

Fetches the valid CustomFieldFilter types as well as the type of Custom Fields they can be associated with

customFieldTemplate : GlobalCustomFieldTemplate!

Fetches the Custom Field Template for a type

Argument Type Description
type SupportsCustomField!
customFields : GenericCustomFieldConnection!

Fetches a list of Custom Fields

Argument Type Description
filters = [] [GenericCustomFieldFieldGraphFilter]
order = "__EMPTY__" GenericCustomFieldFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GenericCustomFieldFieldGraphOrder]
customTemplates : CustomTemplateConnection!

Fetches a list of the available Custom Templates

Argument Type Description
filters = [] [CustomTemplateFieldGraphFilter]
order = "__EMPTY__" CustomTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CustomTemplateFieldGraphOrder]
customTranslations : [CustomTranslation!]!

Fetches a list of Custom Translations

Argument Type Description
locale String!

the locale for which to fetch translations (e.g. "en-US")
dataImports : DataImportConnection!

Returns a list of data import tasks that have been created

Argument Type Description
filters = [] [DataImportFieldGraphFilter]
order = "__EMPTY__" DataImportFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DataImportFieldGraphOrder]
digitalTaxes : DigitalTaxConnection!

Fetches a list of Digital Tax mappings between Tax Types and Country/Provinces that apply to digital product purchases from Accounts according to their billing address.

Argument Type Description
filters = [] [DigitalTaxFieldGraphFilter]
order = "__EMPTY__" DigitalTaxFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DigitalTaxFieldGraphOrder]
discountPromotionCodes : DiscountPromotionCodeConnection!

Fetches a list of Discount Promotion Codes

Argument Type Description
filters = [] [DiscountPromotionCodeFieldGraphFilter]
order = "__EMPTY__" DiscountPromotionCodeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DiscountPromotionCodeFieldGraphOrder]
discounts : DiscountConnection!

Fetches a list of Discounts

Argument Type Description
filters = [] [DiscountFieldGraphFilter]
order = "__EMPTY__" DiscountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DiscountFieldGraphOrder]
documentCategories : DocumentCategoryConnection!

Fetches a list of Document Categories

Argument Type Description
filters = [] [DocumentCategoryFieldGraphFilter]
order = "__EMPTY__" DocumentCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentCategoryFieldGraphOrder]
documentTemplates : DocumentTemplateConnection!

Fetches a list of document templates

Argument Type Description
filters = [] [DocumentTemplateFieldGraphFilter]
order = "__EMPTY__" DocumentTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentTemplateFieldGraphOrder]
documents : DocumentConnection!

Fetches a page of DMS Documents. Translations of a Document are not listed here; read them from Document.translations.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
includeReports String
downloadDocument : DocumentDownloadUrlResponse

Fetches the download URL for a given document ID

Argument Type Description
documentId ID!

The document ID to fetch
revisionId ID

The optional Document Revision ID to fetch
expiresIn Int

The expiry time for the URL in seconds. Defaults to 60 seconds, max 21600 (6 hours)
echo : String

Echoes back the provided value

Argument Type Description
value String

an optional string value to be echoed back (defaults to null)
id ID

an optional ID value to be echoed back (defaults to null)
emailAccounts : EmailAccountConnection!

Fetches a list of Email Accounts

Argument Type Description
filters = [] [EmailAccountFieldGraphFilter]
order = "__EMPTY__" EmailAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EmailAccountFieldGraphOrder]
enquiries : EnquiryConnection!

Fetches a page of Enquiries.

Argument Type Description
filters = [] [EnquiryFieldGraphFilter]
order = "__EMPTY__" EnquiryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EnquiryFieldGraphOrder]
eventAuditLogEntries : EventAuditLogEntryConnection!

Fetches a page of Event audit log entries. Filter by eventId for one Event's history. Requires the Event view permission.

Argument Type Description
filters = [] [EventAuditLogEntryFieldGraphFilter]
order = "__EMPTY__" EventAuditLogEntryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventAuditLogEntryFieldGraphOrder]
eventIssues : EventRequirementConnection!

Fetches a page of Event Issues, which pulls all instructors on all sessions of each event to calculate instructor conflicts and surface any other Issues that would block or hinder running the training event. Can filter by id, staff contact id, or provide a start and/or end point to filter by the event's startDate (rangeStart ge -> rangeEnd lt).

Argument Type Description
filters = [] [EventRequirementFieldGraphFilter]
first = 100 Int
offset = 0 Int
eventLifecycleChanges : EventLifecycleChangeConnection!

Fetches a page of Event changes worth reporting on: reschedules today, other kinds later. Filter by eventId for one Event's changes, which includes its Sessions'. Requires the Event view permission.

Argument Type Description
filters = [] [EventLifecycleChangeFieldGraphFilter]
order = "__EMPTY__" EventLifecycleChangeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventLifecycleChangeFieldGraphOrder]
eventStats : EventStats!

EXPERIMENTAL Returns a time series aggregation of Event Statistics. This is a work in progress and will change.

Argument Type Description
timeRange [MonthYearInput]!

A tuple specifying a start and end MonthYear to filter the stats. Limited to less than 13 month durations.
resolution SliceResolution!

What time period to aggregate the resulting stat slices by. Only supports WHOLE for now.
eventTemplates : EventTemplateConnection!

Fetches a list of the available Event Templates

Argument Type Description
filters = [] [EventTemplateFieldGraphFilter]
order = "__EMPTY__" EventTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventTemplateFieldGraphOrder]
events : EventConnection!

Fetches a page of Events

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
externalCalendarEvents : ExternalCalendarEventConnection

Fetches a list of External Calendar Events

Argument Type Description
filters = [] [ExternalCalendarEventFieldGraphFilter]
order = "__EMPTY__" ExternalCalendarEventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalCalendarEventFieldGraphOrder]
externalConfigurations : ExternalConfigurationConnection!

Fetches a list of External Configurations

Argument Type Description
filters = [] [ExternalConfigurationFieldGraphFilter]
order = "__EMPTY__" ExternalConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalConfigurationFieldGraphOrder]
externalIdDefinitions : ExternalIdDefinitionConnection!

Returns a Connection of all defined External IDs across the platform, with the entity type they apply to and the human-readable labels.

Argument Type Description
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
externalIdEntities : ExternalIdEntityConnection!

Returns a Connection of Nodes which have the specified External ID set

Argument Type Description
type SupportsExternalIDType!

Node type
name String!

External ID name
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
externalIds : [ExternalId!]!

List of External IDs associated with the given Node ID

Argument Type Description
nodeId ID!

the ID of the node to return external IDs for
externalLogOrigins : ExternalLogOriginConnection

Fetches a list of External Logs

Argument Type Description
filters = [] [ExternalLogOriginFieldGraphFilter]
order = "__EMPTY__" ExternalLogOriginFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogOriginFieldGraphOrder]
externalLogs : ExternalLogConnection

Fetches a list of External Logs

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
fetchEventRescheduleConflicts : EventReschedulingConflict!

Fetches the conflicts for potential Event or Session reschedule

Argument Type Description
input EventReschedulingConflictInput!

The input type with the values to fetch Event rescheduling conflicts
fetchParentEventRescheduleConflicts : EventReschedulingConflict!

Fetches the conflicts for a potential Event reschedule, using the dates for a potential new Session

Argument Type Description
input ParentEventReschedulingConflictInput!

The input type with the values to fetch Event rescheduling conflicts
fetchSellablePrice : [SellablePrice!]!

Fetches the appropriate Price(s) for a Sellable:

Argument Type Description
sellableId ID!

The ID of the Sellable (Course, Path, Event, Item)
sellableType SellableType!

The Type of the Sellable to query the Price for
currencyCode String

DEPRECATED: In favor of financialUnitId
financialUnitId ID

The Currency or Training Token Type to query the Price for
regionId ID

The ID of the Region to query the Price for
accountId ID

The Account to query the Price for (blank is for e.g. In progress Account-less Opportunities)
pricingAgreementValidityDateTime TimeZonedDateTime

The DateTime to query if there's a Pricing Agreement Price in effect
isNewPrivateEvent = false Boolean

Whether or not the Sellable is a new Private Event
priceLevelId ID

The Price Level to query the Price for (only applicable for Public Events and Learning Paths)
financialAccounts : FinancialAccountConnection!

Fetches a list of Financial Accounts

Argument Type Description
filters = [] [FinancialAccountFieldGraphFilter]
order = "__EMPTY__" FinancialAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FinancialAccountFieldGraphOrder]
folders : FolderConnection!

DMS folder

Argument Type Description
filters = [] [FolderFieldGraphFilter]
order = "__EMPTY__" FolderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FolderFieldGraphOrder]
formSubmissions : FormSubmissionConnection!

Fetches a page of Form Submissions.

Argument Type Description
filters = [] [FormSubmissionFieldGraphFilter]
order = "__EMPTY__" FormSubmissionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FormSubmissionFieldGraphOrder]
formTemplateFields : [FormTemplateField!]!

The fields of every form template with whether their values are included in global search. Super Users only.

generateId : ID!

Generates an encoded API ID given the type and numeric ID provided

Argument Type Description
type String!

the entity type (e.g. "Organisation", "Person", "Course" etc.)
id Int!

the numeric identifier for the entity
giftVoucherConfigurations : GiftVoucherConfigurationConnection!

Fetches a list of Gift Voucher Configurations

Argument Type Description
filters = [] [GiftVoucherConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherConfigurationFieldGraphOrder]
giftVouchers : GiftVoucherConnection!

Fetches a list of Gift Vouchers

Argument Type Description
filters = [] [GiftVoucherFieldGraphFilter]
order = "__EMPTY__" GiftVoucherFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherFieldGraphOrder]
globalSearch : SearchResult!

Searches for the provided query string across the system and returns any matching entities (see return type documentation for details)

Argument Type Description
query String!

the string to search for
gradeTemplates : GradeTemplateConnection!

Fetches a page of Grade Templates

Argument Type Description
filters = [] [GradeTemplateFieldGraphFilter]
order = "__EMPTY__" GradeTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GradeTemplateFieldGraphOrder]
hello : String!

Returns "Hello"

honorifics : [Honorific!]!

Returns a list of Honorifics

identityProviders : IdentityProviderConnection!

Fetches a list of Identity Provider

Argument Type Description
filters = [] [IdentityProviderFieldGraphFilter]
order = "__EMPTY__" IdentityProviderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [IdentityProviderFieldGraphOrder]
industries : IndustryConnection!

Fetches a list of Industries

Argument Type Description
filters = [] [IndustryFieldGraphFilter]
order = "__EMPTY__" IndustryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [IndustryFieldGraphOrder]
instructorAbsenceReasons : InstructorAbsenceReasonConnection!

Fetches a list of Instructor Absence Reasons

Argument Type Description
filters = [] [InstructorAbsenceReasonFieldGraphFilter]
order = "__EMPTY__" InstructorAbsenceReasonFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InstructorAbsenceReasonFieldGraphOrder]
instructorCourseRates : InstructorCourseRateConnection!

Fetches a list of Instructor Course Rates

Argument Type Description
filters = [] [InstructorCourseRateFieldGraphFilter]
order = "__EMPTY__" InstructorCourseRateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InstructorCourseRateFieldGraphOrder]
integrationRetry : IntegrationRetryConnection!

Returns a list of integration runs that have been re-attempted

Argument Type Description
filters = [] [IntegrationRetryFieldGraphFilter]
order = "__EMPTY__" IntegrationRetryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [IntegrationRetryFieldGraphOrder]
invoices : InvoiceConnection!

Fetches a list of the available Invoices

Argument Type Description
filters = [] [InvoiceFieldGraphFilter]
order = "__EMPTY__" InvoiceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InvoiceFieldGraphOrder]
isPromotionCodeValidForBrand : Boolean!

Returns whether the specified promotion code is valid for the brand

Argument Type Description
code String!

the promotion code to validate
brandId String!

the ID of the Brand to validate against
jobRoles : JobRoleConnection!

Fetches a list of Job Roles

Argument Type Description
filters = [] [JobRoleFieldGraphFilter]
order = "__EMPTY__" JobRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [JobRoleFieldGraphOrder]
leadDeadReasons : LeadDeadReasonConnection!

Fetches a page of Lead Dead Reasons.

Argument Type Description
filters = [] [LeadDeadReasonFieldGraphFilter]
order = "__EMPTY__" LeadDeadReasonFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LeadDeadReasonFieldGraphOrder]
learnerAssessments : LearnerAssessmentConnection!

Fetches a page of Learner Assessments

Argument Type Description
filters = [] [LearnerAssessmentFieldGraphFilter]
order = "__EMPTY__" LearnerAssessmentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerAssessmentFieldGraphOrder]
learners : LearnerConnection!

Fetches a paginated list of event learners.

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
learnersStats : LearnersStatsConnection!

Fetches statistics of learners for current event.

Argument Type Description
filters = [] [LearnersStatsFieldGraphFilter]
order = "__EMPTY__" LearnersStatsFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnersStatsFieldGraphOrder]
learningCategories : LearningCategoryConnection!

Fetches a page of Learning Categories

Argument Type Description
filters = [] [LearningCategoryFieldGraphFilter]
order = "__EMPTY__" LearningCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningCategoryFieldGraphOrder]
learningPathEventSelectionOptions : LearningPathEventSelectionOptionConnection!

Fetches suitable Events that can fulfil a Course Objective on a Learning Path. A learningPathId or learningObjectiveId must be provided.

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
learningPathId ID

if provided, all suitable Events for all of the Learning Path Course Objectives will be returned.
learningObjectiveId ID

if provided, all suitable Events for the given Course Objective ID will be returned.
learningPathLearners : LearningPathLearnerConnection!

Fetches a list of Learning Path Learners

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
learningPaths : LearningPathConnection!

Fetches a list of LearningPaths

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
customFieldFilters [CustomFieldFilter]

Filter by Learning Path Custom Field values, where each filter's id is a CustomFieldDefinition ID
learningTags : LearningTagConnection!

Fetches a list of Learning Tags

Argument Type Description
filters = [] [LearningTagFieldGraphFilter]
order = "__EMPTY__" LearningTagFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningTagFieldGraphOrder]
legacyIdFromNodeId : String!

Translates a nodeId to the record identifier used in previous versions of Administrate’s API.

Argument Type Description
nodeId String!

The ID of the Node
lmsConfiguration : LMSConfiguration!

Returns the LMS portal user configuration

lmsIntegrationSettings : LmsIntegrationSettings!

Fetches LMS Integration Settings

locales : LocaleConnection!

Fetches a list of Locales

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
locations : LocationConnection!

Fetches a list of Locations

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
marketingActivities : MarketingActivityConnection!

Fetches a list of Marketing Activities

Argument Type Description
filters = [] [MarketingActivityFieldGraphFilter]
order = "__EMPTY__" MarketingActivityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MarketingActivityFieldGraphOrder]
marketingLists : MarketingListConnection!

Fetches Marketing Lists.

Argument Type Description
filters = [] [MarketingListFieldGraphFilter]
order = "__EMPTY__" MarketingListFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MarketingListFieldGraphOrder]
marketingSourceTypes : MarketingSourceTypeConnection!

Fetches a list of MarketingSourceTypes that match a list of filters

Argument Type Description
filters = [] [MarketingSourceTypeFieldGraphFilter]
order = "__EMPTY__" MarketingSourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MarketingSourceTypeFieldGraphOrder]
memberships : MembershipConnection!

Fetches a list of Memberships

Argument Type Description
filters = [] [MembershipFieldGraphFilter]
order = "__EMPTY__" MembershipFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MembershipFieldGraphOrder]
node : Node

Fetches the Node with the given ID

Argument Type Description
id ID!

The ID of the Node
nodeByExternalId : Node

Find a Node given an External ID

Argument Type Description
type SupportsExternalIDType!

Node type
name String!

External ID name
value String!

External ID value
nodesByExternalId : NodeConnection!

Returns a page of Nodes given an External ID name and a list of External ID Values

Argument Type Description
type SupportsExternalIDType!

Node type
name String!

External ID name
values [String]!

List of External ID values :poram limit: The maximum number of nodes per Connection page
limit = 50 Int
offset = 0 Int

The offset to start returning results from
opportunities : OpportunityConnection!

Fetches a page of Opportunities

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
opportunityAttributes : OpportunityAttributeConnection!

Fetches a list of all attributes available for an Opportunity

Argument Type Description
filters = [] [OpportunityAttributeFieldGraphFilter]
order = "__EMPTY__" OpportunityAttributeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityAttributeFieldGraphOrder]
opportunitySections : OpportunitySectionConnection!

Fetches a list of all sections available for an Opportunity

Argument Type Description
filters = [] [OpportunitySectionFieldGraphFilter]
order = "__EMPTY__" OpportunitySectionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunitySectionFieldGraphOrder]
opportunityStages : OpportunityStageConnection!

Fetches a list of all stages available for an Opportunity Step

Argument Type Description
filters = [] [OpportunityStageFieldGraphFilter]
order = "__EMPTY__" OpportunityStageFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStageFieldGraphOrder]
opportunitySteps : OpportunityStepConnection!

Fetches a list of all steps available for an Opportunity

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
opportunityTransitions : OpportunityTransitionConnection!

Fetches a list of all transitions available for an Opportunity

Argument Type Description
filters = [] [OpportunityTransitionFieldGraphFilter]
order = "__EMPTY__" OpportunityTransitionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityTransitionFieldGraphOrder]
orderPointOfSaleFields : OrderPointOfSaleFieldConnection!

Fetches a list of configured Order Point of Sale fields

Argument Type Description
filters = [] [OrderPointOfSaleFieldFieldGraphFilter]
order = "__EMPTY__" OrderPointOfSaleFieldFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OrderPointOfSaleFieldFieldGraphOrder]
paymentMethodTypes : [PaymentMethodType!]!

Fetches a list of Payment Method Types

paymentRegions : PaymentRegionConnection!

Fetches a list of Payment Region Types

Argument Type Description
filters = [] [PaymentRegionFieldGraphFilter]
order = "__EMPTY__" PaymentRegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PaymentRegionFieldGraphOrder]
payments : PaymentConnection!

Fetches a list of Payments

Argument Type Description
filters = [] [PaymentFieldGraphFilter]
order = "__EMPTY__" PaymentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PaymentFieldGraphOrder]
plans : PlanConnection!

Fetches a list of Plans

Argument Type Description
filters = [] [PlanFieldGraphFilter]
order = "__EMPTY__" PlanFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PlanFieldGraphOrder]
portalForHost : Portal

Fetches a Portal for a specified Host URL

Argument Type Description
host URL!

The Host URL of the Portal to fetch
portalLoginHistory : PortalLoginHistoryConnection!

Fetches a list of Portal Login History records

Argument Type Description
filters = [] [PortalLoginHistoryFieldGraphFilter]
order = "__EMPTY__" PortalLoginHistoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalLoginHistoryFieldGraphOrder]
portals : PortalConnection!

Fetches a list of Portals

Argument Type Description
filters = [] [PortalFieldGraphFilter]
order = "__EMPTY__" PortalFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalFieldGraphOrder]
priceLevels : PriceLevelConnection!

Fetches a list of the available Price Levels

Argument Type Description
filters = [] [PriceLevelFieldGraphFilter]
order = "__EMPTY__" PriceLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PriceLevelFieldGraphOrder]
pricingBands : PricingBandConnection!

Fetches a list of the available Pricing Bands

Argument Type Description
filters = [] [PricingBandFieldGraphFilter]
order = "__EMPTY__" PricingBandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PricingBandFieldGraphOrder]
promotionCampaigns : PromotionCampaignConnection!

Fetches a page of Promotion Campaigns

Argument Type Description
filters = [] [PromotionCampaignFieldGraphFilter]
order = "__EMPTY__" PromotionCampaignFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PromotionCampaignFieldGraphOrder]
provinceByCode : Province

Returns a Province given its code

Argument Type Description
code String!

the Province code to search for
provincesByCodes : [Province]!

Returns a list of Provinces given a list of codes

Argument Type Description
codes [String]!

the list of Province codes to search for
purchaseLedger : PurchaseDocumentConnection!

Fetches a page of all Purchase Ledger entries (Invoices, Orders, Credit Notes and Payments)

Argument Type Description
filters = [] [PurchaseDocumentFieldGraphFilter]
order = "__EMPTY__" PurchaseDocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PurchaseDocumentFieldGraphOrder]
refunds : RefundConnection!

Fetches a list of Refunds

Argument Type Description
filters = [] [RefundFieldGraphFilter]
order = "__EMPTY__" RefundFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RefundFieldGraphOrder]
regions : RegionConnection!

Fetches a page of Regions

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
registerables : RegisterableConnection!

Fetches a page of items that have been part of a Registration, such as Events or Learning Paths

Argument Type Description
filters = [] [RegisterableFieldGraphFilter]
order = "__EMPTY__" RegisterableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegisterableFieldGraphOrder]
registrationRules : RegistrationRuleConnection!

Fetches a list of Automatic Learning Path Registration Rules

Argument Type Description
filters = [] [RegistrationRuleFieldGraphFilter]
order = "__EMPTY__" RegistrationRuleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationRuleFieldGraphOrder]
registrations : RegistrationConnection!

Fetches a page of Registrations

Argument Type Description
filters = [] [RegistrationFieldGraphFilter]
order = "__EMPTY__" RegistrationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationFieldGraphOrder]
remoteMeetingProviders : [RemoteMeetingProvider!]!

Returns a list of all Remote Meeting Providers with their configuration status. Each provider is marked as active if configured via webhooks, inactive otherwise.

reports : ReportConnection!

Fetches a page of saved Reports

Argument Type Description
filters = [] [ReportFieldGraphFilter]
order = "__EMPTY__" ReportFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ReportFieldGraphOrder]
resourceBookingReasons : ResourceBookingReasonConnection!

Fetches a list of Resource Booking Reasons

Argument Type Description
filters = [] [ResourceBookingReasonFieldGraphFilter]
order = "__EMPTY__" ResourceBookingReasonFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceBookingReasonFieldGraphOrder]
resourceBookings : ResourceBookingConnection!

Fetches a page of Resource bookings

Argument Type Description
filters = [] [ResourceBookingFieldGraphFilter]
order = "__EMPTY__" ResourceBookingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceBookingFieldGraphOrder]
resourceStats : ResourceStatConnection!

Fetches a page of Resources statistics such as booking count

Argument Type Description
filters = [] [ResourceStatFieldGraphFilter]
order = "__EMPTY__" ResourceStatFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceStatFieldGraphOrder]
resourceTypes : ResourceTypeConnection!

Fetches a page of Resource Types

Argument Type Description
filters = [] [ResourceTypeFieldGraphFilter]
order = "__EMPTY__" ResourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceTypeFieldGraphOrder]
resources : ResourceConnection!

Fetches a page of Resources

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
salesLedger : SalesDocumentConnection!

Fetches a page of all Sales Ledger entries (Invoices, Credit Notes, Sales Orders and Payments)

Argument Type Description
filters = [] [SalesDocumentFieldGraphFilter]
order = "__EMPTY__" SalesDocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SalesDocumentFieldGraphOrder]
sendingEmailAddresses : SendingEmailAddressConnection!

Fetches a list of Sending Email Addresses

Argument Type Description
filters = [] [SendingEmailAddressFieldGraphFilter]
order = "__EMPTY__" SendingEmailAddressFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingEmailAddressFieldGraphOrder]
sendingPhoneNumbers : SendingPhoneNumberConnection!

Fetches a list of Sending Phone Numbers

Argument Type Description
filters = [] [SendingPhoneNumberFieldGraphFilter]
order = "__EMPTY__" SendingPhoneNumberFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingPhoneNumberFieldGraphOrder]
staff : StaffConnection!

Fetches a page of Staff members

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
staffRoles : StaffRoleConnection!

Fetches a page of Staff Roles

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
staffUnavailability : StaffUnavailabilityConnection!

Fetches a list of Staff Unavailabilities

Argument Type Description
filters = [] [StaffUnavailabilityFieldGraphFilter]
order = "__EMPTY__" StaffUnavailabilityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffUnavailabilityFieldGraphOrder]
standardFieldValidations : [StandardFieldValidation!]!

Fetches a list of configured validations for our form fields

Argument Type Description
entityType StandardFieldValidationEntityType
stockItems : StockItemConnection!

Fetches a list of the available Stock Items

Argument Type Description
filters = [] [StockItemFieldGraphFilter]
order = "__EMPTY__" StockItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StockItemFieldGraphOrder]
suggestString : [String]!

Fetches the top 30 most likely results for a given category of object matching a given search string, ordered alphabetically. Useful for typeahead searches

Argument Type Description
queryString String!

The search text
category StringSuggestionServiceCategory!

The type of results to search for
surveys : SurveyConnection!

Fetches a page of Surveys

Argument Type Description
filters = [] [SurveyFieldGraphFilter]
order = "__EMPTY__" SurveyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SurveyFieldGraphOrder]
systemSettings : SystemSettings!

Returns editable SystemSettings administration queries.

taskAuditLogEntries : TaskAuditLogEntryConnection!

Fetches a page of Task audit log entries. Filter by eventId for the history of one Event's tasks. Requires the Event view permission.

Argument Type Description
filters = [] [TaskAuditLogEntryFieldGraphFilter]
order = "__EMPTY__" TaskAuditLogEntryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskAuditLogEntryFieldGraphOrder]
taskTypes : TaskTypeConnection!

Fetches a list of Task Types that match a list of filters

Argument Type Description
filters = [] [TaskTypeFieldGraphFilter]
order = "__EMPTY__" TaskTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskTypeFieldGraphOrder]
taskWorkflows : TaskWorkflowConnection!

Fetches a list of Task Workflows that match a list of filters

Argument Type Description
filters = [] [TaskWorkflowFieldGraphFilter]
order = "__EMPTY__" TaskWorkflowFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskWorkflowFieldGraphOrder]
tasks : TaskConnection!

Fetches a list of Tasks that match a list of filters

Argument Type Description
filters = [] [TaskFieldGraphFilter]
order = "__EMPTY__" TaskFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskFieldGraphOrder]
taxTypes : TaxTypeConnection!

Fetches a list of Tax Types that match a list of filters

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
trainingPassTypes : TrainingPassTypeConnection!

Fetches a list of Training Pass Types

Argument Type Description
filters = [] [TrainingPassTypeFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeFieldGraphOrder]
trainingPasses : TrainingPassConnection!

Fetches a list of Training Passes

Argument Type Description
filters = [] [TrainingPassFieldGraphFilter]
order = "__EMPTY__" TrainingPassFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassFieldGraphOrder]
trainingTokenIssues : TrainingTokenIssueConnection!

Fetches a list of Training Token Issues

Argument Type Description
filters = [] [TrainingTokenIssueFieldGraphFilter]
order = "__EMPTY__" TrainingTokenIssueFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenIssueFieldGraphOrder]
trainingTokenTransactions : TrainingTokenTransactionConnection!

Fetches a list of Training Token Transactions

Argument Type Description
filters = [] [TrainingTokenTransactionFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTransactionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTransactionFieldGraphOrder]
trainingTokenTypes : TrainingTokenTypeConnection!

Fetches a list of Training Token Types that match a list of filters

Argument Type Description
filters = [] [TrainingTokenTypeFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTypeFieldGraphOrder]
triggerEmails : TriggerEmailConnection!

Fetches a list of Trigger Emails

Argument Type Description
filters = [] [TriggerEmailFieldGraphFilter]
order = "__EMPTY__" TriggerEmailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerEmailFieldGraphOrder]
triggerLogs : TriggerLogConnection!

Fetches a list of Trigger Logs

Argument Type Description
filters = [] [TriggerLogFieldGraphFilter]
order = "__EMPTY__" TriggerLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerLogFieldGraphOrder]
triggerSms : TriggerSmsConnection!

Fetches a list of Trigger Sms

Argument Type Description
filters = [] [TriggerSmsFieldGraphFilter]
order = "__EMPTY__" TriggerSmsFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerSmsFieldGraphOrder]
triggers : TriggerConnection!

Fetches a list of Triggers

Argument Type Description
filters = [] [TriggerFieldGraphFilter]
order = "__EMPTY__" TriggerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerFieldGraphOrder]
triggersForEvent : [Trigger!]!

List of Triggers that apply to the given event.

Argument Type Description
event_id ID!
filters = [] [TriggerFieldGraphFilter]
order = "__EMPTY__" TriggerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerFieldGraphOrder]
unregisteredLearnerGroups : UnregisteredLearnerGroupConnection!

Fetches a page of unregistered Learners

Argument Type Description
filters = [] [UnregisteredLearnerGroupFieldGraphFilter]
order = "__EMPTY__" UnregisteredLearnerGroupFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UnregisteredLearnerGroupFieldGraphOrder]
usageStats : UsageStats!

Returns some platform usage statistics over the time period specified

Argument Type Description
filterFrom TimeZonedDateTime!

the start point of the time range to show statistics for
filterTo TimeZonedDateTime!

the end point of the time range to show statistics for
userRoles : UserRoleConnection!

Fetches a list of the available User Roles

Argument Type Description
filters = [] [UserRoleFieldGraphFilter]
order = "__EMPTY__" UserRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserRoleFieldGraphOrder]
users : UserConnection!

Fetches a list of Users

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
venues : VenueConnection!

Fetches a list of Venues

Argument Type Description
filters = [] [VenueFieldGraphFilter]
order = "__EMPTY__" VenueFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [VenueFieldGraphOrder]
verifyPromotionCode : Boolean!

Verifies if a Promotion code can be applied

Argument Type Description
code String!

the promotion code to validate
viewer : Viewer!

Details about the user currently accessing the API, including permissions and notifications

webhookLogs : WebhookLogConnection!

Fetches a list of webhook logs

Argument Type Description
filters = [] [WebhookLogFieldGraphFilter]
order = "__EMPTY__" WebhookLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WebhookLogFieldGraphOrder]
webhookTypes : WebhookTypeConnection!

Fetches a list of webhook types

Argument Type Description
filters = [] [WebhookTypeFieldGraphFilter]
order = "__EMPTY__" WebhookTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WebhookTypeFieldGraphOrder]
webhooks : WebhookConnection!

Fetches a list of configured Webhooks

Argument Type Description
filters = [] [WebhookFieldGraphFilter]
order = "__EMPTY__" WebhookFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WebhookFieldGraphOrder]
welcomeMessages : WelcomeMessageConnection!

Fetches a list of Welcome Messages

Argument Type Description
filters = [] [WelcomeMessageFieldGraphFilter]
order = "__EMPTY__" WelcomeMessageFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WelcomeMessageFieldGraphOrder]
workingPatternRealization : WorkingPatternRealization

Returns the realization of a Working Pattern Rotation for a given length based on a start date

Argument Type Description
rotationId ID!

The Rotation ID to realize
startDate Date!

The Start Date to start the realization from
days Int!

The amount of days to calculate this realization for
workingPatterns : WorkingPatternConnection!

Returns a list of WorkingPatterns

Argument Type Description
filters = [] [WorkingPatternFieldGraphFilter]
order = "__EMPTY__" WorkingPatternFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WorkingPatternFieldGraphOrder]
workplaces : WorkplaceConnection!

Fetches a list of Workplaces

Argument Type Description
filters = [] [WorkplaceFieldGraphFilter]
order = "__EMPTY__" WorkplaceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WorkplaceFieldGraphOrder]
Preview fields (1)

Preview fields may change. Contact Support to request access.

summary : Summary

Returns a collection of summaries of ADM activities over past day
Preview true
Deprecated fields (2)
contactCustomSystemFieldDefinitions : [ContactCustomSystemFieldDefinition!]!

Removal date: TBD.

Replaced by custom fields

taskWorkflowGroups : TaskWorkflowGroupConnection!

Fetches a list of Task Workflow Groups that match a list of filters

Removal date: 2026-06-26.

Replaced by taskWorkflows

Argument Type Description
filters = [] [TaskWorkflowGroupFieldGraphFilter]
order = "__EMPTY__" TaskWorkflowGroupFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskWorkflowGroupFieldGraphOrder]
Back to top

Mutation

Root Mutation Type

account : AccountMutations!

Mutations for Accounts

accountAssociationTypes : AccountAssociationTypeMutations!

Mutations for Account Association Types

accountProject : AccountProjectMutations!

Mutations for Account Projects

achievement : AchievementMutations!

Mutations for Achievements

achievementNumberSequence : AchievementNumberSequenceMutations!

Mutations for Achievement Number Sequences

achievementType : AchievementTypeMutations!

Mutations for Achievement Types

address : AddressMutations!

Mutations for Addresses

adhocSms : AdhocSmsMutations!

Mutations for sending adhoc sms to learners on events

authorizedApplications : AuthorizedApplicationsMutations!

Mutations for managing Authorized Applications

automatorSettings : AutomatorSettingsMutations!

Mutations for managing Automator Settings

brands : BrandMutations!

Mutations for Brands

bulkAdhocEmails : BulkAdhocEmailMutations!

Mutations for sending adhoc emails for Events with large amounts of learners

calendarIntegration : CalendarIntegrationMutations!

Mutations for managing the Calendar Integration

calendarIntegrationSettings : CalendarIntegrationSettingsMutations!

Mutations for managing Calendar Integration Settings

cancellationReasons : CancellationReasonMutations!

Mutations for Cancellation Reasons.

cancellationRequest : CancellationRequestMutations!

Mutations for Cancellation Requests

certificateType : CertificateTypeMutations!

Mutations for Certificate Types

communication : CommunicationMutations!

Mutations for Communications

communicationTemplate : CommunicationTemplateMutations!

Mutations for Communication Templates

companies : CompanyMutations!

Mutations for Companies

contact : ContactMutations!

Mutations for Contacts

contactAdhocEmails : ContactAdhocEmailMutations!

Mutations for sending ad-hoc emails to specific Contacts

contactCredentials : ContactCredentialsMutations!

Mutations for Contact Credentials

courseTemplate : CourseTemplateMutations!

Mutations for Course Templates

creditNotes : CreditNoteMutations!

Mutations for Credit Notes

customFields : CustomFieldMutations!

Mutations for Custom Fields

customTranslations : CustomTranslationMutations!

Mutations for Custom Translations

dataImports : DataImportMutations!

Mutations to manage processing of bulk data
DataImportIgnore true
discountPromotionCodes : DiscountPromotionCodeMutations!

Mutations for Discount Promotion Codes

discounts : DiscountMutations!

Mutations for Discounts

documentCategory : DocumentCategoryMutations!

Mutations for Document Categories

documentTemplates : DocumentTemplateMutations!

Mutations for Document Templates

documents : DocumentMutations!

Mutations for Documents

emailAccounts : EmailAccountMutations!

Mutations for Email Accounts

enquiries : EnquiryMutations!

Mutations for Enquiries

event : EventMutations!

Mutations for Events

eventBreakout : EventBreakoutMutations!

Mutations for Event Breakouts

externalConfiguration : ExternalConfigurationMutations!

Mutations for External Configurations

externalId : ExternalIDMutations!

Mutations for External IDs

externalLog : ExternalLogMutations!

Mutations for External Logs

externalLogOrigin : ExternalLogOriginMutations!

Mutations for External Log Origins

folders : FolderMutations!

Mutations for Folders

formSubmissions : FormSubmissionMutations!

Mutations for Form Submissions

giftVouchers : GiftVoucherMutations!

Mutations for Gift Vouchers

identityProviders : IdentityProviderMutations!

Mutations for Identity Providers

instructorAbsenceReason : InstructorAbsenceReasonMutations!

Mutations for Instructor Absence Reasons

instructorCourseRate : InstructorCourseRateMutations!

Mutations for Instructor Course Rates

integrationRetry : IntegrationRetryMutations!

Mutations for Integration Retries

invoices : InvoiceMutations!

Mutations for Invoices

jobRole : JobRoleMutations!

Mutations for Job Roles

learner : LearnerMutations!

Mutations for Learners

learnerAssessments : LearnerAssessmentMutations!

Mutations for Learner Assessments

learningCategories : LearningCategoryMutations!

Mutations for Learning Categories

learningObjectives : LearningObjectiveMutations!

Mutations for Learning Objectives

learningOutcomes : LearningOutcomeMutations!

Mutations for Learning Outcomes

learningPaths : LearningPathMutations!

Mutations for Learning Paths

learningTags : LearningTagMutations!

Mutations for Learning Tags

lmsIntegrationSettings : LmsIntegrationSettingsMutations!

Mutations for managing LMS Integration Settings

locale : LocaleMutations!

Mutations for Locales

location : LocationMutations!

Mutations for Locations

membership : MembershipMutations!

Mutations for Memberships

opportunities : OpportunityMutations!

Mutations for Opportunities

opportunityAttributes : OpportunityAttributeMutations!

Mutations for Opportunity Attributes

opportunitySteps : OpportunityStepMutations!

Mutations for Opportunity Steps

opportunityTransitions : OpportunityTransitionMutations!

Mutations for Opportunity Transitions

plan : PlanMutations!

Mutations for Plans

portals : PortalMutations!

Mutations for Portals

priceLevels : PriceLevelMutations!

Mutations for Price Levels

promotionCampaign : PromotionCampaignMutations!

Mutations for Promotion Campaigns

purchaseCreditNotes : PurchaseCreditNoteMutations!

Mutations for Purchase Credit Notes

purchaseInvoices : PurchaseInvoiceMutations!

Mutations for Purchase Invoices

regions : RegionMutations!

Mutations for Regions

registration : RegistrationMutations!

Mutations for Registrations

registrationRules : RegistrationRuleMutations!

Mutations for RegistrationRules

resourceBooking : ResourceBookingMutations!

Mutations for Resource Bookings

resourceBookingReason : ResourceBookingReasonMutations!

Mutations for Resource Booking Reasons

resourceTypes : ResourceTypeMutations!

Mutations for Resource Types.

resources : ResourceMutations!

Mutations for Resources

sendingAddresses : SendingAddressMutations!

Mutations for Sending Addresses

session : SessionMutations!

Mutations for Sessions

staffRoles : StaffRoleMutations!

Mutations for Staff Roles

staffUnavailability : StaffUnavailabilityMutations!

Mutations for Staff Unavailability

standardFieldValidations : StandardFieldValidationMutations!

Mutations for Standard Field Validations

stockItem : StockItemMutations!

Mutations for Stock Items

summaryIntegration : SummaryIntegrationMutations!

Mutations for managing the Summary Integration

systemSettings : SystemSettingsMutations!

Mutations for editable system settings.

taskTemplates : TaskTemplateMutations!

Mutations for Task Templates

taskWorkflows : TaskWorkflowMutations!

Mutations for Task Workflows

tasks : TaskMutations!

Mutations for Tasks

taxTypes : TaxTypeMutations!

Mutations for Tax Types

trainingPass : TrainingPassMutations!

Mutations for Training Passes

trainingTokenBalances : TokenBalanceMutations!

Mutations for Training Token Balances

trainingTokenIssues : TokenIssueMutations!

Mutations for Training Token Issues

trainingTokenTransaction : TokenTransactionMutations!

Mutations for Training Token Transactions

triggers : TriggerMutations!

Mutations for Triggers

users : UserMutations!

Mutations for Users

webhooks : WebhookMutations!

Mutations for Webhooks

welcomeMessage : WelcomeMessageMutations!

Mutations for Welcome Messages

workingPatterns : WorkingPatternMutations!

Mutations for Working Patterns

workplaces : WorkplaceMutations!

Mutations for Workplaces

Deprecated fields (3)
customField : DeprecatedCustomFieldMutations!

Removal date: TBD.

Replaced by customFields

opportunity : DeprecatedOpportunityMutations!

Removal date: TBD.

Replaced by opportunities

taskWorkflowGroups : TaskWorkflowGroupMutations!

Mutations for Task Workflow Groups

Removal date: 2026-06-26.

replaced by taskWorkflows

Back to top

Account

An organisation which groups Contacts together

Related types: Node

ancestors : [AccountAncestor!]!

An ordered list of Account ancestors for this account

billingContact : Contact

The Contact that Bookings for this Account default their Billing Contact to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
billingEmailAddress : String

Account's Billing Email address

brand : Brand

The default brand set on this Account

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
company : Company

The Company that owns this Account

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
companyRegistrationNumber : String

The Company Registration Number for this Account

contacts : ContactConnection!

Contacts who belong to the Account

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
coordinators : ContactConnection!

The Contacts that Coordinate the Account

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime

When the account has been created

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Account

Argument Type Description
filter CustomFieldFilterInput
defaultPriceLevel : PriceLevel

The default price level set on this Account

Argument Type Description
filters = [] [PriceLevelFieldGraphFilter]
order = "__EMPTY__" PriceLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PriceLevelFieldGraphOrder]
documents : DocumentConnection!

Documents mapped to this account

emailAddress : String

Account's email address

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Account

industries : IndustryConnection

The list of Industries linked to the Account

Argument Type Description
filters = [] [IndustryFieldGraphFilter]
order = "__EMPTY__" IndustryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [IndustryFieldGraphOrder]
isCustomer : Boolean!

Whether the account is flagged as a Customer

isEmployee : Boolean!

Whether the account is flagged as an Employee

isIndividual : Boolean!

Whether the account is flagged as an Individual

isPartner : Boolean!

Whether the account is flagged as a Partner

isSupplier : Boolean!

Whether the account is flagged as a Supplier

isVenue : Boolean!

Whether the account is flagged as a Venue

lastUpdatedAt : TimeZonedDateTime

The last time the details of the Account were changed

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

members : MembershipConnection!

Primary and secondary members of the Account

Argument Type Description
filters = [] [MembershipFieldGraphFilter]
order = "__EMPTY__" MembershipFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MembershipFieldGraphOrder]
name : String!

Name of the Account

notes : String

Account's notes

owner : User

The User assigned as the owner of this Account

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
parentAccount : Account

The Parent Account of the Account

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
phoneNumbers : [AccountPhoneNumber!]!

The list of PhoneNumbers of the Account

postalAddresses : [AccountPostalAddress!]!

The list of PostalAddresses of the Account

pricingAgreements : PricingAgreementConnection!

The list of Pricing Agreements linked to the Account

Argument Type Description
filters = [] [PricingAgreementFieldGraphFilter]
order = "__EMPTY__" PricingAgreementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PricingAgreementFieldGraphOrder]
primaryContact : Contact

The primary Contact of the Account

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
projects : AccountProjectConnection!

The list of Account Projects linked to the Account

Argument Type Description
filters = [] [AccountProjectFieldGraphFilter]
order = "__EMPTY__" AccountProjectFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountProjectFieldGraphOrder]
receiveNoPublicity : Boolean!

Whether the account is flagged to not receive any publicity

rootAccount : Account

The Account with which the Pricing Agreement is associated

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
source : MarketingSource

The Marketing Source of this Account

trainingPasses : TrainingPassConnection!

The Training Passes that belong to this Account

Argument Type Description
filters = [] [TrainingPassFieldGraphFilter]
order = "__EMPTY__" TrainingPassFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassFieldGraphOrder]
trainingTokenAccounts : TrainingTokenAccountConnection!

The entity which relates an Account to many Token Issues.

Argument Type Description
filters = [] [TrainingTokenAccountFieldGraphFilter]
order = "__EMPTY__" TrainingTokenAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenAccountFieldGraphOrder]
vatNumber : String

Account's VAT Number

weblinkSettings : AccountWeblinkSettings!

Settings that determine how the Account behaves when used in Weblink Portals

website : String

Account's Website URL

workingPatterns : [WorkingPattern!]!

All the Working Patterns available to this account

Argument Type Description
filters = [] [WorkingPatternFieldGraphFilter]
order = "__EMPTY__" WorkingPatternFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WorkingPatternFieldGraphOrder]
Back to top

AccountAncestor

Entity representing an Account's Ancestor in the Account's hierarchy

id : ID!

ID of the Account Ancestor

name : String!

Name of the Account Ancestor

Back to top

AccountAssociation

Allows Course Templates and Learning Paths to be linked to any Account via one or more configurable Account Association Types.

Related types: Node

account : Account!

The Account associated with the Course Template or Learning Path

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
associationType : AccountAssociationType!

The Account Association type

Argument Type Description
filters = [] [AccountAssociationTypeFieldGraphFilter]
order = "__EMPTY__" AccountAssociationTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountAssociationTypeFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Account Association

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

AccountAssociationConnection

A connection containing page information and edges for AccountAssociation

edges : [AccountAssociationEdge!]!

The list of AccountAssociation edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AccountAssociationEdge

Contains cursor and node information for type AccountAssociation

cursor : String!

A string that can be used for cursor-based pagination

node : AccountAssociation!

The AccountAssociation node.

Back to top

AccountAssociationField

Fields for filtering and ordering Account Associations

id
Back to top

AccountAssociationFieldGraphFilter

Filter that can be applied to limit which AccountAssociation nodes are returned

field : AccountAssociationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AccountAssociationFieldGraphOrder

Specifies the order in which AccountAssociation nodes are returned via the Connection

field : AccountAssociationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AccountAssociationType

The Type of Association an Account has with a Course Template or Learning Path e.g. Partner, Sponsor, Strategic Partner etc.

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Account Association Type

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Account Association Type

Back to top

AccountAssociationTypeConnection

A connection containing page information and edges for AccountAssociationType

edges : [AccountAssociationTypeEdge!]!

The list of AccountAssociationType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AccountAssociationTypeCreateInput

An input for creating an Account Association Type

name : String!

The name given to the Account Association Type (e.g. Partner)

Back to top

AccountAssociationTypeDeleteInput

An input for deleting an Account Association Type

accountAssociationTypeId : ID!

The ID of the Account Association Type to be deleted

Back to top

AccountAssociationTypeEdge

Contains cursor and node information for type AccountAssociationType

cursor : String!

A string that can be used for cursor-based pagination

node : AccountAssociationType!

The AccountAssociationType node.

Back to top

AccountAssociationTypeField

Fields for filtering and ordering Account Association Types

id
name
Back to top

AccountAssociationTypeFieldGraphFilter

Filter that can be applied to limit which AccountAssociationType nodes are returned

field : AccountAssociationTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AccountAssociationTypeFieldGraphOrder

Specifies the order in which AccountAssociationType nodes are returned via the Connection

field : AccountAssociationTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AccountAssociationTypeMutateResponse

A Response from mutating an Account Association Type

Related types: MutationResponse

accountAssociationType : AccountAssociationType

The Account Association Type that was created

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AccountAssociationTypeMutations

Mutations for Account Association Types

create : AccountAssociationTypeMutateResponse!

Creates an Account Association Type

Argument Type Description
input AccountAssociationTypeCreateInput!

The input type with the values to be set on the new Account Association Type
delete : AccountAssociationTypeMutateResponse!

Deletes an Account Association Type

Argument Type Description
input AccountAssociationTypeDeleteInput!

The input type with the ID of the Account Association Type to be deleted
Back to top

AccountConnection

A connection containing page information and edges for Account

edges : [AccountEdge!]!

The list of Account edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AccountCreateInput

An Input for creating an Account

name : String!

The name of the Account

emailAddress : String

The email address of the Account

billingEmailAddress : String

The billing email address of the Account

website : String

The website URL of the Account

notes : String

The notes of the Account

phoneNumbers : [AccountPhoneNumberInput]

The list of PhoneNumbers of the Account

postalAddresses : [AccountPostalAddressInput]

The list of PostalAddresses of the Account

source : MarketingSourceInput

The new MarketingSource of the Account

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Account

weblinkSettings : AccountWeblinkSettingsInput

The Weblink Settings of the Account

parentAccountId : ID

The ID of the Account that will be the immediate ancestor of the new Account. Cannot be defined in the same mutation call as parentAccountExternalId

parentAccountExternalId : ExternalIdInput

An External Id that identifies the Account that will be the immediate ancestor of the new Account. Cannot be defined in the same mutation call as parentAccountId

isCustomer : Boolean

The field that marks an Account as a Customer

brandId : ID

The ID of the default brand set on this Account

companyId : ID

The ID of the Company that owns this Account

ownerId : ID

The User assigned as the owner of this Account

companyRegistrationNumber : String

The Company Registration Number for this Account

vatNumber : String

The Account's VAT Number

isEmployee : Boolean

Whether the account is flagged as an Employee

isPartner : Boolean

Whether the account is flagged as a Partner

receiveNoPublicity : Boolean

Whether the account is flagged to not receive any publicity

industryIds : [ID]

The IDs of the of Industries linked to the Account

isSupplier : Boolean

Whether the account is flagged as a Supplier

isVenue : Boolean

Whether the account is flagged as a Venue

Back to top

AccountDeleteBulkInput

Input type for deleting Accounts

accountIds : [ID]!
confirmed : Boolean
Back to top

AccountEdge

Contains cursor and node information for type Account

cursor : String!

A string that can be used for cursor-based pagination

node : Account!

The Account node.

Back to top

AccountField

Fields for filtering and ordering Accounts isPartner: DEPRECATED on 2024-03-11: feature will be removed on 2024-06-11

id
name
isIndividual
createdAt
website
emailAddress
billingEmailAddress
notes
landlinePhoneNumber
addressTown
rootAccountId
canSelfCheckoutByInvoice
isCoordinatedByContactId
hasActiveTrainingPass
vatNumber
lastUpdatedAt
companyName
companyId
Deprecated values (1)
isPartner

Removal date: 2024-06-11.

feature will be removed

Back to top

AccountFieldGraphFilter

Filter that can be applied to limit which Account nodes are returned

field : AccountField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AccountFieldGraphOrder

Specifies the order in which Account nodes are returned via the Connection

field : AccountField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AccountMakeIndividualInput

An Input for marking an Account as an Individual

accountId : ID!

The ID of the Account to be marked as an Individual

Back to top

AccountMergeExternalInput

An Input for merging two Accounts using their External IDs

fromAccount : ExternalIdInput!

The External ID of the Account that will be merged and then deleted

toAccount : ExternalIdInput!

The External ID of the Account that will be merged into

overwriteFromAccountExternalId : Boolean

Sets whether to override the From Account external ID with the To Account external ID when the To Account doesn't exist

fieldSelections : [AccountMergeFieldSelectionInput]

Optional per-field winners. Any field not listed uses the default rules: the surviving account wins and blank fields fill from the deleted account, except boolean flags (set if either account has them set) and industries (combined from both accounts). Omitting this is backwards compatible.

Back to top

AccountMergeField

An Account field whose value can be chosen when merging. Each member maps to the account attribute the merge service resolves. ROOT_ACCOUNT is accepted but has no effect: the root account is derived from where the surviving Account sits in the hierarchy, so it follows PARENT_ACCOUNT rather than being chosen. It is kept for backwards compatibility.

EMAIL
BILLING_EMAIL
WEBSITE
VAT_NUMBER
COMPANY_REGISTRATION_NUMBER
COMPANY
BRAND
SOURCE
PRIMARY_CONTACT
PARENT_ACCOUNT
ROOT_ACCOUNT
OWNER
NOTES
IS_CUSTOMER
IS_EMPLOYEE
IS_PARTNER
IS_SUPPLIER
IS_VENUE
NO_PUBLICITY
CAN_SELF_CHECKOUT_BY_INVOICE
INDUSTRIES
Back to top

AccountMergeFieldSelectionInput

Chooses which account wins for a single field in a merge.

field : AccountMergeField!

The Account field to choose a value for

winner : AccountMergeWinner!

Which account (surviving or deleted) the value comes from

Back to top

AccountMergeInput

An Input for merging two Accounts

fromAccount : ID!

The ID of the Account that will be merged and then deleted

toAccount : ID!

The ID of the Account that will be merged into

fieldSelections : [AccountMergeFieldSelectionInput]

Optional per-field winners. Any field not listed uses the default rules: the surviving account wins and blank fields fill from the deleted account, except boolean flags (set if either account has them set) and industries (combined from both accounts). Omitting this is backwards compatible.

Back to top

AccountMergeWinner

Which account a field's value is taken from in a merge.

SURVIVING
DELETED
Back to top

AccountMutateResponse

A Response from mutating an Account

Related types: MutationResponse

account : Account

The Account that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AccountMutations

Mutations for Accounts

addPricingAgreement : AccountPricingAgreementResponse!

Adds a new Pricing Agreement to an Account

Argument Type Description
input AddPricingAgreementInput!

The input type with the values to be set on the new Pricing Agreement
addPricingAgreementPrice : AccountPricingAgreementResponse!

Adds a new Price to a Pricing Agreement

Argument Type Description
input AddPricingAgreementPriceInput!

The input type with the values to be set on the new Price
addProject : AccountProjectMutateResponse!

Adds a new Account Project linked to the Account

Argument Type Description
input AccountProjectAddInput!

The input type with the values to be set on the new Account Project
create : AccountMutateResponse!

Creates an Account

Argument Type Description
input AccountCreateInput!

The input type with the values to be set on the new Account
createBatch : [AccountMutateResponse!]!

Creates multiple Accounts A limit of 1000 per submission
DataImportIgnore true
Argument Type Description
input [AccountCreateInput]!

A list of input types containing the values to be set on the new Accounts
createIndividual : AccountMutateResponse!

Creates an Individual Account

Argument Type Description
input IndividualAccountCreateInput!

The input type with the values to be set on the new Individual Account and Contact
delete : [AccountMutateResponse!]!

Deletes Accounts.

Argument Type Description
input AccountDeleteBulkInput!

The input containing the list of the accounts IDs to delete.
deleteProject : AccountProjectMutateResponse!

Removes an Account Project from the Account

Argument Type Description
input AccountProjectDeleteInput!

Removes an Account Project from the Account
linkDocument : AccountMutateResponse!

Links a Document to an Account

Argument Type Description
input LinkDocumentAccountInput!

The input type with the values used to link a Document to the Account
makeIndividual : AccountMutateResponse!

Mark this Account as an Individual with a single Contact

Argument Type Description
input AccountMakeIndividualInput!

The input specifying the Account to be updated
makeStandard : AccountMutateResponse!

Mark this Individual Account as a Standard Account with a single Contact

Argument Type Description
input AccountMakeIndividualInput!

The input specifying the Account to be updated
merge : AccountMutateResponse!

Merges two Accounts

Argument Type Description
input AccountMergeInput!
mergeByExternalIds : AccountMutateResponse!

Merge an Account into an Account using their External IDs

Argument Type Description
input AccountMergeExternalInput!

The Input type containing the external IDs of the Accounts to merge
unlinkDocument : AccountMutateResponse!

Unlinks a Document from an Account

Argument Type Description
input UnlinkDocumentAccountInput!

The input type with the values used to unlink a Document from the Account
update : AccountMutateResponse!

Updates the details of an Account

Argument Type Description
input AccountUpdateInput!

The input type with the values to be updated
updateBatch : [AccountMutateResponse!]!

Updates multiple Accounts A limit of 1000 per submission
DataImportIgnore true
Argument Type Description
input [AccountUpdateInput]!

A list of input types containing the values to be updated on the Accounts
updateIndividual : AccountMutateResponse!

Updates an Individual Account

Argument Type Description
input IndividualAccountUpdateInput!

The input type with the values to be updated on the Individual Account and Contact
updatePricingAgreement : AccountPricingAgreementResponse!

Update a Pricing Agreement for an Account

Argument Type Description
input UpdatePricingAgreementInput!

The input type with the values to be updated on the Pricing Agreement
updatePricingAgreementPrice : AccountPricingAgreementPriceResponse!

Update a Pricing Agreement Price

Argument Type Description
input UpdatePricingAgreementPriceInput!

The input type with the values to update
upsertBatchByExternalId : [AccountMutateResponse!]!

Upserts multiple Accounts A limit of 1000 per submission
DataImportIgnore true
Argument Type Description
input [AccountUpsertByExternalIdInput]!

A list of input types containing the values to be set on the new or existing Accounts
upsertByExternalId : AccountMutateResponse!

Updates an Account identified by an External ID, or creates an Account with the External ID assigned

Argument Type Description
input AccountUpsertByExternalIdInput!

The input type with the values to be set on the existing or new Account
Back to top

AccountPhoneNumber

A PhoneNumber of an Account

number : String!

The phone number

usage : AccountPhoneNumberUsage!

The usage of the phone number

Deprecated fields (2)
label : String!

The usage of the phone number

Removal date: TBD.

Replaced by usage field.

phoneNumber : String!

The phone number

Removal date: TBD.

Replaced by number field.

Back to top

AccountPhoneNumberInput

An Input for a PhoneNumber of an Account

usage : AccountPhoneNumberUsage!

The AccountPhoneNumberUsage of the PhoneNumber being mutated

number : String

The phone number

Back to top

AccountPhoneNumberUsage

The usages of a PhoneNumber on an Account

landline
fax
mobile
Back to top

AccountPostalAddress

PostalAddress of an Account

address : PostalAddress!

The PostalAddress

usage : AccountPostalAddressUsage!

The usage of the PostalAddress

Deprecated fields (7)
city : String

The city name of the PostalAddress

Removal date: TBD.

Moved as part of address field

country : Country

The Country of the PostalAddress

Removal date: TBD.

Moved as part of address field

label : String

The label of the address, for example 'shipping'.

Removal date: TBD.

Moved as part of address field

lines : [String]!

The first 1 - 3 lines of the address, typically including street and building number.

Removal date: TBD.

Moved as part of address field

postcode : String

The postcode of the PostalAddress

Removal date: TBD.

Moved as part of address field

region : String

The region name of the PostalAddress

Removal date: TBD.

Moved as part of address field

town : String

The town name of the PostalAddress

Removal date: TBD.

Moved as part of address field

Back to top

AccountPostalAddressInput

An Input for a PostalAddress of an Account

usage : AccountPostalAddressUsage!

The AccountPostalAddressUsage of the PostalAddress being mutated

address : PostalAddressWithContactPersonInput!

The details of the PostalAddress

Back to top

AccountPostalAddressUsage

The usages of a PostalAddress on an Account

billing
default
shipping
Back to top

AccountPricingAgreementPriceResponse

A response from adding or updating a Price for a Pricing Agreement

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

pricingAgreementPrice : PricingAgreementPrice

The Pricing Agreement Price that was added

Back to top

AccountPricingAgreementResponse

A Response from mutating a Pricing Agreement

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

pricingAgreement : PricingAgreement

The Pricing Agreement that was mutated

Back to top

AccountProject

An Account Project

Related types: Node

account : Account!

The Account associated with this Account Project

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
contact : Contact

The Contact associated with this Account Project

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
currency : Currency!

The Currency of the Account Project

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
documents : DocumentConnection!

Documents associated with the Account Project.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
endDate : Date!

The Ending Date of the Account Project

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
externalNotes : String

The Notes which are visible to Users who have the permission to view Account Projects

id : ID!

The ID of the Account Project

internalNotes : String

The Notes which are only visible to Users with the permission to view internal notes on an Account Project

internalReference : Node

The Internal Node that the Account Project references

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : AccountProjectLifecycleState!

The Lifecycle State of the Account Project

name : String!

The Name given to the Account Project

region : Region!

"The Region of the Account Project"

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
registrations : RegistrationConnection!

Registrations associated with the Account Project.

Argument Type Description
filters = [] [RegistrationFieldGraphFilter]
order = "__EMPTY__" RegistrationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationFieldGraphOrder]
startDate : Date!

The Starting Date of the Account Project

Back to top

AccountProjectAddInput

An Input for creating an Account Project

name : String!

The Name given to the new Account Project

accountId : ID!

The Name given to the new Account Project

contactId : ID!

The ID of the Contact associated with the new Account Project

startDate : Date!

The Starting Date of the new Account Project

endDate : Date!

The Ending Date of the new Account Project

currencyCode : String!

The Code of the Currency of the new Account Project

regionId : ID!

The Region ID of the new Account Project

internalReferenceId : ID

The Internal Reference ID of the new Account Project

externalNotes : String

The External Notes of the new Account Project

internalNotes : String

The Internal Notes of the new Account Project

lifecycleState : AccountProjectLifecycleState

The Lifecycle State of the new Account Project

Back to top

AccountProjectConnection

A connection containing page information and edges for AccountProject

edges : [AccountProjectEdge!]!

The list of AccountProject edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AccountProjectCreateInvoiceInput

The input type with the Registrations to be Invoiced

accountProjectId : ID!

The ID of the Account Project

registrationIds : [ID]!

A list with the ID's of the Registrations to be Invoiced

Back to top

AccountProjectDeleteInput

An Input for deleting an Account Project

accountProjectId : ID!

The ID of the Account Project to be deleted

Back to top

AccountProjectDocumentAddInput

The input type with the Document to be added to the Account Project

accountProjectId : ID!

The ID of the Account Project

documentId : ID!

The ID of the Document to be added to the Account Project

Back to top

AccountProjectDocumentRemoveInput

The input type with the Document to be removed from the Account Project

accountProjectId : ID!

The ID of the Account Project

documentId : ID!

The ID of the Document to be removed from the Account Project

Back to top

AccountProjectEdge

Contains cursor and node information for type AccountProject

cursor : String!

A string that can be used for cursor-based pagination

node : AccountProject!

The AccountProject node.

Back to top

AccountProjectEditInput

An Input to edit an Account Project

id : ID!

The ID of the Account Project

name : String

The edited Name of the Account Project

startDate : Date

The edited Starting Date of the Account Project

endDate : Date

The edited Ending Date of the Account Project

contactId : ID

The edited ID of the Contact associated with the Account Project

currencyCode : String

The edited Code of the Currency of the Account Project

regionId : ID

The edited Region ID of the Account Project

internalReferenceId : ID

The edited Internal Reference ID of the Account Project

externalNotes : String

The edited External Notes of the Account Project

internalNotes : String

The edited Internal Notes of the Account Project

lifecycleState : AccountProjectLifecycleState

The edited Lifecycle State of the Account Project

Back to top

AccountProjectEventAddInput

The input type with the Private Event to be added on the new Account Project

accountProjectId : ID!

The ID of the Account Project

eventId : ID!

The ID of the Private Event Item to be added to the Account Project

Back to top

AccountProjectField

Fields for filtering and ordering Accounts Projects

id
name
lifecycleState
startDate
endDate
Back to top

AccountProjectFieldGraphFilter

Filter that can be applied to limit which AccountProject nodes are returned

field : AccountProjectField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AccountProjectFieldGraphOrder

Specifies the order in which AccountProject nodes are returned via the Connection

field : AccountProjectField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AccountProjectLifecycleState

The Lifecycle State of the Account Project

active
draft
inactive
Back to top

AccountProjectMutateResponse

A Response from mutating an Account Project

Related types: MutationResponse

account : Account

The Account related to the the Account Project that was mutated

accountProject : AccountProject

The Account Project that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AccountProjectMutations

Mutations for Account Project

addDocumentToProject : AccountProjectMutateResponse!

Adds a Document to the Account Project

Argument Type Description
input AccountProjectDocumentAddInput!
addEventToProject : AccountProjectMutateResponse!

Adds an Account Project Private Event to the Account Project

Argument Type Description
input AccountProjectEventAddInput!
addStockItemToProject : AccountProjectMutateResponse!

Adds an Account Project Stock Item to the Account Project

Argument Type Description
input AccountProjectStockItemAddInput!
createInvoice : AccountProjectMutateResponse!

Creates an Invoice for the Registrations of the Account Project

Argument Type Description
input AccountProjectCreateInvoiceInput!
editProject : AccountProjectMutateResponse!

Edits an Account Project details

Argument Type Description
input AccountProjectEditInput!
removeDocument : AccountProjectMutateResponse!

Removes a Document to the Account Project

Argument Type Description
input AccountProjectDocumentRemoveInput!
removeRegistration : AccountProjectMutateResponse!

Removes a Registration from the Account Project

Argument Type Description
input AccountProjectRemoveRegistrationInput!
Back to top

AccountProjectRemoveRegistrationInput

The input type with the Registration to be removed from the Account Project

accountProjectId : ID!

The ID of the Account Project

registrationId : ID!

The ID of the Registration to be removed from the Account Project

Back to top

AccountProjectStockItemAddInput

The input type with the Stock Item to be added on the new Account Project

accountProjectId : ID!

The ID of the Account Project

stockItemId : ID!

The ID of the Stock Item to be added to the Account Project

quantity : Int

The Quantity of the Account Project Item

amount : Decimal

The Amount of the Account Project Item

Back to top

AccountSyncMode

The Sync Mode for Accounts

single
multi
Back to top

AccountTaskCreateInput

An Input for creating an Account Task

taskTypeId : ID!

The ID of the Task Type

userId : ID!

The ID of the User to assign the Task to

name : String!

The name of the Task

accountId : ID!

The ID of the Account the Task is linked to

dueDate : LocalDateTime!

The due date of the Task

timeZoneName : String!

The timezone of the Task

description : String!

The description of the Task

status : TaskStatus

The Status of the Task

showOnCalendar : Boolean

Whether to display this Task on the calendar

endDate : LocalDateTime

The end date of the Task

Back to top

AccountUpdateInput

An Input for updating an Account

accountId : ID!

The ID of the Account being updated

name : String

The new name of the Account

emailAddress : String

The new email address of the Account

billingEmailAddress : String

The new billing email address of the Account

website : String

The new website URL of the Account

notes : String

The new notes of the Account

primaryContactId : ID

The ID of the new primary contact of the Account

billingContactId : ID

The ID of the Contact that Bookings for this Account default their Billing Contact to

phoneNumbers : [AccountPhoneNumberInput]

The list of PhoneNumbers of the Account

postalAddresses : [AccountPostalAddressInput]

The list of PostalAddresses of the Account

source : MarketingSourceInput

The new MarketingSource of the Account

customFieldValues : [CustomFieldValueInput]

The CustomFieldValues of the Account

weblinkSettings : AccountWeblinkSettingsInput

The Weblink Settings of the Account

isCustomer : Boolean

The field that marks an Account as a Customer

brandId : ID

The ID of the default brand set on this Account

companyId : ID

The ID of the Company that owns this Account

ownerId : ID

The User assigned as the owner of this Account

parentAccountId : ID

The ID of the Account that will be the immediate ancestor of this Account. Cannot be defined in the same mutation call as parentAccountExternalId

parentAccountExternalId : ExternalIdInput

An External Id that identifies the Account that will be the immediate ancestor of this Account. Cannot be defined in the same mutation call as parentAccountId

companyRegistrationNumber : String

The Company Registration Number for this Account

vatNumber : String

The Account's VAT Number

isEmployee : Boolean

Whether the account is flagged as an Employee

isPartner : Boolean

Whether the account is flagged as a Partner

receiveNoPublicity : Boolean

Whether the account is flagged to not receive any publicity

industryIds : [ID]

The IDs of the of Industries linked to the Account

isSupplier : Boolean

Whether the account is flagged as a Supplier

isVenue : Boolean

Whether the account is flagged as a Venue

Back to top

AccountUpsertByExternalIdInput

An Input for upserting an Account by External ID

externalId : ExternalIdInput!

The External ID used to identify the Account to update. If an Account does not exist, this External ID is set on the created Account

account : AccountUpsertInput!

The details with which to update or create the Account

Back to top

AccountUpsertInput

An Input for upserting an Account

name : String!

The name of the Account

emailAddress : String

The email address of the Account

billingEmailAddress : String

The billing email address of the Account

website : String

The website URL of the Account

notes : String

The notes of the Account

phoneNumbers : [AccountPhoneNumberInput]

The list of PhoneNumbers of the Account

postalAddresses : [AccountPostalAddressInput]

The list of PostalAddresses of the Account

source : MarketingSourceInput

The MarketingSource of the Account

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Account

weblinkSettings : AccountWeblinkSettingsInput

The Weblink Settings of the Account

parentAccountId : ID

The ID of the Account that will be the immediate ancestor of the Account. Cannot be defined in the same mutation call as parentAccountExternalId

parentAccountExternalId : ExternalIdInput

An External Id that identifies the Account that will be the immediate ancestor of the Account. Cannot be defined in the same mutation call as parentAccountId

isCustomer : Boolean

The field that marks an Account as a Customer

brandId : ID

The ID of the default brand set on this Account

companyId : ID

The ID of the Company that owns this Account

ownerId : ID

The User assigned as the owner of this Account

companyRegistrationNumber : String

The Company Registration Number for this Account

vatNumber : String

The Account's VAT Number

isEmployee : Boolean

Whether the account is flagged as an Employee

isPartner : Boolean

Whether the account is flagged as a Partner

receiveNoPublicity : Boolean

Whether the account is flagged to not receive any publicity

industryIds : [ID]

The IDs of the of Industries linked to the Account

isSupplier : Boolean

Whether the account is flagged as a Supplier

isVenue : Boolean

Whether the account is flagged as a Venue

Back to top

AccountWeblinkSettings

Configuration options that apply to portal orders for this Account

canSelfCheckoutByInvoice : Boolean!

Whether the Account is flagged as having permission to pay by invoice when checking out through Weblink

Back to top

AccountWeblinkSettingsInput

An Input for the Weblink Settings of an Account

canSelfCheckoutByInvoice : Boolean

Whether the Account is allowed to checkout in Weblink by Invoice

Back to top

Achievement

A recognition that a Learner has successfully completed a piece of Training

Related types: Node

achievementCertificateDocuments : AchievementCertificateDocumentConnection

Any Documents that belong to the Achievement Certificate.

Argument Type Description
filters = [] [AchievementCertificateDocumentFieldGraphFilter]
order = "__EMPTY__" AchievementCertificateDocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementCertificateDocumentFieldGraphOrder]
achievementType : AchievementType!

The Achievement Type linked to the Achievement

Argument Type Description
filters = [] [AchievementTypeFieldGraphFilter]
order = "__EMPTY__" AchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementTypeFieldGraphOrder]
brand : Brand

The Brand associated with the Opportunity

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
certificateGenerationErrors : [CertificateGenerationLog!]!

Return certificate generation errors in a list

contact : Contact

The Contact linked to the Achievement

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime!

The date and time this Achievement was created

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Achievement

Argument Type Description
filter CustomFieldFilterInput
documents : AchievementDocumentConnection

Any Documents that belong to the Achievement.

Argument Type Description
filters = [] [AchievementDocumentFieldGraphFilter]
order = "__EMPTY__" AchievementDocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementDocumentFieldGraphOrder]
expiresAt : Date

The date this Achievement expires

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Achievement

identifier : String

The string identifier of the Achievement

issuedCertificate : Document

The issued certificate document associated with the Achievement

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : AchievementLifecycleState!

The Lifecycle State of the Achievement

registerable : Registerable

The Registerable associated to the Achievement

Argument Type Description
filters = [] [RegisterableFieldGraphFilter]
order = "__EMPTY__" RegisterableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegisterableFieldGraphOrder]
validFrom : Date!

The date this Achievement is valid from

Deprecated fields (1)
achievedAt : Date!

The date this Achievement is valid from

Removal date: TBD.

Replaced by validFrom

Back to top

AchievementAddDocumentInput

An input for adding a new Achievement Document

documentId : ID

the ID of a DMS document to associate to an Achievement

url : String

the URL of a document to associate to an Achievement

Back to top

AchievementCertificateDocument

The Mapping between Achievement and related Certificate Documents and Certificate Types

Related types: Node

certificateType : CertificateType!

The Certificate Type

Argument Type Description
filters = [] [CertificateTypeFieldGraphFilter]
order = "__EMPTY__" CertificateTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CertificateTypeFieldGraphOrder]
document : Document!

The Document representing Certificate

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Mapping

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

AchievementCertificateDocumentConnection

A connection containing page information and edges for AchievementCertificateDocument

edges : [AchievementCertificateDocumentEdge!]!

The list of AchievementCertificateDocument edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AchievementCertificateDocumentEdge

Contains cursor and node information for type AchievementCertificateDocument

cursor : String!

A string that can be used for cursor-based pagination

node : AchievementCertificateDocument!

The AchievementCertificateDocument node.

Back to top

AchievementCertificateDocumentFieldGraphFilter

Filter that can be applied to limit which AchievementCertificateDocument nodes are returned

field : AchievementCertificateDocumentTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AchievementCertificateDocumentFieldGraphOrder

Specifies the order in which AchievementCertificateDocument nodes are returned via the Connection

field : AchievementCertificateDocumentTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AchievementCertificateDocumentTypeField

An enumeration.

id
Back to top

AchievementConnection

A connection containing page information and edges for Achievement

edges : [AchievementEdge!]!

The list of Achievement edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AchievementDMSDocument

A Document in the DMS belonging to a specific Achievement.

Related types: AchievementDocument Node

dmsDocument : Document

The Document in the DMS for the specific Achievement.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Achievement Document

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

AchievementDocument

A document beloning to a specific Achievement.

Related types: AchievementDMSDocument AchievementDocumentURL

id : ID!

The ID of the Achievement Document

Back to top

AchievementDocumentConnection

A connection containing page information and edges for AchievementDocument

edges : [AchievementDocumentEdge!]!

The list of AchievementDocument edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AchievementDocumentEdge

Contains cursor and node information for type AchievementDocument

cursor : String!

A string that can be used for cursor-based pagination

node : AchievementDocument!

The AchievementDocument node.

Back to top

AchievementDocumentField

Fields for filtering and ordering Achievement Documents

id
Back to top

AchievementDocumentFieldGraphFilter

Filter that can be applied to limit which AchievementDocument nodes are returned

field : AchievementDocumentField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AchievementDocumentFieldGraphOrder

Specifies the order in which AchievementDocument nodes are returned via the Connection

field : AchievementDocumentField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AchievementDocumentURL

A link to a Document belonging to a specific Achievement.

Related types: AchievementDocument Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Achievement Document

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

url : URL!

The URL pointing to the link for the Document belonging to the specific Achievement.

Back to top

AchievementEdge

Contains cursor and node information for type Achievement

cursor : String!

A string that can be used for cursor-based pagination

node : Achievement!

The Achievement node.

Back to top

AchievementField

Fields for filtering and ordering Achievements

id
expiresAt
validFrom
createdAt
identifier
achievementTypeName
brandId
brandIdOrNull
lifecycleState
contactId
sourceType
sourceCourseTemplateId
sourceCourseTemplateVersionNumber
sourceEventId
Back to top

AchievementFieldGraphFilter

Filter that can be applied to limit which Achievement nodes are returned

field : AchievementField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AchievementFieldGraphOrder

Specifies the order in which Achievement nodes are returned via the Connection

field : AchievementField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AchievementLifecycleState

The Lifecycle State of the Achievement

active
revoked
expired
Back to top

AchievementMutateResponse

A Response from mutating an Achievement

Related types: MutationResponse

achievement : Achievement

The Achievement that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AchievementMutations

Mutations for Achievement

update : AchievementMutateResponse!

Updates an Achievement

Argument Type Description
input AchievementUpdateInput!

The input type with the values to be set on the updated Achievement
Back to top

AchievementNumberSequence

A Sequence Number used for uniquely identifying an Achievements)

Related types: Node

eventTemplate : String

The template used to format an Achievement Number for an Event

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Achievement Number Sequence

lastValueUsed : Int

The last value generated for the Achievement Number Sequence

learningPathTemplate : String

The template used to format an Achievement Number for a Learning Path

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of this Achievement Number

paddingLength : Int!

The required minimum length of the Achievement Number Sequence. Padding using leading zeros is used to achieve this required minimum length.

startingValue : Int

The value from which the Achievement Number Sequence starts

Back to top

AchievementNumberSequenceConnection

A connection containing page information and edges for AchievementNumberSequence

edges : [AchievementNumberSequenceEdge!]!

The list of AchievementNumberSequence edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AchievementNumberSequenceCreateInput

An input for creating a Achievement Number Sequence

name : String!

The name given to the Achievement Number Sequence

paddingLength : Int

The minimum length of the Achievement Number Sequence value. Any values with fewer significant figures than this value will be padded with zeros (e.g. sequence ABC-0008 has a padding length of 4)

startingValue : Int

The starting non-negative value of the Achievement Number Sequence.

eventTemplate : String

The template used to format an Event Achievement number.

learningPathTemplate : String

The template used to format an Learning Path Achievement number.

Back to top

AchievementNumberSequenceEdge

Contains cursor and node information for type AchievementNumberSequence

cursor : String!

A string that can be used for cursor-based pagination

node : AchievementNumberSequence!

The AchievementNumberSequence node.

Back to top

AchievementNumberSequenceFieldGraphFilter

Filter that can be applied to limit which AchievementNumberSequence nodes are returned

field : AchievementNumberSequenceTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AchievementNumberSequenceFieldGraphOrder

Specifies the order in which AchievementNumberSequence nodes are returned via the Connection

field : AchievementNumberSequenceTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AchievementNumberSequenceMutateResponse

A Response from mutating an Achievement Number Sequence

Related types: MutationResponse

achievementNumberSequence : AchievementNumberSequence

The Achievement Number Sequence that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AchievementNumberSequenceMutations

Mutations for Sequence

create : AchievementNumberSequenceMutateResponse!

Creates a Achievement Number Sequence

Argument Type Description
input AchievementNumberSequenceCreateInput!

The input type with the values to be set on the new Achievement Number Sequence
update : AchievementNumberSequenceMutateResponse!

Updates a Achievement Number Sequence

Argument Type Description
input AchievementNumberSequenceUpdateInput!

The input type with the values to be set on the updated Achievement Number Sequence
Back to top

AchievementNumberSequenceTypeField

Fields for filtering and sorting Achievement Number Sequence

id
name
Back to top

AchievementNumberSequenceUpdateInput

An input for updating a Achievement Number Sequence

id : ID!

The ID of the Achievement Number Sequence being updated

name : String

The name given to the Achievement Number Sequence

eventTemplate : String

The template used to format an Event Achievement number.

learningPathTemplate : String

The template used to format an Learning Path Achievement number.

Back to top

AchievementSource

How an Achievement came to be recorded. Course and Learning Path are assigned by the system when an award comes through a Learner; manual and external are declared by whoever created the record.

course
learning_path
manual
external
Back to top

AchievementSourceInput

Where an Achievement being awarded to a Contact came from

type : AchievementSource!

Where the record came from. Only manual and external are accepted; course and learning_path are assigned by the system when an Achievement is awarded to a Learner

courseTemplateId : ID

The Course Template the Achievement was earned on

courseTemplateVersionNumber : Int

The Course Template version the Achievement was earned on

eventId : ID

The Event the Achievement was earned through. When given, the Course Template and version are read from the Event

Back to top

AchievementType

A category of Achievements sharing common characteristics (certificate, sequence number, validity etc.)

Related types: Node

certificateType : CertificateType

The Certificate Type associated with the Achievement Type

Argument Type Description
filters = [] [CertificateTypeFieldGraphFilter]
order = "__EMPTY__" CertificateTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CertificateTypeFieldGraphOrder]
certificateTypes : CertificateTypeConnection!

The Certificate Types associated with the Achievement Type

Argument Type Description
filters = [] [CertificateTypeFieldGraphFilter]
order = "__EMPTY__" CertificateTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CertificateTypeFieldGraphOrder]
description : String

The Description of the Achievement Type

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Achievement Type

image : DownloadableFile

The image associated with the Achievement Type

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : LifecycleState!

The Lifecycle State of the Achievement Type

name : String!

The Name given to the Achievement Type

sequence : AchievementNumberSequence

The Achievement Number Sequence associated with the Achievement Type

Argument Type Description
filters = [] [AchievementNumberSequenceFieldGraphFilter]
order = "__EMPTY__" AchievementNumberSequenceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementNumberSequenceFieldGraphOrder]
validityPeriod : DateDelta

The default validity period in days of the Achievement Type

Back to top

AchievementTypeConnection

A connection containing page information and edges for AchievementType

edges : [AchievementTypeEdge!]!

The list of AchievementType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AchievementTypeCreateInput

An input for creating an Achievement Type

name : String!

The name given to the Achievement Type

validityPeriod : DateDeltaInput

The default validity period of the Achievement Type

description : String

A description of the Achievement Type

imageId : ID

The document ID of the image associated with the Achievement Type

certificateTypeId : ID

The Certificate Type ID associated with the Achievement Type

certificateTypeIds : [ID]

The list of Certificate Type IDs associated with the Achievement Type

sequenceId : ID

The Sequence ID associated with the Achievement Type

Back to top

AchievementTypeEdge

Contains cursor and node information for type AchievementType

cursor : String!

A string that can be used for cursor-based pagination

node : AchievementType!

The AchievementType node.

Back to top

AchievementTypeField

Fields for filtering and ordering Achievement Types

id
name
lifecycleState
Back to top

AchievementTypeFieldGraphFilter

Filter that can be applied to limit which AchievementType nodes are returned

field : AchievementTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AchievementTypeFieldGraphOrder

Specifies the order in which AchievementType nodes are returned via the Connection

field : AchievementTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AchievementTypeMutateResponse

A Response from mutating an Achievement Type

Related types: MutationResponse

achievementType : AchievementType

The Achievement Type that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AchievementTypeMutations

Mutations for Achievement Type

create : AchievementTypeMutateResponse!

Creates an Achievement Type

Argument Type Description
input AchievementTypeCreateInput!

The input type with the values to be set on the new Achievement Type
update : AchievementTypeMutateResponse!

Updates an Achievement Type

Argument Type Description
input AchievementTypeUpdateInput!

The input type with the values to be set on the updated Achievement Type
Back to top

AchievementTypeUpdateInput

An input for updating an Achievement Type

achievementTypeId : ID!

The ID of the Achievement Type being updated

name : String

The updated name of the Achievement Type

isArchived : Boolean

Flag indicating whether the Achievement Type is archived or not

validityPeriod : DateDeltaInput

The updated validity period of the Achievement Type

description : String

The updated description of the Achievement Type

imageId : ID

The document ID of the image associated with the Achievement Type

certificateTypeId : ID

The Certificate Type ID associated with the Achievement Type

certificateTypeIds : [ID]

Optional list of Certificate Type IDs to be associated with the Achievement Type. If empty list provided any existing associations are to be removed.

sequenceId : ID

The Sequence ID associated with the Achievement Type

Back to top

AchievementUpdateInput

An input for updating an Achievement

achievementId : ID!

The ID of the Achievement being updated

expiresAt : Date

The updated expiry date of the Achievement

brandId : ID

The updated brand ID associated with the Achievement

documents : [AchievementAddDocumentInput]

The list of documents to be added to the Achievement

revokedAt : Date

The date when the Achievement was revoked

customFieldValues : [CustomFieldValueInput]
validFrom : Date

The date when the Achievement is valid

Back to top

AchievementValidFromBlendedTypes

An enumeration.

sameAsIssuedAt
sameAsClassroomEndDate
sameAsLmsEndDate
sameAsLearnerExpirationDate
sameAsEventEndDate
Back to top

AchievementValidFromClassroomTypes

An enumeration.

sameAsIssuedAt
sameAsClassroomEndDate
Back to top

AchievementValidFromLmsTypes

An enumeration.

sameAsIssuedAt
sameAsLmsEndDate
sameAsLearnerExpirationDate
sameAsEventEndDate
Back to top

AchievementValidFromTypes

An enumeration.

same_as_issued_at
same_as_classroom_end_date
same_as_lms_end_date
same_as_learner_expiration_date
same_as_event_end_date
Back to top

AddedCalendarsResponse

The response with the Successful and Failed Calendars attempted to be added to be synced

failure : [AddedRoomResponse!]!

Room Calendars that have failed to be added to be synced

success : [AddedRoomResponse!]!

Room Calendars that have been successfully added to be synced

Back to top

AddedRoomResponse

The response from adding a Room Calendar to be synced

code : Int!

Status code of the attempt to add the Room Calendar

message : String!

Response message for adding the Room Calendar

success : Boolean!

Flag determining if the attempt to add the Room Calendar was successful

vendorId : String!

ID issued by the Vendor for the Room Calendar

Back to top

AddPaymentAllocationsInput

The input for adding allocations for a Payment

paymentId : ID!

The id of the Payment we wish to add allocations to

allocations : [InvoicesPaymentAllocationInput]!

The list of allocations of this Payment

Back to top

AddPricingAgreementInput

An Input for creating a Pricing Agreement for an Account

accountId : ID!

The Account ID of the Account to apply to Pricing Agreement to

name : String!

The Name given to the new Pricing Agreement

startDateTime : LocalDateTime!

The DateTime of when the Pricing Agreement commences

timeZoneName : String!

The Time Zone which the Pricing Agreement respects for startDateTime and endDateTime

endDateTime : LocalDateTime!

The DateTime of when the Pricing Agreement ceases

isInheritedByChildAccounts : Boolean!

Whether or not the Pricing Agreement should be inherited by child accounts

Back to top

AddPricingAgreementPriceInput

An Input for creating a Price for Pricing Agreement Price

pricingAgreementId : ID!

The Pricing Agreement ID to apply a Price and Course to

currencyCode : String!

The Code of the Currency of the applied Price

price : Float!

The Price for the applied sellable in the Pricing Agreement

sellableType : SellableType!

The type of sellable in the Pricing Agreement

regionId : ID!

The Region ID to apply a Region to the Price Agreement

courseId : ID

The Course Template ID to apply a Course to the Price Agreement

learningPathId : ID

The Price for the applied Learning Path in the Pricing Agreement

itemId : ID

The Price for the applied Item in the Pricing Agreement

taxTypeId : ID

The default Tax Type ID used for the applied Price

priceLevelId : ID

The ID of the Price Level to which this Pricing Agreement Price applies

Back to top

Address

Addresses are specific places on a map.

Related types: Node

city : String!

An alias for town, it is the city/town of the address

country : Country!

The Country the Address is in

countryName : String!

The Country Name the address resides in

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Address

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

line1 : String!

Line1 of the address

line2 : String!

Line2 of the address (aka street)

line3 : String!

Line 3 of the address

locality : String!

An alias for line 3

name : String!

The name of the Address

postalCode : String!

The postal/zip code of the address

region : String!

The region of the address

state : String!

Alias for region (in the US regions are states)

street : String!

An alias for line2, this is the street or second line of the address

town : String!

The town of the address

type : String!

The type of address

unit : String!

An alias for line1

zipCode : String!

An alias for postalCode.

Back to top

AddressConnection

A connection containing page information and edges for Address

edges : [AddressEdge!]!

The list of Address edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AddressCreateInput

An Input for creating an Address

countryId : ID!

The countryID that this address is in

name : String

An optional friendly name for the address

addressType : AddressType

An optional type for the address (billing/home)

street : String

Line 1 of the address

locality : String

Line 2 of the address

unit : String
town : String

The city of the address

region : String

The country / region / state of the address

postalCode : String

The postal or zip code of the address

Back to top

AddressEdge

Contains cursor and node information for type Address

cursor : String!

A string that can be used for cursor-based pagination

node : Address!

The Address node.

Back to top

AddressField

Fields for filtering and ordering Addresses

id
Back to top

AddressFieldGraphFilter

Filter that can be applied to limit which Address nodes are returned

field : AddressField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AddressFieldGraphOrder

Specifies the order in which Address nodes are returned via the Connection

field : AddressField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AddressMutateResponse

A Response from mutating an Address

Related types: MutationResponse

address : Address

The Address that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AddressMutations

Mutations for Addresses

create : AddressMutateResponse!

Creates a new address

Argument Type Description
input AddressCreateInput!

Incoming new address
update : AddressMutateResponse!

Updates an Address

Argument Type Description
input AddressUpdateInput!

The fields to update in the Address
Back to top

AddressType

Types of Content available

default
home
billing
work
Back to top

AddressUpdateInput

An input for updating an Address

addressId : ID!

The ID of the address being updated

countryId : ID

The Country the Address is in

name : String

The name of the Address

addressType : AddressType

The type of Address

street : String

The Address street or first line

locality : String

The Address second line

unit : String

The address third line

town : String

The Address town or third line

region : String

The Address region or state

postalCode : String

The Address postal or zip code

Back to top

AddRoomCalendarsInput

An input for adding Room Calendars to be synced

vendorId : String!

ID issued by the Vendor for the Calendar to be added

resourceAdministratorId : String!

Resource Administrator ID for the owner of the Calendar to be added

Back to top

AddStaffRoleInput

An input for creating a batch of Staff Roles

name : String!

The name of the Staff Role

checkConflicts : Boolean

Whether this Staff Role generates conflicts for any Staff calendar assigned this role on a booking

Back to top

AddWebLinkPaymentProviderDefinitionsInput

The input type with the values used to add Attribute Definitions to a WebLink Portal Payment Provider

portalId : ID!

The ID of the WebLink Portal

paymentProviderType : WebLinkPaymentProviderType!

The type of the WebLink Portal Payment Provider

definitionKeys : [ID]!

The identifiers for the Attribute Definitions to add to the Payment Provider

Back to top

AdhocSmsLearnerInput

The input for sending an SMS to Learners on an Event. Either Learner IDs or audience must be specified

eventId : String!

The ID of the event on which the Learners exist

audience : [BulkLearnerEmailAudience]

The category of Learners we wish to send SMS messages to

sendingAddressId : ID

The ID of the sending SMS from which the messages should originate.

body : String

The body of the SMS. If set, it will override any provided TemplateId

templateId : ID

The ID of the Communications Template to use for the SMS. Must be an SMS-type Template.

learnerIds : [String]

The Learners we want to send SMS messages to. An empty list is not a valid input.

contentLocaleId : ID

The ID of the Locale the body is written in, so that merge fields resolve in the same language. Defaults to the language the Event is delivered in.

Back to top

AdhocSmsMutations

Mutations for sending adhoc SMS to Learners and Staff on events

sendAdhocSmsToBookingContacts : AdhocSmsMutationsResponse!

Sends an adhoc SMS to the booking contacts of specific Learners by ID, or to a specific audience of Learners.

Argument Type Description
input AdhocSmsLearnerInput!
sendAdhocSmsToLearners : AdhocSmsMutationsResponse!

Sends an adhoc SMS to specific Learners by ID, or to a specific audience of Learners.

Argument Type Description
input AdhocSmsLearnerInput!
sendAdhocSmsToStaff : AdhocSmsMutationsResponse!

Sends an adhoc SMS to a subset of Staff by ID. If no Staff are specified, sends to all Staff on an Event.

Argument Type Description
input AdhocSmsStaffInput!
Back to top

AdhocSmsMutationsResponse

The response type for adhoc SMS mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AdhocSmsStaffInput

The input for sending an SMS to Staff on an Event. Either Staff IDs must be specified, or SMS will be sent to all Staff on the Event.

eventId : String!

The ID of the Event on which the Staff are set.

sendingAddressId : ID

The ID of the sending SMS from which the messages should originate.

body : String

The body of the SMS. If set, it will override any provided TemplateId

templateId : ID

The ID of the communications template to use for the SMS. Must be an SMS-type template.

staffIds : [String]

The Staff we want to send SMS messages to. If not specified, all Staff on the Event will receive an SMS. An empty list is not a valid input.

contentLocaleId : ID

The ID of the Locale the body is written in, so that merge fields resolve in the same language. Defaults to the language the Event is delivered in.

Back to top

AdminCompleteDiscussionInput

An input for completion a discussion submitted by a Admin

learnerId : ID!

The ID of the Learner who the discussion is being completed for

contentId : ID!

The ID of the Discussion Content

Back to top

AdminCompleteScormInput

An input for completing SCORM as an Admin

learnerId : ID!

The ID of the Learner progressing the SCORM Content

contentId : ID!

The ID of the Content being completed

Back to top

AdminCompleteVideoInput

An input for completing video content as an Admin

learnerId : ID!

The ID of the Learner viewing the Video

contentId : ID!

The ID of the Content being completed

Back to top

AggregatedAvailability

The aggregated availability for the unregistered learners of a given event over a given period of time

availabilityTimeSpans : [AvailabilityTimeSpan!]!

The lengths of time a number of learners is available during the availability range

totalLearners : Int!

The total number of unregistered learners for the given course

Back to top

ArchiveStaffRoleInput

An input for archiving a batch of Staff Roles if they cannot be removed because they are in use.

staffRoleId : ID!

the ID of the Staff Role to archive

Back to top

Assessment

A piece of work that can be submitted by each Learner on an Event

absoluteDueDate : LocalDateTime

The specific date and time of when an Assessment is due

description : String

Description of the Assessment

dueDateOffset : Int

Number of days the due date is offset by

dueDateOffsetType : AssessmentDueDateOffset

When the due date offset days commence from

gradeTemplate : GradeTemplate

GradeTemplate associated with the Assessment

Argument Type Description
filters = [] [GradeTemplateFieldGraphFilter]
order = "__EMPTY__" GradeTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GradeTemplateFieldGraphOrder]
id : ID!

ID of the Assessment

name : String!

Name of the Assessment

Back to top

AssessmentDueDateOffset

The type of offset used for relative due dates on Assessments

BEFORE_START
AFTER_START
BEFORE_END
AFTER_END
Back to top

AssociatedAccountDiscountabilityRule

Promotion Campaign Discountability Rules related to Associated Accounts

Related types: PromotionDiscountabilityRule

discountableAssociatedAccounts : AccountConnection!

The Associated Accounts related to this Discountability Rule

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
type : PromotionCriterionType!

The type of Discountability Rule (e.g. Course, Location, etc)

Back to top

AssociatedAccountEligibilityRule

Promotion Campaign Eligibility Rules related to Associated Accounts

Related types: PromotionEligibilityRule

eligibleAssociatedAccounts : AccountConnection!

Associated Accounts that the Promotion Campaign Eligibility Rule is related to

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
type : PromotionCriterionType!

The type of Eligibility Rule (e.g. Course, Location, etc)

Back to top

AssociateUnnamedLearnerWithContactsInput

An input to associate Contacts with an Unnamed Learner

learnerId : ID!

The ID of the Unnamed Learner to associate the Contacts with

contactIds : [ID]!

A list of Contact IDs to associate this Learner with

communicationsContactId : ID

An optional Contact ID that will receive all Communications for the newly named Learners instead of their own Contact

Back to top

AssociateUnnamedLearnerWithContactsResponse

A response from associating an Unnamed Learner with Contacts

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learners : [Learner!]

The Learners that were associated with existing Contacts

Back to top

AssociateUnnamedWithContactsInput

An Input to associate Contacts to an Unnamed Learning Path Learner

learningPathLearnerId : ID!

The Unnamed Learning Path Learner to associate

contactIds : [ID]!

A list of Contact IDs to associate this Learning Path Learner with

Back to top

AssociateUnnamedWithContactsResponse

A response from associating Unnamed Learning Path Learners

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learners : [LearningPathLearner!]

The Learning Path Learners that were associated with existing Contacts

Back to top

AttemptScormInput

An input for recording a SCORM attempt

learnerId : ID!

The ID of the Learner attempting the SCORM Content

contentId : ID!

The ID of the SCORM Content being attempted

completedByAdmin : Boolean

True if manually completed by an Admin

Back to top

AuditLogChange

One flattened change from an audit log entry: a single field's value before and after, with the item it belongs to when the change is part of a collection (a Session, a Resource Booking, a staff member).

field : String!

A stable dotted key for the changed field, e.g. "title" or "resource_bookings.start".

kind : AuditLogChangeKind!

Whether the change added, altered or removed the value.

newValue : String

The value after the change, serialised as text. Datetimes are ISO formatted; see valueFormat.

previousValue : String

The value before the change, serialised as text. Datetimes are ISO formatted; see valueFormat.

subject : String

The item the change belongs to, when it is part of a collection - a Resource's name, a Session's title.

valueFormat : AuditLogValueFormat!

How the values should be presented.

Back to top

AuditLogChangeKind

Whether the change added, altered or removed the value.

added
changed
removed
Back to top

AuditLogValueFormat

How a change's values should be presented.

text
date
datetime
boolean
number
Back to top

AuthenticationProvider

An enumeration.

Microsoft
Custom
Back to top

AuthorizedApplications

Authorized Applications

clientCredentials : [ClientCredentials!]!

Client Credentials for the instance

Back to top

AuthorizedApplicationsMutations

Manage Authorized Applications

createClientCredential : CreateClientCredentialResponse!

Generates new Client Credentials

Argument Type Description
input CreateClientCredentialInput!

The name and description for the new Client Credentials
revokeClientCredential : RevokeClientCredentialResponse!

Revokes a client credential by key

Argument Type Description
clientKey String!

The key of the client credential to revoke
updateClientCredential : CreateClientCredentialResponse!

Updates an existing Client Credential

Argument Type Description
input UpdateClientCredentialInput!

The key of the Client Credential to update and new values
Back to top

AutomatorAutomation

The Administrate Automator Automations configured in your instance

Related types: Node

connection : AutomatorConnection!

The Automator Connection associated with the Automator Automation

Argument Type Description
filters = [] [AutomatorConnectionFieldGraphFilter]
order = "__EMPTY__" AutomatorConnectionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AutomatorConnectionFieldGraphOrder]
createdAt : TimeZonedDateTime!

The time that the Automator Automation was created

executionCount : Float!

The cumulative count of executions observed for this Automation since tracking began.

executionsSyncedAt : TimeZonedDateTime

The time of the most recent successful execution sync for this Automation, or null if executions have not yet been synced

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Automator Automation

integrationLog : ExternalLogOrigin

The Integration Log associated with the Automator Automation

Argument Type Description
filters = [] [ExternalLogOriginFieldGraphFilter]
order = "__EMPTY__" ExternalLogOriginFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogOriginFieldGraphOrder]
isArchived : Boolean!

Whether the Automator Automation is archived

last24hExecutionCount : Int!

The count of executions for this Automation observed in the 24 hours prior to the most recent execution sync

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Automator Automation

status : AutomatorAutomationStatus!

The status of the Automator Automation

updatedAt : TimeZonedDateTime!

The time that the Automator Automation was last updated

webhook : Webhook

The Webhook associated with the Automator Automation

Argument Type Description
filters = [] [WebhookFieldGraphFilter]
order = "__EMPTY__" WebhookFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WebhookFieldGraphOrder]
workflowId : String!

The workflow ID of the Automator Automation

Back to top

AutomatorAutomationConnection

A connection containing page information and edges for AutomatorAutomation

edges : [AutomatorAutomationEdge!]!

The list of AutomatorAutomation edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AutomatorAutomationCreateInput

An input for creating an Automator Automation

connectionId : ID!

The ID of the Automator Connection associated with the Automation

workflowId : String!

The workflow ID of the Automator Automation

status : AutomatorAutomationStatus!

The status of the Automator Automation

name : String

The name of this Automation

webhookId : ID

The Webhook that can be linked to the Automator Automation

integrationLogId : ID

The ID of the Integration Log associated with the Automation

Back to top

AutomatorAutomationCreateResponse

A Response for an Automator Automation Create Mutation

Related types: MutationResponse

automation : AutomatorAutomation

The Automation that was created

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AutomatorAutomationEdge

Contains cursor and node information for type AutomatorAutomation

cursor : String!

A string that can be used for cursor-based pagination

node : AutomatorAutomation!

The AutomatorAutomation node.

Back to top

AutomatorAutomationField

An enumeration.

id
name
connectionId
integrationLogId
workflowId
isArchived
status
executionCount
last24hExecutionCount
executionsSyncedAt
createdAt
updatedAt
webhookTypeId
Back to top

AutomatorAutomationFieldGraphFilter

Filter that can be applied to limit which AutomatorAutomation nodes are returned

field : AutomatorAutomationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AutomatorAutomationFieldGraphOrder

Specifies the order in which AutomatorAutomation nodes are returned via the Connection

field : AutomatorAutomationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AutomatorAutomationStatus

An enumeration.

Enabled
Disabled
Back to top

AutomatorAutomationUpdateInput

An input for updating an Automator Automation

automationId : ID!

The ID of the Automator Automation that is being updated

status : AutomatorAutomationStatus

The new status of the Automator Automation

name : String

The new name of the Automator Automation

webhookId : ID

The ID name of the Webhook to Assign to this Automation

Back to top

AutomatorAutomationUpdateResponse

A Response for an Automator Automation Update Mutation

Related types: MutationResponse

automation : AutomatorAutomation

The Automation that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AutomatorConnection

The Administrate Automator Connections configured in your instance

Related types: Node

createdAt : TimeZonedDateTime!

The time that the Automator Connection was created

environment : ConnectionEnvironment!

The environment the Automator Connection has been set up in

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Automator Connection

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

projectId : String!

The Project ID associated with the Automator Connection

status : AutomatorConnectionStatus!

The status of the Automator Connection

updatedAt : TimeZonedDateTime!

The time that the Automator Connection was last updated

Back to top

AutomatorConnectionConnection

A connection containing page information and edges for AutomatorConnection

edges : [AutomatorConnectionEdge!]!

The list of AutomatorConnection edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AutomatorConnectionCreateInput

An input for creating an Automator Connection

projectId : String!

The Project ID associated with the Automator Connection

environment : ConnectionEnvironment!

The environment the Automator Connection has been set up in

status : AutomatorConnectionStatus!

The status of the Automator Connection

Back to top

AutomatorConnectionCreateResponse

A Response for an Automator Connection Create Mutation

Related types: MutationResponse

connection : AutomatorConnection

The Connection that was created

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AutomatorConnectionEdge

Contains cursor and node information for type AutomatorConnection

cursor : String!

A string that can be used for cursor-based pagination

node : AutomatorConnection!

The AutomatorConnection node.

Back to top

AutomatorConnectionField

An enumeration.

id
projectId
environment
status
createdAt
updatedAt
Back to top

AutomatorConnectionFieldGraphFilter

Filter that can be applied to limit which AutomatorConnection nodes are returned

field : AutomatorConnectionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AutomatorConnectionFieldGraphOrder

Specifies the order in which AutomatorConnection nodes are returned via the Connection

field : AutomatorConnectionField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AutomatorConnectionStatus

An enumeration.

Enabled
Disabled
Back to top

AutomatorConnectionUpdateInput

An input for updating an Automator Connection

connectionId : ID!

The ID of the Automator Connection that is being updated

status : AutomatorConnectionStatus!

The new status of the Automator Connection

Back to top

AutomatorConnectionUpdateResponse

A Response for an Automator Connection Update Mutation

Related types: MutationResponse

connection : AutomatorConnection

The Connection that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AutomatorCustomer

The kind of organisation an Automator project is being registered for. Used as the prefix of the created n8n project name, e.g. "[Customer] ...".

Customer
Administrate
Prospect
Back to top

AutomatorRegisterInput

An input for registering the current instance for Automator

name : String!

The name of the n8n project to create

customerType : AutomatorCustomer!

The kind of organisation, used as the project name prefix

Back to top

AutomatorRegisterResponse

A Response for an Automator Register Mutation

Related types: MutationResponse

connectionId : ID

The ID of the Automator Connection that was created

errors : [FieldError!]!

The errors returned by the mutation

projectId : String

The ID of the n8n project that was created

Back to top

AutomatorSettings

Administrate Automator Settings configured in your instance

automations : AutomatorAutomationConnection!

Returns a list of Administrate Automator Automations

Argument Type Description
filters = [] [AutomatorAutomationFieldGraphFilter]
order = "__EMPTY__" AutomatorAutomationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AutomatorAutomationFieldGraphOrder]
automatorUsers : AutomatorUserConnection!

Returns a list of Administrate Automator Users

Argument Type Description
filters = [] [AutomatorUserFieldGraphFilter]
order = "__EMPTY__" AutomatorUserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AutomatorUserFieldGraphOrder]
connections : AutomatorConnectionConnection!

Returns a list of Administrate Automator Connections

Argument Type Description
filters = [] [AutomatorConnectionFieldGraphFilter]
order = "__EMPTY__" AutomatorConnectionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AutomatorConnectionFieldGraphOrder]
webhookMappings : AutomatorWebhookMappingConnection!

Returns a list of Administrate Automator Webhook Mappings

Argument Type Description
filters = [] [AutomatorWebhookMappingFieldGraphFilter]
order = "__EMPTY__" AutomatorWebhookMappingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AutomatorWebhookMappingFieldGraphOrder]
Back to top

AutomatorSettingsMutations

Updates that can be made to Administrate Automator Settings

createAutomation : AutomatorAutomationCreateResponse!

Creates a new Automator Automation

Argument Type Description
input AutomatorAutomationCreateInput!
createConnection : AutomatorConnectionCreateResponse!

Creates a new Automator Connection

Argument Type Description
input AutomatorConnectionCreateInput!
createUser : AutomatorUserCreateResponse!

Creates a new Automator User

Argument Type Description
input AutomatorUserCreateInput!
deleteUser : AutomatorUserDeleteResponse!

Deletes an Automator User

Argument Type Description
input AutomatorUserDeleteInput!
generateSsoPayload : AutomatorSsoPayloadResponse!

Generates a SAML SSO payload for launching n8n Automator

Argument Type Description
input AutomatorSsoPayloadInput!
registerForAutomator : AutomatorRegisterResponse!

Registers the current instance for Automator by creating an n8n project and an enabled Production Automator Connection for it. Restricted to internal Administrate staff.

Argument Type Description
input AutomatorRegisterInput!
updateAutomation : AutomatorAutomationUpdateResponse!

Updates an existing Automator Automation

Argument Type Description
input AutomatorAutomationUpdateInput!
updateConnection : AutomatorConnectionUpdateResponse!

Updates an existing Automator Connection

Argument Type Description
input AutomatorConnectionUpdateInput!
updateUser : AutomatorUserUpdateResponse!

Updates an existing Automator User

Argument Type Description
input AutomatorUserUpdateInput!
Back to top

AutomatorSsoPayloadInput

An input for generating an SSO payload to launch n8n Automator

connectionId : ID!

The ID of the Automator Connection

Back to top

AutomatorSsoPayloadResponse

A Response for an Automator SSO Payload Mutation

Related types: MutationResponse

acsUrl : String

The Assertion Consumer Service URL to POST the SAML Response to

errors : [FieldError!]!

The errors returned by the mutation

relayState : String

The RelayState URL to include in the SAML POST

samlResponse : String

The base64-encoded SAML Response

Back to top

AutomatorUser

The Administrate Automator Users configured in your instance

Related types: Node

admin : Boolean!

Whether the Automator User is an admin

connection : AutomatorConnection!

The Automator Connection associated with the Automator User

Argument Type Description
filters = [] [AutomatorConnectionFieldGraphFilter]
order = "__EMPTY__" AutomatorConnectionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AutomatorConnectionFieldGraphOrder]
createdAt : TimeZonedDateTime!

The time that the Automator User was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
externalUserId : String

The external user ID assigned to the Automator User

id : ID!

The ID of the Automator User

isArchived : Boolean!

Whether the Automator User is archived

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

role : AutomatorUserRole!

The role assigned to the Automator User

status : AutomatorUserStatus!

The status of the Automator User

updatedAt : TimeZonedDateTime!

The time that the Automator User was last updated

user : User!

The User associated with the Automator User

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

AutomatorUserConnection

A connection containing page information and edges for AutomatorUser

edges : [AutomatorUserEdge!]!

The list of AutomatorUser edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AutomatorUserCreateInput

An input for creating an Automator User

userId : ID!

The User ID associated with the Automator User

connectionId : ID!

The Automator Connection ID associated with the Automator User

role : AutomatorUserRole!

The role assigned to the Automator User

status : AutomatorUserStatus!

The status of the Automator User

externalUserId : String

The external user ID assigned to the Automator User

Back to top

AutomatorUserCreateResponse

A Response for an Automator User Create Mutation

Related types: MutationResponse

automatorUser : AutomatorUser

The Automator User that was created

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AutomatorUserDeleteInput

An input for deleting an Automator User

automatorUserId : ID!

The ID of the Automator User to delete

Back to top

AutomatorUserDeleteResponse

A Response for an Automator User Delete Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AutomatorUserEdge

Contains cursor and node information for type AutomatorUser

cursor : String!

A string that can be used for cursor-based pagination

node : AutomatorUser!

The AutomatorUser node.

Back to top

AutomatorUserField

An enumeration.

id
userId
connectionId
externalUserId
role
status
admin
isArchived
createdAt
updatedAt
Back to top

AutomatorUserFieldGraphFilter

Filter that can be applied to limit which AutomatorUser nodes are returned

field : AutomatorUserField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AutomatorUserFieldGraphOrder

Specifies the order in which AutomatorUser nodes are returned via the Connection

field : AutomatorUserField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AutomatorUserRole

An enumeration.

Editor
Viewer
Back to top

AutomatorUserStatus

An enumeration.

Active
Pending
Disabled
Back to top

AutomatorUserUpdateInput

An input for updating an Automator User

automatorUserId : ID!

The ID of the Automator User that is being updated

role : AutomatorUserRole

The new role of the Automator User

status : AutomatorUserStatus

The new status of the Automator User

externalUserId : String

The new external user ID of the Automator User

Back to top

AutomatorUserUpdateResponse

A Response for an Automator User Update Mutation

Related types: MutationResponse

automatorUser : AutomatorUser

The Automator User that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

AutomatorWebhookMapping

The Administrate Automator Webhook Mappings configured in your instance

Related types: Node

automation : AutomatorAutomation!

The Automator Automation associated with the Automator Webhook Mapping

Argument Type Description
filters = [] [AutomatorAutomationFieldGraphFilter]
order = "__EMPTY__" AutomatorAutomationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AutomatorAutomationFieldGraphOrder]
createdAt : TimeZonedDateTime!

The time that the Automator Webhook Mapping was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Automator Webhook Mapping

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

updatedAt : TimeZonedDateTime!

The time that the Automator Webhook Mapping was last updated

webhook : Webhook!

The Webhook associated with the Automator Webhook Mapping

Argument Type Description
filters = [] [WebhookFieldGraphFilter]
order = "__EMPTY__" WebhookFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WebhookFieldGraphOrder]
Back to top

AutomatorWebhookMappingConnection

A connection containing page information and edges for AutomatorWebhookMapping

edges : [AutomatorWebhookMappingEdge!]!

The list of AutomatorWebhookMapping edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

AutomatorWebhookMappingEdge

Contains cursor and node information for type AutomatorWebhookMapping

cursor : String!

A string that can be used for cursor-based pagination

node : AutomatorWebhookMapping!

The AutomatorWebhookMapping node.

Back to top

AutomatorWebhookMappingField

An enumeration.

id
automationId
webhookId
createdAt
updatedAt
Back to top

AutomatorWebhookMappingFieldGraphFilter

Filter that can be applied to limit which AutomatorWebhookMapping nodes are returned

field : AutomatorWebhookMappingField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

AutomatorWebhookMappingFieldGraphOrder

Specifies the order in which AutomatorWebhookMapping nodes are returned via the Connection

field : AutomatorWebhookMappingField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

AvailabilityTimeSpan

A range of available time with the number of learners available and the start and end grains, which are the number of half hours from midnight of the availability start date

endGrain : Int!

The time the availability span ends, represented in half hours from midnight of the availability start date

learnerCount : Int!

The number of learners available during this time span

startGrain : Int!

The time the availability span starts, represented in half hours from midnight of the availability start date

Back to top

Billable

Something that you can generate a bill for i.e. an Event, a Learner, a Learning Path Learner etc.

Related types: Event LearningPathLearner Learner

id : ID!

The ID of the Billable.

Back to top

BlendedEventCreateInput

An Input for creating a Blended Event

eventType : EventType!
timeZoneName : String!
classroomStartDateTime : LocalDateTime

The classroom start date and time (without a timezone). Provide either this field and classroomEndDateTime, or the timezone-aware timeZonedClassroomStart/timeZonedClassroomEnd pair - not both. How the classroom start and end are used depends on how the Event's classroom sessions are set up:

  • No courseTemplateId: one classroom session is created, running from the start to the end. Both are required unless sessions is given.
  • courseTemplateId with session templates: the sessions come from the Course Template. Only the start is used - its date sets when the sessions begin and its time shifts them from the template's default session times; the end is ignored.
  • courseTemplateId with a schedule but no session templates: provide both a start and an end to create one session running from the start to the end, or provide only the start to create sessions from the schedule (the end is then ignored).
  • sessionSchedule provided together with a courseTemplateId: sessions are created from that schedule, starting on the start date; the end is ignored. A sessionSchedule given without a courseTemplateId is ignored (the rules above still apply).
  • sessions provided: those classroom sessions are created as given and set the Event's classroom start and end, so this field and classroomEndDateTime can be omitted; anything supplied for them is replaced by the span of the sessions. The LMS dates are unaffected.
classroomEndDateTime : LocalDateTime

The classroom end date and time (without a timezone). Sets the classroom session's end only when the Event has a single classroom session: when no courseTemplateId is given, or when the Course Template has a schedule but no session templates and a start is also provided. Otherwise - including whenever sessions is given - it is ignored and taken from the created sessions (see classroomStartDateTime).

timeZonedClassroomStart : TimeZonedDateTime

The same as classroomStartDateTime but with a timezone; see that field for how the classroom start and end are used. Use this pair instead of the version without a timezone, not both.

timeZonedClassroomEnd : TimeZonedDateTime

The same as classroomEndDateTime but with a timezone; see that field for how the classroom start and end are used.

lmsStartDateTime : LocalDateTime

The LMS start date and time (without a timezone). Either provide both lmsStartDateTime and lmsEndDateTime, or provide a courseTemplateId whose Course Template has an LMS schedule so the LMS dates can be taken from it. Used exactly as given.

lmsEndDateTime : LocalDateTime

The LMS end date and time (without a timezone). See lmsStartDateTime.

timeZonedLmsStart : TimeZonedDateTime

The same as lmsStartDateTime but with a timezone. Use this pair instead of the version without a timezone, not both.

timeZonedLmsEnd : TimeZonedDateTime

The same as lmsEndDateTime but with a timezone.

title : String
location : ID
locationId : ID
taxType : ID
taxTypeId : ID
timeZone : String
courseCode : String
code : String
lifecycleState : EventLifecycleState
status : EventStatus
minPlaces : Int
maxPlaces : Int
targetFillRate : Int
achievementTypeId : ID
achievementValidFrom : AchievementValidFromTypes
courseTemplateId : ID
courseTemplateVersionId : ID

Experimental. Pin the Event to a frozen version of the Course Template given in courseTemplateId, so its content is taken from that version instead of the current one. Requires the Course Template versioning feature.

privateEventDetails : PrivateEventDetailsCreateInput
registrationDeadline : LocalDateTime
registrationOpensAt : LocalDateTime
localeId : ID
webConferencingIntegrationId : ID
customFieldValues : [CustomFieldValueInput]
sessions : [SessionCreateDetailsInput]

The list of classroom Sessions to create on the Event, each with its own start and end. Replaces the sessions that would otherwise come from the courseTemplateId, sessionSchedule or classroom start/end, so the Event ends up with only these Sessions.

venueId : ID
externalNotes : String
internalNotes : String
lmsAnnouncements : String
taskWorkflowGroupIds : [ID]
taskWorkflowIds : [ID]
Back to top

BlendedEventUpsertByExternalIdInput

An input to Create or Update a Blended Event based on a provided External ID

externalId : ExternalIdInput!

The External ID used to identify the Event to upsert. If an Event does not exist, this External ID is set on the created Event.

event : BlendedEventUpsertInput!

The details with which to create or update the Event.

Back to top

BlendedEventUpsertInput

An Input for upserting a blended Event

eventType : EventType!
timeZoneName : String!
classroomStartDateTime : LocalDateTime

The classroom start date and time (without a timezone). Used as in BlendedEventCreateInput when this upsert creates a new Event. To add or change an Event's classroom sessions - including when updating an existing Event - use the sessions field.

classroomEndDateTime : LocalDateTime

The classroom end date and time (without a timezone). As in BlendedEventCreateInput, only used when a new Event is created with a single classroom session; otherwise manage session ends through the sessions field.

timeZonedClassroomStart : TimeZonedDateTime

The same as classroomStartDateTime but with a timezone; use this pair instead of the version without a timezone, not both.

timeZonedClassroomEnd : TimeZonedDateTime

The same as classroomEndDateTime but with a timezone.

lmsStartDateTime : LocalDateTime

The LMS start date and time (without a timezone). Used as in BlendedEventCreateInput when this upsert creates a new Event.

lmsEndDateTime : LocalDateTime

The LMS end date and time (without a timezone). Used as in BlendedEventCreateInput when this upsert creates a new Event.

timeZonedLmsStart : TimeZonedDateTime

The same as lmsStartDateTime but with a timezone; use this pair instead of the version without a timezone, not both.

timeZonedLmsEnd : TimeZonedDateTime

The same as lmsEndDateTime but with a timezone.

title : String
location : ID
locationId : ID
taxType : ID
taxTypeId : ID
timeZone : String
courseCode : String
code : String
lifecycleState : EventLifecycleState
status : EventStatus
minPlaces : Int
maxPlaces : Int
targetFillRate : Int
achievementTypeId : ID
achievementValidFrom : AchievementValidFromTypes
courseTemplateId : ID
privateEventDetails : PrivateEventDetailsCreateInput
registrationDeadline : LocalDateTime
registrationOpensAt : LocalDateTime
localeId : ID
webConferencingIntegrationId : ID
customFieldValues : [CustomFieldValueInput]
sessions : [SessionUpsertByExternalIdDetailsInput]

The list of Sessions to upsert on this Event. Give a Session an externalId to update it in place on future calls; without one, a new Session is always added. Sessions omitted from a later call are left untouched

venueId : ID
externalNotes : String
internalNotes : String
lmsAnnouncements : String
taskWorkflowGroupIds : [ID]
taskWorkflowIds : [ID]
Back to top

BlendedSchedule

A schedule for the event tied to the Course

Related types: Schedule

accessDuration : LmsDuration

The access duration of the LMS course

courseDuration : LmsDuration

The course duration of the LMS course

lmsEndOffset : LmsScheduleOffset

The Schedule LMS end offset

lmsStartOffset : LmsScheduleOffset

The Schedule LMS start offset

registrationDeadlineOffset : RegistrationDeadlineOffset

The Schedule registration deadline offset

session : ScheduleSession!

The schedule details for the BlendedSchedule Session (e.g. start/end times and repeat intervals)

Back to top

BlendedScheduleInput

An input to set Blended Schedule on a Course Template

registrationDeadlineOffset : RegistrationDeadlineOffsetInput
lmsStartOffset : LmsScheduleOffsetInput
Back to top

Bookable

A thing that is available to book onto

Related types: Event LearningPath

id : ID!

The ID of the Bookable

Back to top

BookableConnection

A connection containing page information and edges for Bookable

edges : [BookableEdge!]!

The list of Bookable edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

BookableEdge

Contains cursor and node information for type Bookable

cursor : String!

A string that can be used for cursor-based pagination

node : Bookable!

The Bookable node.

Back to top

BookableFieldGraphFilter

Filter that can be applied to limit which Bookable nodes are returned

field : BookableTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

BookableFieldGraphOrder

Specifies the order in which Bookable nodes are returned via the Connection

field : BookableTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

BookableTypeField

Fields for filtering and ordering Bookables. isValidForPortal: Whether the Bookable is valid for a specific Portal learningMode: The Learning Mode of the Bookable (Events only) remainingPlaces: How many places are remaining to book on the Bookable end: The Bookable end date start: The Bookable start date type: The type of Bookable isBundle: Whether the Bookable is a bundle (Paths only, will show ALL events regardless) language: The language of the Bookable (taken from the locale or defaults to English) e.g "English"

end
isValidForPortal
isBeforeRegistrationDeadline
learningMode
remainingPlaces
start
type
isBundle
locationId
courseId
language
Back to top

BookingStat

An aggregated statistic regarding an entity's bookings

totalCount : Int!

Total number of bookings for the entity

Back to top

BookingTerms

The Booking Terms for a Weblink Portal

terms : [PortalTerm!]!

Booking Terms connected to the Weblink Portal

Back to top

Boolean

The Boolean scalar type represents true or false.

Back to top

Brand

A Contact facing identity used with Portals such as LMS and Weblink

Related types: Node

availabilityState : BrandAvailabilityState!

The current availability of this Brand

branding : Branding!

The elements used to define this Brand's visual identity

contactCredentials : ContactCredentialsConnection!

The Contact Credentials that can be used to sign in to this Brand

Argument Type Description
filters = [] [ContactCredentialsFieldGraphFilter]
order = "__EMPTY__" ContactCredentialsFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactCredentialsFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Brand

identityProviderConfigurations : BrandIdentityProviderConfigurationConnection!

Configurations of Identity Providers that can sign in to this Brand

Argument Type Description
filters = [] [BrandIdentityProviderConfigurationFieldGraphFilter]
order = "__EMPTY__" BrandIdentityProviderConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandIdentityProviderConfigurationFieldGraphOrder]
isDefault : Boolean!

Indicates if this is the default Brand

isLoginByTokenEnabled : Boolean!

Indicates if Contacts are allowed to log into this Brand by requesting a sign-in token

isResetPasswordBySMSEnabled : Boolean!

Indicates if Contacts are allowed to reset their password by receiving an SMS Code

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of this Brand

portals : PortalConnection!

The Portals associated with this Brand

Argument Type Description
filters = [] [PortalFieldGraphFilter]
order = "__EMPTY__" PortalFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalFieldGraphOrder]
postSignoutRedirectUrl : URL

The the URL to redirect to once the user has been signed out

sendingEmailAddress : SendingEmailAddress

A verified Email Address used to send communication emails from, such as password reset emails

Argument Type Description
filters = [] [SendingEmailAddressFieldGraphFilter]
order = "__EMPTY__" SendingEmailAddressFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingEmailAddressFieldGraphOrder]
sendingPhoneNumber : SendingPhoneNumber

A Phone Number Address used to send communication messages from, such as SMS password reset

Argument Type Description
filters = [] [SendingPhoneNumberFieldGraphFilter]
order = "__EMPTY__" SendingPhoneNumberFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingPhoneNumberFieldGraphOrder]
sessionTtl : Int!

Indicates the Brand's session time to live

setupCredentialsForExistingContactsOnFirstLogin : Boolean!

Whether existing Contacts in the CRM without Contact Credentials can enter their email on the Brand's login screen and be automatically sent an email with instructions to setup their password

singleSignOnOnly : Boolean!

Indicates if Contacts can log into this Portal only by Single Sign On

ssoUriInfo : SsoUriInfo!

The URI's required to setup an SSO integration

welcomeMessage : WelcomeMessage

A Welcome Message associated to this Brand

Argument Type Description
filters = [] [WelcomeMessageFieldGraphFilter]
order = "__EMPTY__" WelcomeMessageFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WelcomeMessageFieldGraphOrder]
Back to top

BrandAvailabilityState

Availability states for Brands

enabled
disabled
Back to top

BrandConnection

A connection containing page information and edges for Brand

edges : [BrandEdge!]!

The list of Brand edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

BrandCreateInput

An Input for creating a new Brand

name : String!

The name of the new Brand

isDefault : Boolean

Indicates if this is the default Brand

singleSignOnOnly : Boolean

Denotes whether Contacts are limited to using Single Sign On for this Brand

sessionTtl : Int

Indicates the time to live for the session

isLoginByTokenEnabled : Boolean

Indicates if Contacts are allowed to log into this Brand by requesting a sign-in token

sendingEmailAddressId : ID

A Verified Sending Email Address to be used for this Brand's email communications

isResetPasswordBySMSEnabled : Boolean

Indicates if Contacts are allowed to reset their password by receiving an SMS pin

sendingPhoneNumberId : ID

A Sending Phone Number used for this Brand's SMS communications

postSignoutRedirectUrl : URL

The URL users should be redirected to when signing out

setupCredentialsForExistingContactsOnFirstLogin : Boolean

Whether existing Contacts in the CRM without Contact Credentials can enter their email on the Brand's login screen and be automatically sent an email with instructions to setup their password

Back to top

BrandedCertificateTemplate

A Branded Certificate Template linked to a Certificate Type

brand : Brand!

ID of the Brand linked ot the Template

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
certificateTemplate : CertificateTemplate!

ID of the Certificate Template linked to the Template

Argument Type Description
filters = [] [CertificateTemplateFieldGraphFilter]
order = "__EMPTY__" CertificateTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CertificateTemplateFieldGraphOrder]
Back to top

BrandedCertificateTemplateInput

The input type used to map a Brand to a Certificate Template for a given Certificate Type

brandId : ID!
certificateTemplateId : ID!
Back to top

BrandEdge

Contains cursor and node information for type Brand

cursor : String!

A string that can be used for cursor-based pagination

node : Brand!

The Brand node.

Back to top

BrandEnableInput

An Input for enabling a Brand

brandId : ID!

The ID of the Brand to enable

Back to top

BrandFieldGraphFilter

Filter that can be applied to limit which Brand nodes are returned

field : BrandTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

BrandFieldGraphOrder

Specifies the order in which Brand nodes are returned via the Connection

field : BrandTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

BrandIdentityProviderConfiguration

A Brand's Identity Provider configuration and auto-provisioning settings

Related types: Node

autoProvisionLearners : Boolean!

Indicates if Learners will be provisioned a Contact when signing in to the Brand for the first time using this Identity Provider

brand : Brand!

The Brand that the Identity Provider can sign in to

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
defaultAccount : Account

The Account that auto-provisioned Contacts will belong to. If this is not set, Individual Accounts will be created for each Contact

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Brand Identity Provider Mapping

identityProvider : IdentityProvider!

The Identity Provider used by the Brand to sign in

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

BrandIdentityProviderConfigurationConnection

A connection containing page information and edges for BrandIdentityProviderConfiguration

edges : [BrandIdentityProviderConfigurationEdge!]!

The list of BrandIdentityProviderConfiguration edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

BrandIdentityProviderConfigurationEdge

Contains cursor and node information for type BrandIdentityProviderConfiguration

cursor : String!

A string that can be used for cursor-based pagination

node : BrandIdentityProviderConfiguration!

The BrandIdentityProviderConfiguration node.

Back to top

BrandIdentityProviderConfigurationField

Fields for filtering and ordering Brand Identity Provider Configurations

id
brand_id
Back to top

BrandIdentityProviderConfigurationFieldGraphFilter

Filter that can be applied to limit which BrandIdentityProviderConfiguration nodes are returned

field : BrandIdentityProviderConfigurationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

BrandIdentityProviderConfigurationFieldGraphOrder

Specifies the order in which BrandIdentityProviderConfiguration nodes are returned via the Connection

field : BrandIdentityProviderConfigurationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

BrandIdentityProviderConfigurationInput

An Input for updating a Brand's Identity Provider configuration and auto-provisioning settings

brandId : ID!

The ID of the Brand that the Identity Provider will be configured to sign in to

identityProviderId : ID!

The ID of the Identity Provider which can be used to sign in to the Brand

autoProvisionLearners : Boolean

Denotes whether Learners will be provisioned a Contact when signing in to the Brand for the first time using this Identity Provider

defaultAccountId : ID

The Account that auto-provisioned Contacts will belong to. If this is not set, Individual Accounts will be created for each Contact during provisioning

Back to top

Branding

A collection of elements used to define a Brand's visual identity

buttons : BrandingButtons!

The Button options used by this Branding

colours : BrandingColours!

The Colours used by this Branding

images : BrandingImages!

The Images used by this Branding

typefaces : BrandingTypefaces!

The Typefaces used by this Branding

Back to top

BrandingButtons

Settings that define Branding Buttons

borderRadius : String!

The border radius on Buttons that have this Branding applied

Back to top

BrandingButtonsInput

An Input for updating a Brand's button characteristics

borderRadius : String

The new Button border radius of the Branding. Units supported: "em", "px" or "%".

Back to top

BrandingColours

A collection of Colours that are part of a Branding

contrastText : Colour!

The text Color used on color branded backgrounds like title bars

mainText : Colour!

The text Color used on light backgrounds like the Course description and Event lists

navigationBackground : Colour!

The Background Color used on Page Navigation Bars

navigationButtonText : Colour!

The text Color used on buttons within the Navigation Bar

primary : Colour!

The primary Branding Color used as a highlight and selection Colour

primaryActionButton : Colour!

The background Color used on primary actions, like the checkout button

primaryActionButtonText : Colour!

The text Color used on primary actions, like the checkout button

secondary : Colour!

The secondary Branding Color

secondaryActionButton : Colour!

The background Color used on secondary actions, like the cancel button

secondaryActionButtonText : Colour!

The text Color used on secondary actions, like the cancel button

Back to top

BrandingColoursInput

An Input for updating a Brand's colour palette

primary : Colour

The new primary Color of the Branding

secondary : Colour

The new secondary Color of the Branding

mainText : Colour

The new main text Color of the Branding

contrastText : Colour

The new contrast text Color of the Branding

primaryActionButton : Colour

The new primary action button background Color of the Branding

primaryActionButtonText : Colour

The new primary action button text Color of the Branding

secondaryActionButton : Colour

The new secondary action button background Color of the Branding

secondaryActionButtonText : Colour

The new secondary action button text Color of the Branding

navigationBackground : Colour

The new navigation bar background Color of the Branding

navigationButtonText : Colour

The new navigation bar button text Color of the Branding

Back to top

BrandingImage

Settings that define a Branding Image

document : Document

The DMS document that stores this Image

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
hash : String

The hash that identifies the current version of the Image

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
Back to top

BrandingImages

A collection of Images that are part of a Branding

favicon : BrandingImage!

The favicon Image displayed in browser tabs that have this Branding applied

signInBackground : BrandingImage!

The Image displayed in the background of sign in screens that have this Branding applied

Deprecated fields (3)
logoForDarkHeader : BrandingImage!

The logo displayed in headers with a dark background on pages that have this Branding applied

Removal date: 2023-08-23.

Replaced by weblinkLogo

logoForLightHeader : BrandingImage!

The logo displayed in headers with a light background on pages that have this Branding applied

Removal date: 2023-08-23.

Replaced by lmsLogo

Back to top

BrandingImagesInput

An Input specifying the Brand's logos for display in the LMS and WebLink Portals for the Brand

logoForLightHeader : ID

Deprecated in favor of lmsLogo.

logoForDarkHeader : ID

Deprecated in favor of weblinkLogo.

signInBackground : ID

The sign in background Image

favicon : ID

The favicon Image

Back to top

BrandingTypeface

Settings that define a Branding Type Face

fallbackSystemFontFamily : SystemFontFamily

The font family that is used for this Typeface when the WebFont is not defined or fails to load

webFont : WebFont

An externally hosted Web Font that is used for this Typeface

Back to top

BrandingTypefaceInput

An Input for specifying a font's preferred and fall back family

fallbackSystemFontFamily : SystemFontFamily!

The new fallback system font family of the Typeface

webFont : WebFontInput

The new WebFont of the Typeface

Back to top

BrandingTypefaces

Settings that define a Branding Type Face

body : BrandingTypeface!

The Typeface used by body text on pages that have this Branding applied

title : BrandingTypeface!

The Typeface used by titles on pages that have this Branding applied

Back to top

BrandingTypefacesInput

An Input for updating the fonts used when rendering a Brand's portals

title : BrandingTypefaceInput

The new title Typeface of the Branding

body : BrandingTypefaceInput

The new body Typeface of the Branding

Back to top

BrandMutationResponse

A Response from mutating a Brand

Related types: MutationResponse

brand : Brand

The Brand that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

BrandMutations

Mutations available for Brands

create : BrandMutationResponse!

Creates a Brand

Argument Type Description
input BrandCreateInput!

The input type with the values used to create a Brand
createIdentityProviderConfiguration : BrandMutationResponse!

Configures an Identity Provider so that it can be used to sign in to a Brand

Argument Type Description
input BrandIdentityProviderConfigurationInput!

The input type with the values used to configure an Identity Portal for a Brand
disable : BrandMutationResponse!

Disables a Brand

Argument Type Description
input BrandEnableInput!

The input type with the values used to disable a Brand
enable : BrandMutationResponse!

Enables a Brand

Argument Type Description
input BrandEnableInput!

The input type with the values used to enable a Brand
removeIdentityProviderConfiguration : BrandMutationResponse!

Removes an Identity Provider as a method to sign in to a Brand

Argument Type Description
input RemoveBrandIdentityProviderConfigurationInput!

The input type with the values used to remove the configuration of an Identity Portal for a Brand
update : BrandMutationResponse!

Update the details of a Brand

Argument Type Description
input BrandUpdateInput!

The input type with the values used to update the details of a Brand
updateBranding : BrandMutationResponse!

Update the Branding of a Brand

Argument Type Description
input BrandUpdateBrandingInput!

The input type with the values used to update the Branding of a Brand
updateIdentityProviderConfiguration : BrandMutationResponse!

Updates the configuration of an Identity Provider that can be used to sign in to a Brand

Argument Type Description
input BrandIdentityProviderConfigurationInput!

The input type with the values used to update the configuration of an Identity Portal for a Brand
Back to top

BrandTypeField

Fields for filtering and sorting Brands

id
name
availabilityState
hasCredentialsForContactId
Back to top

BrandUpdateBrandingInput

An Input for updating a Brand's theme (colours, fonts, logos and other visual characteristics)

brandId : ID!

The ID of the Brand to update

colours : BrandingColoursInput

The Colours of the Brand's Branding to update

images : BrandingImagesInput

The Images of the Brand's Branding to update

typefaces : BrandingTypefacesInput

The Typefaces of the Brand's Branding to update

buttons : BrandingButtonsInput

The Buttons of the Brand's Branding to update

Back to top

BrandUpdateInput

An Input for updating a new Brand

brandId : ID!

The ID of the Brand to update

name : String

The edited name of the Brand

isDefault : Boolean

The edited value indicating if this is the default Brand

singleSignOnOnly : Boolean

The edited value that denotes whether Contacts are limited to using Single Sign On for this Brand

sessionTtl : Int

The edited value indicating the time to live for a session

isLoginByTokenEnabled : Boolean

The edited value indicating if Contacts are allowed to log into this Brand by requesting a sign-in token

sendingEmailAddressId : ID

A Verified Sending Email Address to be used for this Brand's email communications

isResetPasswordBySMSEnabled : Boolean

The edited value indicating if Contacts are allowed to reset their password by receiving an SMS pin

sendingPhoneNumberId : ID

A Sending Phone Number used for this Brand's SMS communications

postSignoutRedirectUrl : URL

The URL users should be redirected to when signing out

setupCredentialsForExistingContactsOnFirstLogin : Boolean

Whether existing Contacts in the CRM without Contact Credentials can enter their email on the Brand's login screen and be automatically sent an email with instructions to setup their password

Back to top

BulkAdhocEmailAttachment

The ID and type of the attachment

name : String
folderId : String
url : String
Back to top

BulkAdhocEmailAttachmentDocument

An enumeration.

dms
template
dynamic_dms
ical_event
ical_learning_path
ical_sessions
opportunity_quote
opportunity_document
report
certificate
custom_certificate
invoice
opportunity_invoice
sales_receipt
token_receipt
sign_in_sheet
event_pdf
course_pdf
evaluation_summary_pdf
evaluation_form
Back to top

BulkAdhocEmailMutations

Mutations for sending adhoc emails for Events with large amounts of learners

sendBulkBookingContactAdhocEmail : BulkAdhocEmailMutationsResponse!

Sends an adhoc email to the booking contacts for all, or a specified subset of Learners on an Event

Argument Type Description
input SendBulkLearnerAdhocEmailInput!
sendBulkContactAdhocEmail : BulkAdhocEmailMutationsResponse!

Sends an adhoc email to specified Contacts on an Event

Argument Type Description
input SendBulkContactAdhocEmailInput!
sendBulkLearnerAdhocEmail : BulkAdhocEmailMutationsResponse!

Sends an adhoc email to all, or a specified subset of Learners on an Event

Argument Type Description
input SendBulkLearnerAdhocEmailInput!
sendBulkStaffAdhocEmail : BulkAdhocEmailMutationsResponse!

Sends an adhoc email to all, or a specified subset of Staff on an Event

Argument Type Description
input SendBulkStaffAdhocEmailInput!
Back to top

BulkAdhocEmailMutationsResponse

The response type for bulk adhoc email mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

BulkLearnerEmailAudience

An enumeration.

active
inactive
cancelled
passed
failed
Back to top

BulkSessionMutationResponse

A Response for a Bulk Session Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

sessions : [Session!]!

The Sessions that were mutated

Back to top

BuyXGetYRule

A Rule set up as part of a Promotion Campaign ensuring when the Buyer purchases "X", they also get "Y" for free.

buyQuantity : Int!

For Buy-X-Get-Y rules, this specifies the quantity of "X" required in order to get "Y"

getQuantity : Int!

For Buy-X-Get-Y rules, this specifies the quantity of "Y" received

maxQuantity : Int

For Buy-X-Get-Y rules, this specifies the maximum quantity of "Y" that can be received

sameEventOnly : Boolean

For Buy-X-Get-Y rules, this specifies that the "Y" has to be the same event

Back to top

BuyXGeyYRulesCreateInput

An input for setting the Buy-X-Get-Y Rules when creating a new Promotion Campaign

buyQuantity : Int!

This specifies the quantity of "X" required to be purchased in order to get "Y"

getQuantity : Int!

This specifies the quantity of "Y" received

maxQuantity : Int

This specifies the maximum quantity of "Y" than can be received

sameEventOnly : Boolean
Back to top

BuyXGeyYRulesUpdateInput

An input for setting the Buy-X-Get-Y Rules when updating an existing Promotion Campaign

buyQuantity : Int

This specifies the quantity of "X" required to be purchased in order to get "Y"

getQuantity : Int

This specifies the quantity of "Y" received

maxQuantity : Int

This specifies the maximum quantity of "Y" than can be received

sameEventOnly : Boolean
Back to top

Calendarable

An entity that has a start and end so can be displayed on a calendar

Related types: Event Session

end : LocalDateTime

End of the calendarable entity

id : ID!

ID of the Calendarable entity

start : LocalDateTime

Start of the calendarable entity

Back to top

CalendarableConnection

A connection containing page information and edges for Calendarable

edges : [CalendarableEdge!]!

The list of Calendarable edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CalendarableEdge

Contains cursor and node information for type Calendarable

cursor : String!

A string that can be used for cursor-based pagination

node : Calendarable!

The Calendarable node.

Back to top

CalendarableField

An enumeration.

start
end
Back to top

CalendarableFieldGraphFilter

Filter that can be applied to limit which Calendarable nodes are returned

field : CalendarableField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CalendarableFieldGraphOrder

Specifies the order in which Calendarable nodes are returned via the Connection

field : CalendarableField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CalendarEntry

An entry with a start and end time on a Calendar

Related types: Node

assignee : User

The User this Calendar Entry is assigned to

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Calendar Entry

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Calendar Entry

notes : String

The notes of the Calendar Entry

timeZonedEnd : TimeZonedDateTime!

The Date and Time the Calendar Entry ends with time zone information

timeZonedStart : TimeZonedDateTime!

The Date and Time the Calendar Entry starts with time zone information

type : TaskType

The Type of the Calendar Entry

Argument Type Description
filters = [] [TaskTypeFieldGraphFilter]
order = "__EMPTY__" TaskTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskTypeFieldGraphOrder]
Back to top

CalendarEntryConnection

A connection containing page information and edges for CalendarEntry

edges : [CalendarEntryEdge!]!

The list of CalendarEntry edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CalendarEntryEdge

Contains cursor and node information for type CalendarEntry

cursor : String!

A string that can be used for cursor-based pagination

node : CalendarEntry!

The CalendarEntry node.

Back to top

CalendarEntryField

Fields for filtering and ordering Calendar Entries

id
name
assigneeId
assignedContactId
taskTypeId
timeZonedStart
timeZonedEnd
Back to top

CalendarEntryFieldGraphFilter

Filter that can be applied to limit which CalendarEntry nodes are returned

field : CalendarEntryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CalendarEntryFieldGraphOrder

Specifies the order in which CalendarEntry nodes are returned via the Connection

field : CalendarEntryField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CalendarIntegration

calendar integration type

Related types: Node

calendarType : String!

Calendar type of the Calendar Integration

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Calendar Integration

lastSyncedAt : TimeZonedDateTime

Last time the calendar was synced

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

status : CalendarIntegrationStatus!

Status of the Calendar Integration

Back to top

CalendarIntegrationAddRoomCalendarResponse

A Response for the addRoomCalendars calendar integration mutation

Related types: MutationResponse

addedCalendars : AddedCalendarsResponse!

Room Calendars that have been attempted to be added to be synced

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CalendarIntegrationMapResourceCalendarsResponse

A response for the mapResourceCalendars calendar integration mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

resourceCalendars : [ResourceCalendar!]!

List of Resource Calendars that were successfully mapped to Resources

Back to top

CalendarIntegrationMutations

Updates calendar integration information.

addRoomCalendars : CalendarIntegrationAddRoomCalendarResponse!

Adds available Vendor Calendars for Rooms to be synced

Argument Type Description
input [AddRoomCalendarsInput]!

The input type with the values used to add Room Calendars
mapResourceCalendars : CalendarIntegrationMapResourceCalendarsResponse!

Maps the list of External Calendars to the specified Resources

Argument Type Description
input [MapResourceCalendarsInput]!

The input type with the list of values used to map External Calendars to Resources
removeCalendars : RemoveCalendarsResponse!

Removes Entities' connected calendars

Argument Type Description
input [RemoveCalendarsInput]!

a list of Entity calendars to remove
removeRoomCalendars : CalendarIntegrationRemoveRoomCalendarResponse!

Removes the specified list of Room Calendars and any synced Events

Argument Type Description
input [RemoveRoomCalendarsInput]!

The input type with the list values used to remove Room Calendars
sendSetupEmail : CalendarIntegrationSendSetupEmailResponse!

Sends a contact an email to request they share their calendar

Argument Type Description
input CalendarIntegrationSendSetupEmailInput!

The input with details about the email to be sent
syncCalendars : SyncCalendarsResponse!

Synchronises the specified entities' connected calendars to make sure they are up to date

Argument Type Description
input [SyncCalendarsInput]!

a list of Entity calendars to sync
syncResourceCalendars : SyncCalendarsResponse!

Synchronises the specified resources' connected calendars to make sure they are up to date

Argument Type Description
input [SyncResourceCalendarsInput]!

a list of resource calendars to sync
Back to top

CalendarIntegrationRemoveRoomCalendarResponse

A response for the removeRoomCalendars calendar integration mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

totalRemoved : Int!

Number of Room Calendars successfully removed

Back to top

CalendarIntegrationResourceAuthenticatedUser

Calendar Sync Authenticated Resource User

company : Company

The Company that the Authenticated Resource User belongs to

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
connectionStatus : ResourceUserConnectionStatus!

ConnectionStatus of the Authenticated Resource User

lastUpdatedAt : TimeZonedDateTime!

Last time the Resource User was updated at

logoutUrl : String!

URL used to disconnect the Resource Authenticated User and stop syncing

user : User

The Administrate User has authenticated

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
vendor : CalendarIntegrationResourceAuthenticatedUserVendor!

Vendor used to Authenticate the Resource User

Back to top

CalendarIntegrationResourceAuthenticatedUserVendor

Vendor Details for the Calendar Sync Authenticated Resource User

email : String!

The Email Address used by the Vendor for the logged in User

id : String!

The ID used by the Vendor for the logged in User

name : String!

Vendor used to Authenticate the Resource User

userDisplayName : String

The Display Name used by the Vendor for the logged in User

Back to top

CalendarIntegrationRoom

Available Room for the Authenticated Resource User

email : String!

Email of the Room

resourceAdminId : String!

Resource Administrator ID of the Room

title : String

Title of the Room

vendorId : String!

Vendor ID of the Room

Back to top

CalendarIntegrationSendSetupEmailInput

An input for sending a Calendar Share Request to a Contact

sendingAddressId : ID!

the Sending Address to use for the emails

contactIds : [ID]!

the Contacts to which to send the email to

subject : String

the email subject, sent to every Contact. If not specified, each Contact receives the calendar setup template subject in their Communication Language, or the default translation

body : String

the email body, sent to every Contact. If not specified, each Contact receives the calendar setup template body in their Communication Language, or the default translation

ccAddresses : [String]

any additional email addresses to send the email as Carbon Copy

Back to top

CalendarIntegrationSendSetupEmailResponse

A Response for the sendSharingRequestEmail calendar integration mutation

Related types: MutationResponse

emails : [Email!]!

The emails that were sent

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CalendarIntegrationSettings

Calendar Integration Settings Type

authenticatedResourceUsers : [CalendarIntegrationResourceAuthenticatedUser!]!

List of Users the current TMS User has authenticated for the Resource Calendar Sync

Argument Type Description
filters CalendarIntegrationSettingsFieldGraphFilter
availableRooms : [CalendarIntegrationRoom!]!

List of Rooms available for Calendar Integration

resourceCalendars : [ResourceCalendar!]!

List of Resource Calendars available for Calendar Integration

resourceLoginUrl : String!

URL for the Calendar Integration Service to login to connect resource calendars

storeMinimalEventDetails : Boolean!

Only busy times for all External Calendar Events are imported when enabled - titles are not displayed.

supportedVendors : [String!]!

List of supported Calendar Integration Vendors

Back to top

CalendarIntegrationSettingsField

Fields for filtering and ordering Calendar Integration Settings

currentUser
Back to top

CalendarIntegrationSettingsFieldGraphFilter

Filter that can be applied to limit which CalendarIntegrationSettings nodes are returned

field : CalendarIntegrationSettingsField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CalendarIntegrationSettingsMutations

Updates calendar integration information.

set : CalendarIntegrationSettingsResponse!

Sets Calendar Integration Settings

Argument Type Description
input CalendarSettingsSetInput!

The input type with the values used to set Calendar Integration Settings
Back to top

CalendarIntegrationSettingsResponse

A Response for a Calendar Integration Settings Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

settings : CalendarIntegrationSettings!

The Calendar Integration Settings

Back to top

CalendarIntegrationStatus

The status of a Calendar Integration

active
inactive
error
suspended
Back to top

CalendarSettingsSetInput

An input for setting Calendar Integration Settings

storeMinimalEventDetails : Boolean!

Only show busy times on all External Calendar Events will hide the titles of External Calendar Events when enabled.

Back to top

CancellationReason

A pre-defined set of reasons for a Learner to pick from when cancelling a Registration.

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Cancellation Reason

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

reasonText : String!

The Text for the Cancellation Reason

Back to top

CancellationReasonConnection

A connection containing page information and edges for CancellationReason

edges : [CancellationReasonEdge!]!

The list of CancellationReason edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CancellationReasonCreateInput

An input for creating a Cancellation Reason.

reasonText : String!
Back to top

CancellationReasonDeleteInput

An input for deleting a Cancellation Reason.

cancellationReasonId : ID!
Back to top

CancellationReasonEdge

Contains cursor and node information for type CancellationReason

cursor : String!

A string that can be used for cursor-based pagination

node : CancellationReason!

The CancellationReason node.

Back to top

CancellationReasonField

Fields for filtering and ordering Cancellation Reasons

id
Back to top

CancellationReasonFieldGraphFilter

Filter that can be applied to limit which CancellationReason nodes are returned

field : CancellationReasonField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CancellationReasonFieldGraphOrder

Specifies the order in which CancellationReason nodes are returned via the Connection

field : CancellationReasonField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CancellationReasonMutationResponse

A response from mutating a Cancellation Reason.

Related types: MutationResponse

cancellationReason : CancellationReason

The Cancellation Reason that was mutated.

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CancellationReasonMutations

Mutations available for Cancellation Reasons.

create : CancellationReasonMutationResponse!

Creates a Cancellation Reason.

Argument Type Description
input CancellationReasonCreateInput!
delete : CancellationReasonMutationResponse!

Deletes a Cancellation Reason.

Argument Type Description
input CancellationReasonDeleteInput!
update : CancellationReasonMutationResponse!

Updates a Cancellation Reason.

Argument Type Description
input CancellationReasonUpdateInput!
Back to top

CancellationReasonUpdateInput

An input for updating a Cancellation Reason.

cancellationReasonId : ID!
reasonText : String!
Back to top

CancellationRequest

A request to Cancel a Registration for a particular Learner.

Related types: Node

approvalState : CancellationRequestApprovalState!

The Approval State of the Cancellation Request

createdAt : LocalDateTime!

When the Cancellation Request was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Cancellation Request

learner : Learner!

The Learner linked to the Cancellation Request

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

reason : CancellationReason!

The Reason for the Cancellation Request

Argument Type Description
filters = [] [CancellationReasonFieldGraphFilter]
order = "__EMPTY__" CancellationReasonFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CancellationReasonFieldGraphOrder]
reasonNotes : String

The note that accompanies the above Reason for the Cancellation Request

updatedAt : LocalDateTime

The last time the Cancellation Request was updated

Back to top

CancellationRequestApprovalState

The Approval State of the Cancellation Request

pending
rejected
approved
Back to top

CancellationRequestApproveInput

An Input for approving a Cancellation Request

cancellationRequestId : ID!
Back to top

CancellationRequestConnection

A connection containing page information and edges for CancellationRequest

edges : [CancellationRequestEdge!]!

The list of CancellationRequest edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CancellationRequestCreateInput

An Input for creating a Cancellation Request

learnerId : ID!

The ID of the learner requesting this Cancellation Request

reasonId : ID!

The ID of the reason for the Cancellation Request

reasonNotes : String

The optional note that accompanies the Reason for the Cancellation Request

Back to top

CancellationRequestEdge

Contains cursor and node information for type CancellationRequest

cursor : String!

A string that can be used for cursor-based pagination

node : CancellationRequest!

The CancellationRequest node.

Back to top

CancellationRequestField

Fields for filtering and ordering Cancellation Requests

id
approvalState
learnerId
brandId
contactId
Back to top

CancellationRequestFieldGraphFilter

Filter that can be applied to limit which CancellationRequest nodes are returned

field : CancellationRequestField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CancellationRequestFieldGraphOrder

Specifies the order in which CancellationRequest nodes are returned via the Connection

field : CancellationRequestField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CancellationRequestMutationResponse

A Response from mutating a CancellationRequest

Related types: MutationResponse

cancellationRequest : CancellationRequest

The CancellationRequest that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CancellationRequestMutations

Mutations available for CancellationRequest

approve : CancellationRequestMutationResponse!

Approves a Cancellation Request

Argument Type Description
input CancellationRequestApproveInput!

The input type with the values used to approve a Cancellation Request
create : CancellationRequestMutationResponse!

Creates a Cancellation Request

Argument Type Description
input CancellationRequestCreateInput!

The input type with the values used to create a Cancellation Request
reject : CancellationRequestMutationResponse!

Transitions a Cancellation Request's approval state to rejected

Argument Type Description
input CancellationRequestRejectInput!

The input type with the values used to reject a Cancellation Request
Back to top

CancellationRequestRejectInput

An Input for rejecting a Cancellation Request

cancellationRequestId : ID!
Back to top

CascadableFields

Field names that are cascadable from a Course Template to Events and Sessions

title
code
companyId
localeId
accessViaPassTypeIds
lmsAutopassLearner
minPlaces
maxPlaces
customFieldValues
Back to top

CatalogOptions

The Catalog Options for a Weblink Portal

categories : [LearningCategory]!

The Learning Categories associated with this Portal

currency : Currency

The Currency the WebLink Portal will use

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
region : Region

The Region the WebLink Portal is in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
showEmptyCourses : Boolean!

A setting boolean to show or hide courses with no events

Back to top

CatalogueItem

A thing that is available to be sold

Related types: CourseTemplate LearningPath

id : ID!

The ID of the Catalogue Item

includedInPassTypeIds : [ID!]!

Identifiers for Published Training Pass Types that grant access to this Catalogue Item

name : String!

The name of the Catalogue Item

Deprecated fields (1)
includedInTrainingPasses : TrainingPassTypeConnection!

Published Training Pass Types that grants access to this Catalogue Item

Removal date: TBD.

Deprecated in favour of includedInPassTypeIds

Argument Type Description
filters = [] [TrainingPassTypeFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeFieldGraphOrder]
Back to top

CatalogueItemConnection

A connection containing page information and edges for CatalogueItem

edges : [CatalogueItemEdge!]!

The list of CatalogueItem edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CatalogueItemEdge

Contains cursor and node information for type CatalogueItem

cursor : String!

A string that can be used for cursor-based pagination

node : CatalogueItem!

The CatalogueItem node.

Back to top

CatalogueItemFieldGraphFilter

Filter that can be applied to limit which CatalogueItem nodes are returned

field : CatalogueItemTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CatalogueItemFieldGraphOrder

Specifies the order in which CatalogueItem nodes are returned via the Connection

field : CatalogueItemTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CatalogueItemTypeField

Fields for filtering and ordering Catalogue Items. locationId: Filter by Catalogue Items that contain events in specific locations. Returns Course Templates only. sessionStartTime: Filter catalogue returning only Course Templates with at least one event matching the specified session start time (no time zone information taken into account, event times will be treated as local times). sessionEndTime: Filter catalogue returning only Course Templates with at least one event matching the specified session end time (no time zone information taken into account, event times will be treated as local times). timeZonedStart: Filter catalogue returning only Course Templates with at least one event starting at the specified time (which must contain a time zone offset) timeZonedEnd: Filter catalogue returning only Course Templates with at least one event ending at the specified time (which must contain a time zone offset) remainingPlaces: Filter by Catalogue Items that contain only events with a matching number of places available. Returns Course Templates only. dayOfWeek: Filter by Catalogue Items where at least one event matches the specified days of the week. Day must be one of Mon|Tue|Wed|Thu|Fri|Sat|Sun. Returns Course Templates only. hasValidPriceForRegion: Filter Catalogue by the Region id of Course Prices and Learning Path Prices. Returns Course Templates and Learning Paths that have a Price in the specified Region. includedInTrainingPass: Filter Catalogue by one or more Training Pass Type ids that include Courses and Learning Paths. excludeTrainingPassType: Filter Catalogue by excluding Courses and Learning Paths included in a specified Training Pass Type. codeOrTitle: Filter Catalogue by searching for the code or title. learningTagId: Filter by Catalogue Items that contain Events or Learning Paths with a specific Learning Tag.

id
name
isBundle
isValidForPortal
learningCategoryId
type
isAssociatedWithAccount
isAssociatedByAccountAssociationType
locationId
sessionStartTime
sessionEndTime
timeZonedStart
timeZonedEnd
remainingPlaces
dayOfWeek
hasValidPriceForRegion
includedInTrainingPass
excludeTrainingPassType
codeOrTitle
learningTagId
Back to top

CategoryDiscountabilityRule

Promotion Campaign Discountability Rules related to Categories

Related types: PromotionDiscountabilityRule

discountableCategories : LearningCategoryConnection!

The Learning Categories that are discountable as part of the Category Discountability Rule

Argument Type Description
filters = [] [LearningCategoryFieldGraphFilter]
order = "__EMPTY__" LearningCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningCategoryFieldGraphOrder]
type : PromotionCriterionType!

The type of Discountability Rule (e.g. Course, Location, etc)

Back to top

CategoryEligibilityRule

Promotion Campaign Eligibility Rules related to Categories

Related types: PromotionEligibilityRule

eligibleCategories : LearningCategoryConnection!

The Learning Categories this Rule contains

Argument Type Description
filters = [] [LearningCategoryFieldGraphFilter]
order = "__EMPTY__" LearningCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningCategoryFieldGraphOrder]
type : PromotionCriterionType!

The type of Eligibility Rule (e.g. Course, Location, etc)

Back to top

CcAddress

Email address to CC on automatic communications

emailAddress : String!

Email address to CC on automatic communications

Back to top

CertificateGenerationLog

A log representing a specific Certificate being generated.

Related types: Node

achievementId : ID!

The ID of the achievement

certificateId : ID!

The ID of the Certificate Template

certificateTypeId : ID

The ID of the Certificate Type

errorDetail : String

The latest certificate generation error message

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
generatedAt : LocalDateTime!

The date and time this log has been generated

id : ID!

The ID of the Certificate Generation Log.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

status : CertificateGenerationLogStatus!

The status of the generaiont "success" or "failure"

Back to top

CertificateGenerationLogStatus

The status of the certificate generation

success
failure
Back to top

CertificateTemplate

Related types: Node

entityType : SupportedEntities!

The type of entity supported by the certificate.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Certificate Template

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The Name given to the Certificate Template

Back to top

CertificateTemplateConnection

A connection containing page information and edges for CertificateTemplate

edges : [CertificateTemplateEdge!]!

The list of CertificateTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CertificateTemplateEdge

Contains cursor and node information for type CertificateTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : CertificateTemplate!

The CertificateTemplate node.

Back to top

CertificateTemplateField

Fields for filtering and ordering Certificate Templates

id
name
Back to top

CertificateTemplateFieldGraphFilter

Filter that can be applied to limit which CertificateTemplate nodes are returned

field : CertificateTemplateField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CertificateTemplateFieldGraphOrder

Specifies the order in which CertificateTemplate nodes are returned via the Connection

field : CertificateTemplateField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CertificateType

Related types: Node

brandedCertificateTemplates : [BrandedCertificateTemplate!]!

The Branded Certificate Templates of the Certificate Type

defaultCertificateTemplate : CertificateTemplate!

The Default Certificate Template of the Certificate Type

Argument Type Description
filters = [] [CertificateTemplateFieldGraphFilter]
order = "__EMPTY__" CertificateTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CertificateTemplateFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Certificate Type

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : CertificateTypeLifecycleState!

The Lifecycle State of the Certificate Type

name : String!

The name of the Certificate Type

Back to top

CertificateTypeConnection

A connection containing page information and edges for CertificateType

edges : [CertificateTypeEdge!]!

The list of CertificateType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CertificateTypeCreateInput

An input for creating a Certificate Type

name : String!

The name given to the Certificate Type

defaultCertificateTemplateId : ID!
brandedCertificateTemplates : [BrandedCertificateTemplateInput]

A list of certificate template overrides used to associate Brands to Certificate Templates for a given Certificate Type

Back to top

CertificateTypeEdge

Contains cursor and node information for type CertificateType

cursor : String!

A string that can be used for cursor-based pagination

node : CertificateType!

The CertificateType node.

Back to top

CertificateTypeField

Fields for filtering and ordering Certificate Types

id
name
lifecycleState
Back to top

CertificateTypeFieldGraphFilter

Filter that can be applied to limit which CertificateType nodes are returned

field : CertificateTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CertificateTypeFieldGraphOrder

Specifies the order in which CertificateType nodes are returned via the Connection

field : CertificateTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CertificateTypeLifecycleState

An enumeration.

active
archived
Back to top

CertificateTypeMutateResponse

A Response from mutating an Certificate Type

Related types: MutationResponse

certificateType : CertificateType

The Certificate Type that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CertificateTypeMutations

Mutations for Certificate Type

create : CertificateTypeMutateResponse!

Creates a Certificate Type

Argument Type Description
input CertificateTypeCreateInput!

The input type with the values to be set on the new Certificate Type
update : CertificateTypeMutateResponse!

Updates a Certificate Type

Argument Type Description
input CertificateTypeUpdateInput!

The input type with the values to be set on the updated Certificate Type
Back to top

CertificateTypeUpdateInput

An input for updating a Certificate Type

certificateTypeId : ID!

The ID of the Certificate Type being updated

name : String

The updated name given to the Certificate Type

defaultCertificateTemplateId : ID
isArchived : Boolean

The flag indicating if the Certificate Type is archived

brandedCertificateTemplates : [BrandedCertificateTemplateInput]

A list of certificate template overrides used to associate Brands to Certificate Templates for a given Certificate Type

Back to top

ClassroomEventCreateInput

An Input for creating a Classroom Event

eventType : EventType!
timeZoneName : String!
classroomStartDateTime : LocalDateTime

The classroom start date and time (without a timezone). Provide either this field and classroomEndDateTime, or the timezone-aware timeZonedClassroomStart/timeZonedClassroomEnd pair - not both. How the start and end are used depends on how the Event's sessions are set up:

  • No courseTemplateId: one session is created, running from the start to the end. Both are required unless sessions is given.
  • courseTemplateId with session templates: the sessions come from the Course Template. Only the start is used - its date sets when the sessions begin and its time shifts them from the template's default session times; the end is ignored.
  • courseTemplateId with a schedule but no session templates: provide both a start and an end to create one session running from the start to the end, or provide only the start to create sessions from the schedule (the end is then ignored).
  • sessionSchedule provided together with a courseTemplateId: sessions are created from that schedule, starting on the start date; the end is ignored. A sessionSchedule given without a courseTemplateId is ignored (the rules above still apply).
  • sessions provided: those sessions are created as given and set the Event's start and end, so this field and classroomEndDateTime can be omitted; anything supplied for them is replaced by the span of the sessions.
classroomEndDateTime : LocalDateTime

The classroom end date and time (without a timezone). Sets the session's end only when the Event has a single session: when no courseTemplateId is given, or when the Course Template has a schedule but no session templates and a start is also provided. Otherwise - including whenever sessions is given - it is ignored and taken from the created sessions (see classroomStartDateTime).

timeZonedClassroomStart : TimeZonedDateTime

The same as classroomStartDateTime but with a timezone; see that field for how the start and end are used. Use this pair instead of the version without a timezone, not both.

timeZonedClassroomEnd : TimeZonedDateTime

The same as classroomEndDateTime but with a timezone; see that field for how the start and end are used.

title : String
location : ID
locationId : ID
taxType : ID
taxTypeId : ID
timeZone : String
courseCode : String
code : String
lifecycleState : EventLifecycleState
status : EventStatus
minPlaces : Int
maxPlaces : Int
targetFillRate : Int
achievementTypeId : ID
achievementValidFrom : AchievementValidFromTypes
courseTemplateId : ID
courseTemplateVersionId : ID

Experimental. Pin the Event to a frozen version of the Course Template given in courseTemplateId, so its content is taken from that version instead of the current one. Requires the Course Template versioning feature.

privateEventDetails : PrivateEventDetailsCreateInput
registrationDeadline : LocalDateTime
registrationOpensAt : LocalDateTime
localeId : ID
webConferencingIntegrationId : ID
customFieldValues : [CustomFieldValueInput]
sessions : [SessionCreateDetailsInput]

The list of Sessions to create on the Event, each with its own start and end. Replaces the sessions that would otherwise come from the courseTemplateId, sessionSchedule or classroom start/end, so the Event ends up with only these Sessions.

venueId : ID
externalNotes : String
internalNotes : String
taskWorkflowGroupIds : [ID]
taskWorkflowIds : [ID]
Back to top

ClassroomEventUpsertByExternalIdInput

An input to Create or Update a Classroom Event based on a provided External ID

externalId : ExternalIdInput!

The External ID used to identify the Event to upsert. If an Event does not exist, this External ID is set on the created Event.

event : ClassroomEventUpsertInput!

The details with which to create or update the Event.

Back to top

ClassroomEventUpsertInput

An Input for creating a Classroom Event

eventType : EventType!
timeZoneName : String!
classroomStartDateTime : LocalDateTime

The classroom start date and time (without a timezone). Used as in ClassroomEventCreateInput when this upsert creates a new Event. To add or change an Event's sessions - including when updating an existing Event - use the sessions field.

classroomEndDateTime : LocalDateTime

The classroom end date and time (without a timezone). As in ClassroomEventCreateInput, only used when a new Event is created with a single session; otherwise manage session ends through the sessions field.

timeZonedClassroomStart : TimeZonedDateTime

The same as classroomStartDateTime but with a timezone; use this pair instead of the version without a timezone, not both.

timeZonedClassroomEnd : TimeZonedDateTime

The same as classroomEndDateTime but with a timezone.

title : String
location : ID
locationId : ID
taxType : ID
taxTypeId : ID
timeZone : String
courseCode : String
code : String
lifecycleState : EventLifecycleState
status : EventStatus
minPlaces : Int
maxPlaces : Int
targetFillRate : Int
achievementTypeId : ID
achievementValidFrom : AchievementValidFromTypes
courseTemplateId : ID
privateEventDetails : PrivateEventDetailsCreateInput
registrationDeadline : LocalDateTime
registrationOpensAt : LocalDateTime
localeId : ID
webConferencingIntegrationId : ID
customFieldValues : [CustomFieldValueInput]
sessions : [SessionUpsertByExternalIdDetailsInput]

The list of Sessions to upsert on this Event. Give a Session an externalId to update it in place on future calls; without one, a new Session is always added. Sessions omitted from a later call are left untouched

venueId : ID
externalNotes : String
internalNotes : String
taskWorkflowGroupIds : [ID]
taskWorkflowIds : [ID]
Back to top

ClassroomSchedule

A schedule for the event tied to the Course

Related types: Schedule

registrationDeadlineOffset : RegistrationDeadlineOffset

The Schedule registration deadline offset

session : ScheduleSession!

The Session's Schedule

Back to top

ClassroomScheduleInput

An input to set Classroom Schedule on a Course Template

registrationDeadlineOffset : RegistrationDeadlineOffsetInput
Back to top

Client

Client details

description : String

The Client description

key : String!

The Client key

name : String!

The Client name

secret : String

The Client secret. Only available when creating client credentials

Back to top

ClientCredentials

Client Credentials details

client : Client!

The Client details

createdAt : LocalDateTime!

The date and time the Client Credentials were created

user : User

The User the client credentials grant will send API requests on behalf of

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

Colour

A hexadecimal code of format #RRGGBB that represents a colour

Back to top

Communication

A communication sent for an event, from either a trigger or a manually composed (ad hoc) email

contact : Contact

The Contact the Communication was sent to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
email : Email

The Email holding delivery detail for an ad hoc Communication

Argument Type Description
filters = [] [EmailFieldGraphFilter]
order = "__EMPTY__" EmailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EmailFieldGraphOrder]
error : String

The error recorded for the Communication, if any

event : Event

The Event the Communication belongs to

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
id : ID!

ID of the Communication. Trigger communications share their ID with the underlying Trigger Log; ad hoc communications with the underlying Email.

learner : Learner

The Learner the Communication was sent to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
scheduledEmailAddress : String

The scheduled email address of the Communication, if any

sentAt : LocalDateTime

When the Communication was sent

sentByUser : User

The User who manually sent the Communication, if any

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
session : Session

The Session the Communication belongs to, if any

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
source : CommunicationSource!

Whether this Communication came from a trigger or an ad hoc email

staff : Staff

The Staff member the Communication was sent to

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
status : String!

The current status of the Communication. Trigger communications use the Trigger Log and Trigger Email status vocabulary; ad hoc communications report pending, sent or error.

subject : String

The email subject

template : CommunicationTemplate

The Communication Template used, if any

Argument Type Description
filters = [] [CommunicationTemplateFieldGraphFilter]
order = "__EMPTY__" CommunicationTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CommunicationTemplateFieldGraphOrder]
toAddress : String

The address the Communication was sent to

trigger : Trigger

The Trigger that produced the Communication. Null for ad hoc communications.

Argument Type Description
filters = [] [TriggerFieldGraphFilter]
order = "__EMPTY__" TriggerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerFieldGraphOrder]
triggerEmail : TriggerEmail

The Trigger Email holding delivery detail for a trigger Communication

Argument Type Description
filters = [] [TriggerEmailFieldGraphFilter]
order = "__EMPTY__" TriggerEmailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerEmailFieldGraphOrder]
type : CommunicationType!

The communication channel

Back to top

CommunicationConnection

A connection containing page information and edges for Communication

edges : [CommunicationEdge!]!

The list of Communication edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CommunicationEdge

Contains cursor and node information for type Communication

cursor : String!

A string that can be used for cursor-based pagination

node : Communication!

The Communication node.

Back to top

CommunicationField

Fields for filtering and ordering Communications. bookingContactId is a filter-only field: it is resolved by joining out to the learner's registration rather than by a column of the Communication itself, so ordering by it is not supported.

id
source
type
status
communicationOrLogStatus
sentAt
communicationDate
contactId
learnerId
staffId
staffStatus
bookingContactId
eventId
triggerId
templateId
sentByUser
triggerName
contactName
templateName
learnerLifecycleState
scheduledEmail
Back to top

CommunicationFieldGraphFilter

Filter that can be applied to limit which Communication nodes are returned

field : CommunicationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CommunicationFieldGraphOrder

Specifies the order in which Communication nodes are returned via the Connection

field : CommunicationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CommunicationMutationResponse

A Response for a Communication Update Mutation

Related types: MutationResponse

email : Email

The email returned by the mutation

emailGroup : EmailGroup

The email group returned by the mutation

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CommunicationMutations

Available Mutations for Communications

sendTemplatedEmailForOpportunity : CommunicationMutationResponse!

Send an ad-hoc email from an Opportunity Document Template

Argument Type Description
input OpportunityAdHocEmailInput!
sendTemplatedLearnerEmailForEvent : CommunicationMutationResponse!

Send an ad-hoc email

Argument Type Description
input LearnersAdHocEmailInput!
Back to top

CommunicationSource

An enumeration.

trigger
adhoc
Back to top

CommunicationStats

Communication statistics over the time period specified.

adhocEmailGroups : Int!

The number of Adhoc Groups of Emails Sent

adhocEmails : Int!

The number of Adhoc Emails Sent

automatedCourseTriggers : Int!

The number of Course Triggers sent

automatedOpportunityTriggers : Int!

The number of Opportunity Triggers sent

emailTemplatesSent : Int!

The number of Email Templates Sent

smsTemplatesSent : Int!

The number of SMS Templates Sent

submissions : Int!

The number of Submissions

Back to top

CommunicationTemplate

A Communication Template containing text and formatting to deliver to a Contact

Related types: Node

audience : CommunicationTemplateAudience!

The audience chosen for the Communication Template

body : String!

The body of the Communication Template

code : CommunicationTemplateCode

The code of the Communication Template that is used only for system templates

company : Company

The Company that owns this Communication Template, null for global templates

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Communication Template

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

localeData : [TemplateLocaleData!]!

Localized data of the Communication Template

missingTranslations : [Locale!]!

Locale for which there is no localized data

name : String!

The name of the Communication Template that will be shown in the list

origin : CommunicationTemplateOrigin!

The origin of the Communication Template, system or user

subject : String

The subject of the Communication Template

type : CommunicationTemplateType!

The type of delivery method the Communication Template is intended to be used with

Back to top

CommunicationTemplateAssignLocaleToDataInput

The input type with the values used to assign locale to unknown data

templateLocaleDataId : ID!

The ID of the locale data

localeId : ID!

What should be the locale for this locale data

Back to top

CommunicationTemplateAttachment

Communication Template Attachment for a specific Locale Data

category : DocumentCategory

Category of the document

Argument Type Description
filters = [] [DocumentCategoryFieldGraphFilter]
order = "__EMPTY__" DocumentCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentCategoryFieldGraphOrder]
certificate : CertificateTemplate

Certificate of the Attachment

Argument Type Description
filters = [] [CertificateTemplateFieldGraphFilter]
order = "__EMPTY__" CertificateTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CertificateTemplateFieldGraphOrder]
document : Document

The DMS document that stores this Downloadable File

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
id : ID!

The ID of the Attachment

type : String!

Type of the Attachment

Back to top

CommunicationTemplateAttachmentConnection

A connection containing page information and edges for CommunicationTemplateAttachment

edges : [CommunicationTemplateAttachmentEdge!]!

The list of CommunicationTemplateAttachment edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CommunicationTemplateAttachmentCreateInput

The input type with the values used to create an Attachment for Communication Template

communicationTemplateId : ID!

The ID of template this attachment is for

localeId : ID!

What is the locale of this attachment

type : String!

The type of the attachment

documentId : ID

The ID of the document related to this attachment

documentCategoryId : ID

The ID of the document category

certificateId : ID

The ID of the certificate related to this attachment

Back to top

CommunicationTemplateAttachmentDeleteInput

The input type with the values used to delete an Attachment

communicationTemplateAttachmentId : ID!

The ID of the attachment to be deleted

Back to top

CommunicationTemplateAttachmentEdge

Contains cursor and node information for type CommunicationTemplateAttachment

cursor : String!

A string that can be used for cursor-based pagination

node : CommunicationTemplateAttachment!

The CommunicationTemplateAttachment node.

Back to top

CommunicationTemplateAttachmentFieldGraphFilter

Filter that can be applied to limit which CommunicationTemplateAttachment nodes are returned

field : CommunicationTemplateAttachmentTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CommunicationTemplateAttachmentFieldGraphOrder

Specifies the order in which CommunicationTemplateAttachment nodes are returned via the Connection

field : CommunicationTemplateAttachmentTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CommunicationTemplateAttachmentTypeField

Fields for filtering and sorting Communication Templates Attachment

id
templateId
templateLocaleDataId
Back to top

CommunicationTemplateAttachmentUpdateInput

The input type with the values used to update an Attachment

communicationTemplateAttachmentId : ID!

The ID of the attachment

type : String

The type of the attachment

documentId : ID

The ID of the document related to this attachment

documentCategoryId : ID

The ID of the document category

certificateId : ID

The ID of the certificate related to this attachment

Back to top

CommunicationTemplateAudience

An enumeration.

delegates
staff
booking_contacts
scheduled
surveymonkey_respondents
opportunity_owner
opportunity_contact
opportunity_recipient
opportunity_billing_contact
learning_assignments
payment_billing_email
gift_voucher_recipient
training_pass_recipient
training_token_point_of_contact
password_reset
contact
Back to top

CommunicationTemplateCode

An enumeration.

lms_password_setup
lms_password_reset
lms_temporary_password
lms_email_verify
lms_reset
idp_password_setup
idp_password_reset
idp_email_verify
idp_temporary_password
tms_password_reset
tms_email_2fa_code
sms_password_reset
calendar_setup
instructor_removed
Back to top

CommunicationTemplateConnection

A connection containing page information and edges for CommunicationTemplate

edges : [CommunicationTemplateEdge!]!

The list of CommunicationTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CommunicationTemplateCreateInput

The input type with the values used to create a Communication Template

type : CommunicationTemplateType!

Whether this template is for sms or email

audience : CommunicationTemplateAudience!

To whom is this template addressed

body : String!

The body of the template

name : String

A unique name of the template that will be used in the listings

subject : String

The subject of the template

localeId : ID

What should be the default locale for this template

origin : CommunicationTemplateOrigin

Whether this template is for the user or for the system

code : CommunicationTemplateCode

The code that represents the system template

companyId : ID

The ID of the company this template is for, global if not provided

Back to top

CommunicationTemplateDeleteInput

The input type with the values used to delete a Communication Template

communicationTemplateId : ID!

The ID of the template to delete

Back to top

CommunicationTemplateEdge

Contains cursor and node information for type CommunicationTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : CommunicationTemplate!

The CommunicationTemplate node.

Back to top

CommunicationTemplateFieldGraphFilter

Filter that can be applied to limit which CommunicationTemplate nodes are returned

field : CommunicationTemplateTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CommunicationTemplateFieldGraphOrder

Specifies the order in which CommunicationTemplate nodes are returned via the Connection

field : CommunicationTemplateTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CommunicationTemplateLocaleDataCreateInput

The input type with the values used to create a Locale Data for Communication Template

communicationTemplateId : ID!

The ID of template this locale data is for

localeId : ID!

What is the locale for this data

body : String

The body of the locale data

subject : String

The subject of the locale data

isDefault : Boolean

Whether or not this locale data should be default for the template

Back to top

CommunicationTemplateLocaleDataDeleteInput

The input type with the values used to delete a Locale Data for Communication Template

communicationTemplateId : ID!

The ID of the template

localeId : ID!

The ID of the locale

Back to top

CommunicationTemplateLocaleDataSetDefaultInput

The input type with the values used to set the default Locale Data for a Communication Template

communicationTemplateId : ID!

The ID of the template

localeId : ID!

The ID of the locale

Back to top

CommunicationTemplateLocaleDataUpdateInput

The input type with the values used to update a Locale Data for Communication Template

communicationTemplateId : ID!

The ID of the template

localeId : ID!

The ID of the locale

body : String

The body of the locale data

subject : String

The subject of the locale data

isDefault : Boolean

Whether or not this locale data should be default for the template

Back to top

CommunicationTemplateMutateResponse

A response from CommunicationTemplate Mutations

Related types: MutationResponse

communicationTemplate : CommunicationTemplate

A Communication Template that has been mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CommunicationTemplateMutations

Mutations for a Communication Template

assignLocaleToData : CommunicationTemplateMutateResponse!

Assigns a Locale to Template Locale Data which previously had an unknown Locale

Argument Type Description
input CommunicationTemplateAssignLocaleToDataInput!

The input type with the values used to assign a Locale
create : CommunicationTemplateMutateResponse!

Creates a new Communication Template

Argument Type Description
input CommunicationTemplateCreateInput!

The input type with the values used to create a Communication Template
createAttachment : CommunicationTemplateMutateResponse!

Creates a new Attachment for a Communication Template in a given Locale

Argument Type Description
input CommunicationTemplateAttachmentCreateInput!

The input type with the values used to create an Attachment
createLocaleData : CommunicationTemplateMutateResponse!

Creates a new Locale Data (i.e. the subject and body for a specific Locale) for a Communication Template

Argument Type Description
input CommunicationTemplateLocaleDataCreateInput!

The input type with the values used to create a Locale Data
delete : CommunicationTemplateMutateResponse!

Deletes an existing Communication Template

Argument Type Description
input CommunicationTemplateDeleteInput!

The input type with the values used to delete a Communication Template
deleteAttachment : CommunicationTemplateMutateResponse!

Deletes an existing Attachment from a Communication Template

Argument Type Description
input CommunicationTemplateAttachmentDeleteInput!

The input type with the values used to delete an Attachment
deleteLocaleData : CommunicationTemplateMutateResponse!

Deletes an existing Locale Data (i.e. the subject and body for a specific Locale) for a Communication Template

Argument Type Description
input CommunicationTemplateLocaleDataDeleteInput!

The input type with the values used to delete a Locale Data
setDefaultLocaleData : CommunicationTemplateMutateResponse!

Sets a Locale Data (i.e. the subject and body for a specific Locale) as the default for a Communication Template

Argument Type Description
input CommunicationTemplateLocaleDataSetDefaultInput!

The input type with the values used to set a default Locale Data
update : CommunicationTemplateMutateResponse!

Updates an existing Communication Template

Argument Type Description
input CommunicationTemplateUpdateInput!

The input type with the values used to update a Communication Template
updateAttachment : CommunicationTemplateMutateResponse!

Updates an existing Attachment for a Communication Template

Argument Type Description
input CommunicationTemplateAttachmentUpdateInput!

The input type with the values used to update an Attachment
updateLocaleData : CommunicationTemplateMutateResponse!

Updates an existing Locale Data (i.e. the subject and body for a specific Locale) for a Communication Template

Argument Type Description
input CommunicationTemplateLocaleDataUpdateInput!

The input type with the values used to udpate a Locale Data
Back to top

CommunicationTemplateOrigin

An enumeration.

user
system
Back to top

CommunicationTemplateType

An enumeration.

email
sms
Back to top

CommunicationTemplateTypeField

Fields for filtering and sorting Communication Templates

id
name
audience
type
localizedSubject
origin
code
companyId
Back to top

CommunicationTemplateUpdateInput

The input type with the values used to update a Communication Template

communicationTemplateId : ID!

The ID of the template to update

type : CommunicationTemplateType

Whether this template is for sms or email

name : String

A unique name of the template that will be used in the listings

audience : CommunicationTemplateAudience

To whom is this template addressed

companyId : ID
Back to top

CommunicationType

An enumeration.

email
sms
Back to top

Company

Companies are the trading entities in which you own/work for.

Related types: Node

account : Account

Account assigned to the Company

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
bankDetails : [CompanyBankDetail!]!

Bank details for the Company

Argument Type Description
filters = [] [CompanyBankDetailFieldGraphFilter]
order = "__EMPTY__" CompanyBankDetailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyBankDetailFieldGraphOrder]
certificateBackgroundDocument : Document

The document used as the company's certificate background.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
certificateLogoDocument : Document

The document used as the company's certificate logo.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
certificateSignatureDocument : Document

The document used as the company's certificate signature.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
code : String!

Code used to refer to the Company

currency : Currency!

Base currency the company operates in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
customFieldValues : [CustomFieldValue!]!

Custom Field values for the Company

Argument Type Description
filter CustomFieldFilterInput
defaultInvoiceDueDateOffset : Int

The default number of days until an invoice is due

defaultTax : TaxType

The default Tax applied to financial transactions

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
firstDayOfWeek : Day

The first day of the week for the Company

id : ID!

ID of the Company

invoiceLanguage : Locale

The invoice language for the Company

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

locale : Locale

The locale for the Company

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
logoDocument : Document

The document used as the company's logo.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
name : String!

Name of the Company

nonWorkingDays : [String!]!

List of non-working days for the Company. Calculated based on working days.

registrationNumbers : String

Company registration numbers

timeZone : String

The timezone for the Company

uaeKsaCompliance : Boolean!

Flag to enable UAE/KSA compliance for invoices and credit notes viewed in English

userCount : Int!

Get the count of active users belonging to this Company

workingDays : [Day!]!

List of working days for the Company

Back to top

CompanyBankDetail

Bank details for a company

Related types: Node

currency : Currency!

Currency for the bank details

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
details : String!

The bank detail information

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the bank detail

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

CompanyBankDetailField

Fields for filtering and ordering company bank details

id
company_id
Back to top

CompanyBankDetailFieldGraphFilter

Filter that can be applied to limit which CompanyBankDetail nodes are returned

field : CompanyBankDetailField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CompanyBankDetailFieldGraphOrder

Specifies the order in which CompanyBankDetail nodes are returned via the Connection

field : CompanyBankDetailField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CompanyConnection

A connection containing page information and edges for Company

edges : [CompanyEdge!]!

The list of Company edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CompanyCreateInput

An Input for creating a Company

name : String!

The name of the Company

code : String!

The short code for the Company

currencyId : ID!

The currency ID for the Company

accountId : ID!

The account ID associated with the Company

defaultTaxId : ID!

The default tax ID for the Company

locale : String

The locale for the Company

invoiceLanguage : String

The invoice language for the Company

registrationNumbers : String

The registration numbers of the Company

defaultInvoiceDueDateOffset : Int

The default number of days for invoice due dates

uaeKsaCompliance : Boolean

Flag to indicate UAE/KSA compliance

timezone : String

The timezone for the Company

firstDayOfWeek : Day

The first day of the week for the Company

workingDays : [Day]

A list of non-working days for the Company

logoDocument : ID

The Document object for the company's logo

certificateLogoDocument : ID

The Document object for the certificate logo

certificateSignatureDocument : ID

The Document object for the certificate signature

certificateBackgroundDocument : ID

The Document object for the certificate background

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues for the Company

Back to top

CompanyEdge

Contains cursor and node information for type Company

cursor : String!

A string that can be used for cursor-based pagination

node : Company!

The Company node.

Back to top

CompanyField

Fields for filtering and ordering Companies

id
name
code
Back to top

CompanyFieldGraphFilter

Filter that can be applied to limit which Company nodes are returned

field : CompanyField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CompanyFieldGraphOrder

Specifies the order in which Company nodes are returned via the Connection

field : CompanyField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CompanyMutationResponse

A Response for a Company Mutation

Related types: MutationResponse

company : Company

The Company that was created or updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CompanyMutations

Available Mutations on a Company

create : CompanyMutationResponse!

Creates a new Company

Argument Type Description
input CompanyCreateInput!

The input type with the values for the new Company
delete : CompanyMutationResponse!

Deletes a Company

Argument Type Description
companyId ID!

The ID of the company to be deleted
removeBankDetails : CompanyMutationResponse!

Removes the bank details for a Company and currency

Argument Type Description
input CompanyRemoveBankDetailsInput!

The input type with the values for the currency to remove
setBankDetails : CompanyMutationResponse!

Creates or updates the bank details for a Company and currency

Argument Type Description
input CompanySetBankDetailsInput!

The input type with the values for the bank details
update : CompanyMutationResponse!

Updates the details of a Company

Argument Type Description
input CompanyUpdateInput!

The input type with the values to be updated
Back to top

CompanyRemoveBankDetailsInput

An Input for removing a Company's bank details

companyId : ID!

The ID of the Company being updated

currencyId : String!

The currency for the Company's bank account

Back to top

CompanySetBankDetailsInput

An Input for updating a Company's bank details

companyId : ID!

The ID of the Company being updated

currencyId : String!

The currency for the Company's bank account

details : String

The details for the Company's bank account

Back to top

CompanyUpdateInput

An Input for updating a Company

companyId : ID!

The ID of the Company being updated

name : String

The name of the Company

code : String

The short code for the Company

currencyId : ID

The currency ID for the Company

accountId : ID

The account ID associated with the Company

locale : String

The locale for the Company

invoiceLanguage : String

The invoice language for the Company

registrationNumbers : String

The registration numbers of the Company

defaultTaxId : ID

The default tax ID for the Company

defaultInvoiceDueDateOffset : Int

The default number of days for invoice due dates

uaeKsaCompliance : Boolean

Flag to indicate UAE/KSA compliance

timezone : String

The timezone for the Company

firstDayOfWeek : Day

The first day of the week for the Company

workingDays : [Day]

A list of non-working days for the Company

logoDocument : ID

The Document object for the company's logo

certificateLogoDocument : ID

The Document object for the certificate logo

certificateSignatureDocument : ID

The Document object for the certificate signature

certificateBackgroundDocument : ID

The Document object for the certificate background

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Company to update

Back to top

ConnectionEnvironment

The Automator Connection environment

Staging
Production
Back to top

ConstraintName

An enumeration.

RespectStartDay
EvenEventDistribution
ReduceInstructorConflicts
ConsistentInstructors
EvenInstructorWorkload
ReduceResourceConflicts
ConsistentResources
EvenResourceUsage
SkippedDays
Back to top

Contact

A person/individual

Related types: Node

account : Account

Primary Account the Contact belongs to

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
achievements : AchievementConnection!

The Achievements that belong to the Contact

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
calendarIntegrations : [CalendarIntegration!]

The Calendar Integrations configured for this Contact

Argument Type Description
status [CalendarIntegrationStatus]

only include integrations in the provided status
coordinatorManagedAccounts : AccountConnection!

The Accounts that the Coordinator is responsible for

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
coordinatorManagedContacts : ContactConnection!

The Contacts belonging to the Accounts that the Coordinator is responsible for

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime

The Date and Time the Contact was created

credentials : ContactCredentialsConnection!

The Credentials this Contact has to sign in to Brands

Argument Type Description
filters = [] [ContactCredentialsFieldGraphFilter]
order = "__EMPTY__" ContactCredentialsFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactCredentialsFieldGraphOrder]
customFieldValues : [CustomFieldValue!]!

Custom Field values for the Contact

Argument Type Description
filter CustomFieldFilterInput
dateOfBirth : Date

Date of birth of the contact

department : String

The department of the Contact

documents : DocumentConnection!

Documents mapped to this contact

emailAddress : String

Primary email address of the Contact

emailAddresses : [ContactEmailAddress!]!

List of email addresses of the Contact

emails : EmailConnection!

Emails sent to the Contact

Argument Type Description
filters = [] [EmailFieldGraphFilter]
order = "__EMPTY__" EmailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EmailFieldGraphOrder]
externalCalendarEvents : ExternalCalendarEventConnection!

External Calendar Events for this contact

Argument Type Description
filters = [] [ExternalCalendarEventFieldGraphFilter]
order = "__EMPTY__" ExternalCalendarEventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalCalendarEventFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
faxPhoneNumber : String

The Fax phone number of the Contact

hasLeftCompany : Boolean!

Whether or not the Contact has left the Company

holidayAllocation : HolidayAllocationConnection!

This Contact's holiday allocations (a number of fractional holiday days by year)

homePhoneNumber : String

The Home phone number of the Contact

id : ID!

ID of the Contact

individualAccount : Account

The Individual Account of the Contact

instructorBio : String

The Contact's Instructor Biography

instructorCompany : Company

The Company that owns the Instructor relationship

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
instructorContractNotes : String

The Contact's Instructor Contract Notes

instructorOwner : User

The User who owns the Instructor relationship

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
invoicePaymentDate : Date

Invoice payment date of the contact

isCoordinator : Boolean!

Flag noting if this contact is a Coordinator for any Account

isInstructorDormant : Boolean!

Whether the Contact is Dormant as an Instructor

isQualified : Boolean!

Returns whether the Contact is qualified to staff the given Event (or Event Need) for the given Staff Role, given the Event Requirements set on the Event (or Event Need's Course Template) and the Staff Exceptions on the Course Template

Argument Type Description
eventId ID!

the ID of an Event or Event Need for which the qualification check is performed
staffRoleId ID!

the Staff Role for which the qualification check is performed
isStaff : Boolean!

Whether the Contact is a Staff member or not

isStaffException : Boolean!

Returns whether the Contact is listed as a Staff Exception for the given Event or Event Need's Course Template and the specified Staff Role.

Argument Type Description
eventId ID!

the ID of an Event or Event Need to check the Staff Exception list against
staffRoleId ID!

the Staff Role to check the Exception against
jobRole : String

The job role of the Contact

lastUpdatedAt : TimeZonedDateTime

The Date and Time the Contact was last updated

learners : LearnerConnection!

List of instances the Contact has been a Learner on an Event

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
learningPathLearners : LearningPathLearnerConnection!

List of instances the Contact has been a Learner on a Learning Path

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lineManages : MembershipJobRoleConnection!

Lists Job Roles Managed by the Contact

Argument Type Description
filters = [] [MembershipJobRoleFieldGraphFilter]
order = "__EMPTY__" MembershipJobRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MembershipJobRoleFieldGraphOrder]
linkedIn : String

This Contact's LinkedIn username

lmsAccess : LMSAccess!

Contains details about the Contact's LMS access

lmsLoginEmailAddress : String

The Email address this Contact has to sign in to the LMS

Argument Type Description
filters = [] [ContactCredentialsFieldGraphFilter]
order = "__EMPTY__" ContactCredentialsFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactCredentialsFieldGraphOrder]
locale : String!

The locale that LMS content is delivered in

marketingActivity : MarketingActivity

The Marketing Activity of this Contact

Argument Type Description
filters = [] [MarketingActivityFieldGraphFilter]
order = "__EMPTY__" MarketingActivityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MarketingActivityFieldGraphOrder]
membershipOrganization : String

The Organization the Contact is a member of

memberships : MembershipConnection!

Contact's Memberships

Argument Type Description
filters = [] [MembershipFieldGraphFilter]
order = "__EMPTY__" MembershipFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MembershipFieldGraphOrder]
mobilePhoneNumber : String

The Mobile phone number of the Contact

nationality : String

Nationality of the contact

notes : String

Notes to add to the Contact

officePhoneNumber : String

The Office phone number of the Contact

passportAuthority : String

Passport authority of the contact

passportExpiryDate : Date

Passport expiry date of the contact

passportIssueDate : Date

Passport issue date of the contact

passportNumber : String

Passport number of the contact

personalName : PersonalName

The personal name of the Contact

phoneNumbers : [ContactPhoneNumber!]!

List of phone numbers of the Contact

postalAddress : PostalAddress

PostalAddress of the Contact

preferredLocale : Locale

A Contact’s preferred locale for content to be delivered across the platform. This is distinct from the locale field which only applies to LMS.

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
profilePictureDocument : Document

The Profile Picture Document for a contact

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
requestedUpdateEmailVerification : Boolean!

If this Contact has requested verifying their updated email

skype : String

This Contact's Skype username

source : MarketingSource

The MarketingSource of this Contact

spokenLanguages : [Locale!]!

The Locales this Contact speaks. This is distinct from preferredLocale and locale, which describe how content is delivered to the Contact rather than the languages the Contact can be staffed to teach in.

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
staff : StaffConnection!

List of instances the Contact has been Staff on an Event

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
staffRoles : [StaffRole!]!

Staff Role this Contact is assigned to

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
supervisor : Contact

Contact's Supervisor

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
timeZoneName : String

The timezone for this Contact

trainingPasses : TrainingPassConnection!

The Training Passes that belong to this Contact

Argument Type Description
filters = [] [TrainingPassFieldGraphFilter]
order = "__EMPTY__" TrainingPassFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassFieldGraphOrder]
unsubscribeFromCommunications : Boolean!

Whether the Contact is unsubscribed from Communications

workingPatternRotation : WorkingPatternRotation

The Working Pattern Rotation that this Contact is on

Argument Type Description
filters = [] [WorkingPatternRotationFieldGraphFilter]
order = "__EMPTY__" WorkingPatternRotationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WorkingPatternRotationFieldGraphOrder]
workplaces : [Workplace!]!

The Workplaces associated with this Contact

Argument Type Description
filters = [] [WorkplaceFieldGraphFilter]
order = "__EMPTY__" WorkplaceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WorkplaceFieldGraphOrder]
Deprecated fields (13)
address : PostalAddress

PostalAddress of the Contact

Removal date: TBD.

Replaced by postalAddress field.

customStudentId : String

The custom student ID of the Contact

Removal date: TBD.

Now queryable as part of contact.customSystemFields

customSystemFields : [ContactCustomSystemField!]!

Removal date: TBD.

Replaced by custom fields

firstName : String

The first name of the Contact

Removal date: TBD.

Moved into personalName.

isAdmin : Boolean!

Whether the Contact is an Administrator or not

Removal date: 2026-05-11.

replaced by staffRoles

isInstructor : Boolean!

Whether the Contact is Instructor or not

Removal date: 2026-05-11.

replaced by staffRoles

isMarketingContact : Boolean!

Whether the Contact is a Marketing Contact or not

Removal date: TBD.

Now queryable as part of contact.customSystemFields

lastName : String

The last name of the Contact

Removal date: TBD.

Moved into personalName.

middleName : String

The middle name of the Contact

Removal date: TBD.

Moved into personalName.

name : String

The full name of the Contact. Composed of the first, middle and last names

Removal date: TBD.

Moved into personalName.

organisation : Account

Account the Contact belongs to

Removal date: TBD.

Replaced by account field.

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
title : Honorific

The title of the Contact

Removal date: TBD.

Moved into personalName.

unsubscribeFromThirdPartyMail : Boolean!

Whether the Contact is unsubscribed from Third Party Mail

Removal date: TBD.

Now queryable as part of contact.customSystemFields

Back to top

ContactAdhocEmailInput

The input for sending an ad-hoc email to a specific contact. Either a subject and body must be specified, or a template ID must be provided. If subject and body are provided, they will override any provided template ID.

contactId : ID!

The contact ID of the intended email recipient

subject : String!

The subject of the email.

body : String!

The body of the email.

sendingAddressId : ID

The ID of the sending email address from which the emails should originate.

attachments : [BulkAdhocEmailAttachment]

A list of the ID/Type mappings of DMS or communication template documents to attach to the email.

ccList : [String]

A list of valid email addresses to send a copy (CC) of the email to.

bccList : [String]

A list of valid email addresses to send a blind copy (BCC) of the email to.

Back to top

ContactAdhocEmailMutations

Mutations for sending ad-hoc emails to specific Contacts

sendContactAdhocEmail : ContactAdhocEmailMutationsResponse!

Sends an ad-hoc email to a specified Contact

Argument Type Description
input ContactAdhocEmailInput!
Back to top

ContactAdhocEmailMutationsResponse

The response type for contact ad-hoc email mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ContactAnonymizerInput

An Input for anonymizing a Contact

contactId : ID!

The ID of the Contact being anonymized

Back to top

ContactAwardAchievementInput

An input to award an Achievement to a Contact

contactId : ID!

The ID of the Contact being awarded an Achievement

achievementTypeId : ID!

The ID of the Achievement Type being awarded

achievedAt : Date

(Deprecated) The date when the Achievement is valid from

validFrom : Date

The date when the Achievement is valid from

identifier : String

The identifier of the Achievement being awarded

expiresAt : Date

The date when the Achievement expires

brandId : ID

The ID of the Brand associated with the Achievement

documents : [AchievementAddDocumentInput]

The list of documents to be added to the Achievement

source : AchievementSourceInput

Where the Achievement came from. Omitted records nothing, rather than assuming

Back to top

ContactBooking

A Contact event or booking for a certain activity. This could be an instructor booking, a holiday booking or an External Calendar event.

bookingType : ContactBookingType!

The type of Contact Booking

contact : Contact

The Contact this booking is for This value is null if the current user does not have permissions to view the contact

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
end : TimeZonedDateTime!

The start of the Contact Booking

entity : ContactBookingEntity!

The entity the Contact is booked onto

Argument Type Description
filters = [] [SessionNeedFieldGraphFilter]
order = "__EMPTY__" SessionNeedFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionNeedFieldGraphOrder]
id : ID!

The ID of the entity for this Contact Booking

start : TimeZonedDateTime!

The start of the Contact Booking

title : String

A descriptive title for the Contact Booking

unconfirmed : Boolean!

Whether the Contact has not confirmed attendance to this Booking

Back to top

ContactBookingConnection

A connection containing page information and edges for ContactBooking

edges : [ContactBookingEdge!]!

The list of ContactBooking edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ContactBookingEdge

Contains cursor and node information for type ContactBooking

cursor : String!

A string that can be used for cursor-based pagination

node : ContactBooking!

The ContactBooking node.

Back to top

ContactBookingEntity

Interface representing a generic activity or commitment a Contact is booked on

Related types: Event Session ExternalCalendarEvent SessionNeed StaffUnavailability

id : ID!

ID of the entity the Contact is booked on

Back to top

ContactBookingFieldGraphFilter

Filter that can be applied to limit which ContactBooking nodes are returned

field : ContactBookingFilterField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ContactBookingFieldGraphOrder

Specifies the order in which ContactBooking nodes are returned via the Connection

field : ContactBookingOrderField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ContactBookingFilterField

An enumeration.

bookingType
contactId
start
end
rangeInEventId
rangeInRequirementsForEventId
rangeInRequirementsForStaffRoleId
rangeInSessionId
rangeInStaffId
eventId
sessionId
unconfirmed
includePlans
planId
Back to top

ContactBookingOrderField

An enumeration.

contactId
start
end
Back to top

ContactBookingType

The type of Contact Booking

session
event
absence
externalEvent
Back to top

ContactConflict

A Conflict for a specific Contact when duplicating a Session.

contact : Contact

The Contact which could not be booked.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
Back to top

ContactConnection

A connection containing page information and edges for Contact

edges : [ContactEdge!]!

The list of Contact edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ContactCoordinatorInput

An input to make or revoke a Contact a Coordinator for specific Accounts

contactId : ID!

The Contact ID of the Coordinator

accountIds : [ID]!

The Account IDs being added or removed

Back to top

ContactCreateIndividualAccountInput

An Input for creating a Contact as part of an Individual Account

personalName : PersonalNameCreateInput!

The personal name of the Contact

jobRole : String

The job role of the Contact

postalAddress : PostalAddressInput

The PostalAddress of the Contact

source : MarketingSourceInput

The MarketingSource of this Contact

emailAddresses : [ContactEmailAddressInput]

The list of EmailAddresses of the Contact

phoneNumbers : [ContactPhoneNumberInput]

The list of PhoneNumbers of the Contact

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Contact

locale : String

The locale for this Contact

timeZoneName : String

The timezone for this Contact

workplaceIds : [ID]

The IDs of the Workplaces for this Contact

isInstructor : Boolean

DEPRECATED (replaced by staffRoleIds) - Sets if a Contact can be an Instructor on Events

instructorBio : String

The Instructor Biography for the Contact

isStaff : Boolean

Sets if a Contact is a Staff member

isAdmin : Boolean

DEPRECATED (replaced by staffRoleIds) - Sets if a Contact is an Administrator

department : String

The Contact's Department Name

notes : String

Optional Notes to add to the Contact

unsubscribeFromCommunications : Boolean

Sets if a Contact is unsubscribed from Communications

workingPatternRotationId : ID

The ID of the Working Pattern Rotation that this Contact is on

linkedIn : String

The linkedin profile of the contact

skype : String

The Skype ID of the contact

holidayAllocation : [HolidayAllocationInput]

Set a list of Holiday Allocation

supervisorId : ID

ID of the supervisor

preferredLocaleId : ID

A Contact’s preferred locale for content to be delivered across the platform. This is distinct from the locale field which only applies to LMS.

nationality : String

The nationality of the contact

dateOfBirth : Date

The date of birth of the contact

passportNumber : String

The passport number of the contact

passportAuthority : String

The passport authority of the contact

passportIssueDate : Date

The passport issue date of the contact

passportExpiryDate : Date

The passport expiry date of the contact

invoicePaymentDate : Date

The passport invoice payment date of the contact

marketingActivityId : ID

ID of the marketing activity saved on the contact

staffRoleIds : [ID]

A list of Staff Role IDs the Contact is assigned to.

Back to top

ContactCreateInput

An Input for creating a Contact

accountId : ID!

The Account ID that the Contact belongs to

personalName : PersonalNameCreateInput!

The personal name of the Contact

jobRole : String

The job role of the Contact

jobRoleId : String

The job role ID of the primary Job Role of the primary Account for the Contact

postalAddress : PostalAddressInput

The PostalAddress of the Contact

source : MarketingSourceInput

The MarketingSource of this Contact

emailAddresses : [ContactEmailAddressInput]

The list of EmailAddresses of the Contact

phoneNumbers : [ContactPhoneNumberInput]

The list of PhoneNumbers of the Contact

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Contact

locale : String

The locale that LMS content is delivered in

preferredLocaleId : ID

A Contact’s preferred locale for content to be delivered across the platform. This is distinct from the locale field which only applies to LMS.

timeZoneName : String

The timezone for this Contact

workplaceIds : [ID]

The IDs of the Workplaces for this Contact

isInstructor : Boolean

DEPRECATED (replaced by staffRoleIds) - Sets if a Contact can be an Instructor on Events

instructorBio : String

The Instructor Biography for the Contact

isStaff : Boolean

Sets if a Contact is a Staff member

isAdmin : Boolean

DEPRECATED (replaced by staffRoleIds) - Sets if a Contact is an Administrator

isMarketingContact : Boolean

Sets if a Contact is a Marketing Contact

department : String

The Contact's Department Name

notes : String

Optional Notes to add to the Contact

unsubscribeFromCommunications : Boolean

Sets if a Contact is unsubscribed from Communications

workingPatternRotationId : ID

The ID of the Working Pattern Rotation that this Contact is on

hasLeftCompany : Boolean

Set if a Contact has left the company

nationality : String

Set nationality of the contact

dateOfBirth : Date

Set date of birth of the contact

passportNumber : String

Set passport number of the contact

passportAuthority : String

Set passport authority of the contact

passportIssueDate : Date

Set passport issue date of the contact

passportExpiryDate : Date

Set passport expiry date of the contact

invoicePaymentDate : Date

Set passport invoice payment date of the contact

linkedIn : String
skype : String
holidayAllocation : [HolidayAllocationInput]

Set a list of Holiday Allocation

supervisorId : ID

ID of the supervisor

marketingActivityId : ID

ID of the marketing activity saved on the contact

membershipOrganization : String

The Organization the Contact is a member of

customSystemFields : [ContactCustomSystemFieldUpdateInput]

The list of contact system fields and values to set on the Contact

staffRoleIds : [ID]

A list of Staff Role IDs the Contact is assigned to.

spokenLanguageCodes : [String]

The full locale codes (e.g. "en-US", "pt-BR") of the languages the Contact speaks. Codes not present in Locales are rejected; an empty list or null sets no languages.

Back to top

ContactCredentials

Credentials required for a Contact to sign in to a Brand

Related types: Node

accessBlocked : Boolean!

Flag if the Contact Credentials access was blocked

brand : Brand!

The Brand that these credentials are used to sign in to

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
contact : Contact!

The Contact that these credentials are used to sign in

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
emailVerified : Boolean!

If the Contact Credentials email address has been verified

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of these Contact Credentials

lastActive : TimeZonedDateTime

The last time these Contact Credentials were used in an activity

lastLogin : TimeZonedDateTime

The last time these Contact Credentials were used to log in

learnerWelcomed : Boolean!

If the Contact has been shown the portal Welcome Message

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

passwordExpiresAt : TimeZonedDateTime

The time remaining before the password expires

passwordRequiresReset : Boolean

The Contact Credential's current password requires reset

passwordResetCodeExpiryTime : TimeZonedDateTime

The time remaining before the password reset code expires

passwordResetRedirectURL : URL

The URL the users will be redirected to after resetting their password

username : String!

The username for the these Contact Credentials

Back to top

ContactCredentialsBlockAccessInput

An Input for blocking a Contact's credentials access

contactCredentialId : ID!

The ID of the Contact Credentials to be blocked from access

Back to top

ContactCredentialsBulkMutateResponse

A Response from mutating multiple Contact Credentials in bulk

Related types: MutationResponse

contactCredentialsList : [ContactCredentials!]!

The list of Contact Credentials that were successfully created

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ContactCredentialsConnection

A connection containing page information and edges for ContactCredentials

edges : [ContactCredentialsEdge!]!

The list of ContactCredentials edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ContactCredentialsCreateForLearnerInput

An Input for creating Contact Credentials for a Learner

learnerId : ID!

The ID of the Learner to create credentials for

sendEmail : Boolean

Whether to send setup email to the contact (defaults to True)

username : String

Optional username for the credentials (defaults to contact's email)

Back to top

ContactCredentialsCreateForLearnersInput

An Input for creating Contact Credentials for multiple Learners

learners : [ContactCredentialsCreateForLearnerInput]!

A list of Learner inputs to create credentials for

Back to top

ContactCredentialsCreateInput

An Input for creating a Contact's Credentials for accessing Portals such as LMS and WebLink

contactId : ID!

The ID of the Contact that will sign in to the Brand

portalId : ID

The ID of a Portal belonging to the Brand that the Contact will sign in to. Either a portalId or a brandId is required. Emails sent to the Contact during Credential creation will include a link to this Portal

brandId : ID

The ID of the Brand that the Contact will sign in to. Either a portalId or a brandId is required.

username : String

The username used when signing in. Will default to the primary Email Address of the Contact if not set

passwordResetRedirectURL : URL

The URL the users will be redirected to after resetting their password

redirectURL : URL

The URL the users will be redirected to after setting up their password

Back to top

ContactCredentialsCreateWithPasswordInput

An Input for creating a Contact's Credentials for accessing Portals such as LMS and WebLink and supply a password at the same time

contactId : ID!

The ID of the Contact that will sign in to the Brand

password : String!

The password of the Contact Credentials that are attempting to sign in

portalId : ID

The ID of a Portal belonging to the Brand that the Contact will sign in to. Either a portalId or a brandId is required. Emails sent to the Contact during Credential creation will include a link to this Portal

brandId : ID

The ID of the Brand that the Contact will sign in to. Either a portalId or a brandId is required.

username : String

The username used when signing in. Will default to the primary Email Address of the Contact if not set

passwordResetRedirectURL : URL

The URL the users will be redirected to after resetting their password

redirectURL : URL

The URL the users will be redirected to after verifying their email

Back to top

ContactCredentialsEdge

Contains cursor and node information for type ContactCredentials

cursor : String!

A string that can be used for cursor-based pagination

node : ContactCredentials!

The ContactCredentials node.

Back to top

ContactCredentialsField

Fields for filtering and ordering Contact Credentials

id
brandId
contactId
canSignInToLms
Back to top

ContactCredentialsFieldGraphFilter

Filter that can be applied to limit which ContactCredentials nodes are returned

field : ContactCredentialsField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ContactCredentialsFieldGraphOrder

Specifies the order in which ContactCredentials nodes are returned via the Connection

field : ContactCredentialsField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ContactCredentialsGeneratedPassResetCodeMutationResponse

A Response from mutating Contact Credentials

Related types: MutationResponse

contactCredentials : ContactCredentials

The ContactCredentials that were mutated

errors : [FieldError!]!

The errors returned by the mutation

generatedPasswordResetCode : String

The Password Reset Code that was generated

Back to top

ContactCredentialsGeneratedPasswordMutationResponse

A Response from mutating Contact Credentials

Related types: MutationResponse

contactCredentials : ContactCredentials

The ContactCredentials that were mutated

errors : [FieldError!]!

The errors returned by the mutation

generatedTemporaryPassword : String

The Temporary Password that was generated

Back to top

ContactCredentialsGeneratePasswordResetCodeInput

An Input for generating a code to reset a Contact's password

contactCredentialsId : ID!
Back to top

ContactCredentialsGenerateTemporaryPasswordInput

An Input for generating a temporary password for a Contact Credential

contactCredentialsId : ID!
Back to top

ContactCredentialsMutationResponse

A Response from mutating Contact Credentials

Related types: MutationResponse

contactCredentials : ContactCredentials

The ContactCredentials that were mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ContactCredentialsMutations

Mutations available for Contact Credentials

blockAccess : ContactCredentialsMutationResponse!

Blocks the specified Portal Credentials from being used

Argument Type Description
input ContactCredentialsBlockAccessInput!

The input type with the values used to block Contact Credentials
create : ContactCredentialsMutationResponse!

Creates Credentials used by a Contact to sign in

Argument Type Description
input ContactCredentialsCreateInput!

The input type with the values used to create Contact Credentials
createForLearners : ContactCredentialsBulkMutateResponse!

Creates Credentials for multiple Learners to sign in

Argument Type Description
input ContactCredentialsCreateForLearnersInput!

The input type with a list of Learners to create credentials for
createWithPassword : ContactCredentialsMutationResponse!

Creates Credentials with a passowrd used by a Contact to sign in

Argument Type Description
input ContactCredentialsCreateWithPasswordInput!

The input type with the values used to create Contact Credentials
createWithoutCommunications : ContactCredentialsMutationResponse!

Creates Credentials used by a Contact to sign in without sending them a setup email

Argument Type Description
input ContactCredentialsCreateInput!

The input type with the values used to create Contact Credentials
generatePasswordResetCode : ContactCredentialsGeneratedPassResetCodeMutationResponse!

Generates a new password reset code for the Contact Credentials and sends it to the requester

Argument Type Description
input ContactCredentialsGeneratePasswordResetCodeInput!

The input type with the values used to generate a password reset code
markWelcomed : ContactCredentialsMutationResponse!

Marks the Contact as welcomed by the portal used by these Credentials

Argument Type Description
input MarkContactWelcomedInput!

The input type with the identifier of the Contact Credentials
remove : ContactCredentialsRemoveMutationResponse!

Removes Credentials used by a Contact to sign in to a portal

Argument Type Description
input ContactCredentialsRemoveInput!

The input type with the values used to remove Contact Credentials
requestPasswordResetTokenForId : ContactCredentialsMutationResponse!

Generates a new reset password token for some Contact Credentials and sends it to the primary Email Address of the Contact

Argument Type Description
input ContactCredentialsRequestPasswordResetTokenForIdInput!

The input type with the values used to request a password reset token
restoreAccess : ContactCredentialsMutationResponse!

Restores access to Portal for specified Contact Credentials

Argument Type Description
input ContactCredentialsRestoreAccessInput!

The input type with the values used to restore access of Contact Credentials
setPassword : ContactCredentialsMutationResponse!

Sets the password of a Contact Credential

Argument Type Description
input ContactCredentialsSetPasswordInput!

The input type with the values used to set the password
update : ContactCredentialsMutationResponse!

Updates Credentials used by a Contact to sign in

Argument Type Description
input ContactCredentialsUpdateInput!

The input type with the values used to update Contact Credentials
Deprecated fields (1)
generateTemporaryPassword : ContactCredentialsGeneratedPasswordMutationResponse!

Generates a new temporary password for the Contact Credentials and sends it to the requester

Removal date: TBD.

Replaced by generatePasswordResetCode

Argument Type Description
input ContactCredentialsGenerateTemporaryPasswordInput!

The input type with the values used to generate a temporary password
Back to top

ContactCredentialsRemoveInput

An Input for removing a Contact's Credential

contactCredentialId : ID!

The ID of the Contact Credentials to remove

Back to top

ContactCredentialsRemoveMutationResponse

A Response from removing Contact Credentials

Related types: MutationResponse

contactCredentialsId : ID

The ID of the Contact Credentials that were removed

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ContactCredentialsRequestPasswordResetTokenForIdInput

An Input for requesting a Password reset token for a Contact Credential

contactCredentialsId : ID!
Back to top

ContactCredentialsRestoreAccessInput

An Input for restoring access to a Contact's Credential

contactCredentialId : ID!

The ID of the Contact Credentials to restore access to

Back to top

ContactCredentialsSetPasswordInput

An Input for setting a Contact's Credentials new password

contactId : ID!

The id of the Contact the Contact Credentials belong to

host : URL!

The URL of the Host of the Contact Credentials to set the password for

newPassword : String!

The new password of the Contact Credentials

currentPassword : String!

The current password of the Contact Credentials

verifyEmail : Boolean

Set the Contact Credentials Email Verification

Back to top

ContactCredentialsUpdateInput

An Input for updating a Contact's existing Credential

contactCredentialsId : ID!

The ID of the Contact Credentials to update

username : String!

The edited username of the Contact Credentials

Back to top

ContactCustomSystemField

The custom field set in System

key : String!

Identifier of the Contact Custom System Field

label : String!

Label of the Contact Custom System Field

type : ContactCustomSystemFieldType!

Type of the Contact Custom System Field

value : String

Value of the Contact Custom System Field

Back to top

ContactCustomSystemFieldDefinition

A Custom System Field Definition for a Contact.

key : String!

The Identifier of the Contact Custom System Field Definition.

label : String!

The label of the Contact Custom System Field Definition.

type : String!

The type of Contact Custom System Field Definition.

Back to top

ContactCustomSystemFieldType

An enumeration.

string
checkbox
date
dropdown
Back to top

ContactCustomSystemFieldUpdateInput

key : String!
value : String
Back to top

ContactDeleteInput

An Input for deleting a Contact

contactId : ID!

The ID of the Contact being deleted

Back to top

ContactEdge

Contains cursor and node information for type Contact

cursor : String!

A string that can be used for cursor-based pagination

node : Contact!

The Contact node.

Back to top

ContactEmailAddress

An email address of a Contact

address : String

The email address

usage : ContactEmailAddressUsage!

The usage of the email address

Deprecated fields (2)
emailAddress : String!

The email address

Removal date: TBD.

Replaced by address

label : String!

The label of the email address, for example 'Email1'

Removal date: TBD.

Replaced by usage

Back to top

ContactEmailAddressInput

An Input for an email address of a Contact

usage : ContactEmailAddressUsage!

The ContactEmailAddressUsage of the EmailAddress being mutated

address : String

The email address

Back to top

ContactEmailAddressUsage

The usages of an email address on a Contact

primary
secondary
Back to top

ContactField

Fields for filtering and ordering Contacts

id
firstName
lastName
name
canStaffEvent
emailAddress
isInstructor
isAdmin
isStaff
hasLeftCompany
accountId
accountName
isCoordinator
isAssociatedWithWorkplace
workplaceLocationId
sharingAccountManagementWithCoordinatorId
notSharingAccountManagementWithCoordinatorId
isStaffOrInstructor
hasActiveTrainingPass
hasAncestorAccountId
approvedCourseIds
calendarIntegrationStatus
byNameAccountOrEmail
jobRoleId
staffRoleId
staffRoleName
isQualifiedForEventId
isExceptionForEventId
qualifiedForCourseId
speaksLocale
createdAt
lastUpdatedAt
companyId
companyName
timeZoneName
Back to top

ContactFieldGraphFilter

Filter that can be applied to limit which Contact nodes are returned

field : ContactField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ContactFieldGraphOrder

Specifies the order in which Contact nodes are returned via the Connection

field : ContactField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ContactMembershipMutationInput

An Input for creating or deleting Contact Account Memberships

contactId : ID!

The ID of the Contact

accountId : ID!

The ID of the Account

Back to top

ContactMembershipWithJobRoleMutationInput

An Input for creating Contact Account Membership with JobRole

contactId : ID!

The Contact ID of the Membership

accountId : ID!

The Account ID of the Membership

startDate : TimeZonedDateTime!

The start date of the Job Role

jobRoleId : ID

The Job Role of the Membership

endDate : TimeZonedDateTime

The end date of the Job Role

lineManager : ID

The Line Manager of the Job Role

Back to top

ContactMergeExternalInput

An Input for merging two Contacts using their External IDs

fromContact : ExternalIdInput!

The External ID of the Contact that will be merged and then deleted

toContact : ExternalIdInput!

The External ID of the Contact that will be merged into

overwriteFromContactExternalId : Boolean

Sets whether to override the From Contact external ID with the To Contact external id when the To Contact doesn't exist

Back to top

ContactMergeInput

An Input for merging two Contacts

fromContact : ID!

The ID of the Contact that will be merged and then deleted

toContact : ID!

The ID of the Contact that will be merged into

Back to top

ContactMutateResponse

A Response from mutating a Contact

Related types: MutationResponse

contact : Contact

The Contact that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ContactMutations

Mutations for Contacts

addContactAccountMembership : MembershipMutateResponse!

Adds a new Contact Account Membership with a Job Role

Argument Type Description
input ContactMembershipWithJobRoleMutationInput!

The input type with the values used to create a Contact Account Membership
anonymize : ContactMutateResponse!

Anonymize a Contact and remove all Personally Identifiable Information. This will remove any associated data that could be used to personally identify this contact in the system. It is not recoverable after this mutation has been run. This action will not remove PII pertaining to Financial Documents

Argument Type Description
input ContactAnonymizerInput!

The Input type for Anonymizing a Contact
assignExternalCalendarEvents : ExternalCalendarEventMutationResponse!

Adds External Calendar Events for a contact

Argument Type Description
input [ExternalCalendarEventAssignInput]!
awardAchievement : ContactMutateResponse!

Awards an Achievement to a Contact

Argument Type Description
input ContactAwardAchievementInput!

The input type with the values used to award an Achievement to the Contact
create : ContactMutateResponse!

Creates a Contact

Argument Type Description
input ContactCreateInput!

The input type with the values to be set on the new Contact
createBatch : [ContactMutateResponse!]!

Creates multiple Contacts A limit of 1000 per submission
DataImportIgnore true
Argument Type Description
input [ContactCreateInput]!

A list of input types containing the values to be set on the new Contacts
delete : ContactMutateResponse!

Delete an existing Contact The Contact will be soft deleted, but not accessible by the TMS or Core GraphQL API. All Contact Credentials for this contact will be removed.

Argument Type Description
input ContactDeleteInput!

The input type to lookup the Contact to delete
deleteContactAccountMembership : MembershipMutateResponse!

Deletes an existing Contact Account Membership

Argument Type Description
input ContactMembershipMutationInput!

The input type with the values used to delete a Contact Account Membership
linkDocument : ContactMutateResponse!

Links a Document to a Contact

Argument Type Description
input LinkDocumentContactInput!

The input type with the values used to link a Document to the Contact
makeCoordinatorForAccounts : ContactMutateResponse!

Makes a Contact a Coordinator for the supplied Accounts

Argument Type Description
input ContactCoordinatorInput!

The input type with the values used to make a Contact a Coordinator
merge : ContactMutateResponse!

Merge a Contact into a Contact

Argument Type Description
input ContactMergeInput!

The Input type with the values to Merge two Contacts
mergeByExternalIds : ContactMutateResponse!

Merge a Contact into a Contact using their External IDs

Argument Type Description
input ContactMergeExternalInput!

The Input type containing the external IDs of the Contacts to merge
removeExternalCalendarEvents : ExternalCalendarEventRemoveResponse!

Removes External Calendar Events for a contact, optionally restricted to specific event IDs

Argument Type Description
input [ExternalCalendarEventRemoveInput]!
revokeCoordinatorForAccounts : ContactMutateResponse!

Revokes Coordinator rights for a Contact for the supplied Accounts

Argument Type Description
input ContactCoordinatorInput!

The input type with the values used to revoke Coordinator rights to a Contact
setPrimaryContactAccountMembership : ContactMutateResponse!

Changes primary Contact Account Membership

Argument Type Description
input SetPrimaryContactAccountMembershipInput!

The input type with the values used to set a primary Contact Account Membership
unlinkDocument : ContactMutateResponse!

Unlinks a Document from a Contact

Argument Type Description
input UnlinkDocumentContactInput!

The input type with the values used to unlink a Document from the Contact
update : ContactMutateResponse!

Update the details of an existing Contact

Argument Type Description
input ContactUpdateInput!

The input type with the values to be updated
updateBatch : [ContactMutateResponse!]!

Updates multiple Contacts A limit of 1000 per submission
DataImportIgnore true
Argument Type Description
input [ContactUpdateInput]!

A list of input types containing the values to be updated on the Contacts
updateExternalCalendarEvents : ExternalCalendarEventMutationResponse!

Updates existing External Calendar Events for a contact

Argument Type Description
input [ExternalCalendarEventUpdateInput]!
upsertBatchByExternalId : [ContactMutateResponse!]!

Updates multiple Contacts identified by an External ID. If a Contact with the provided External ID does not already exist, it attempts to match with an existing Contact having the same primary email address or full name. If this attempt fails, either because there are zero or multiple matches, or these matches already have the External ID set, a new Contact will be created and assigned the provided External ID.

Argument Type Description
input [ContactUpsertByExternalIdInput]!

The input type with the External ID and the Contact values for updating or inserting the Contact.
upsertByExternalId : ContactMutateResponse!

Updates a Contact identified by an External ID. If it does not already exist, it attempts to match with an existing Contact having the same primary email address or full name. If this attempt fails, either because there are zero or multiple matches, or these matches already have the External ID set, a new Contact will be created and assigned the provided External ID.

Argument Type Description
input ContactUpsertByExternalIdInput!

The input type with the External ID and the Contact values for updating or inserting the Contact.
Deprecated fields (1)
createContactAccountMembership : MembershipMutateResponse!

Creates a new Contact Account Membership

Removal date: TBD.

Replaced by addContactAccountMembership

Argument Type Description
input ContactMembershipMutationInput!

The input type with the values used to create a Contact Account Membership
Back to top

ContactPhoneNumber

A PhoneNumber of a Contact

number : String!

The phone number

usage : ContactPhoneNumberUsage!

The usage of the phone number

Deprecated fields (2)
label : String!

The usage of the phone number

Removal date: TBD.

Replaced by usage field.

phoneNumber : String!

The phone number

Removal date: TBD.

Replaced by number field.

Back to top

ContactPhoneNumberInput

An Input for a phone number of a Contact

usage : ContactPhoneNumberUsage!

The ContactPhoneNumberUsage of the PhoneNumber being mutated

number : String

The phone number

Back to top

ContactPhoneNumberUsage

The usages of a PhoneNumber on a Contact

fax
home
mobile
office
Back to top

ContactStat

Aggregated statistics for a Contact

bookings : BookingStat!

Booking-related statistics for the Contact

contact : Contact!

The Contact this statistic is for

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
Back to top

ContactStatConnection

A connection containing page information and edges for ContactStat

edges : [ContactStatEdge!]!

The list of ContactStat edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ContactStatEdge

Contains cursor and node information for type ContactStat

cursor : String!

A string that can be used for cursor-based pagination

node : ContactStat!

The ContactStat node.

Back to top

ContactStatFieldGraphFilter

Filter that can be applied to limit which ContactStat nodes are returned

field : ContactStatFilterField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ContactStatFieldGraphOrder

Specifies the order in which ContactStat nodes are returned via the Connection

field : ContactStatOrderField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ContactStatFilterField

An enumeration.

id
firstName
lastName
name
canStaffEvent
emailAddress
isInstructor
isAdmin
isStaff
hasLeftCompany
accountId
accountName
isCoordinator
isAssociatedWithWorkplace
workplaceLocationId
sharingAccountManagementWithCoordinatorId
notSharingAccountManagementWithCoordinatorId
isStaffOrInstructor
hasActiveTrainingPass
hasAncestorAccountId
approvedCourseIds
calendarIntegrationStatus
byNameAccountOrEmail
jobRoleId
staffRoleId
staffRoleName
isQualifiedForEventId
isExceptionForEventId
qualifiedForCourseId
speaksLocale
createdAt
lastUpdatedAt
companyId
companyName
timeZoneName
bookingType
start
end
rangeInEventId
rangeInRequirementsForEventId
rangeInRequirementsForStaffRoleId
rangeInSessionId
rangeInStaffId
eventId
sessionId
unconfirmed
includePlans
planId
Back to top

ContactStatOrderField

An enumeration.

id
firstName
lastName
bookingsTotalCount
Back to top

ContactTaskCreateInput

An Input for creating a Contact Task

taskTypeId : ID!

The ID of the Task Type

userId : ID!

The ID of the User to assign the Task to

name : String!

The name of the Task

contactId : ID!

The ID of the Contact the Task is linked to

dueDate : LocalDateTime!

The due date of the Task

timeZoneName : String!

The timezone of the Task

description : String

The description of the Task

status : TaskStatus

The Status of the Task

showOnCalendar : Boolean

Whether to display this Task on the calendar

endDate : LocalDateTime

The end date of the Task

Back to top

ContactUpdateInput

An Input for updating a Contact

contactId : ID

The ID of the Contact being updated

personalName : PersonalNameUpdateInput

New Personal Name

jobRole : String

The new job role of the Contact

postalAddress : PostalAddressInput

The new PostalAddress of the Contact

source : MarketingSourceInput

The new MarketingSource of this Contact

emailAddresses : [ContactEmailAddressInput]

The list of EmailAddresses of the Contact being added or updated

phoneNumbers : [ContactPhoneNumberInput]

The list of PhoneNumbers of the Contact being added or updated

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Contact being updated

locale : String

The locale that LMS content is delivered in

preferredLocaleId : ID

A Contact’s preferred locale for content to be delivered across the platform. This is distinct from the locale field which only applies to LMS.

timeZoneName : String

The timezone for this Contact

workplaceIds : [ID]

The IDs of the Workplaces for this Contact

accountId : ID

The account ID for this Contact

isInstructor : Boolean

DEPRECATED (replaced by staffRoleIds) - Sets if a Contact can be an Instructor on Events

isInstructorDormant : Boolean

Sets if a Contact is Dormant as an Instructor

instructorBio : String

The Instructor Biography for the Contact

instructorCompanyId : ID

ID of the company that owns the instructor relationship

instructorOwnerId : ID

ID of the user that owns the instructor relationship

instructorContractNotes : String

The Contacts Instructor Contract Notes

workingPatternRotationId : ID

The ID of the Working Pattern Rotation this Contact is on

isStaff : Boolean

Sets if a Contact is a Staff member

isAdmin : Boolean

DEPRECATED (replaced by staffRoleIds) - Sets if a Contact is an Administrator

isMarketingContact : Boolean

Sets if a Contact is a Marketing Contact

department : String

New Department Name

notes : String

New Notes to add to the Contact

unsubscribeFromCommunications : Boolean

Sets if a Contact is unsubscribed from Communications

hasLeftCompany : Boolean

Set if a Contact has left the company

nationality : String

Set nationality of the contact

dateOfBirth : Date

Set date of birth of the contact

passportNumber : String

Set passport number of the contact

passportAuthority : String

Set passport authority of the contact

passportIssueDate : Date

Set passport issue date of the contact

passportExpiryDate : Date

Set passport expiry date of the contact

invoicePaymentDate : Date

Set passport invoice payment date of the contact

linkedIn : String

The linkedin profile of the contact

skype : String

The Skype ID of the contact

holidayAllocation : [HolidayAllocationInput]

Set a list of Holiday Allocation

supervisorId : ID

ID of the supervisor

marketingActivityId : ID

ID of the marketing activity saved on the contact

membershipOrganization : String

The Organization the Contact is a member of

customSystemFields : [ContactCustomSystemFieldUpdateInput]

The list of contact system fields and values to set on the Contact

staffRoleIds : [ID]

A list of Staff Role IDs the Contact is assigned to.

spokenLanguageCodes : [String]

The full locale codes (e.g. "en-US", "pt-BR") of the languages the Contact speaks. A list replaces the full set; an empty list or null clears it; omitting the field leaves it unchanged.

Back to top

ContactUpsertByExternalIdInput

An Input for upserting a Contact by External ID

externalId : ExternalIdInput!

The External ID used to identify the Contact to update. If a Contact does not exist, this External ID is set on the created Contact

contact : ContactUpsertInput!

The details with which to update or create the Contact

Back to top

ContactUpsertInput

Base Input Class for creating or updating a Contact

personalName : PersonalNameCreateInput!

The personal name of the Contact

accountId : ID

The Account ID that the Contact belongs to

accountExternalId : ExternalIdInput

The External ID used to identify the Account that the Contact belongs to

isIndividual : Boolean

Whether this Contact should be an Individual Account (default: false)

jobRole : String

The free-text job role of the Contact

jobRoleId : String

The job role ID of the primary Job Role of the primary Account for the Contact

jobRoleExternalId : ExternalIdInput

The External ID used to identify the Job Role for the Contact

postalAddress : PostalAddressInput

The PostalAddress of the Contact

source : MarketingSourceInput

The MarketingSource of this Contact

emailAddresses : [ContactEmailAddressInput]

The list of EmailAddresses of the Contact

phoneNumbers : [ContactPhoneNumberInput]

The list of PhoneNumbers of the Contact

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Contact

locale : String

The locale that LMS content is delivered in

preferredLocaleId : ID

A Contact’s preferred locale for content to be delivered across the platform. This is distinct from the locale field which only applies to LMS.

timeZoneName : String

The timezone for this Contact

workplaceIds : [ID]

The IDs of the Workplaces for this Contact

workplaceExternalIds : [ExternalIdInput]

The External IDs used to identify the Workplaces the Contact belongs to

isInstructor : Boolean

DEPRECATED (replaced by staffRoleIds) - Sets if a Contact can be an Instructor on Events

instructorBio : String

The Instructor Biography for the Contact

isStaff : Boolean

Sets if a Contact is a Staff member

isAdmin : Boolean

DEPRECATED (replaced by staffRoleIds) - Sets if a Contact is an Administrator

isMarketingContact : Boolean

Sets if a Contact is a Marketing Contact

department : String

The Contact's Department Name

notes : String

Optional Notes to add to the Contact

unsubscribeFromCommunications : Boolean

Sets if a Contact is unsubscribed from Communications

workingPatternRotationId : ID

The ID of the Working Pattern Rotation that this Contact is on

hasLeftCompany : Boolean

Set if a Contact has left the company

nationality : String

Set nationality of the contact

dateOfBirth : Date

Set date of birth of the contact

passportNumber : String

Set passport number of the contact

passportAuthority : String

Set passport authority of the contact

passportIssueDate : Date

Set passport issue date of the contact

passportExpiryDate : Date

Set passport expiry date of the contact

invoicePaymentDate : Date

Set passport invoice payment date of the contact

linkedIn : String

The linkedin profile of the contact

skype : String

The Skype ID of the contact

holidayAllocation : [HolidayAllocationInput]

Set a list of Holiday Allocation

supervisorId : ID

ID of the supervisor

marketingActivityId : ID

ID of the marketing activity saved on the contact

membershipOrganization : String

The Organization the Contact is a member of

customSystemFields : [ContactCustomSystemFieldUpdateInput]

The list of contact system fields and values to set on the Contact

staffRoleIds : [ID]

A list of Staff Role IDs the Contact is assigned to.

Back to top

ContactWithConflicts

List any conflicts with Sessions of training any Instructor has during the given date range up to 90 days in length.

conflictCount : Int!

The total number of conflicts for all sessions listed

contact : Contact!

The Instructor's Contact

sessions : [SessionWithConflicts!]!

The List of all sessions this Instructor is on that have conflicts

Back to top

Content

Substantive information or creative material to aid training

Related types: LmsContent

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Content

Argument Type Description
filter CustomFieldFilterInput
displayName : String

The main display name of the content

id : ID!

ID of the Content

type : ContentType!

Type of the Content

Deprecated fields (1)
name : String

Name of the Content

Removal date: TBD.

Deprecated in favour of displayName

Back to top

ContentComment

Comment made by a Learner on LMS content

Related types: Node

comment : String!

The text of the Comment

contact : Contact!

The Contact for the user that created the Comment

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : LocalDateTime!

The Date and Time the ContentComment was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The Document ID

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

ContentCommentConnection

A connection containing page information and edges for ContentComment

edges : [ContentCommentEdge!]!

The list of ContentComment edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ContentCommentEdge

Contains cursor and node information for type ContentComment

cursor : String!

A string that can be used for cursor-based pagination

node : ContentComment!

The ContentComment node.

Back to top

ContentCommentField

Fields for filtering and ordering Comments

id
contactId
createdAt
Back to top

ContentCommentFieldGraphFilter

Filter that can be applied to limit which ContentComment nodes are returned

field : ContentCommentField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ContentCommentFieldGraphOrder

Specifies the order in which ContentComment nodes are returned via the Connection

field : ContentCommentField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ContentConnection

A connection containing page information and edges for Content

edges : [ContentEdge!]!

The list of Content edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ContentEdge

Contains cursor and node information for type Content

cursor : String!

A string that can be used for cursor-based pagination

node : Content!

The Content node.

Back to top

ContentField

Fields for filtering and ordering Event Content

id
type
courseId
isActive
order
isArchived
isHidden
Back to top

ContentFieldGraphFilter

Filter that can be applied to limit which Content nodes are returned

field : ContentField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ContentFieldGraphOrder

Specifies the order in which Content nodes are returned via the Connection

field : ContentField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ContentResultStatus

An enumeration.

incomplete
completed
passed
failed
downloaded
Back to top

ContentType

Types of Content available

document
presentation
quiz
separator
scorm
resource
video
external
discussion
kryterion
Back to top

ConvertAnonymousLearnerInput

An Input for merging an anonymous Learner's records with a Contact

contactId : ID!

The Contact ID to receive all the anonymous progress

trackingIdentifier : String!

The Tracking Identifier used to record an anonymous Learner's progress

Back to top

ConvertedRegistrationsResponse

The Registrations for Events and Learning Paths altered by Registration Conversion

Related types: MutationResponse

achievements : [Achievement!]!

The Achievement types involved in this Registration conversion

errors : [FieldError!]!

The errors returned by the mutation

learners : [Learner!]!

The Event Learners that were part of this conversion

learningPathLearners : [LearningPathLearner!]!

The Learning Path Learners that were part of this conversion

Back to top

Coordinate

One of a pair of numbers that show the exact position of a point. It is represented by Decimal with 8 points of precision.

Back to top

Country

A nation with a designated ISO country code

code : String!

ISO designated country code

id : ID!

ID of the Country

name : String!

Name of the Country

provinces : [Province!]!

Provinces which are associated with this Country

timeZones : [String!]!

Time zones which are associated with this Country

Back to top

CourseAddPrivatePriceInput

An input type for adding private prices to Course Templates

courseTemplateId : ID!

The Course Template this price is for

regionId : ID!

The Region this price will be used for

financialUnitId : ID!

the Financial Unit for the price (Currency or Training Token)

amount : Decimal!

The amount for the price in the specified Financial Unit

Back to top

CourseAddPublicPriceInput

An input type for adding public prices to Course Templates

courseTemplateId : ID!

The Course Template this price is for

regionId : ID!

The Region this price will be used for

priceLevelId : ID!

The Price Level this price corresponds to

amount : Decimal!

The amount for the price in the specified Financial Unit

financialUnitId : ID!

the Financial Unit for the price (Currency or Training Token)

Back to top

CourseAvailabilityBlocker

A reason no concrete Course availability option could be found.

available : Int

Available quantity, when the blocker concerns quantity.

code : CourseAvailabilityBlockerCode!

Machine-readable reason no option was found.

maximumCapacity : Int

Largest learner capacity found, when capacity blocked the request.

message : String!

Concise human-readable explanation of the blocker.

required : Int

Required quantity, when the blocker concerns quantity.

Back to top

CourseAvailabilityBlockerCode

Why no Course availability option could be found.

no_saved_location
no_classroom_sessions
preferred_start_day_required
course_not_scheduled_on_day
course_outside_horizon
no_qualified_staff
staff_unavailable
no_suitable_resource
resource_unavailable
insufficient_resource_quantity
insufficient_capacity
Back to top

CourseAvailabilityDay

Availability summary and blockers for one potential start date.

blockers : [CourseAvailabilityBlocker!]!

Reasons this date cannot currently be offered.

date : Date!

Potential Course start date.

isPreferredStart : Boolean!

Whether this date matches the Course Template's preferred weekday.

optionCount : Int!

Number of available Location options on this date.

Back to top

CourseAvailabilityInput

Input describing one Course Event whose availability should be found.

courseTemplateId : ID!

The Course to run

locationId : ID

Optional Location in which the Event should run

endingAt : Date

Last date to consider; defaults to 90 days after startingFrom

learnerCount : Int

How many learners must fit in this single Event

relaxPreferredStartDay : Boolean

Allow starts on other scheduled weekdays

startingFrom : Date

First date to consider; defaults to today

maxOptions : Int

Maximum concrete options to return; defaults to 10

Back to top

CourseAvailabilityOption

One concrete way to run the requested Course as a single Event.

isPreferredStart : Boolean!

Whether this option starts on the template's preferred weekday.

location : Location!

Saved Location proposed for the Event.

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
maximumCapacity : Int

Maximum learners supported by the Course and selected Resources.

personnelAssignments : [CourseAvailabilityPersonnelAssignment!]!

Personnel and Staff Roles to create for this option.

personnelCosts : [CourseAvailabilityPersonnelCost!]!

Calculated costs for proposed Personnel with applicable rates.

personnelRequirements : [CourseAvailabilityPersonnelRequirement!]!

Required roles with selected and other available Personnel.

personnelRuleChecks : [PersonnelRuleCheck!]!

Advisory CBR outcomes for this option's proposed Personnel. One check per issue a Personnel Issues rule reports; Personnel the rules raise nothing for do not appear here. Event-dependent rules are deferred because discovery considers a hypothetical Event. Re-run Personnel availability with the persisted Event before assigning or publishing it.

resourceRequirements : [CourseAvailabilityResourceRequirement!]!

Required types with selected and other available Resources.

resources : [Resource!]!

All Resources this option would book.

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
sessionCount : Int!

Number of Sessions in the Course Event.

sessions : [CourseAvailabilitySession!]!

Proposed Sessions, in time order.

staff : [Contact!]!

All Staff this option would assign.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
startsAt : LocalDateTime!

Date and time of the first Session.

startsOn : Date!

Calendar day on which the Course starts.

Back to top

CourseAvailabilityPersonnelAssignment

Personnel and role to assign when scheduling an option.

personnelId : ID!

The Contact to add as Personnel.

staffRoleId : ID!

The Staff Role under which to assign the Contact.

Back to top

CourseAvailabilityPersonnelCost

Calculated cost for proposed Personnel with a Course rate.

amount : Decimal!

Calculated cost for this option.

currency : Currency!

Currency in which the rate and cost are expressed.

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
personnel : Contact!

The proposed member of Personnel whose rate was applied.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
rate : Decimal!

Configured Course rate used in the calculation.

ratePer : String!

Unit to which the configured rate applies.

Back to top

CourseAvailabilityPersonnelRequirement

Selected and alternative Personnel for one required Staff Role.

alternativePersonnel : [Contact!]!

Other qualified and available Personnel for this role.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
alternativePersonnelIds : [ID!]!

IDs of other qualified and available Personnel for this role.

personnelCosts : [CourseAvailabilityPersonnelCost!]!

Calculated costs for every selectable member of Personnel.

quantity : Int!

Number of Personnel required in this role.

selectedPersonnel : [Contact!]!

Personnel selected for the proposed Event.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
selectedPersonnelIds : [ID!]!

IDs of the Personnel selected for the proposed Event.

staffRole : StaffRole!

Staff Role this requirement must satisfy.

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
staffRoleId : ID!

ID of the required Staff Role.

Back to top

CourseAvailabilityResourceRequirement

Selected and alternative Resources for one required Resource Type.

alternativeResourceIds : [ID!]!

IDs of other suitable and available Resources of this type.

alternativeResources : [Resource!]!

Other suitable and available Resources of this type.

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
quantity : Int!

Number of Resources required of this type.

resourceType : ResourceType!

Resource Type this requirement must satisfy.

Argument Type Description
filters = [] [ResourceTypeFieldGraphFilter]
order = "__EMPTY__" ResourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceTypeFieldGraphOrder]
resourceTypeId : ID!

ID of the required Resource Type.

selectedResourceIds : [ID!]!

IDs of the Resources selected for the proposed Event.

selectedResources : [Resource!]!

Resources selected for the proposed Event.

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
Back to top

CourseAvailabilityResponse

Availability options, blockers, or structured input errors.

blockers : [CourseAvailabilityBlocker!]

Reasons no options were found; empty when at least one option exists.

days : [CourseAvailabilityDay!]

Availability and blockers for each date in the searched horizon.

errors : [FieldError!]!

Structured errors when the requested constraints are invalid.

options : [CourseAvailabilityOption!]

Concrete placements for one Event, in chronological order.

preferredStartDay : String

Preferred starting weekday configured on the Course Template.

searchedFrom : Date

First date searched, or null when the input was invalid.

searchedUntil : Date

Last date searched, or null when the input was invalid.

Back to top

CourseAvailabilitySession

One proposed Session within a Course availability option.

end : LocalDateTime!

When this Session would end.

resources : [Resource!]!

Resources which would be booked for this Session.

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
staff : [Contact!]!

Staff who would be assigned to this Session.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
start : LocalDateTime!

When this Session would start.

Back to top

CourseBreakout

A Course Breakout

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
groups : CourseBreakoutGroupConnection!

The Breakout Groups belonging to this Course Breakout

Argument Type Description
filters = [] [CourseBreakoutGroupFieldGraphFilter]
order = "__EMPTY__" CourseBreakoutGroupFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseBreakoutGroupFieldGraphOrder]
id : ID!

The ID of the Course Breakout

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Course Breakout

Back to top

CourseBreakoutField

Fields for filtering and ordering Course Breakouts

id
courseTemplateId
name
Back to top

CourseBreakoutFieldGraphFilter

Filter that can be applied to limit which CourseBreakout nodes are returned

field : CourseBreakoutField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseBreakoutFieldGraphOrder

Specifies the order in which CourseBreakout nodes are returned via the Connection

field : CourseBreakoutField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseBreakoutGroup

A Course Breakout Group

Related types: Node

breakout : CourseBreakout!

The Breakout this Group belongs to

Argument Type Description
filters = [] [CourseBreakoutFieldGraphFilter]
order = "__EMPTY__" CourseBreakoutFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseBreakoutFieldGraphOrder]
capacity : Int

The maximum number of learners this Breakout Group can accommodate

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Course Breakout Group

Argument Type Description
filter CustomFieldFilterInput
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Course Breakout Group

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Course Breakout Group

sessionTemplates : SessionTemplateConnection!

The Session Templates belonging to this Course Breakout Group

Argument Type Description
filters = [] [SessionTemplateFieldGraphFilter]
order = "__EMPTY__" SessionTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionTemplateFieldGraphOrder]
Back to top

CourseBreakoutGroupConnection

A connection containing page information and edges for CourseBreakoutGroup

edges : [CourseBreakoutGroupEdge!]!

The list of CourseBreakoutGroup edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseBreakoutGroupEdge

Contains cursor and node information for type CourseBreakoutGroup

cursor : String!

A string that can be used for cursor-based pagination

node : CourseBreakoutGroup!

The CourseBreakoutGroup node.

Back to top

CourseBreakoutGroupField

Fields for filtering and ordering Course Breakout Groups

id
breakoutId
name
Back to top

CourseBreakoutGroupFieldGraphFilter

Filter that can be applied to limit which CourseBreakoutGroup nodes are returned

field : CourseBreakoutGroupField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseBreakoutGroupFieldGraphOrder

Specifies the order in which CourseBreakoutGroup nodes are returned via the Connection

field : CourseBreakoutGroupField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseCustomFieldDiscountabilityRule

Promotion Campaign Discountability Rules related to Course Custom Fields

Related types: PromotionDiscountabilityRule

courseCustomFieldValues : [CustomFieldValue!]!

Custom field values associated to the Promotion restrictions

type : PromotionCriterionType!

The type of Discountability Rule (e.g. Course, Location, etc)

Back to top

CourseCustomFieldEligibilityRule

Promotion Campaign Eligibility Rules related to Course Custom Fields

Related types: PromotionEligibilityRule

courseCustomFieldValues : [CustomFieldValue!]!

A list of custom fields involved in this Course discount eligibility rule

type : PromotionCriterionType!

The type of Eligibility Rule (e.g. Course, Location, etc)

Back to top

CourseCustomFieldMappings

The input type with Custom Course Fields to map to Portal Fields

courseCustomFieldId : ID!

The ID of Custom Field to map from

portalField : PortalCourseField!

The Portal Field to map the Custom Field to

Back to top

CourseDeletePriceInput

An input type for deleting Course Template prices

coursePriceId : ID!

The Course Template price to delete

Back to top

CourseDetailsAddInput

An Input containing the details required by a Course Interest

Back to top

CourseDetailsUpdateInput

An Input containing the details required by a Course Interest

Back to top

CourseDiscountabilityRule

Promotion Campaign Discountability Rules related to Course Templates

Related types: PromotionDiscountabilityRule

discountableCourses : CourseTemplateConnection!

A list of Course Templates part of this discountability rule

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
type : PromotionCriterionType!

The type of Discountability Rule (e.g. Course, Location, etc)

Back to top

CourseEligibilityRule

Promotion Campaign Eligibility Rules related to Course Templates

Related types: PromotionEligibilityRule

eligibleCourses : CourseTemplateConnection!

A list of Course Templates eligible for this Promotion rule

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
type : PromotionCriterionType!

The type of Eligibility Rule (e.g. Course, Location, etc)

Back to top

CourseItem

The mapping relating a Course Template and a Stock Item

Related types: Node

duplicateBehavior : CourseItemDuplicateBehavior!

The Invoice behavior for duplicate Course Stock Items

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The unique identifier of this Course Stock Item mapping

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

location : Location

The Location of the Course Stock Item, defaults to all Locations

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
stockItem : StockItem!

The Stock Item for this Course Template mapping

Argument Type Description
filters = [] [StockItemFieldGraphFilter]
order = "__EMPTY__" StockItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StockItemFieldGraphOrder]
Back to top

CourseItemConnection

A connection containing page information and edges for CourseItem

edges : [CourseItemEdge!]!

The list of CourseItem edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseItemCreateInput

An Input for creating a Course Item

courseTemplateId : ID!

The ID of the Course Template to associate with the Course Item

itemId : ID!

The ID of the Item to associate with the Course Item

duplicateBehavior : CourseItemDuplicateBehavior!

The behavior type

locationId : ID

The optional ID of the Location to associate with the Course Item

Back to top

CourseItemDeleteInput

An Input for deleting a Course Item

courseItemId : ID!

The ID of the Course Item being deleted

Back to top

CourseItemDuplicateBehavior

An enumeration.

allow
only_one_per_invoice
charge_once_per_invoice
Back to top

CourseItemEdge

Contains cursor and node information for type CourseItem

cursor : String!

A string that can be used for cursor-based pagination

node : CourseItem!

The CourseItem node.

Back to top

CourseItemField

CourseItem Fields for Filtering and Ordering

id
Back to top

CourseItemFieldGraphFilter

Filter that can be applied to limit which CourseItem nodes are returned

field : CourseItemField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseItemFieldGraphOrder

Specifies the order in which CourseItem nodes are returned via the Connection

field : CourseItemField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseItemUpdateInput

An Input for updating a Course Item

courseItemId : ID!

The ID of the Course Item being updated

courseTemplateId : ID

The new ID of the Course Template to associate with the Course Item

itemId : ID

The new ID of the Item to associate with the Course Item

duplicateBehavior : CourseItemDuplicateBehavior

The new behavior type

locationId : ID

The ID of the new Location to associate with the Course Item

Back to top

CourseLevel

The skill level a Course is targeted at

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Course Level

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of this Course Level

Back to top

CourseLevelConnection

A connection containing page information and edges for CourseLevel

edges : [CourseLevelEdge!]!

The list of CourseLevel edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseLevelEdge

Contains cursor and node information for type CourseLevel

cursor : String!

A string that can be used for cursor-based pagination

node : CourseLevel!

The CourseLevel node.

Back to top

CourseLevelField

Fields for filtering and ordering CourseLevels

id
name
Back to top

CourseLevelFieldGraphFilter

Filter that can be applied to limit which CourseLevel nodes are returned

field : CourseLevelField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseLevelFieldGraphOrder

Specifies the order in which CourseLevel nodes are returned via the Connection

field : CourseLevelField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseLmsContent

The Type of LMS Content associated with a Course Template

document
quiz
presentation
resource
scorm
separator
video
external
Back to top

CourseObjective

An Objective within a Learning Path's learning journey, representing a Course Template that must be completed in order to complete this Learning Path

Related types: Node LearningObjective

courseTemplate : CourseTemplate!

The Course Template that must be completed in order to complete this Objective.

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
credits : Int

The number of credits that this LearningObjective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The unique identifier of this Course Objective.

isMandatory : Boolean!

Denotes whether or not the LearningObjective is mandatory

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningObjective in the set of LearningPath objectives

selectableEvents : [Event!]!

A restricted list of Events that can be selected to fulfil the Objective. An empty list signifies that any Event for the Objective's Course Template can be selected.

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
Back to top

CourseOutcome

A Learner's record relating to a Course Objective

Related types: Node LearningOutcome

course : CourseTemplate

The Course for the Event that was completed in order to complete a Learning Objective.

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
credits : Int

The number of credits that the LearningOutcome represents

event : Event

The Event that was completed in order to complete a Learning Objective.

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The unique identifier of this Course Outcome.

isCompleted : Boolean

Denotes whether or not the LearningOutcome has been completed by the Learner

isMandatory : Boolean!

Denotes whether or not the LearningOutcome is mandatory

learner : Learner

The Learner who achieved this Outcome and completed a Learning Objective.

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
learningObjective : LearningObjective!

The LearningObjective to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
learningPathLearner : LearningPathLearner!

The LearningPathLearner to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningOutcome in the set of LearningAssignment outcomes

Back to top

CourseOutcomeConnection

A connection containing page information and edges for CourseOutcome

edges : [CourseOutcomeEdge!]!

The list of CourseOutcome edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseOutcomeEdge

Contains cursor and node information for type CourseOutcome

cursor : String!

A string that can be used for cursor-based pagination

node : CourseOutcome!

The CourseOutcome node.

Back to top

CourseOutcomeField

CourseOutcome Fields for Filtering and Ordering

id
Back to top

CourseOutcomeFieldGraphFilter

Filter that can be applied to limit which CourseOutcome nodes are returned

field : CourseOutcomeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseOutcomeFieldGraphOrder

Specifies the order in which CourseOutcome nodes are returned via the Connection

field : CourseOutcomeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CoursePrivatePriceInput

An input type for creating a course's private listing

regionId : ID!

The Region this price will be used for

financialUnitId : ID!

the Financial Unit for the price (Currency or Training Token)

amount : Decimal!

The amount for the price in the specified Financial Unit

Back to top

CoursePublicPriceInput

An input type for creating a course's public pricing listing

regionId : ID!

The Region this price will be used for

priceLevelId : ID!

The Price Level this price corresponds to

amount : Decimal!

The amount for the price in the specified Financial Unit

financialUnitId : ID!

the Financial Unit for the price (Currency or Training Token)

Back to top

CourseTemplate

Defines a pattern used to create Events which represent training a particular subject or skill

Related types: Node InterestItem CatalogueItem TrainingPassTypeContent

accountAssociations : AccountAssociationConnection!

The Account Associations for this Course Template

Argument Type Description
filters = [] [AccountAssociationFieldGraphFilter]
order = "__EMPTY__" AccountAssociationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountAssociationFieldGraphOrder]
achievementTypes : CourseTemplateAchievementTypeConnection

The Achievement Types for the Course Templates

Argument Type Description
filters = [] [CourseTemplateAchievementTypeFieldGraphFilter]
order = "__EMPTY__" CourseTemplateAchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateAchievementTypeFieldGraphOrder]
canDelete : Boolean!

Whether this Course Template can be deleted If it's used in any Events, it cannot be deleted

code : String!

A code used to refer to the Course

company : Company

The Company assigned to this Course Template

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
courseItems : CourseItemConnection

Mappings of Stock Items to this Course Template

Argument Type Description
filters = [] [CourseItemFieldGraphFilter]
order = "__EMPTY__" CourseItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseItemFieldGraphOrder]
courseText1 : String

Custom description field 1: The default label is Course Summary

courseText10 : String

Custom description field 10

courseText11 : String

Custom description field 11

courseText12 : String

Custom description field 12

courseText13 : String

Custom description field 13

courseText14 : String

Custom description field 14

courseText2 : String

Custom description field 2: The default label is Introduction

courseText3 : String

Custom description field 3: The default label is Topics

courseText4 : String

Custom description field 4: The default label is Benefits

courseText5 : String

Custom description field 5: The default label is Prerequisites

courseText6 : String

Custom description field 6: The default label is Teaching Method

courseText7 : String

Custom description field 7

courseText8 : String

Custom description field 8

courseText9 : String

Custom description field 9

cpe : Decimal

Amount of Continued Professional Education hours

createdAt : TimeZonedDateTime

The time the Course Template was created

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Course Template

Argument Type Description
filter CustomFieldFilterInput
eventLearningMode : LearningMode

The Event Learning Mode for this Course Template

eventTemplate : EventTemplate

The event template for this course

Argument Type Description
filters = [] [EventTemplateFieldGraphFilter]
order = "__EMPTY__" EventTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventTemplateFieldGraphOrder]
events : EventConnection!

The events linked to this Course Template

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
featuredInPortals : [WebLinkPortal!]!

The Portals that this Course Template is featured in

feedbackSurvey : Survey

The survey link associated with this Course Template

Argument Type Description
filters = [] [SurveyFieldGraphFilter]
order = "__EMPTY__" SurveyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SurveyFieldGraphOrder]
id : ID!

ID of the CourseTemplate

image : Document

The image for this Course

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
imageGallery : DocumentConnection!

The image Gallery for this Course

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
includedInPassTypeIds : [ID!]!

Identifiers for Published Training Pass Types that grant access to this Course Template

interests : InterestConnection!

Opportunity interests related to the Course Template

Argument Type Description
filters = [] [InterestFieldGraphFilter]
order = "__EMPTY__" InterestFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InterestFieldGraphOrder]
learningCategories : LearningCategoryConnection!

Categories this Course Template is tagged with

Argument Type Description
filters = [] [LearningCategoryFieldGraphFilter]
order = "__EMPTY__" LearningCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningCategoryFieldGraphOrder]
learningTags : LearningTagConnection!

The Learning Tags associated with this Course Template

Argument Type Description
filters = [] [LearningTagFieldGraphFilter]
order = "__EMPTY__" LearningTagFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningTagFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

level : CourseLevel

The skill level this Course is targeted at

Argument Type Description
filters = [] [CourseLevelFieldGraphFilter]
order = "__EMPTY__" CourseLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseLevelFieldGraphOrder]
lifecycleState : CourseTemplateLifecycleState!

The state of the Course Template in its lifecycle

lmsContent : CourseTemplateLmsContentConnection

The Lms Content associated with this Course Template

Argument Type Description
filters = [] [CourseTemplateLmsContentFieldGraphFilter]
order = "__EMPTY__" CourseTemplateLmsContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateLmsContentFieldGraphOrder]
lmsResourcesText : String

A block of text with some useful Links to Resources - text view of lmsResources.

lmsSummary : String

A block of text explaining the summary of the eLearning of the course to appear in Administrate's LMS.

locale : Locale

"The Locale of this Course Template"

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
maxPlaces : Int

The maximum number of bookable places for the Course

minPlaces : Int

The minimum number of booked places required for the Course

passingRules : CourseTemplatePassingRules!

Configuration for Course Template Passing Rules. Determines how Learners to be progressed into Passed status.

pointOfSaleFields : [PointOfSaleFieldDefinition!]!

Point of Sale Fields Mapped to this Course Template

pricingBand : PricingBand

The pricing band for this course

Argument Type Description
filters = [] [PricingBandFieldGraphFilter]
order = "__EMPTY__" PricingBandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PricingBandFieldGraphOrder]
privatePrices : CourseTemplatePrivatePriceConnection!

The default prices available for this course when scheduled as a private event

Argument Type Description
filters = [] [CourseTemplatePrivatePriceFieldGraphFilter]
order = "__EMPTY__" CourseTemplatePrivatePriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplatePrivatePriceFieldGraphOrder]
publicPrices : CourseTemplatePublicPriceConnection!

The default prices available for this course when scheduled as a public event

Argument Type Description
filters = [] [CourseTemplatePublicPriceFieldGraphFilter]
order = "__EMPTY__" CourseTemplatePublicPriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplatePublicPriceFieldGraphOrder]
purchaseRequiresReview : Boolean!

Dictates if a Cart that contains this Course will be submitted for review before checkout in a Weblink Portal. Requires the orderReviewStep and orderRetrievalStep to be defined in the Weblink Portal's Opportunity Steps.

registrationOpensOffset : Int

The time that the registration will open described by days before the start date.

relatedCoursesText : String

The related courses text associated with this Course Template

requiredResources : [CourseTemplateResourceRequirement!]

Resources (equipment, rooms, etc) the course requires

Argument Type Description
filters = [] [CourseTemplateResourceRequirementFieldGraphFilter]
order = "__EMPTY__" CourseTemplateResourceRequirementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateResourceRequirementFieldGraphOrder]
requiredStaff : [CourseTemplateStaffRequirement!]

Staff (instructors, assistants, etc) the course requires

Argument Type Description
filters = [] [CourseTemplateStaffRequirementFieldGraphFilter]
order = "__EMPTY__" CourseTemplateStaffRequirementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateStaffRequirementFieldGraphOrder]
schedule : Schedule

The schedule associated with this Course Template

scoreTemplates : [CustomTemplate]!

The score templates for this course

Argument Type Description
filters = [] [CustomTemplateFieldGraphFilter]
order = "__EMPTY__" CustomTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CustomTemplateFieldGraphOrder]
sessionTemplates : SessionTemplateConnection!

The Session Templates linked to this Course Template

Argument Type Description
filters = [] [SessionTemplateFieldGraphFilter]
order = "__EMPTY__" SessionTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionTemplateFieldGraphOrder]
shortCode : String

A 3 character code used to refer to the Course

showLevelOnPdf : Boolean

Whether to show the course level on the PDF

staffExceptions : StaffExceptionConnection!

Personnel that has been approved to staff the Course as a specific Role

Argument Type Description
filters = [] [StaffExceptionFieldGraphFilter]
order = "__EMPTY__" StaffExceptionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffExceptionFieldGraphOrder]
targetFillRate : Int

A target percentage for how much we want the event to be.

taskWorkflows : TaskWorkflowConnection!

The Task Workflows associated with this Course Template

Argument Type Description
filters = [] [TaskWorkflowFieldGraphFilter]
order = "__EMPTY__" TaskWorkflowFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskWorkflowFieldGraphOrder]
title : String!

Name of the Course

updatedAt : TimeZonedDateTime!

The last time the Course Template was updated

Deprecated fields (7)
approvedInstructors : ContactConnection!

The list of Instructors approved for the Course Template.

Removal date: TBD.

Deprecated in favor of exceptionalStaff

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
exceptionalStaff : ContactConnection!

The list of Contacts on the Staff Exceptions list who can always be assigned to Events created from this Course Template.

Removal date: 2026-07-16.

Replaced by staffExceptions

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
includedInTrainingPasses : TrainingPassTypeConnection!

Published Training Pass Types that grants access to this Course Template

Removal date: TBD.

Deprecated in favour of includedInPassTypeIds

Argument Type Description
filters = [] [TrainingPassTypeFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeFieldGraphOrder]
introduction : String

A block of text explaining the introduction to the Course

Removal date: TBD.

Replaced by Custom Field.

lmsResources : [CourseTemplateResource!]!

Some useful Links to Resources

Removal date: TBD.

Deprecated in favour of lmsResourcesText

name : String!

Name of the Course

Removal date: TBD.

Replaced by title field.

stockItems : StockItemConnection

Stock Items mapped to this Course Template

Removal date: TBD.

Deprecated in favor of courseItems

Argument Type Description
filters = [] [StockItemFieldGraphFilter]
order = "__EMPTY__" StockItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StockItemFieldGraphOrder]
Back to top

CourseTemplateAchievementType

The Mapping between Course Template and related Achievement Types

Related types: Node

achievementType : AchievementType!

The Achievement Type mapped to this Course Template

Argument Type Description
filters = [] [AchievementTypeFieldGraphFilter]
order = "__EMPTY__" AchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementTypeFieldGraphOrder]
autoAward : Boolean!

Indicate whether related Achievement is awarded automatically upon event completion by learner. Given Event is created based on the Course Template

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Mapping

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lmsCompletionThreshold : Int

The LMS Completion Threshold percentage required to award the Achievement Type

Back to top

CourseTemplateAchievementTypeConnection

A connection containing page information and edges for CourseTemplateAchievementType

edges : [CourseTemplateAchievementTypeEdge!]!

The list of CourseTemplateAchievementType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseTemplateAchievementTypeEdge

Contains cursor and node information for type CourseTemplateAchievementType

cursor : String!

A string that can be used for cursor-based pagination

node : CourseTemplateAchievementType!

The CourseTemplateAchievementType node.

Back to top

CourseTemplateAchievementTypeField

Fields for filtering and ordering Achievement Types associated with the Course Templates

id
autoAward
Back to top

CourseTemplateAchievementTypeFieldGraphFilter

Filter that can be applied to limit which CourseTemplateAchievementType nodes are returned

field : CourseTemplateAchievementTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseTemplateAchievementTypeFieldGraphOrder

Specifies the order in which CourseTemplateAchievementType nodes are returned via the Connection

field : CourseTemplateAchievementTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseTemplateAddAccountAssociationInput

An Input to allow a user to add an Account Association to a Course Template

courseTemplateId : ID!

The Course Template

accountId : ID!

The Account to associate with the Course Template

accountAssociationTypeId : ID!

The Account Association Type which defines the association

Back to top

CourseTemplateAddAchievementTypeInput

An Input for adding new Achievement Type to a Course Template

courseTemplateId : ID!

The ID of the Course Template to add the Achievement Type to.

achievementTypeId : ID!

The ID of Achievement Type to add to the Course Template.

autoAward : Boolean!

Setting for whether Achievement should be automatically awarded when Learner passes the derived Event.

lmsCompletionThreshold : Int
Back to top

CourseTemplateAddLmsContentTypeExternalInput

An Input to allow a user to add LMS Resources of type external to a Course Template

courseTemplateId : ID!

The Course Template

resources : [LmsResourceTypeExternalInput]!

The LMS Resources to add to the Course Template

Back to top

CourseTemplateAddLmsContentTypeResourceInput

An Input to allow a user to add LMS Resources of type external to a Course Template

courseTemplateId : ID!

The Course Template

resources : [LmsResourceTypeResourceInput]!

The LMS Resources to add to the Course Template

Back to top

CourseTemplateAddLmsContentTypeSeparatorInput

An Input to allow a user to add LMS Resources of type separator to a Course Template

courseTemplateId : ID!

The Course Template

resources : [LmsResourceTypeSeparatorInput]!

The LMS Resources to add to the Course Template

Back to top

CourseTemplateAddLmsResourcesResponse

A Response for a CourseTemplate AddLmsResources Mutation(s)

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

lmsResources : [CourseTemplateLmsContent!]

The LMS Resources that were added

Back to top

CourseTemplateAddTagsInput

An Input to allow a user to add Learning Tags to a Course Template

courseTemplateId : ID!

The Course Template

learningTagIds : [ID]!

The Learning Tags to add to the Course Template

Back to top

CourseTemplateBulkResponse

A Response for CourseTemplate bulk Mutation

Related types: MutationResponse

courseTemplates : [CourseTemplate!]

The Course Templates that were updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateConnection

A connection containing page information and edges for CourseTemplate

edges : [CourseTemplateEdge!]!

The list of CourseTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseTemplateCreateInput

An input type for creating a Course Template

title : String!

The title of the Course Template (max 255 characters)

code : String!

The code of the Course Template (max 120 characters)

shortCode : String

The short code of the Course Template. Must be 3 characters or less

lifecycleState : CourseTemplateLifecycleState

The lifecycle state of the Course Template

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Course Template to set

localeId : ID

The primary Locale of the Course Template - the language its own, untranslated content is written in

deliveryLocaleIds : [ID]

The Locales this Course Template can be delivered in. Separate from its translations

defaultDeliveryLocaleId : ID

The Locale the Course Template is delivered in by default. Must be one of deliveryLocaleIds

featuredInPortals : [ID]

The list of Weblink Portal ID's this Course Template is featured in

publicPrices : [CoursePublicPriceInput]

Optional list of public prices this Course Template will be created with

privatePrices : [CoursePrivatePriceInput]

Optional list of private prices this Course Template will be created with

registrationOpensOffset : Int

Optional integer with the number of days before the start date when registration will be opened

lmsSummary : String

Optional Summary to describe the course, can be formatted as HTML text or plain text.

lmsResourcesText : String

Optional Summary to describe the course materials, can be formatted as HTML text or plain text.

relatedCoursesText : String

Optional Summary to describe related courses, can be formatted as HTML text or plain text.

approvedInstructors : [ID]

DEPRECATED (2026-04-16, replaced by addStaffExceptions) - Optional list of Contact IDs to assign as approved instructors for the Course

exceptionalStaffIds : [ID]

DEPRECATED (2026-04-16, replaced by addStaffExceptions) - Optional list of Contact IDs to set as the Staff Exceptions list for the Course

learningTagIds : [ID]

List of Learning Tag IDs this Course Template is part of

learningCategories : [ID]

Optional list of Learning Category IDs to set as Learning Categories for the Course

minPlaces : Int

Optional minimum booked places required for the Course

maxPlaces : Int

Optional maximum booked places available on the Course

targetFillRate : Int
cpe : Decimal

Optional amount of Continued Professional Education hours

showLevelOnPdf : Boolean

Whether to display the course level on the course PDF

purchaseRequiresReview : Boolean

Whether to require order review in WebLink

companyId : ID

The Course Template company for segregation purposes

levelId : ID

The Level for this Course Template

taskWorkflowGroupIds : [ID]

Optional task workflows to attach to this template - DEPRECATED (replaced by taskWorkflowIds)

taskWorkflowIds : [ID]

Optional task workflows to attach to this template

imageIds : [ID]

Optional DMS document image IDs to attach to this template

learningMode : LearningMode

Optional learning mode for this Course Template, either classroom, lms or blended

pricingBandId : ID

Optional pricing band to attach to the Course Template

eventTemplateId : ID

Optional event template ID to attach to the Course Template

courseText1 : String

Optional custom text field 1, default UI label is Course Summary

courseText2 : String

Optional custom text field 2, default UI label is Introduction

courseText3 : String

Optional custom text field 3, default UI label is Topics

courseText4 : String

Optional custom text field 4, default UI label is Course Benefits

courseText5 : String

Optional custom text field 5, default UI label is Prerequisites

courseText6 : String

Optional custom text field 6, default UI label is Teaching Method

courseText7 : String

Optional custom text field 7

courseText8 : String

Optional custom text field 8

courseText9 : String

Optional custom text field 9

courseText10 : String

Optional custom text field 10

courseText11 : String

Optional custom text field 11

courseText12 : String

Optional custom text field 12

courseText13 : String

Optional custom text field 13

courseText14 : String

Optional custom text field 14

feedbackSurveyId : ID

Optional feedback survey to attach to the course

feedbackSurveyRatingQuestionId : ID

The question on the survey to use as the feedback question

Back to top

CourseTemplateCreateResponse

A Response for CourseTemplate Create Mutation

Related types: MutationResponse

courseTemplate : CourseTemplate

The CourseTemplate that was created

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateDeleteAllResourceRequirementsInput

An Input for deleting all Resource Requirements from a Course Template

courseTemplateId : String!

The ID of Course Template

Back to top

CourseTemplateDeleteAllStaffRequirementsInput

An Input for deleting all Staff Requirements from a Course Template

courseTemplateId : ID!

The ID of Course Template

Back to top

CourseTemplateDeleteLmsResourcesInput

An Input to allow a user to delete LMS Resources

courseTemplateId : ID!

The Course Template

resourcesIds : [ID]!

The LMS Resources IDs to delete

Back to top

CourseTemplateDuplicateInput

An input type for duplicating an existing Course Template

code : String!

The Code for the new Course Template being created

Back to top

CourseTemplateEdge

Contains cursor and node information for type CourseTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : CourseTemplate!

The CourseTemplate node.

Back to top

CourseTemplateEditAchievementTypeInput

An Input for editing Achievement Type on a Course Template

courseTemplateAchievementTypeId : ID!

The ID of Course Template Achievement Type to edit.

autoAward : Boolean!

Setting for whether Achievement should be automatically awarded when Learner passes the derived Event.

lmsCompletionThreshold : Int
Back to top

CourseTemplateEditPassingRulesBlendedInput

An Input for editing Blended section of Passing Rules for a Course Template

autoPassLearner : Boolean
achievementValidFrom : AchievementValidFromBlendedTypes
allowedMissedSessions : Int
requireRegistrationInvoiceToBePaid : Boolean
Back to top

CourseTemplateEditPassingRulesClassroomInput

An Input for editing Classroom section of Passing Rules for a Course Template

autoPassLearner : Boolean
allowedMissedSessions : Int
requireRegistrationInvoiceToBePaid : Boolean
Back to top

CourseTemplateEditPassingRulesInput

An Input for editing Passing Rules for a Course Template

Back to top

CourseTemplateEditPassingRulesLmsInput

An Input for editing LMS section of Passing Rules for a Course Template

autoPassLearner : Boolean
achievementValidFrom : AchievementValidFromLmsTypes
requireRegistrationInvoiceToBePaid : Boolean
Back to top

CourseTemplateField

Fields for filtering and ordering CourseTemplates

id
code
name
title
introduction
lmsSummary
lmsResources
lmsResourcesText
relatedCoursesText
lifecycleState
levelId
learningCategoryId
hasPriceInCurrency
hasPriceInRegion
isValidForPortal
isValidForPortalPrivateOnly
withNoEvents
codeOrTitle
scheduleType
updatedAt
createdAt
Back to top

CourseTemplateFieldGraphFilter

Filter that can be applied to limit which CourseTemplate nodes are returned

field : CourseTemplateField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseTemplateFieldGraphOrder

Specifies the order in which CourseTemplate nodes are returned via the Connection

field : CourseTemplateField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseTemplateGenerateSessionsInput

An input for generating sessions associated to a Course Template

courseTemplateId : ID!

The ID of the Course Template for which sessions are being created

Back to top

CourseTemplateLifecycleState

The lifecycle state of a Course Template

draft
published
archived
Back to top

CourseTemplateLmsContent

The LMS Content associated with a Course Template

Related types: Node

courseId : ID!

The Course ID this LMS Content is associated with

description : String

The given Description for this LMS Content

document : Document

The document object associated with this LMS Content

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
externalActivityDescription : String

The Description of the External Activity

externalActivityUrl : String

The URL of the External Activity

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Course Resource Mapping for LMS Content

includedInPassTypeIds : [String!]!

Training Pass Type IDs that grant access to this content

isArchived : Boolean!

Whether the LMS Content is Archived

isAutoComplete : Boolean!

Whether the LMS Content is set to auto-complete

isHidden : Boolean!

Whether the LMS Content is Hidden

isPremium : Boolean!

If the content requires a Training Pass to access it

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

optional : Boolean!

Whether the LMS Content is required for the Learner to Complete/Pass the Event

order : Int

The order of the LMS Content, from lowest (top) to highest (bottom)

type : CourseLmsContent!

The type of the LMS Content

Back to top

CourseTemplateLmsContentConnection

A connection containing page information and edges for CourseTemplateLmsContent

edges : [CourseTemplateLmsContentEdge!]!

The list of CourseTemplateLmsContent edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseTemplateLmsContentEdge

Contains cursor and node information for type CourseTemplateLmsContent

cursor : String!

A string that can be used for cursor-based pagination

node : CourseTemplateLmsContent!

The CourseTemplateLmsContent node.

Back to top

CourseTemplateLmsContentField

Fields for filtering and ordering CourseTemplateLmsContent

id
Back to top

CourseTemplateLmsContentFieldGraphFilter

Filter that can be applied to limit which CourseTemplateLmsContent nodes are returned

field : CourseTemplateLmsContentField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseTemplateLmsContentFieldGraphOrder

Specifies the order in which CourseTemplateLmsContent nodes are returned via the Connection

field : CourseTemplateLmsContentField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseTemplateLmsContentInput

An Input for setting the Optional status of an Lms Content associated with a Course Template

courseTemplateLmsContentMapId : ID!

The ID of the Course Template Lms Resource Mapping being updated

optional : Boolean!
Back to top

CourseTemplateLmsContentResponse

A Response for a CourseTemplate setCourseTemplateLmsContentOptional Mutation

Related types: MutationResponse

courseTemplateLmsContent : CourseTemplateLmsContent

The Course Template LMS Content that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateMutationResponse

A Response for Mutating a Course Template

Related types: MutationResponse

courseTemplate : CourseTemplate

The CourseTemplate that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateMutations

Available Mutations on a CourseTemplate

addAccountAssociation : CourseTemplateMutationResponse!

Add an Account Association to a Course Template

Argument Type Description
input CourseTemplateAddAccountAssociationInput!

An input for adding an Account Association to a Course Template
addAchievementType : CourseTemplateMutationResponse!

Add Achievement Type to a Course Template

Argument Type Description
input CourseTemplateAddAchievementTypeInput!

The input type with Achievement Type details to be added to the Course Template
addCourseItems : CourseTemplateBulkResponse!

Adds Course Items, mapping a Stock Item to a Course Template

Argument Type Description
input [CourseItemCreateInput]!
addLmsContentTypeExternal : CourseTemplateAddLmsResourcesResponse!

Add LMS Content of type external to the Course Template.

Argument Type Description
input CourseTemplateAddLmsContentTypeExternalInput!
addLmsContentTypeResource : CourseTemplateAddLmsResourcesResponse!

Add LMS Content of type resource to the Course Template.

Argument Type Description
input CourseTemplateAddLmsContentTypeResourceInput!
addLmsContentTypeSeparator : CourseTemplateAddLmsResourcesResponse!

Add LMS Content of type separator to the Course Template.

Argument Type Description
input CourseTemplateAddLmsContentTypeSeparatorInput!
addPrivatePrices : CourseTemplatePriceMutationResponse!

Adds private prices to Course Templates

Argument Type Description
input [CourseAddPrivatePriceInput]!
addPublicPrices : CourseTemplatePriceMutationResponse!

Adds public prices to Course Templates

Argument Type Description
input [CourseAddPublicPriceInput]!
addRequiredResource : CourseTemplateMutationResponse!

Add a Required Resource to a Course Template

Argument Type Description
input CourseTemplateResourceRequirementCreateInput!

The Resource Requirement to add
addRequiredStaff : CourseTemplateMutationResponse!

Add a Required Staff to a Course Template

Argument Type Description
input CourseTemplateStaffRequirementCreateInput!

The Staff Requirement to add
addSessionTemplate : SessionTemplateResponse!

Adds a new Session Template to a Course Template

Argument Type Description
input SessionTemplateCreateInput!
addStaffExceptions : CourseTemplateBulkResponse!

Adds personnel that is always allowed to staff Events for this Course template

Argument Type Description
input [StaffExceptionsAddInput]!
addTags : CourseTemplateTagMutationResponse!

Add Learning Tags to a Course Template

Argument Type Description
input CourseTemplateAddTagsInput!

An input for adding Learning Tags to a Course Template
create : CourseTemplateCreateResponse!

Creates a new Course Template

Argument Type Description
input CourseTemplateCreateInput!
delete : CourseTemplateMutationResponse!

Delete a Course Template

Argument Type Description
courseTemplateId ID!

The ID of the Course Template to be deleted
deleteAllRequiredResources : CourseTemplateMutationResponse!

Delete all existing Required Resources from this Course Template

Argument Type Description
input CourseTemplateDeleteAllResourceRequirementsInput!
deleteAllRequiredStaff : CourseTemplateMutationResponse!

Delete all existing Required Staff from this Course Template

Argument Type Description
input CourseTemplateDeleteAllStaffRequirementsInput!
deleteCourseItems : CourseTemplateBulkResponse!

Deletes Course Item mappings

Argument Type Description
input [CourseItemDeleteInput]!
deleteLmsContent : CourseTemplateMutationResponse!

Deletes LMS Content records by their IDs.

Argument Type Description
input CourseTemplateDeleteLmsResourcesInput!
deletePrices : CourseTemplatePriceMutationResponse!

Deletes Course Template prices

Argument Type Description
input [CourseDeletePriceInput]!
deleteRequiredResource : CourseTemplateMutationResponse!

Delete an existing Required Resource on a Course Template

Argument Type Description
input CourseTemplateResourceRequirementDeleteInput!

The input specifying the Required Resource to be deleted
deleteRequiredStaff : CourseTemplateMutationResponse!

Delete an existing Required Staff on a Course Template

Argument Type Description
input CourseTemplateStaffRequirementDeleteInput!

The input specifying the Required Staff to be deleted
deleteSessionTemplate : CourseTemplateResponse!

Deletes a Session Template from a Course Template

Argument Type Description
input SessionTemplateDeleteInput!
duplicate : CourseTemplateCreateResponse!

Creates a Course Template which is a duplicate of the specified Course Template

Argument Type Description
courseTemplateId ID!

The ID of the Course Template being duplicated
input CourseTemplateDuplicateInput!

The input type with the new values for the duplicated Course Template
editAchievementType : CourseTemplateMutationResponse!

Edit Achievement Type on a Course Template

Argument Type Description
input CourseTemplateEditAchievementTypeInput!

The input type with Achievement Type details to edit
editPassingRules : CourseTemplateMutationResponse!

Edit Passing Rules on a Course Template

Argument Type Description
courseTemplateId ID!

ID reference of a Course Template
input CourseTemplateEditPassingRulesInput!

Details of Passing Rules attributes to be updated
generateSessionTemplates : CourseTemplateResponse!

Creates Session Templates using the defined Schedule on a Course Template

Argument Type Description
input CourseTemplateGenerateSessionsInput!
removeAccountAssociation : CourseTemplateMutationResponse!

Remove an Account Association from a Course Template

Argument Type Description
input CourseTemplateRemoveAccountAssociationInput!

An input for removing an Account Association from a Course Template
removeAchievementType : CourseTemplateMutationResponse!

Remove Achievement Type from a Course Template

Argument Type Description
input CourseTemplateRemoveAchievementTypeInput!

The input type with Achievement Type details to be removed from a Course Template
removeStaffExceptions : CourseTemplateBulkResponse!

Removes personnel that is always allowed to staff Events for this Course template. Returns the Course Templates affected by this mutation.

Argument Type Description
input [StaffExceptionsRemoveInput]!
removeTags : CourseTemplateTagMutationResponse!

Remove Learning Tags from a Course Template

Argument Type Description
input CourseTemplateRemoveTagsInput!

An input for removing Learning Tags from a Course Template
setBlendedSchedule : CourseTemplateSetScheduleResponse!

Sets the schedule for the blended learning mode of Events generated from this Course Template

Argument Type Description
input CourseTemplateSetBlendedScheduleInput!
setClassroomSchedule : CourseTemplateSetScheduleResponse!

Sets the schedule for the classroom learning mode of Events generated from this Course Template

Argument Type Description
input CourseTemplateSetClassroomScheduleInput!
setCourseTemplateLmsContentOptional : CourseTemplateLmsContentResponse!

Marks some LMS content for this Course Template as optional, i.e. not required to pass.

Argument Type Description
input CourseTemplateLmsContentInput!
setImage : CourseTemplateSetImageResponse!

Associates an image stored in the DMS to the Course Template.

Argument Type Description
input CourseTemplateSetImageInput!
setLmsSchedule : CourseTemplateSetScheduleResponse!

Sets the schedule for the LMS learning mode of Events generated from this Course Template

Argument Type Description
input CourseTemplateSetLmsScheduleInput!
setPointOfSaleFields : CourseTemplateMutationResponse!

Associates Point of Sale fields to this Course Template to capture specific information when this Course is being sold.

Argument Type Description
input CourseTemplatePointOfSalesFieldsInput!
setTags : CourseTemplateTagMutationResponse!

Set Learning Tags on a Course Template. Will overwrite any existing Learning Tags on this Course Template.

Argument Type Description
input CourseTemplateSetTagsInput!

An input for setting Learning Tags on a Course Template
update : CourseTemplateUpdateResponse!

Updates an existing Course Template

Argument Type Description
courseTemplateId ID!
input CourseTemplateUpdateInput!
updateCourseItems : CourseTemplateBulkResponse!

Updates Course Item mappings

Argument Type Description
input [CourseItemUpdateInput]!
updateLmsContentTypeExternal : CourseTemplateUpdateLmsResourcesResponse!

Update LMS Content of type external.

Argument Type Description
input CourseTemplateUpdateLmsContentTypeExternalInput!
updatePrices : CourseTemplatePriceMutationResponse!

Updates Course Template prices

Argument Type Description
input [CourseUpdatePriceInput]!
updateRequiredResource : CourseTemplateMutationResponse!

Update an existing Required Resource on a Course Template

Argument Type Description
input CourseTemplateResourceRequirementUpdateInput!

The input values to be updates on the Required Resource
updateRequiredStaff : CourseTemplateMutationResponse!

Update an existing Required Staff on a Course Template

Argument Type Description
input CourseTemplateStaffRequirementUpdateInput!

The input values to be updated on the Required Staff
updateSessionTemplate : SessionTemplateResponse!

Updates an existing Session Template on a Course Template

Argument Type Description
input SessionTemplateUpdateInput!
upsertByExternalId : CourseTemplateMutationResponse!

Updates a Course Template identified by an External ID. If no Course Template has the External ID, one is created and assigned it.

Argument Type Description
input CourseTemplateUpsertByExternalIdInput!

The External ID and the values to set on the existing or new Course Template.
Back to top

CourseTemplatePassingRules

Defines the rules for what qualifies as passing on a Course Template

blended : CourseTemplatePassingRulesBlended!

Determines Passing Rules for Blended evenets derived from current Course Type.

classroom : CourseTemplatePassingRulesClassroom!

Determines Passing Rules for Classroom based evenets derived from current Course Type.

lms : CourseTemplatePassingRulesLms!

Determines Passing Rules for Self Paced (LMS) evenets derived from current Course Type.

Back to top

CourseTemplatePassingRulesBlended

Defines the rules for what qualifies as passing on a Course Template for Blended Events

achievementValidFrom : AchievementValidFromBlendedTypes

Defines when Achievement for Event is going to be valid from

allowedMissedSessions : Int

Number of missed sessions in an Event a Learner is allow to qualify as Passed upon Event completion

autoPassLearner : Boolean!

Determines if Learners are marked as Passed upon completion Event

requireRegistrationInvoiceToBePaid : Boolean!

Determines if Learners are required to have their Registration Invoice paid in full to be marked as Passed upon completion Event

Back to top

CourseTemplatePassingRulesClassroom

Defines the rules for what qualifies as passing on a Course Template for Classroom Events

achievementValidFrom : AchievementValidFromClassroomTypes

Defines when Achievement for Event is going to be valid from

allowedMissedSessions : Int

Number of missed sessions in an Event a Learner is allow to qualify as Passed upon Event completion

autoPassLearner : Boolean!

Determines if Learners are marked as Passed upon completion Event

requireRegistrationInvoiceToBePaid : Boolean!

Determines if Learners are required to have their Registration Invoice paid in full to be marked as Passed upon completion Event

Back to top

CourseTemplatePassingRulesLms

Defines the rules for what qualifies as passing on a Course Template for LMS Events

achievementValidFrom : AchievementValidFromLmsTypes

Defines when Achievement for Event is going to be valid from

autoPassLearner : Boolean!

Determines if Learners are marked as Passed upon completion Event

requireRegistrationInvoiceToBePaid : Boolean!

Determines if Learners are required to have their Registration Invoice paid in full to be marked as Passed upon completion Event

Back to top

CourseTemplatePointOfSalesFieldsInput

An input for Mapping Point Of Sale Fields to a Course Template

courseTemplateId : ID!

The ID of the Course Template being updated

pointOfSaleFieldIds : [ID]!

A list of Point of Sale Fields to map to this Course Template

Back to top

CourseTemplatePrice

Interface describing common attributes for Course Template prices

Related types: CourseTemplatePrivatePrice CourseTemplatePublicPrice

amount : Decimal!

Total value of Price

financialUnit : FinancialUnit!

Financial Unit of the Price (Currency or Token Type)

Argument Type Description
filters = [] [TrainingTokenTypeFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTypeFieldGraphOrder]
id : ID!

Id of the Course Template Price

region : Region!

The Region where the Price is used

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

CourseTemplatePriceField

An enumeration.

id
amount
regionId
currencyCode
Back to top

CourseTemplatePriceMutationResponse

A Response for mutating Course Template Prices

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

prices : [CourseTemplatePrice!]!

The Prices that were mutated

Back to top

CourseTemplatePrivatePrice

A private price for a Course Template

Related types: CourseTemplatePrice FinancialAmount

amount : Decimal!

Total value of Price

financialUnit : FinancialUnit!

Financial Unit of the Price (Currency or Token Type)

Argument Type Description
filters = [] [TrainingTokenTypeFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTypeFieldGraphOrder]
id : ID!

Id of the Course Template Price

region : Region!

The Region where the Price is used

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

CourseTemplatePrivatePriceConnection

A connection containing page information and edges for CourseTemplatePrivatePrice

edges : [CourseTemplatePrivatePriceEdge!]!

The list of CourseTemplatePrivatePrice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseTemplatePrivatePriceEdge

Contains cursor and node information for type CourseTemplatePrivatePrice

cursor : String!

A string that can be used for cursor-based pagination

node : CourseTemplatePrivatePrice!

The CourseTemplatePrivatePrice node.

Back to top

CourseTemplatePrivatePriceFieldGraphFilter

Filter that can be applied to limit which CourseTemplatePrivatePrice nodes are returned

field : CourseTemplatePriceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseTemplatePrivatePriceFieldGraphOrder

Specifies the order in which CourseTemplatePrivatePrice nodes are returned via the Connection

field : CourseTemplatePriceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseTemplatePublicPrice

A public price for a Course Template

Related types: CourseTemplatePrice FinancialAmount

amount : Decimal!

Total value of Price

financialUnit : FinancialUnit!

Financial Unit of the Price (Currency or Token Type)

Argument Type Description
filters = [] [TrainingTokenTypeFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTypeFieldGraphOrder]
id : ID!

Id of the Course Template Price

priceLevel : PriceLevel

Price Level of the price

Argument Type Description
filters = [] [PriceLevelFieldGraphFilter]
order = "__EMPTY__" PriceLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PriceLevelFieldGraphOrder]
region : Region!

The Region where the Price is used

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

CourseTemplatePublicPriceConnection

A connection containing page information and edges for CourseTemplatePublicPrice

edges : [CourseTemplatePublicPriceEdge!]!

The list of CourseTemplatePublicPrice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CourseTemplatePublicPriceEdge

Contains cursor and node information for type CourseTemplatePublicPrice

cursor : String!

A string that can be used for cursor-based pagination

node : CourseTemplatePublicPrice!

The CourseTemplatePublicPrice node.

Back to top

CourseTemplatePublicPriceFieldGraphFilter

Filter that can be applied to limit which CourseTemplatePublicPrice nodes are returned

field : CourseTemplatePriceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseTemplatePublicPriceFieldGraphOrder

Specifies the order in which CourseTemplatePublicPrice nodes are returned via the Connection

field : CourseTemplatePriceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseTemplateRemoveAccountAssociationInput

An Input to allow a user to remove an Account Association from a Course Template

accountAssociationId : ID!

The Account Association to remove

courseTemplateId : ID!

The Course Template to remove the Account Association from

Back to top

CourseTemplateRemoveAchievementTypeInput

An Input for removing Achievement Type from a Course Template

courseTemplateAchievementTypeId : ID!
Back to top

CourseTemplateRemoveTagsInput

An Input to allow a user to remove Learning Tags from a Course Template

courseTemplateId : ID!

The Course Template

learningTagIds : [ID]!

The Learning Tags to remove from the Course Template

Back to top

CourseTemplateResource

Labeled Link to a Resource for a Course Template

label : String!

Label of the Resource

Back to top

CourseTemplateResourceRequirement

A resource requirement specification for a course template

allSessions : Boolean!

If true, all event sessions require this resource.

id : ID!

ID of the resource requirement

quantity : Int!

The quantity of resources required

resourceType : ResourceType!

The resource type required

Argument Type Description
filters = [] [ResourceTypeFieldGraphFilter]
order = "__EMPTY__" ResourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceTypeFieldGraphOrder]
sessionTemplates : [SessionTemplate!]!

The session_templates that require this resource

Argument Type Description
filters = [] [SessionTemplateFieldGraphFilter]
order = "__EMPTY__" SessionTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionTemplateFieldGraphOrder]
Back to top

CourseTemplateResourceRequirementCreateInput

An Input for creating a Resource Requirement on a Course Template

courseTemplateId : String!

The ID of Course Template

resourceTypeId : String!

The ID of the Resource Type required

quantity : Int

The number of Resources required, defaults to 1

sessionTemplateIds : [String]

Optional list of Session Template IDs to assign required Resources

Back to top

CourseTemplateResourceRequirementDeleteInput

An Input for deleting a Resource Requirement from a Course Template

requiredResourceId : String!

The ID of the Resource Requirement

Back to top

CourseTemplateResourceRequirementField

Fields for filtering and ordering Course Template Resource Requirements

id
Back to top

CourseTemplateResourceRequirementFieldGraphFilter

Filter that can be applied to limit which CourseTemplateResourceRequirement nodes are returned

field : CourseTemplateResourceRequirementField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseTemplateResourceRequirementFieldGraphOrder

Specifies the order in which CourseTemplateResourceRequirement nodes are returned via the Connection

field : CourseTemplateResourceRequirementField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseTemplateResourceRequirementUpdateInput

An Input for editing a Resource Requirement on a Course Template

requiredResourceId : String!

The ID of the Resource Requirement

resourceTypeId : String

The ID of the new Resource Type

quantity : Int

The new number of Resources required

sessionTemplateIds : [String]

Optional list of new Session Template IDs to assign required Resources

Back to top

CourseTemplateResponse

A Response from mutating a CourseTemplate

Related types: MutationResponse

courseTemplate : CourseTemplate

The CourseTemplate that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateSetBlendedScheduleInput

An input for setting the LMS Schedule associated with a Course Template

courseTemplateId : ID!

The ID of the Course Template being updated

schedule : BlendedScheduleInput!

The LMS schedule to replace the one on the Course Template

Back to top

CourseTemplateSetClassroomScheduleInput

An input for setting the Classroom Schedule associated with a Course Template

courseTemplateId : ID!

The ID of the Course Template being updated

schedule : ClassroomScheduleInput!

The classroom schedule to replace the one on the Course Template

Back to top

CourseTemplateSetImageInput

An Input for setting the image on a Course Template

courseTemplateId : ID!

The ID of the Course Template being updated

documentId : ID!
Back to top

CourseTemplateSetImageResponse

A Response for a CourseTemplate SetImage Mutation

Related types: MutationResponse

courseTemplate : CourseTemplate

The CourseTemplate that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateSetLmsScheduleInput

An input for setting the LMS Schedule associated with a Course Template

courseTemplateId : ID!

The ID of the Course Template being updated

schedule : LmsScheduleInput!

The LMS schedule to replace the one on the Course Template

Back to top

CourseTemplateSetScheduleResponse

A Response for a CourseTemplate SetSchedule Mutation

Related types: MutationResponse

courseTemplate : CourseTemplate

The CourseTemplate that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateSetTagsInput

An Input to allow a user to set Learning Tags on a Course Template

courseTemplateId : ID!

The Course Template

learningTagIds : [ID]!

The Learning Tags to set on the Course Template

Back to top

CourseTemplateStaffRequirement

A staff requirement specification for a course template

achievementTypes : [AchievementType!]!

The achievement types required for this staff requirement

Argument Type Description
filters = [] [AchievementTypeFieldGraphFilter]
order = "__EMPTY__" AchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementTypeFieldGraphOrder]
allSessions : Boolean!

If true, all event sessions require this staff.

id : ID!

ID of the staff requirement

quantity : Int!

The quantity of staff required

sessionTemplates : [SessionTemplate!]!

The session_templates that require this staff

Argument Type Description
filters = [] [SessionTemplateFieldGraphFilter]
order = "__EMPTY__" SessionTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionTemplateFieldGraphOrder]
staffRole : StaffRole!

The staff role required

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
Back to top

CourseTemplateStaffRequirementCreateInput

An Input for creating a Staff Requirement on a Course Template

courseTemplateId : ID!

The ID of Course Template

staffRoleId : ID!

The ID of the Staff Role required

quantity : Int

The number of Staff required, defaults to 1

sessionTemplateIds : [ID]

Optional list of Session Template IDs to assign required Staff

requiredAchievementTypeIds : [ID]

Optional list of Achievement Type IDs required for staff in this Staff Requirement

Back to top

CourseTemplateStaffRequirementDeleteInput

An Input for deleting a Staff Requirement from a Course Template

requiredStaffId : ID!

The ID of the Staff Requirement

Back to top

CourseTemplateStaffRequirementField

Fields for filtering and ordering Course Template Staff Requirements

id
Back to top

CourseTemplateStaffRequirementFieldGraphFilter

Filter that can be applied to limit which CourseTemplateStaffRequirement nodes are returned

field : CourseTemplateStaffRequirementField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CourseTemplateStaffRequirementFieldGraphOrder

Specifies the order in which CourseTemplateStaffRequirement nodes are returned via the Connection

field : CourseTemplateStaffRequirementField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CourseTemplateStaffRequirementUpdateInput

An Input for editing a Staff Requirement on a Course Template

requiredStaffId : ID!

The ID of the Staff Requirement

staffRoleId : ID

The ID of the new Staff Role

quantity : Int

The new number of Staff required

sessionTemplateIds : [ID]

Optional list of new Session Template IDs to assign required Staff

requiredAchievementTypeIds : [ID]

Optional list of Achievement Type IDs required for staff in this Staff Requirement

Back to top

CourseTemplateTagMutationResponse

A Response for a CourseTemplate Learning Tags Mutation

courseTemplate : CourseTemplate

The Course Template whose tags were updated.

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateUpdateInput

An input type for updating a Course Template

title : String

The title of the Course Template being updated (max 255 characters)

code : String

The code of the Course Template being updated (max 120 characters)

shortCode : String

The short code of the Course Template. Must be 3 characters or less

lifecycleState : CourseTemplateLifecycleState

The lifecycle state of the Course Template being updated

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the CourseTemplate to update

localeId : ID

The primary Locale of the Course Template - the language its own, untranslated content is written in

deliveryLocaleIds : [ID]

The Locales this Course Template can be delivered in. Separate from its translations

defaultDeliveryLocaleId : ID

The Locale the Course Template is delivered in by default. Must be one of deliveryLocaleIds

featuredInPortals : [ID]

The list of Weblink Portal ID's this Course Template is featured in

registrationOpensOffset : Int

Optional integer with the number of days before the start date when registration will be opened

lmsSummary : String

Optional Summary to describe the course, can be formatted as HTML text or plain text.

lmsResourcesText : String

Optional Summary to describe the course materials, can be formatted as HTML text or plain text.

relatedCoursesText : String

Optional Summary to describe related courses, can be formatted as HTML text or plain text.

approvedInstructors : [ID]

DEPRECATED (2026-04-16, replaced by addStaffExceptions) - Optional list of Contact IDs to assign as approved instructors for the Course

exceptionalStaffIds : [ID]

DEPRECATED (2026-04-16, replaced by addStaffExceptions) - Optional list of Contact IDs to set as the Staff Exceptions list for the Course

learningTagIds : [ID]

List of Learning Tag IDs this Course Template is part of

learningCategories : [ID]

Optional list of Learning Category IDs to set as Learning Categories for the Course

minPlaces : Int

Optional minimum booked places required for the Course

maxPlaces : Int

Optional maximum booked places available on the Course

targetFillRate : Int
cpe : Decimal

Optional amount of Continued Professional Education hours

showLevelOnPdf : Boolean

Whether to display the course level on the course PDF

purchaseRequiresReview : Boolean

Whether to require order review in WebLink

companyId : ID

The Course Template company for segregation purposes

levelId : ID

The Level for this Course Template

taskWorkflowIds : [ID]

Optional task workflows to attach to this template

taskWorkflowGroupIds : [ID]

Optional task workflows to attach to this template - DEPRECATED (replaced by taskWorkflowIds)

imageIds : [ID]

Optional DMS document image IDs to attach to this template

learningMode : LearningMode

Optional learning mode for this Course Template, either classroom, lms or blended

pricingBandId : ID

Optional pricing band to attach to the Course Template

eventTemplateId : ID

Optional event template to attach to the Course Template

courseText1 : String

Optional custom text field 1, default UI label is Course Summary

courseText2 : String

Optional custom text field 2, default UI label is Introduction

courseText3 : String

Optional custom text field 3, default UI label is Topics

courseText4 : String

Optional custom text field 4, default UI label is Course Benefits

courseText5 : String

Optional custom text field 5, default UI label is Prerequisites

courseText6 : String

Optional custom text field 6, default UI label is Teaching Method

courseText7 : String

Optional custom text field 7

courseText8 : String

Optional custom text field 8

courseText9 : String

Optional custom text field 9

courseText10 : String

Optional custom text field 10

courseText11 : String

Optional custom text field 11

courseText12 : String

Optional custom text field 12

courseText13 : String

Optional custom text field 13

courseText14 : String

Optional custom text field 14

feedbackSurveyId : ID

Optional feedback survey to attach to the course

feedbackSurveyRatingQuestionId : ID

The question on the survey to use as the feedback question

Back to top

CourseTemplateUpdateLmsContentTypeExternalInput

An Input to allow a user to add LMS Resources of type external to a Course Template

courseTemplateId : ID!

The Course Template

resourceId : ID!

The LMS Resource ID to update

resource : LmsResourceTypeExternalUpdateInput!

The LMS Resource data to update the content to

Back to top

CourseTemplateUpdateLmsResourcesResponse

A Response for a CourseTemplate UpdateLmsResources Mutation(s)

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

lmsResource : CourseTemplateLmsContent

The LMS Resource that was updated

Back to top

CourseTemplateUpdateResponse

A Response for CourseTemplate Update Mutation

Related types: MutationResponse

courseTemplate : CourseTemplate

The CourseTemplate that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CourseTemplateUpsertByExternalIdInput

An input for upserting a Course Template by External ID.

externalId : ExternalIdInput!

The External ID used to identify the Course Template to update. If no Course Template matches, this External ID is set on the created Course Template.

courseTemplate : CourseTemplateUpsertInput!

The values with which to update or create the Course Template.

Back to top

CourseTemplateUpsertInput

The values to set when upserting a Course Template by External ID. Prices and passing rules are not set here; use their dedicated mutations.

title : String!

The title of the Course Template (max 255 characters)

code : String!

The code of the Course Template (max 120 characters)

shortCode : String

The short code of the Course Template. Must be 3 characters or less

lifecycleState : CourseTemplateLifecycleState

The lifecycle state of the Course Template

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Course Template to set

localeId : ID

The Locale of the Course Template

featuredInPortals : [ID]

The list of Weblink Portal ID's this Course Template is featured in

registrationOpensOffset : Int

Optional integer with the number of days before the start date when registration will be opened

lmsSummary : String

Optional Summary to describe the course, can be formatted as HTML text or plain text.

lmsResourcesText : String

Optional Summary to describe the course materials, can be formatted as HTML text or plain text.

relatedCoursesText : String

Optional Summary to describe related courses, can be formatted as HTML text or plain text.

approvedInstructors : [ID]

DEPRECATED (2026-04-16, replaced by addStaffExceptions) - Optional list of Contact IDs to assign as approved instructors for the Course

exceptionalStaffIds : [ID]

DEPRECATED (2026-04-16, replaced by addStaffExceptions) - Optional list of Contact IDs to set as the Staff Exceptions list for the Course

learningTagIds : [ID]

List of Learning Tag IDs this Course Template is part of

learningCategories : [ID]

Optional list of Learning Category IDs to set as Learning Categories for the Course

minPlaces : Int

Optional minimum booked places required for the Course

maxPlaces : Int

Optional maximum booked places available on the Course

targetFillRate : Int

Optional target fill rate for the Course

cpe : Decimal

Optional amount of Continued Professional Education hours

showLevelOnPdf : Boolean

Whether to display the course level on the course PDF

purchaseRequiresReview : Boolean

Whether to require order review in WebLink

companyId : ID

The Course Template company for segregation purposes

levelId : ID

The Level for this Course Template

taskWorkflowGroupIds : [ID]

Optional task workflows to attach to this template - DEPRECATED (replaced by taskWorkflowIds)

taskWorkflowIds : [ID]

Optional task workflows to attach to this template

imageIds : [ID]

Optional DMS document image IDs to attach to this template

learningMode : LearningMode

Optional learning mode for this Course Template, either classroom, lms or blended

pricingBandId : ID

Optional pricing band to attach to the Course Template

eventTemplateId : ID

Optional event template ID to attach to the Course Template

courseText1 : String

Optional custom text field 1, default UI label is Course Summary

courseText2 : String

Optional custom text field 2, default UI label is Introduction

courseText3 : String

Optional custom text field 3, default UI label is Topics

courseText4 : String

Optional custom text field 4, default UI label is Course Benefits

courseText5 : String

Optional custom text field 5, default UI label is Prerequisites

courseText6 : String

Optional custom text field 6, default UI label is Teaching Method

courseText7 : String

Optional custom text field 7

courseText8 : String

Optional custom text field 8

courseText9 : String

Optional custom text field 9

courseText10 : String

Optional custom text field 10

courseText11 : String

Optional custom text field 11

courseText12 : String

Optional custom text field 12

courseText13 : String

Optional custom text field 13

courseText14 : String

Optional custom text field 14

feedbackSurveyId : ID

Optional feedback survey to attach to the course

feedbackSurveyRatingQuestionId : ID

The question on the survey to use as the feedback question

Back to top

CourseUpdatePriceInput

An input type for updating Course Template prices

coursePriceId : ID!

The Course Template price to update

amount : Decimal

The amount for the price in the specified Financial Unit

Back to top

CreateClientCredentialInput

An input for creating Client Credentials

name : String!

The name of the client credential

userId : String!

ID for the User the token will be generated on behalf of

description : String

The description of the client credential

Back to top

CreateClientCredentialResponse

A Response for creating a Client Credential

Related types: MutationResponse

clientCredential : ClientCredentials

The Client Credential that has been generated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CreateEventBookingInput

An Input for booking a Resource on an Event's Sessions

resourceId : ID!

The ID of the Resource being booked

eventId : ID!

The ID of the Event on whose Sessions the Resource will be booked on. It must be a classroom or blended event with at least 1 session

details : String

Optional notes to store with the booking

requiredSessionsOnly : Boolean

If false (default), the Resource will be booked on all the Sessions of the Event. If true, the Resource will be booked only on the Event Sessions that require the Resource's type

Back to top

CreateLmsResourceInput

An input to add an LMS Resource to an Event

eventId : ID!

The ID of the Event to add LMS Resource to.

resourceType : ContentType!

The LMS Resource type.

displayName : String

A name for the LMS Resource.

htmlDescription : String

A description for the LMS Resource.

ordering : Int

The LMS Resource's position in the list of LMS Resource.

maxCompletions : Int

The maximum number of attempts on this piece of LMS Resource.

externalActivityURL : String

The URL for external activity LMS Resource.

isRequired : Boolean

Is the LMS Resource required to complete the Event.

documentId : ID

The ID of the DMS Document to add as LMS Resource.

isPublic : Boolean

Public LMS Resources can be displayed to users outside of an administrate portal in an embedded context. Defaults to false.

thumbnailDocumentId : ID

The ID of Image from DMS Documents that should be used as a thumbnail.

learningTags : [ID]

The list of LearningTag IDs to create this Event with.

customFieldValues : [CustomFieldValueInput]

The list of Custom Fields to create this LMS Resource with.

autoComplete : Boolean

Flag if the resource will be auto completed after a learner has accessed it

Back to top

CreateSendingEmailAddressInput

An Input for creating a sending email address

name : String!

The name appearing as the sender for emails sent from this sending address

address : String!

The email address any emails will be sent from

Back to top

CreateSessionBookingInput

An Input for booking a Resource on en Event's Session

resourceId : ID!

The ID of the Resource being booked

sessionId : ID!

The ID of the Session to book the Resource on

start : TimeZonedDateTime

The booking start time. If not provided, defaults to the session start time.

end : TimeZonedDateTime

The booking end time. If not provided, defaults to the session end time.

details : String

Optional notes to store with the booking.

Back to top

CreditNote

A Credit Note containing information about an order to be refunded

Related types: SalesDocument Node

account : Account

The Account linked to this Sales Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
accountName : String

The name of the account

allocationStatus : CreditNoteAllocationStatus!

Allocation status for account finance statements.

allocations : [InvoiceAllocation!]!

A list describing how this Credit Note is allocated to each of the Invoices it covers

billingAddress : PostalAddress

The Postal Billing Address of the Credit Note

comments : String

The comments attributed to this Credit Note

company : Company

The Company that issued this Sales Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
companyRegistrationNumber : String

The company registration number on the Credit Note

contactDepartment : String

The Department of the Contact associated with the Credit Note

contactJobTitle : String

The Job Title of the Contact associated with the Credit Note

contactName : String

The Name of the Contact associated with the Credit Note

createdAt : TimeZonedDateTime!

The creation date of the Credit Note

creditDate : Date!

The date that this Credit Note was issued

creditNoteDate : LocalDateTime

The date the Credit Note issued

currency : Currency

The Currency this Sales Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
discount : Discount

The Discount applied to this Sales Document

discountAmount : Decimal!

The total amount of discount applied to this Sales Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
finalisedAt : TimeZonedDateTime

The date at which the Credit Note was finalised

id : ID!

The ID of this Sales Document

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : CreditNoteLifecycleState!

The lifecycle state of this Credit Note

lines : [CreditNoteLine!]!

A list of lines containing the information about the ordered items

number : String!

The sequence number used to identify this Sales Document

otherReference : String

An alternative reference assigned to the Credit Note

purchaseOrderReference : String

The reference of the Purchase Order associated with the Credit Note

refunds : RefundConnection!

A record of Refunds made for this Credit Note

Argument Type Description
filters = [] [RefundFieldGraphFilter]
order = "__EMPTY__" RefundFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RefundFieldGraphOrder]
region : Region

The Region in which the Sales Document is located in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
subTotalAmount : Decimal!

The amount of this Sales Document excluding any Tax or Discount

taxNumber : String

The VAT reference number assigned to the Credit Note

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Sales Document

totalAmount : Decimal!

The total amount of this Sales Document including Tax and Discounts

totalRemaining : Decimal!

Amount of this Credit Note's credit available for refund or allocation to an Invoice

Back to top

CreditNoteAllocationStatus

An enumeration.

Unallocated
PartAllocated
Allocated
Back to top

CreditNoteConnection

A connection containing page information and edges for CreditNote

edges : [CreditNoteEdge!]!

The list of CreditNote edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CreditNoteCreateFromInvoiceInput

Input for creating a Credit Note from an Invoice.

invoiceId : ID!

The ID of the Invoice to credit

finalise : Boolean

Whether the Credit Note should be finalised immediately

Back to top

CreditNoteDeleteInput

The input type with the Credit Note to be deleted.

creditNoteId : ID!

The ID of the Credit Note to be deleted

Back to top

CreditNoteEdge

Contains cursor and node information for type CreditNote

cursor : String!

A string that can be used for cursor-based pagination

node : CreditNote!

The CreditNote node.

Back to top

CreditNoteFieldGraphFilter

Filter that can be applied to limit which CreditNote nodes are returned

field : CreditNoteTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CreditNoteFieldGraphOrder

Specifies the order in which CreditNote nodes are returned via the Connection

field : CreditNoteTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CreditNoteFinaliseInput

The input type with the Credit Note to be finalised"

creditNoteId : ID!

The ID of the Credit Note to be finalised

Back to top

CreditNoteLifecycleState

Denotes the lifecycle state of a Credit Note

Draft

The Credit Note is a draft and edits are allowed

Final

The Credit Note details have been finalised and only non-financial changes are allowed

Void

The Credit Note has been cancelled and is no longer valid

Back to top

CreditNoteLine

A line item of a Credit Note

description : String

Text which describes what was sold

discount : Discount

The discount applied to each unit

extendedAmount : Decimal!

The amount for all units sold, inclusive of tax

financialAccount : FinancialAccount!

Which account in the Chart of Accounts that line item financial transaction is recorded in

giftVoucher : GiftVoucher

The gift voucher transaction source linked to this line.

id : ID!

The ID of the Invoice

isDiscountable : Boolean!

Whether this line should have invoice discounts applied.

isTaxable : Boolean!

Whether this line should have tax applied.

itemPrice : StockItemPrice

The selected item price used to create this line.

linkedSellable : InterestItem

The Event or Learning Path that is optionally linked to the line for grouping.

quantity : Int!

The number of units which were sold

registerable : Registerable

The Learner or Learning Path Learner associated with this Line Item

Argument Type Description
filters = [] [RegisterableFieldGraphFilter]
order = "__EMPTY__" RegisterableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegisterableFieldGraphOrder]
revenueType : String

The IHT revenue type linked to this line.

sellable : InterestItem

The Interest Item this line represents.

serviceDate : Date

The date of service for the line.

tag : EventTag

The legacy event tag linked to this line.

taxAmount : Decimal!

The amount of tax charged for each unit

taxType : TaxType

The type of tax charged on the line item

tokenTransaction : TrainingTokenTransaction

The token transaction linked to this line.

tokenType : TrainingTokenType

The token type linked to this line.

trainingPassTypeOption : TrainingPassTypeOption

The training pass type option linked to this line.

unitAmount : Decimal!

The price charged for each unit after discount has been applied

value : Decimal!

The original price for each unit without discount or tax

Deprecated fields (1)
linkedEvent : Event

The Event that is optionally linked to the line item

Removal date: TBD.

Replaced by linkedSellable

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
Back to top

CreditNoteLineInput

Input for replacing the draft Credit Note lines.

id : ID
description : String
quantity : Int
value : Decimal
financialAccountId : ID
taxTypeId : ID
isTaxable : Boolean
isDiscountable : Boolean
serviceDate : Date
sellableId : ID
linkedSellableId : ID
registrationEntryId : ID
itemPriceId : ID
tagId : ID
revenueType : String
tokenTransactionId : ID
tokenTypeId : ID
giftVoucherId : ID
trainingPassTypeOptionId : ID
Back to top

CreditNoteMutationReponse

A Response for mutating a Credit Note

Related types: MutationResponse

creditNote : CreditNote

The Credit Note mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CreditNoteMutations

Mutations for Credit Notes

createFromInvoice : CreditNoteMutationReponse!

Create a Credit Note from an existing Invoice.

Argument Type Description
input CreditNoteCreateFromInvoiceInput!
createRefund : CreditNoteRefundMutationResponse!

Create a Refund against a Credit Note

Argument Type Description
input CreditNoteRefundInput!

The input type with the Credit Note to be refunded
delete : CreditNoteMutationReponse!

Delete a draft Credit Note.

Argument Type Description
input CreditNoteDeleteInput!
deleteRefund : CreditNoteRefundMutationResponse!

Delete a Refund against a Credit Note

Argument Type Description
input CreditNoteRefundDeleteInput!
finalise : CreditNoteMutationReponse!

Mark a Credit Note as final

Argument Type Description
input CreditNoteFinaliseInput!

The input type with the Credit Note to be finalised
refundGiftVoucher : CreditNoteRefundMutationResponse!

Create a Refund for a Gift Voucher against a Credit Note

Argument Type Description
input CreditNoteRefundGiftVoucherInput!

The input type with the Credit Note of the Gift Voucher that will be refunded
update : CreditNoteMutationReponse!

Update a Credit Note

Argument Type Description
input CreditNoteUpdateInput!

The input type with the ID of the Credit Note to be updated and the details to update
updateRefund : CreditNoteRefundMutationResponse!

Update a Refund against a Credit Note

Argument Type Description
input CreditNoteRefundUpdateInput!
Deprecated fields (1)
refund : CreditNoteRefundMutationResponse!

Create a Refund against a Credit Note

Removal date: TBD.

Replaced by createRefund

Argument Type Description
input CreditNoteRefundInput!

The input type with the Credit Note to be refunded
Back to top

CreditNoteRefundDeleteInput

The input type for deleting a Credit Note Refund

refundId : ID!

The ID of the Refund to be deleted

Back to top

CreditNoteRefundGiftVoucherInput

The input type with the Credit Note to be refunded to a Gift Voucher

creditNoteId : ID!

The ID of the Credit Note to be refunded

giftVoucherConfigurationId : ID!

The ID of the Gift Voucher Configuration to be used to create the Gift Voucher refund

giftVoucherRecipient : GiftVoucherRecipientDetailsInput!

Details of the recipient of the GiftVoucher refund

amount : Decimal!

The amount to be refunded

emailTemplateId : ID!

The ID of the Email Template to be used to send the refunded Gift Voucher

sendingAddressId : ID!

The ID of the Email address the refund email will be sent from

paymentMethodReference : String

A reference to be stored with the refund payment

processedOn : Date

The date the Refund was processed

clearedOn : Date

The date the Refund was cleared

notes : String

Optional additional information about the Refund

Back to top

CreditNoteRefundInput

The input type with the Credit Note to be refunded

creditNoteId : ID!

The ID of the Credit Note to be refunded

amount : Decimal!

The amount to be refunded

paymentMethod : PaymentMethodInput!

The Payment Method used

financialAccountId : ID!

The Financial Account where the Refund funds were deposited

processedOn : Date

The date the Refund was processed

clearedOn : Date

The date the Refund was cleared

notes : String

Optional additional information about the Refund

Back to top

CreditNoteRefundMutationResponse

A Response from Refunding a Credit Note

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

refund : Refund

The Refund made against the Credit Note

Back to top

CreditNoteRefundUpdateInput

The input type for updating a Credit Note Refund

refundId : ID!

The ID of the Refund to be updated

creditNoteId : ID

The ID of the Credit Note to allocate the Refund to

amount : Decimal

The updated amount to be refunded

paymentMethod : UpdatePaymentMethodInput

The updated Payment Method used

financialAccountId : ID

The updated Financial Account where the Refund funds were deposited

processedOn : Date

The updated date the Refund was processed

clearedOn : Date

The updated date the Refund was cleared

notes : String

Updated additional information about the Refund

Back to top

CreditNoteTypeField

Fields for filtering and sorting Credit Notes

accountId
companyId
createdAt
creditDate
currencyCode
regionId
id
finalisedAt
number
lifecycleState
totalRemaining
Back to top

CreditNoteUpdateInput

The input for updating a Credit Note

creditNoteId : ID!

The ID of the Credit Note to be updated

number : String

The sequence number used to identify this Credit Note

accountId : ID

The ID of the Account the Credit Note is assigned to

purchaseOrderReference : String

The reference of the Purchase Order associated with the Credit Note

creditNoteDate : LocalDateTime

The date the Credit Note was issued

taxNumber : String

The VAT reference number assigned to the Credit Note

discountId : ID

The ID of any Discount that has been applied to the Credit Note

contactName : String

The Name of the Contact associated with the Credit Note

contactJobTitle : String

The Job Title of the Contact associated with the Credit Note

contactDepartment : String

The Department of the Contact associated with the Credit Note

billingAddress : PostalAddressInput

The Postal Billing Address of the Credit Note

comments : String

The comments attributed to the Credit Note

otherReference : String

An alternative reference assigned to the Credit Note

accountName : String

An alternative name given to the Account the Credit Note is assigned to

lines : [CreditNoteLineInput]

Replacement draft Credit Note lines

companyRegistrationNumber : String

The company registration number on the Credit Note

Back to top

CreditTrainingPassInput

trainingPassId : ID!

The ID of the Training Pass for which to raise a Credit Note

finaliseCreditNote : Boolean

Whether the Credit Note will be automatically finalised

Back to top

Currency

A currency

Related types: FinancialUnit

code : String!

The short code for this unit of currency (ISO 4217) e.g. 'GBP', 'USD'

id : ID!

The ID for this Currency

isActive : Boolean!

The Currency active status

name : String!

Full name of currency (e.g. 'Pound Sterling')

symbol : String!

Currency symbol such as '£', '$', '€'

Back to top

CurrencyConnection

A connection containing page information and edges for Currency

edges : [CurrencyEdge!]!

The list of Currency edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CurrencyEdge

Contains cursor and node information for type Currency

cursor : String!

A string that can be used for cursor-based pagination

node : Currency!

The Currency node.

Back to top

CurrencyField

An enumeration.

code
name
symbol
isActive
Back to top

CurrencyFieldGraphFilter

Filter that can be applied to limit which Currency nodes are returned

field : CurrencyField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CurrencyFieldGraphOrder

Specifies the order in which Currency nodes are returned via the Connection

field : CurrencyField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CustomBusinessRuleExecutionLog

A record of one live evaluation of a Custom Business Rule — metadata and metrics only (no request/response bodies).

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the execution log record

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

CustomField

A key value pair holding a user defined field

key : String!

Key of the field

value : String

Value of the field

Back to top

CustomFieldDefinition

A defined Custom Field

Related types: StandardCustomFieldDefinition PointOfSaleFieldDefinition

canEdit : Boolean!

Whether the custom field can be edited by the current user

definitionLocator : String

Human readable name of the Custom Field

description : String

A description explaining the use of the Custom Field

includeInSearch : Boolean!

Whether values of this custom field are included in global search

isRequired : Boolean!

Whether the custom field is required

isRestricted : Boolean!

Whether the custom field is required

key : ID!

The identifier for this definition

label : String!

The label of the CustomFieldDefinition

options : [Option!]

Choices to present for a Custom Field with choice options

permissionGrants : [CustomFieldDefinitionPermission!]!

Role permission grants on editing or viewing this custom field's data

roles : [ID!]!

User Roles which have permissions to view and edit the data in this field (empty means no restrictions)

type : CustomFieldType!

The type of value allowed for this Custom Field

Back to top

CustomFieldDefinitionCreateInput

An Input for creating a generic/multi-entity Custom Fields

definition : GenericCustomFieldDefinitionInput!

The CustomFieldDefinition input

entityTypes : [SupportsCustomField]

List of entities to associate with (i.e: [Account, Course])

Back to top

CustomFieldDefinitionCreateResponse

The Custom Field Definition that was created

customFieldDefinition : CustomFieldDefinition

The Custom Field Definition that was created

errors : [FieldError!]!

The errors returned by the mutation

genericCustomFieldDefinition : GenericCustomField

Generic Custom Field Definition that was created

Back to top

CustomFieldDefinitionField

An enumeration.

isStockField
isValidForCourseTemplate
isValidForPortal
Back to top

CustomFieldDefinitionFilter

field : CustomFieldDefinitionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

Back to top

CustomFieldDefinitionInput

An Input for creating a Custom Field

label : String!

The label which describes the contents of the Custom Field

type : CustomFieldType!

The format of the value that will be stored

isRequired : Boolean

Whether or not the Custom Field is required, defaults to False

description : String

A description explaining the use of the Custom Field

options : [String]

List of options for choice or multichoice Custom Fields

roles : [ID]

User Roles which have permissions to view and edit the data

definitionLocator : String

Human readable identifier for the Custom Field in this field (empty means no restrictions)

isTranslatable : Boolean

Whether or not the Custom Field's values can be translated, defaults to False

Back to top

CustomFieldDefinitionPermission

permission : String!

Whether this role has view only or full edit permissions

roleId : String!

The id of the role bound with this permission

Back to top

CustomFieldDefinitionUpdateInput

An Input for updating a Custom Field

definitionId : ID!

The identifier for the Custom Field Definition to update

entityTypes : [SupportsCustomField]

List of entities to associate with (i.e: [Account, Course])

label : String

The label which describes the contents of the Custom Field

isRequired : Boolean

Whether or not the Custom Field is required, defaults to False

isRestricted : Boolean

Whether or not the Custom Field is restricted, defaults to False

isTranslatable : Boolean

Whether or not the Custom Field's values can be translated; left unchanged when omitted

tooltip : String

A description explaining the use of the Custom Field

options : [String]

List of options for choice or multichoice Custom Fields

permissionGrants : [GenericCustomFieldPermissionTypeInput]

User Roles which have permissions to view and edit the data in this field (empty means no restrictions)

definitionLocator : String

Human readable identifier for the Custom Field

position : Int
includeInSearch : Boolean

Whether values are included in global search

Back to top

CustomFieldFilter

A Custom Field Filter

id : String!

The id of the Custom Field Filter

operation : CustomFieldFilterOperation!

CustomFieldFilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CustomFieldFilterInput

definitionKey : ID

The Key for the custom field

definitionLocator : String
isValidForPortal : ID
Back to top

CustomFieldFilterOperation

See https://getadministrate.com/developers/guides/graphql%20basics/filtering/ for details.

eq
ge
gt
like
le
lt
ne
isnull
notnull
wordlike
in
contains
notin
Back to top

CustomFieldFilterType

Types of Custom Field Filters that are supported

text
checkbox
multichoice
Back to top

CustomFieldFilterTypeMapping

A simple type that lists the valid mapping types between a Custom Field Filter Type and a Custom Field Type

type : String!

The type of the Custom Field Filter

validMappings : [String!]!

The Valid Custom Field types that can be mapped to the Custom Field Filter

Back to top

CustomFieldMatch

A custom field whose value matched the search query

definitionId : ID!

The identifier of the custom field definition

label : String!

The label of the custom field

sourceId : ID

The ID of the record the value belongs to, when it is not the record itself.

sourceKind : String

What the value belongs to when it is not the record itself: a session, a breakout group, a learner. Empty for the record's own fields.

value : String!

The stored value that matched, as text. Long values are cut to a window around the match and marked with an ellipsis.

Back to top

CustomFieldMatches

The custom fields that made one search result match

matches : [CustomFieldMatch!]!

The matching fields, in a stable order

nodeId : ID!

The ID of the matching record, as returned in the search results

Back to top

CustomFieldMutations

Mutations available for Custom Fields

addPointOfSaleFieldCourses : PointOfSaleFieldUpdateResponse!

Add Course Templates to a Point of Sale Field

Argument Type Description
input PointOfSaleFieldCourseInput!
archiveGlobalCustomDefinition : GlobalCustomFieldDefinitionRemoveResponse!

Archive an existing Custom Field Definition for a type

Argument Type Description
input GlobalCustomFieldDefinitionRemoveInput!
createGenericCustomFieldDefinition : CustomFieldDefinitionCreateResponse!

Creates a new GenericCustomFieldDefinition

Argument Type Description
input CustomFieldDefinitionCreateInput!
createGlobalCustomDefinition : CustomFieldDefinitionCreateResponse!

Creates a new CustomFieldDefinition which is available for all records of that type

Argument Type Description
input GlobalCustomFieldDefinitionCreateInput!
createPointOfSaleField : PointOfSaleFieldCreateResponse!

Create a Point of Sale Field

Argument Type Description
input PointOfSaleFieldCreateInput!
removeGlobalCustomDefinition : GlobalCustomFieldDefinitionRemoveResponse!

Remove an existing Custom Field Definition for a type

Argument Type Description
input GlobalCustomFieldDefinitionRemoveInput!
removePointOfSaleField : PointOfSaleFieldRemoveResponse!

Remove a Point of Sale Field

Argument Type Description
input PointOfSaleFieldRemoveInput!
removePointOfSaleFieldCourses : PointOfSaleFieldUpdateResponse!

Remove Course Templates from a Point of Sale Field

Argument Type Description
input PointOfSaleFieldCourseInput!
setFormTemplateFieldSearch : FormTemplateFieldSearchResponse!

Sets whether a form template field is included in global search. Super Users only; nothing else of the field changes.

Argument Type Description
input FormTemplateFieldSearchInput!
updateGenericCustomFieldDefinition : CustomFieldDefinitionCreateResponse!

Updates a GenericCustomFieldDefinition

Argument Type Description
input CustomFieldDefinitionUpdateInput!
updateGlobalCustomDefinition : GlobalCustomFieldDefinitionUpdateResponse!

Update an existing CustomFieldDefinition for a type

Argument Type Description
input GlobalCustomFieldDefinitionUpdateInput!
updatePointOfSaleField : PointOfSaleFieldUpdateResponse!

Update a Point of Sale Field

Argument Type Description
input PointOfSaleFieldUpdateInput!
Back to top

CustomFieldOrderingOption

Represents an option for ordering custom fields for customFieldDefinitions query.

field : String!

The name of the field to order by, 'label' is supported.

direction : String!

The direction of the order, either 'asc' for ascending or 'desc' for descending. Case-insensitive.

Back to top

CustomFieldTemplate

A set of CustomFieldDefinitions

Related types: ResourceType GlobalCustomFieldTemplate

customFieldDefinitions : [CustomFieldDefinition!]!

The list of CustomFieldDefinitions of the CustomFieldTemplate

name : String!

The name of the CustomFieldTemplate

Back to top

CustomFieldType

Custom Field type for display

string

Short unformatted text input, suitable for one line input field

text

Unformatted text input, suitable for multi-line input field

email

An email address

integer

A whole number, including sign if negative

number

A number with optional decimal point

url

A web address

country

The code of a country available in the options list

province
language

A language available in the options list

location

The ID of an active Location configured in the system

locations

A list of active Locations configured in the system

contact

The ID of an active Contact in the system

contacts

A list of active Contacts in the system. When storing a value use a pipe separated list of contact IDs.

date

A calendar day in the format yyyy-MM-dd

datetime

A local date and time in the format yyyy-MM-ddTHH:mm:ss

time

A local time in the format HH:mm:ss

checkbox

A true or false boolean

choice

Can pick a single option from a list

multichoice

Can pick multiple options from a list. When storing a value use a pipe separated list of values.

document

A reference to a document stored in the Document Management System (DMS)

html

Formatted text stored as HTML, suitable for display and manipulation in a WYSIWYG editor

Back to top

CustomFieldValue

A value stored for a Custom Field

definition : StandardCustomFieldDefinition!

The CustomFieldDefinition associated with the Custom Field Value

definitionKey : ID!

The identifier of the Custom Field Definition

definitionLocator : String

The human readable definition locator of the Custom Field Definition

mappedValue : String

Returns the related entity field value if this custom field is defined as a Mapped Attribute (currently only supported for Opportunities), or null otherwise

value : String

The value stored

Back to top

CustomFieldValueInput

An Input for a CustomFieldValue

definitionKey : ID!

The identifier for the CustomFieldDefinition of the CustomFieldValue being mutated

value : String

The new value of the CustomFieldValue. Defining this as null will set the value to null

Back to top

CustomPortalTerm

The input type with Custom Portal Term

title : String!

The title of the custom term

text : String!

The core text of the custom terms to which users must agree

languageCode : String

The two letter language code for the language the portal term is in e.g. "en"

order : Int

The order number controlling in which order terms will appear relative to other terms

Back to top

CustomProperty

The parent of a CustomField, CustomProperty is the property the CustomField holds the value for

key : ID!

The identifier of the Custom Property

name : String!

A short name for this Custom Property

type : Type!

A human readable label for display on a form control

Back to top

CustomTemplate

Custom template

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the CustomTemplate

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the CustomTemplate

type : String!

The type of the CustomTemplate

Back to top

CustomTemplateConnection

A connection containing page information and edges for CustomTemplate

edges : [CustomTemplateEdge!]!

The list of CustomTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

CustomTemplateEdge

Contains cursor and node information for type CustomTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : CustomTemplate!

The CustomTemplate node.

Back to top

CustomTemplateField

Fields for filtering and ordering CustomTemplates

id
name
type
Back to top

CustomTemplateFieldGraphFilter

Filter that can be applied to limit which CustomTemplate nodes are returned

field : CustomTemplateField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

CustomTemplateFieldGraphOrder

Specifies the order in which CustomTemplate nodes are returned via the Connection

field : CustomTemplateField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

CustomTranslation

A User interface string that has a custom translation set for display in certain locales

Related types: Node

createdAt : TimeZonedDateTime!

When this translation was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Custom Translation

key : String!

The key of the translation

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

locale : Locale!

The locale of the translation

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
product : CustomTranslationsProduct!

The Product that the translation applies to

updatedAt : TimeZonedDateTime!

When this translation was last updated

value : String!

The value of the translation

Back to top

CustomTranslationCreateInput

The Input type for a new Custom Translation

key : String!

The key of the string we wish to translate

value : String!

The translation to store

localeId : ID!

The locale id this translation applies to

product : CustomTranslationsProduct

The product this translation applies to

Back to top

CustomTranslationMutateResponse

A response from CustomTranslation Mutations

Related types: MutationResponse

customTranslations : [CustomTranslation!]

The created Custom Translations.

errors : [FieldError!]!

The errors returned by the mutation

Back to top

CustomTranslationMutations

Mutations for a Custom Translation

create : CustomTranslationMutateResponse!

Creates new custom translations so that the provided key can be translated to the provided value for the locale and product specified.

Argument Type Description
input [CustomTranslationCreateInput]!
Back to top

CustomTranslationsProduct

The product types that can be associated with the translation

all
Back to top

DataImport

An object containing information about a Data Import task

Related types: Node

createdAt : TimeZonedDateTime!

The time that the task was created

entity : String!

The entity type being imported (e.g., "Account", "Event")

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
failedRows : Int

The number of failed rows in the import task

failureDownloadUrl : String

The presigned download URL of the CSV containing failed operations from the task

id : ID!

The ID of the import request

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

mutation : String!

The mutation type being performed (e.g., "create", "update")

processedRows : Int

The number of rows processed in the import task

status : DataImportStatus!

The status of the task

successDownloadUrl : String

The presigned download URL of the CSV containing successful operations from the task

successfulRows : Int

The number of successfully processed rows in the import task

totalRows : Int

The total number of rows in the import

updatedAt : TimeZonedDateTime!

The time that the task was last updated

uploadUri : String!

The URI of the uploaded CSV provided by the User

user : User!

The User that initiated the task

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

DataImportColumn

A column in the import template for a data import

columnType : String!

The type of the column (e.g. "string", "int", "date")

description : String

The description for the column

dropdownOptions : [DataImportColumnDropdownOption!]

The valid options for the column

example : String

An example value for the column

isMultiSelect : Boolean!

Whether the column is a multi-select field

key : String!

The column key, matching the header row in the import template (e.g. "input/name")

label : String!

The human readable label for the column (e.g. "Name")

outputFormat : String

The output format for the column

required : Boolean!

Whether the column is required

validations : [DataImportColumnValidation!]

The validation rules for the column

Back to top

DataImportColumnDropdownOption

Represents a dropdown option for a column in the data import

alternativeMatches : [String!]

The alternative matches for the dropdown option

description : String

The description of the dropdown option

label : String!

The label of the dropdown option

type : String

The type of the dropdown option

value : String!

The value of the dropdown option

Back to top

DataImportColumnValidation

Represents a validation rule for a column in the data import

columnValues : [DataImportColumnValidationColumnValue!]

The column values to validate against for value-based validation rules (e.g. required_with_values, required_without_values, required_with_all_values, required_without_all_values)

columns : [String!]

The columns to validate against for column-cross validation rules (e.g. required_with, required_without, required_with_all, required_without_all)

errorMessage : String

The error message to display if the validation fails

regex : String

The regex pattern for the column

validate : String!

The validation rule for the column

Back to top

DataImportColumnValidationColumnValue

A column and the set of values that trigger a value-based validation rule

column : String!

The column whose values trigger the validation

values : [String!]!

The values that trigger the validation

Back to top

DataImportConnection

A connection containing page information and edges for DataImport

edges : [DataImportEdge!]!

The list of DataImport edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

DataImportCreateImportInput

Creates an import task from a S3 URI

uploadUri : String!
entity : String!
mutation : String!
Back to top

DataImportCreateResponse

The Input Type for the createImport mutation

Related types: MutationResponse

dataImport : DataImport

The created Data Import task information

errors : [FieldError!]!

The errors returned by the mutation

Back to top

DataImportEdge

Contains cursor and node information for type DataImport

cursor : String!

A string that can be used for cursor-based pagination

node : DataImport!

The DataImport node.

Back to top

DataImportField

Fields for filtering and ordering Data Imports

id
userId
status
createdAt
updatedAt
entity
mutation
processedRows
Back to top

DataImportFieldGraphFilter

Filter that can be applied to limit which DataImport nodes are returned

field : DataImportField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

DataImportFieldGraphOrder

Specifies the order in which DataImport nodes are returned via the Connection

field : DataImportField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

DataImportGenerateUploadUrlResponse

Response type for generating a pre-signed S3 upload URL for uploading a JSON import file

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

filename : String

The filename to use when uploading a JSON import file to the pre-signed S3 upload URL

formFields : String

The fields to include in the form data when uploading a JSON import file to the pre-signed S3 upload URL

postUrl : String

The pre-signed S3 upload URL for uploading a JSON import file

Back to top

DataImportGetColumnsResponse

Response type for fetching the columns for a data import entity/mutation

Related types: MutationResponse

columns : [DataImportColumn!]!

The columns for the import template of the specified entity and mutation

errors : [FieldError!]!

The errors returned by the mutation

Back to top

DataImportMutations

Data Import Mutations

createImport : DataImportCreateResponse!

Creates a new import from a JSON import URI

Argument Type Description
input DataImportCreateImportInput!
getColumns : DataImportGetColumnsResponse!

Returns the columns for the specified entity and mutation.

Argument Type Description
entity String!
mutation String!
requestUploadUrl : DataImportGenerateUploadUrlResponse!

Creates a pre-signed S3 upload URL for uploading a JSON import file

Back to top

DataImportStatus

An enumeration.

ready
checkpoint
processing
completed
failed
partial_success
Back to top

Date

A date as an ISO 8601 formatted string

Back to top

DateDelta

unit : DateDeltaUnit!

Time unit (days/months/years)

value : Int!

Time value

Back to top

DateDeltaInput

value : Int!
Back to top

DateDeltaUnit

An enumeration.

days
months
years
Back to top

Day

An enumeration.

monday
tuesday
wednesday
thursday
friday
saturday
sunday
Back to top

Decimal

A decimal refers generally to the notation of a number in the decimal system, which contains a decimal separator (for example 10.00 or 3.14159)

Back to top

DeleteCustomFieldFilterInput

The input type with the values used to delete a Custom Field Filter for a Portal

portalId : ID!

The ID of the Portal that the Custom Field Filter is linked to

customFieldFilterId : ID!

The ID of the Custom Field Filter to delete

Back to top

DeleteDiscussionCommentInput

An input for deleting a Discussion Comment

commentId : ID!

The ID of the Discussion Comment to be deleted

Back to top

DeleteInput

An Input for deleting a list of Events

eventIds : [ID]!

The list of Event IDs to delete

Back to top

DeleteLmsResourceInput

An input to delete an LMS Resource on an Event

resourceId : ID!

The ID of the LMS resource being deleted.

Back to top

DeleteLmsResourceResponse

A response for deleting an LMS Resource

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

lmsContentId : ID

The ID of the LMS Resource that was deleted

Back to top

DeleteMutationResponse

A Response for a mutation deleting a list of Events

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

events : [Event!]!

The Events that were deleted

Back to top

DeletePaymentAllocationsInput

The input for deleting Payment allocations

paymentId : ID!

The id of the Payment we wish to delete from its allocations

allocationIds : [ID]!

The list of allocation Ids we wish to delete

Back to top

DeprecatedCustomFieldMutations

Mutations available for Custom Fields

createGlobalDefinition : CustomFieldDefinition!

Creates a new CustomFieldDefinition which is available for all records of that type

Argument Type Description
input GlobalCustomFieldDefinitionCreateInput!
Back to top

DeprecatedOpportunityMutations

Mutations for Opportunities

Deprecated fields (1)
create : Opportunity!

Create a new Opportunity owned by you

Removal date: TBD.

Replaced by create in OpportunitiesMutations

Argument Type Description
name String!

The name given to the Opportunity
regionId String!

The ID of the Region in which the Opportunity is based
currency String

A 3-digit ISO code representing the currency used by the Opportunity
Back to top

DigitalTax

An association between a Country (and optional Province within that Country) and a Tax Type that will be applied to all digital product purchases by an Account with a billing address in that location

Related types: Node

country : Country!

The Country in which this Tax Type applies

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this mapping between a Tax Type and a Country/Province

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

province : Province

The Province within the Country in which this Tax Type applies.

taxType : TaxType!

The Tax Type associated with this Country/Province mapping

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
Back to top

DigitalTaxConnection

A connection containing page information and edges for DigitalTax

edges : [DigitalTaxEdge!]!

The list of DigitalTax edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

DigitalTaxCreateInput

The input for creating a Digital Tax which associates a Tax Type to a Country (and optional Province within the Country) so that digital product purchases will be taxed according to the purchasing Account billing address

taxTypeId : ID!

The ID of the Tax Type for this Digital Tax

countryId : ID!

The ID of the Country in which the Tax Type applies

provinceCode : String

The optional Province code in which to apply the Tax Type

Back to top

DigitalTaxDeleteInput

The input for deleting a Digital Tax

digitalTaxId : ID!

The ID of the Digital Tax to delete

Back to top

DigitalTaxEdge

Contains cursor and node information for type DigitalTax

cursor : String!

A string that can be used for cursor-based pagination

node : DigitalTax!

The DigitalTax node.

Back to top

DigitalTaxField

Fields for filtering and ordering DigitalTax

countryId
Back to top

DigitalTaxFieldGraphFilter

Filter that can be applied to limit which DigitalTax nodes are returned

field : DigitalTaxField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

DigitalTaxFieldGraphOrder

Specifies the order in which DigitalTax nodes are returned via the Connection

field : DigitalTaxField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

DigitalTaxMutationResponse

A Response for mutating Digital Taxes

Related types: MutationResponse

digitalTax : DigitalTax

The Tax Type that has been mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

Discount

Discount

Related types: Node

amount : Decimal!

The size of the Discount, with unit defined by the Discount type

companies : CompanyConnection

Companies that can use this Marketing Source

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Discount

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : DiscountLifecycleState!

The lifecycle state of the Discount

maxValue : Decimal

The maximum value of a discount a for a percentage type Discount

name : String!

The name of the Discount

type : DiscountType!

The method of calculation for the Discount

Back to top

DiscountConnection

A connection containing page information and edges for Discount

edges : [DiscountEdge!]!

The list of Discount edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

DiscountCreateInputTypes

An Input for creating a Discount

name : String!
rate : Decimal!
companyId : ID
Back to top

DiscountEdge

Contains cursor and node information for type Discount

cursor : String!

A string that can be used for cursor-based pagination

node : Discount!

The Discount node.

Back to top

DiscountFieldGraphFilter

Filter that can be applied to limit which Discount nodes are returned

field : DiscountTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

DiscountFieldGraphOrder

Specifies the order in which Discount nodes are returned via the Connection

field : DiscountTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

DiscountLifecycleState

Possible states for a Discount in its lifecycle

active
archived
Back to top

DiscountMutationResponse

A Response for mutating a Discount

Related types: MutationResponse

discount : Discount

The Discount Promotion Code that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

DiscountMutations

Mutations for Discount Promotion Codes

create : DiscountMutationResponse!

Creates a new Discount type

Argument Type Description
input DiscountCreateInputTypes!
Back to top

DiscountPromotionCode

Discount Promotion Code

Related types: Node

brand : Brand

The Brand the Discount Promotion Code is restricted to

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
codeValue : String!

The Discount Promotion Code value

courses : [ID!]

The list of Courses the Discount Promotion Code is restricted to

createdAt : TimeZonedDateTime

The date and time the Discount Promotion Code was created

deactivatedAt : TimeZonedDateTime

The date and time the Discount Promotion Code was created

discount : Discount

The Discount the Discount Promotion Code is being applied to

expiresAt : TimeZonedDateTime

The date and time the Discount Promotion Code expires at

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Discount Promotion Code

learningPaths : [ID!]

The list of Learning Paths the Discount Promotion Code is restricted to

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : DiscountPromotionCodeLifecycleState!

The lifecycle state of the Discount Promotion Code

name : String

The name of the Discount Promotion Code

quantityLimit : Int

The limit to the number of Line Items the Discount Promotion Code will affect the resultant Invoice

redemptionLimit : Int

The upper limit to the number of times the Discount Promotion Code can be redeemed

remainingRedemptions : Int

The number of times the Discount Promotion Code can be redeemed. Returning None means there are a limitless number of future redemptions.

totalRedeemed : Int!

The total number of times the Discount Promotion Code has been redeemed

validFrom : TimeZonedDateTime

The date and time the Discount Promotion Code is valid from

Back to top

DiscountPromotionCodeActivateInput

An Input for activating a Discount Promotion Code

discountPromotionCodeId : ID!
Back to top

DiscountPromotionCodeConnection

A connection containing page information and edges for DiscountPromotionCode

edges : [DiscountPromotionCodeEdge!]!

The list of DiscountPromotionCode edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

DiscountPromotionCodeCreateInputTypes

An Input for creating a Discount Promotion Code

code : String!
discountId : ID!
name : String
redemptionLimit : Int
quantityLimit : Int
courses : [ID]
learningPaths : [ID]
brandId : ID
Back to top

DiscountPromotionCodeDeactivateInput

An Input for deactivating a Discount Promotion Code

discountPromotionCodeId : ID!
Back to top

DiscountPromotionCodeEdge

Contains cursor and node information for type DiscountPromotionCode

cursor : String!

A string that can be used for cursor-based pagination

node : DiscountPromotionCode!

The DiscountPromotionCode node.

Back to top

DiscountPromotionCodeField

Fields for filtering and ordering Discount Promotion Codes

codeValue
id
lifecycleState
name
Back to top

DiscountPromotionCodeFieldGraphFilter

Filter that can be applied to limit which DiscountPromotionCode nodes are returned

field : DiscountPromotionCodeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

DiscountPromotionCodeFieldGraphOrder

Specifies the order in which DiscountPromotionCode nodes are returned via the Connection

field : DiscountPromotionCodeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

DiscountPromotionCodeLifecycleState

Possible states for a Discount Promotion Code in its lifecycle

active
expired
inactive
deactivated
redeemed
Back to top

DiscountPromotionCodeMutationResponse

A Response for mutating a Discount Promotion Code

Related types: MutationResponse

discountPromotionCode : DiscountPromotionCode

The Discount Promotion Code that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

DiscountPromotionCodeMutations

Mutations for Discount Promotion Codes

activate : DiscountPromotionCodeMutationResponse!

Activates a deactivated Promo Code so that it can be used again

Argument Type Description
input DiscountPromotionCodeActivateInput!
create : DiscountPromotionCodeMutationResponse!

Creates a new Promo Code that applies the specified discount, with options for limiting validity, number of redemptions and applicable products.

Argument Type Description
input DiscountPromotionCodeCreateInputTypes!
deactivate : DiscountPromotionCodeMutationResponse!

Deactivates an active Promo Code so that it can't be used

Argument Type Description
input DiscountPromotionCodeDeactivateInput!
update : DiscountPromotionCodeMutationResponse!

Updates an existing Promo Code, for example update its value or redemption limit.

Argument Type Description
input DiscountPromotionCodeUpdateInput!
Back to top

DiscountPromotionCodeUpdateInput

An Input for updating a Discount Promotion Code

discountPromotionCodeId : ID!
name : String
codeValue : String
redemptionLimit : Int
Back to top

DiscountType

Types of Discount

percentage
fixed
Back to top

DiscountTypeField

Fields for filtering and ordering Discounts

id
name
amount
type
maxValue
lifecycleState
companyId
Back to top

DiscussionTopicCommentAttempt

Related types: LmsAttempt Node

comment : ContentComment!

The Comment related to this DiscussionTopicCommentAttempt

Argument Type Description
filters = [] [ContentCommentFieldGraphFilter]
order = "__EMPTY__" ContentCommentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentCommentFieldGraphOrder]
completedAt : TimeZonedDateTime

The date and time when the Attempt was completed

completedByAdmin : Boolean!

Whether the Attempt has been manually completed by an Admin

content : LmsContent!

The Attempt's Content

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Attempt

isCompleted : Boolean!

Whether the Attempt has been completed

isPassed : Boolean!

Whether the Attempt has been passed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

updatedAt : TimeZonedDateTime

The date and time when the Attempt was updated

Back to top

DiscussionTopicContentResult

A summary of results for a Learner's Discussion Topic

Related types: LearnerContentResult

completedAttempts : Int!

The number of complete attempts the Learner has had on this EventContent

content : LmsContent!

The EventContent this result relates to

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
contentId : ID!

The ID to the piece of EventContent this result relates to

id : ID!

The ID of the LearnerContentResult

isRequired : Boolean

Whether the EventContent is required for the Learner to complete the Event

lastAccessed : TimeZonedDateTime

The date and time when the EventContent was last accessed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
lmsAttempts : LmsAttemptConnection!

The learner attempts on the EventContent

Argument Type Description
filters = [] [LmsAttemptFieldGraphFilter]
order = "__EMPTY__" LmsAttemptFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LmsAttemptFieldGraphOrder]
numberOfAttempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

progress : Decimal

The percentage complete the Learner has achieved on the EventContent

score : Decimal

The score the Learner has achieved on the EventContent

scorePercent : Decimal

The score percent the Learner has achieved on the EventContent

status : ContentResultStatus!

The current status of the EventContent

Deprecated fields (1)
attempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

Removal date: TBD.

Replaced by numberOfAttempts

Back to top

DisqualifiedStaffIssue

A Staff Contact booked on the Event is no longer qualified to staff it

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

contactId : ID!

The Contact ID of the disqualified Staff member

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

Document

DMS Document including current revision information

Related types: Node

categories : DocumentCategoryConnection!

The Document Categories this Document belongs to

Argument Type Description
filters = [] [DocumentCategoryFieldGraphFilter]
order = "__EMPTY__" DocumentCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentCategoryFieldGraphOrder]
company : Company

The Company that owns this Document Template, null for global templates

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
courseTemplates : CourseTemplateConnection!

Course Templates that listed this DMS Document

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
description : String!

The description of this Document

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
fileExtension : String

The file extension of the document

fileSize : Float

The size of file in megabytes

folder : Folder

The parent Folder of this Document

Argument Type Description
filters = [] [FolderFieldGraphFilter]
order = "__EMPTY__" FolderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FolderFieldGraphOrder]
id : ID!

The Document ID

isReport : Boolean!

If the document is a report

latest : DocumentRevision

The last revision of this Document

learningPaths : LearningPathConnection!

Learning Paths that listed this DMS Document

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

locale : Locale

The Locale of this Document's content, null for the instance default. On a translation this is the Locale it is a translation into.

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
mimeType : String

The mime type of the document

name : String!

The name used to identify the document when viewing in Administrate

tags : [String!]!

The keywords this Document is tagged with, in alphabetical order

translations : DocumentConnection!

The translations of this Document, one per Locale it has been translated into. Each translation is itself a Document carrying its own locale. Empty for a Document that is itself a translation.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
Back to top

DocumentCategory

A Document Category For Dynamic File Attachments

Related types: Node

createdAt : TimeZonedDateTime!

The Date and Time the Document Category was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Document Category

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Document Category

Back to top

DocumentCategoryConnection

A connection containing page information and edges for DocumentCategory

edges : [DocumentCategoryEdge!]!

The list of DocumentCategory edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

DocumentCategoryCreateInput

An Input for creating a Document Category

name : String!

The Document Category name

Back to top

DocumentCategoryDeleteInput

An Input for deleting a Document Category

documentCategoryId : ID!

The ID of Document Category to be deleted

Back to top

DocumentCategoryEdge

Contains cursor and node information for type DocumentCategory

cursor : String!

A string that can be used for cursor-based pagination

node : DocumentCategory!

The DocumentCategory node.

Back to top

DocumentCategoryField

Fields for filtering and ordering Document Categories

id
name
createdAt
deletedAt
Back to top

DocumentCategoryFieldGraphFilter

Filter that can be applied to limit which DocumentCategory nodes are returned

field : DocumentCategoryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

DocumentCategoryFieldGraphOrder

Specifies the order in which DocumentCategory nodes are returned via the Connection

field : DocumentCategoryField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

DocumentCategoryMutateResponse

A response from Document Category Mutations

Related types: MutationResponse

documentCategory : DocumentCategory

A Document Category that has been mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

DocumentCategoryMutations

Mutations for a Document Category

create : DocumentCategoryMutateResponse!

Creates a new Document Category

Argument Type Description
input DocumentCategoryCreateInput!
delete : DocumentCategoryMutateResponse!

Deletes an existing Document Category

Argument Type Description
input DocumentCategoryDeleteInput!
update : DocumentCategoryMutateResponse!

Updates an existing Document Category

Argument Type Description
input DocumentCategoryUpdateInput!
Back to top

DocumentCategoryUpdateInput

An Input for updating a Document Category

documentCategoryId : ID!

The ID of the Document Category being updated

name : String!

The new name for the Document Category

Back to top

DocumentConnection

A connection containing page information and edges for Document

edges : [DocumentEdge!]!

The list of Document edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

DocumentDownloadUrlResponse

The response from a Document download URL request

document : Document!

The Document related to the requested URL

url : String!

The timed download Document URL. This URL will expire after 60 seconds

Back to top

DocumentEdge

Contains cursor and node information for type Document

cursor : String!

A string that can be used for cursor-based pagination

node : Document!

The Document node.

Back to top

DocumentFieldGraphFilter

Filter that can be applied to limit which Document nodes are returned

field : DocumentTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

DocumentFieldGraphOrder

Specifies the order in which Document nodes are returned via the Connection

field : DocumentTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

DocumentMutations

Mutations for Documents

requestUpload : DocumentUploadRequestResponse!

Provides upload details that can be used to upload the document. This also returns the document that will be created after a successful upload

Argument Type Description
input DocumentUploadInput!
requestUploadRevision : DocumentUploadRequestResponse!

Returns the document and upload details that can be used to upload a revision to the document

Argument Type Description
input DocumentRevisionUploadInput!
update : DocumentUpdateMutationResponse!

Updates a Document with the provided input

Argument Type Description
input DocumentUpdateInput!
Back to top

DocumentObjective

Related types: Node LearningObjective

credits : Int

The number of credits that this LearningObjective represents

document : Document!

The document that must be accessed to complete this objective

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
documentId : ID!
expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!
isMandatory : Boolean!

Denotes whether or not the LearningObjective is mandatory

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningObjective in the set of LearningPath objectives

Back to top

DocumentOutcome

Related types: Node LearningOutcome

credits : Int

The number of credits that the LearningOutcome represents

document : Document!
Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!
isCompleted : Boolean

Denotes whether or not the LearningOutcome has been completed by the Learner

isMandatory : Boolean!

Denotes whether or not the LearningOutcome is mandatory

learningObjective : LearningObjective!

The LearningObjective to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
learningPathLearner : LearningPathLearner!

The LearningPathLearner to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningOutcome in the set of LearningAssignment outcomes

Back to top

DocumentRevision

DMS Document including current revision information

fileSizeStr : String

The size of this Document Revision in bytes. Returned as string, to allow universal support for values larger than 2 gigabytes.

filename : String

The name of the file, without the path

id : ID!

The Document Revision ID

identifyingHash : String

An identifier used to fetch the Document Revision

originalExtension : String

The original extension of the file, without the dot

revisionNumber : Int!

The revision number of this Document Revision

scormEntryPoint : String

The entrypoint for SCORM content

scormVersion : String

The version of the Document if it is a piece of SCORM content

status : DocumentRevisionStatus

The status of this Document Revision

Deprecated fields (1)
fileSize : Int

The size of this Document Revision in bytes

Removal date: TBD.

This field does not support values larger than 2 gigabytes. Please use 'fileSizeStr'.

Back to top

DocumentRevisionStatus

The status of Documents's last revision

processing
ready
failed
Back to top

DocumentRevisionUploadInput

Input for uploading a new Document revision

documentId : ID!

The ID of the Document to upload a new revision for

contentType : String!

The MIME type of the file to be uploaded

fileName : String!

The name of the File to be uploaded, used when downloading the file from a browser

Back to top

DocumentTemplate

A Document Template containing text and formatting that can be emailed

Related types: Node

body : String!

The Body of the Document Template

category : DocumentTemplateCategory!

The Category of the Document Template

company : Company

The Company that owns this Document Template, null for global templates

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
footer : String

The Footer of the Document Template

header : String

The Header of the Document Template

id : ID!

The ID of the Document Template

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The Name of the Document Template that will be shown in the list

pdfCss : String

The CSS to be applied to the Document Template PDF

pdfOrientation : String

Printing type of Document Template PDF

pdfZoomLevel : Float

The Zoom Level of the Document Template PDF

Back to top

DocumentTemplateCategory

The category of the Document Template

opportunities
events
Back to top

DocumentTemplateConnection

A connection containing page information and edges for DocumentTemplate

edges : [DocumentTemplateEdge!]!

The list of DocumentTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

DocumentTemplateCreateInput

An Input for creating a Document Template

category : DocumentTemplateCategory!

The category of Document Template

name : String!

The name of the Document Template

body : String!

The body of the Document Template

header : String

The header of the Document Template

footer : String

The footer of the Document Template

pdfZoomLevel : Float

The zoom level of the Document Template PDF (must be between 0 - 1)

pdfCss : String

The custom CSS to be applied to the Document Template PDF generation

pdfOrientation : String

The PDF print type, can be portrait or landscape

companyId : ID

ID of the Company this Document template is for. If null or not provided, the template is considered 'global'.

Back to top

DocumentTemplateDeleteInput

An Input for deleting a Document Template

documentTemplateId : ID!

The ID of the Document Template to be deleted

Back to top

DocumentTemplateEdge

Contains cursor and node information for type DocumentTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : DocumentTemplate!

The DocumentTemplate node.

Back to top

DocumentTemplateFieldGraphFilter

Filter that can be applied to limit which DocumentTemplate nodes are returned

field : DocumentTemplateTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

DocumentTemplateFieldGraphOrder

Specifies the order in which DocumentTemplate nodes are returned via the Connection

field : DocumentTemplateTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

DocumentTemplateMutationResponse

A Response for Document Template mutations

Related types: MutationResponse

documentTemplate : DocumentTemplate

The Document Template that was mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

DocumentTemplateMutations

Mutations for Document Templates

create : DocumentTemplateMutationResponse!

Create a new Document Template

Argument Type Description
input DocumentTemplateCreateInput!

The input type with the values to be set on the new Document Template
delete : DocumentTemplateMutationResponse!

Delete an existing Document Template

Argument Type Description
input DocumentTemplateDeleteInput!

The input type with the ID of the Document Template to be deleted
update : DocumentTemplateMutationResponse!

Update an existing Document Template

Argument Type Description
input DocumentTemplateUpdateInput!

The input type with the values to be updated on the Document Template
Back to top

DocumentTemplateTypeField

Fields for filtering and ordering Documents

id
name
category
companyId
Back to top

DocumentTemplateUpdateInput

An Input for updating a Document Template

documentTemplateId : ID!

The ID of the Document Template to be updated

category : DocumentTemplateCategory

The category of Document Template

name : String

The name of the Document Template

body : String

The body of the Document Template

header : String

The header of the Document Template

footer : String

The footer of the Document Template

pdfZoomLevel : Float

The zoom level of the Document Template PDF (must be between 0 - 1)

pdfCss : String

The custom CSS to be applied to the Document Template PDF generation

pdfOrientation : String

The PDF print type, can be portrait or landscape

companyId : ID

ID of the Company this Document template is for. If null, the template is considered 'global'.

Back to top

DocumentTypeField

Fields for filtering and ordering Documents

id
name
description
folderId
isReport
fileSize
companyId
Back to top

DocumentUpdateInput

Input for updating a Document

documentId : ID!

The ID of the Document to update

name : String

The name of the Document

description : String

The description of the Document

folderId : ID

The folder ID to put the Document into

tags : [String]

The list of tags to associate with the Document

categories : [ID]

The list of categories that this Document belongs to

localeId : ID

EXPERIMENTAL, do not rely on this: it may change or be withdrawn without notice. The Locale of the Document's content. An empty string clears it, meaning the instance default; that is rejected on a Document that is itself a translation

Back to top

DocumentUpdateMutationResponse

The response from a Document update request

Related types: MutationResponse

document : Document

The Document that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

DocumentUploadInput

Input for uploading a new Document

name : String!

The name used to identify the document when viewing in Administrate

description : String!

The description of the Document to upload

contentType : String!

The MIME type of the file to be uploaded

fileName : String!

The name of the File to be uploaded, used when downloading the file from a browser

folderId : String

The folder ID to put the Document into. If unspecified the root Document is assumed

categoryIds : [ID]

The list of categories the document is associated to

translationOfId : ID

EXPERIMENTAL, do not rely on this: it may change or be withdrawn without notice. The ID of the Document this one is a translation of. The translation is placed in that Document's folder, so any folderId is ignored

localeId : ID

EXPERIMENTAL, do not rely on this: it may change or be withdrawn without notice. The Locale of the Document's content, or unset for the instance default. Required when translationOfId is given, and must differ from the other Locales in that translation set

Back to top

DocumentUploadRequestResponse

The response from a Document upload or Document upload revision request. Contains the document and upload details

Related types: MutationResponse

document : Document

The Document to be uploaded

errors : [FieldError!]!

The errors returned by the mutation

uploadDetails : UploadDetails

The UploadDetails generated from the request. Expires after 60 seconds

Back to top

DownloadableFile

Settings that define a Downloadable File

document : Document!

The DMS document that stores this Downloadable File

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
hash : String!

The hash that identifies the current version of the Downloadable File

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
Back to top

Duration

A duration in hours, minutes and seconds

Back to top

Email

Details about the email

Related types: Node

attachments : [EmailAttachment!]

The attachments added to the Email

body : String

The Body of the Email.

ccAddresses : String

The Addresses CC'd on the Email.

createdAt : TimeZonedDateTime!

The date and time the email was created

expiresAt : TimeZonedDateTime

The date and time the email expires at

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the email

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : EmailLifeCycleState!

The Lifecycle State of the Email.

logs : [EmailLog!]!

A list of delivery or engagement events occurred for this Email

subject : String

The Subject of the Email.

toAddress : String

The Address of the recipient of the Email.

userName : String

The name of the User who sent the Email.

Back to top

EmailAccount

Email Account for Email Syncing

accountName : String!

Email Account name

crmIntegrationEnabled : Boolean!

Is the CRM Integration enabled for this email account

emailFolders : EmailFolderConnection!

Email Folders for this Email Account

Argument Type Description
filters = [] [EmailFolderFieldGraphFilter]
order = "__EMPTY__" EmailFolderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EmailFolderFieldGraphOrder]
enquiryIntegrationEnabled : Boolean!

Is Enquiry Integration enabled for this email account

id : ID!

ID of the EmailAccount

isAuthenticated : Boolean!

Does the Email account have an OAuth 2 refresh token

isDisabled : Boolean!

Is the Email account disabled

port : Int

Email IMAP port

provider : AuthenticationProvider!

Authentication provider

server : String

Email IMAP server

username : String!

Email IMAP login username

Back to top

EmailAccountConnection

A connection containing page information and edges for EmailAccount

edges : [EmailAccountEdge!]!

The list of EmailAccount edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EmailAccountCreateInput

An Input for creating an Email Account

accountName : String!

The name of the Email Account

username : String!

The username for connecting to the email provider

password : String!

The password for connecting to the email provider

server : String!

The server address of the email provider

port : Int!

The port of the email provider

Back to top

EmailAccountDeleteInput

An Input for deleting an Email Account

emailAccountId : ID!

The ID of the Email Account that will be deleted

Back to top

EmailAccountEdge

Contains cursor and node information for type EmailAccount

cursor : String!

A string that can be used for cursor-based pagination

node : EmailAccount!

The EmailAccount node.

Back to top

EmailAccountField

Fields for filtering and ordering Email Accounts

id
accountName
username
Back to top

EmailAccountFieldGraphFilter

Filter that can be applied to limit which EmailAccount nodes are returned

field : EmailAccountField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EmailAccountFieldGraphOrder

Specifies the order in which EmailAccount nodes are returned via the Connection

field : EmailAccountField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EmailAccountMutationResponse

Related types: MutationResponse

emailAccount : EmailAccount

The email account created or modified by the mutation

errors : [FieldError!]!

The errors returned by the mutation

Back to top

EmailAccountMutations

Mutations for managing Email Accounts

create : EmailAccountMutationResponse!

Creates a new Email Account

Argument Type Description
input EmailAccountCreateInput!
delete : EmailAccountMutationResponse!

Deletes a specified Email Account

Argument Type Description
input EmailAccountDeleteInput!
update : EmailAccountMutationResponse!

Updates a specified Email Account

Argument Type Description
input EmailAccountUpdateInput!
updateEmailFoldersFromProvider : EmailAccountMutationResponse!

Updates the specified Email Account's Email Folders with those at the email provider

Argument Type Description
input EmailAccountUpdateEmailFoldersInput!
Back to top

EmailAccountUpdateEmailFoldersInput

An Input for populating an Email Account's Email Folders with those at the email provider

emailAccountId : ID!

The ID of the Email Account whose Email Folders will be populated

Back to top

EmailAccountUpdateInput

An Input for updating an Email Account

emailAccountId : ID!

The ID of the Email Account that will be updated

accountName : String

The name of the Email Account

username : String

The username for connecting to the email provider

password : String

The password for connecting to the email provider

server : String

The server address of the email provider

port : Int

The port of the email provider

isDisabled : Boolean

Whether or not the Email Account is disabled

selectedEmailFolderIds : [ID]

The IDs of the Email Account's Email Folders that are selected

crmIntegrationEnabled : Boolean

Whether or not the CRM Integration should be enabled

enquiryIntegrationEnabled : Boolean

Whether or not Enquiry Integration should be enabled

Back to top

EmailAttachment

Email Attachments structure

doc_id : String

The dms document id of the attachment if its of dms type

folder_id : String

The folder for dms document if suitable

name : String

The name of the attachment

type : String!

The type of the attachment

url : String

The url of the attachment

Back to top

EmailConnection

A connection containing page information and edges for Email

edges : [EmailEdge!]!

The list of Email edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EmailEdge

Contains cursor and node information for type Email

cursor : String!

A string that can be used for cursor-based pagination

node : Email!

The Email node.

Back to top

EmailFieldGraphFilter

Filter that can be applied to limit which Email nodes are returned

field : EmailFields!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EmailFieldGraphOrder

Specifies the order in which Email nodes are returned via the Connection

field : EmailFields!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EmailFields

Fields for filtering and ordering Emails

id
opportunityId
templateId
createdAt
state
Back to top

EmailFolder

An Email Folder

emailAccountId : String!

The ID of the Email Account that the Email Folder belong to

folderName : String!

The name of the Email Folder

id : ID!

The ID of the Email Folder

isSelected : Boolean!

If the Email Folder is selected

path : String!

The path to the Email Folder

selectedAt : LocalDateTime

When the Email Folder was selected

Back to top

EmailFolderConnection

A connection containing page information and edges for EmailFolder

edges : [EmailFolderEdge!]!

The list of EmailFolder edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EmailFolderEdge

Contains cursor and node information for type EmailFolder

cursor : String!

A string that can be used for cursor-based pagination

node : EmailFolder!

The EmailFolder node.

Back to top

EmailFolderField

fields for filtering and ordering EmailFolders

id
emailAccountId
Back to top

EmailFolderFieldGraphFilter

Filter that can be applied to limit which EmailFolder nodes are returned

field : EmailFolderField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EmailFolderFieldGraphOrder

Specifies the order in which EmailFolder nodes are returned via the Connection

field : EmailFolderField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EmailGroup

Details about the email group

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the email group

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

EmailLifeCycleState

The possible lifecycle states of an Email

Queued
Ready
Sent
Failed
Processing
Processed
Dropped
Delivered
Deferred
Bounce
Open
Click
Spamreport
Unsubscribe
GroupUnsubscribe
GroupResubscribe
Error
Unknown
Back to top

EmailLog

A delivery or engagement event logged for an Email

eventType : EmailLogType!

The delivery or engagement event type

loggedAt : TimeZonedDateTime!

The date and time this event was recorded

Back to top

EmailLogType

A collection of delivery or engagement events that can be logged for an Email

Processing
Processed
Dropped
Delivered
Deferred
Bounce
Open
Click
Spamreport
Unsubscribe
GroupUnsubscribe
GroupResubscribe
Error
Unknown
Back to top

Enquiry

An inbound enquiry received by the sales team.

Related types: Node

assignee : User

User assigned to process the Enquiry.

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
attachments : [EnquiryAttachment!]!

Files received with this Enquiry.

body : String

Message body.

companyName : String

Company name supplied by the sender.

contact : Contact

Contact associated with the Enquiry.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : LocalDateTime

Date and time the Enquiry was created.

deadReasonId : ID

Dead reason identifier.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
fromEmail : String

Email address of the sender.

fromName : String

Name of the sender.

historyEntries : [MessageHistoryEntry!]!

History entries for this Enquiry.

id : ID!

ID of the Enquiry.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

mimetype : String

Mimetype of the message body.

opportunity : Opportunity

Opportunity associated with the Enquiry.

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
processed : Boolean!

Whether the Enquiry has been processed.

subject : String

Subject of the Enquiry.

telephone : String

Telephone supplied by the sender.

toEmail : String

Email address the Enquiry was sent to.

Back to top

EnquiryAttachment

A file received with an Enquiry.

downloadUrl : String

Short-lived URL for downloading the file.

fileName : String!

Original file name.

id : ID!

ID of the attachment.

mimeType : String!

MIME type of the file.

Back to top

EnquiryConnection

A connection containing page information and edges for Enquiry

edges : [EnquiryEdge!]!

The list of Enquiry edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EnquiryCreateInput

Input for creating an Enquiry.

fromName : String!

Name of the sender

fromEmail : String!

Email address of the sender

subject : String!

Subject of the Enquiry

body : String!

Message body

companyName : String

Company name supplied by the sender

telephone : String

Telephone supplied by the sender

toEmail : String

Email address the Enquiry was sent to

Back to top

EnquiryDeleteInput

Input for deleting an Enquiry.

deadReasonId : ID!
Back to top

EnquiryEdge

Contains cursor and node information for type Enquiry

cursor : String!

A string that can be used for cursor-based pagination

node : Enquiry!

The Enquiry node.

Back to top

EnquiryField

An enumeration.

id
createdAt
fromName
companyName
fromEmail
telephone
subject
assignedToId
contactId
opportunityId
processed
messageStatus
Back to top

EnquiryFieldGraphFilter

Filter that can be applied to limit which Enquiry nodes are returned

field : EnquiryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EnquiryFieldGraphOrder

Specifies the order in which Enquiry nodes are returned via the Connection

field : EnquiryOrderField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EnquiryMarkDeadInput

Input for marking an Enquiry as dead.

deadReasonId : ID!
Back to top

EnquiryMutateResponse

A response from Enquiry mutations.

Related types: MutationResponse

enquiry : Enquiry

The Enquiry that was mutated.

errors : [FieldError!]!

The errors returned by the mutation

Back to top

EnquiryMutations

Mutations for Enquiries.

addToMarketingList : EnquiryMutateResponse!

Add the associated contact to a Marketing List.

Argument Type Description
input MessageAddToMarketingListInput!
assign : EnquiryMutateResponse!

Assign an Enquiry to a user.

Argument Type Description
input MessageAssignInput!
associateContact : EnquiryMutateResponse!

Associate an Enquiry with a contact.

Argument Type Description
input MessageAssociateContactInput!
associateOpportunity : EnquiryMutateResponse!

Associate an Enquiry with an opportunity and mark it as processed.

Argument Type Description
input MessageAssociateOpportunityInput!
create : EnquiryMutateResponse!

Create an Enquiry assigned to the current user.

Argument Type Description
input EnquiryCreateInput!

The input type with the values used to create an Enquiry
createTask : EnquiryMutateResponse!

Create a Task from an Enquiry.

Argument Type Description
input MessageTaskCreateInput!
delete : EnquiryMutateResponse!

Delete an Enquiry.

Argument Type Description
input EnquiryDeleteInput!
markDead : EnquiryMutateResponse!

Mark an Enquiry as dead.

Argument Type Description
input EnquiryMarkDeadInput!
markProcessed : EnquiryMutateResponse!

Mark an Enquiry as processed with no further action required.

Argument Type Description
input MessageMarkProcessedInput!
reply : EnquiryMutateResponse!

Reply to an Enquiry by email.

Argument Type Description
input MessageReplyInput!
Back to top

EnquiryOrderField

An enumeration.

id
createdAt
fromName
companyName
fromEmail
telephone
subject
assignedToId
contactId
opportunityId
processed
Back to top

EnsureKryterionAccountInput

An input for creating an external Kryterion resource

learnerId : ID!

The ID of the Learner we wish to create a KryterionResource for

contentId : ID!

The ID of the Kryterion Activity

Back to top

EntityMapInput

An input with the field data for a single mapping

administrate_custom_field_id : String
vendor_custom_field_id : String
vendor_stock_field : String
administrate_stock_field : String
Back to top

EntityType

An enumeration.

Contact
ContactCustom
LearnerCustom
LearningPathLearnerCustom
Back to top

Event

The instance of training covering a particular course at a set time and location

Related types: Node Calendarable InterestItem Billable Bookable ContactBookingEntity

accessDuration : Int

The number of days this Event is accessible for. Only applicable for self-paced Events. Classroom Events will return null

achievementTypes : EventAchievementTypeConnection

The Achievement Types for the Event

Argument Type Description
filters = [] [EventAchievementTypeFieldGraphFilter]
order = "__EMPTY__" EventAchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventAchievementTypeFieldGraphOrder]
bookedPlaces : Int!

Number of Learners booked

bookingAccount : Account

The Booking Account on a Private Event if one has been assigned

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
cancelledAt : String

The date this Event was cancelled

classroomEnd : LocalDateTime

The ending date and time of the latest, active classroom Session for the Event

classroomStart : LocalDateTime

The starting date and time of the earliest, active classroom Session for the Event

code : String!

A code used to refer to the Event

company : Company

The Company which is responsible for this Event

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
content : ContentConnection!

Contents that belong to the Event

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
cost : Decimal

Total cost of the event

costs : EventCostConnection!

The Costs of the Event

Argument Type Description
filters = [] [EventCostFieldGraphFilter]
order = "__EMPTY__" EventCostFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventCostFieldGraphOrder]
courseTemplate : CourseTemplate

The CourseTemplate used to create this Event

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
createdAt : TimeZonedDateTime!

A timestamp of the time this Event was created

customFieldValues : [CustomFieldValue!]!

Custom Field values for this Event

Argument Type Description
filter CustomFieldFilterInput
dateContractSent : Date

Date the Contract for the Private Events was sent

dateContractSigned : Date

Date the Contract for the Private Events was signed

defaultPrice : EventPrice

Default price charged for attending an event

Argument Type Description
filters = [] [EventPriceFieldGraphFilter]
order = "__EMPTY__" EventPriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventPriceFieldGraphOrder]
defaultTaxType : TaxType

The Tax Type applicable to this Event

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
displayId : String!

A unique number which can be used by a user to quickly reference a specific Event.

documents : [Document!]

Documents mapped to this event

Argument Type Description
id ID
emails : EmailConnection!

Ad-hoc Emails sent for this Event

Argument Type Description
filters = [] [EmailFieldGraphFilter]
order = "__EMPTY__" EmailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EmailFieldGraphOrder]
end : LocalDateTime

The date and time the Event ends

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
externalNotes : String!

Event notes for an external audience

fillRate : Int

A percentage of how full this event is. If there is no limit to students, we return 1. Calculated with: (bookedPlaces + reserved) / maxPlaces

finalInvoice : Invoice

The invoice containing this Private Event's Final revenue.

finalInvoiceIssued : Boolean!

Whether this Private Event has Final revenue on an invoice.

financialUnit : FinancialUnit

The Financial Unit for a Private Event's price

Argument Type Description
filters = [] [TrainingTokenTypeFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTypeFieldGraphOrder]
hasPlacesRemaining : Boolean!

Number of Learner places remaining on the event

id : ID!

ID of the Event

imageHash : String

Hash for the Event Image

imagePath : String!

Path for the Event Image

interested : Int!

Number of Learners interested in the Event

interests : InterestConnection!

Opportunity interests related to the Event

Argument Type Description
filters = [] [InterestFieldGraphFilter]
order = "__EMPTY__" InterestFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InterestFieldGraphOrder]
internalNotes : String!

Event notes for an internal audience

isActive : Boolean!

True if an event is published (i.e. not cancelled or draft) and its end datetime has not yet passed.

isSoldOut : Boolean

Boolean value reporting if the Event is sold out

learnerAccounts : AccountConnection!

Accounts of the Learners on this Event

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
learnerCount : Int!

Total count of learners on this Event. Unnamed learners count as their delegate quantity.

learners : LearnerConnection!

Learners that have been enrolled onto an event

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
learningMode : EventLearningMode!

The form the training takes for instance classroom or blended

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : EventLifecycleState!

The state of the Event in its lifecycle

lmsAnnouncements : String

The Event LMS Announcements/Note

lmsEnd : LocalDateTime

The ending date and time when the LMS access or self paced learning is scheduled to close

lmsStart : LocalDateTime

The starting date and time when the LMS access or self paced learning is scheduled to open

lmsTotalSteps : Int!

The total number of steps in this Event's LMS

locale : Locale

The Event Locale

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
location : Location

Location at which the Event takes place

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
locationName : String

The name of the Location at which the Event takes place

maxPlaces : Int

Maximum number of bookable slots for the Event

minPlaces : Int

Minimum number of booked learners required for the Event. It's a soft field, doesn't imply any specific behaviour.

numExpectedStudents : Int

Number of Students expected on the Event

passingRules : EventPassingRules!

Configuration for Event's Passing Rules. Determines how Learners to be progressed into Passed status.

price : Decimal

The amount for a Private Event's price

prices : EventPriceConnection!

Lists the prices available for purchasing this Event

Argument Type Description
filters = [] [EventPriceFieldGraphFilter]
order = "__EMPTY__" EventPriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventPriceFieldGraphOrder]
profit : Decimal

Total profit of the event

publicDocuments : [Document!]

Documents mapped to this event that are exposed publicly (to the LMS). This respected the lms-showCourseDocuments system setting.

Argument Type Description
id ID
purchaseRequiresReview : Boolean!

Dictates if a Cart that contains this Event will be submitted for review before checkout in a Weblink Portal. Requires the orderReviewStep and orderRetrievalStep to be defined in the Weblink Portal's Opportunity Steps.

region : Region

Region in which the Event takes place

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
registrationDeadline : LocalDateTime

The Registration Deadline of the Event

registrationOpensAt : LocalDateTime

The Registration Opens At Datetime for the Event

registrations : RegistrationConnection!

The registrations for this Event

Argument Type Description
filters = [] [RegistrationFieldGraphFilter]
order = "__EMPTY__" RegistrationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationFieldGraphOrder]
remainingPlaces : Int

Number of Learner places remaining on the event

remoteMeeting : RemoteMeeting

The remote meeting that can be used to attend Event sessions remotely

remoteMeetingHostContact : Contact

The Contact assigned as the meeting host for this Event

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
remoteMeetingHostStaffRole : StaffRole

The Staff Role assigned as the meeting host role for this Event

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
requiredResources : [EventResourceRequirement!]!

Resources (equipment, rooms, etc) the Event requires

Argument Type Description
filters = [] [EventResourceRequirementFieldGraphFilter]
order = "__EMPTY__" EventResourceRequirementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventResourceRequirementFieldGraphOrder]
requiredStaff : [EventStaffRequirement!]

Staff (instructors, assistants, etc) the Event requires

Argument Type Description
filters = [] [EventStaffRequirementFieldGraphFilter]
order = "__EMPTY__" EventStaffRequirementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventStaffRequirementFieldGraphOrder]
reserved : Int!

Number of Learners who have reserved a place on the Event but not yet booked

revenue : Decimal

Total revenue of the event

sentEmails : EventSentEmailConnection!

Automated Emails this Event's triggers sent, for its audit trail. Reading them needs only sight of the Event, not trigger permissions.

Argument Type Description
filters = [] [EventSentEmailFieldGraphFilter]
order = "__EMPTY__" EventSentEmailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventSentEmailFieldGraphOrder]
sessions : SessionConnection!

Sessions that belong to the Event

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
staff : StaffConnection!

Staff attached to an event

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
start : LocalDateTime

The date and time the Event starts

surveys : [Survey!]!

A list of surveys attached to this Event

targetFillRate : Int

A target percentage for how much we want the event to be.

tasks : TaskConnection!

The Tasks to be completed for this Event

Argument Type Description
filters = [] [TaskFieldGraphFilter]
order = "__EMPTY__" TaskFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskFieldGraphOrder]
timeZoneName : String

The time zone in which the Event's dates and times are scheduled

timeZonedClassroomEnd : TimeZonedDateTime

The ending date and time of the latest, active classroom Session for the Event with time zone information

timeZonedClassroomStart : TimeZonedDateTime

The starting date and time of the earliest, active classroom Session for the Event with time zone information

timeZonedEnd : TimeZonedDateTime

The date and time the Event ends with time zone information

timeZonedLmsEnd : TimeZonedDateTime

The ending date and time when the LMS access or self paced learning is scheduled to close with time zone information

timeZonedLmsStart : TimeZonedDateTime

The starting date and time when the LMS access or self paced learning is scheduled to open with time zone information

timeZonedStart : TimeZonedDateTime

The date and time the Event starts with time zone information

title : String!

Title of the Event

totalForecastRevenue : Decimal!

Total forecast revenue for the Event

triggers : [TriggerForEvent!]!

List of Triggers that apply to the given event.

Argument Type Description
filters = [] [TriggerFieldGraphFilter]
order = "__EMPTY__" TriggerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerFieldGraphOrder]
type : EventType!

Type of the Event (public/private)

updatedAt : TimeZonedDateTime!

A timestamp of the last time this Event was updated

venue : Venue

Venue for the event

Argument Type Description
filters = [] [VenueFieldGraphFilter]
order = "__EMPTY__" VenueFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [VenueFieldGraphOrder]
Deprecated fields (8)
achievementType : AchievementType

The Achievement Type for the event

Removal date: 2025-07-21.

Replaced by achievementTypes

Argument Type Description
filters = [] [AchievementTypeFieldGraphFilter]
order = "__EMPTY__" AchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementTypeFieldGraphOrder]
contents : ContentConnection!

Contents that belong to the Event

Removal date: TBD.

Replaced by content

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
endDate : String

Date the Event ends

Removal date: TBD.

Replaced by end

partners : [Account]!

Partners associated with this Event

Removal date: 2024-06-11.

Feature will be removed

personnel : [String!]!

Names of the personnel on an event

Removal date: TBD.

Names of personnel can be found using staff

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
startDate : String

Date the Event starts

Removal date: TBD.

Replaced by start

status : EventStatus!

The status of the Event

Removal date: TBD.

Replaced by lifecycleState

webConferencingIntegration : WebConferencingIntegration

The Web Conferencing Integration used by the Event to create Virtual Classrooms

Removal date: 2025-04-08.

Feature removed

Back to top

EventAchievementType

The Mapping between Event and related Achievement types

Related types: Node

achievementType : AchievementType!

The Achievement Type mapped to the Event

Argument Type Description
filters = [] [AchievementTypeFieldGraphFilter]
order = "__EMPTY__" AchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementTypeFieldGraphOrder]
autoAward : Boolean!

Indicate whether related achievement is awarded automatically upon event completion by learner

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Mapping

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lmsCompletionThreshold : Int

The LMS completion threshold percentage for the achievement type within the event

Back to top

EventAchievementTypeConnection

A connection containing page information and edges for EventAchievementType

edges : [EventAchievementTypeEdge!]!

The list of EventAchievementType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventAchievementTypeEdge

Contains cursor and node information for type EventAchievementType

cursor : String!

A string that can be used for cursor-based pagination

node : EventAchievementType!

The EventAchievementType node.

Back to top

EventAchievementTypeField

Fields for filtering and ordering Achievement Types associated with the Event

id
autoAward
Back to top

EventAchievementTypeFieldGraphFilter

Filter that can be applied to limit which EventAchievementType nodes are returned

field : EventAchievementTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventAchievementTypeFieldGraphOrder

Specifies the order in which EventAchievementType nodes are returned via the Connection

field : EventAchievementTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventAddAchievementTypeInput

An Input for adding new Achievement Type to an Event

eventId : ID!

The ID of the Event to add the Achievement Type to.

achievementTypeId : ID!

The ID of Achievement Type to add to the event.

autoAward : Boolean!

Setting for whether Achievement should be automatically awarded when Learner passes the Event.

lmsCompletionThreshold : Int

The LMS completion threshold percentage required for the Achievement to be awarded.

Back to top

EventAddPriceInput

An Input for adding a price to an Event. A currency code or token type must be specified. There can only be 1 price for the same Price Level and Currency, or the same Price Level and Token Type

eventId : ID!

the ID of the Event this price is for

amount : Decimal!

the Price amount (must be a positive Decimal)

priceLevelId : ID!

the ID of the Price Level for this Price

financialUnitId : ID

the Financial Unit for the price (Currency or Training Token)

isDefault : Boolean

whether to set this price as a default price for the Event

Back to top

EventAuditLogEntry

One entry from an Event's audit log.

Related types: Node

changes : [AuditLogChange!]!

The entry's changes, flattened to one row per field.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the audit log entry.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

modelId : ID!

The Event the entry was recorded against. Editing a Session records the entry against that Session, so this is not always the Event whose history is being read.

occurredAt : TimeZonedDateTime!

When the change was recorded, in UTC.

userName : String

The name of the User who made the change.

Back to top

EventAuditLogEntryConnection

A connection containing page information and edges for EventAuditLogEntry

edges : [EventAuditLogEntryEdge!]!

The list of EventAuditLogEntry edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventAuditLogEntryEdge

Contains cursor and node information for type EventAuditLogEntry

cursor : String!

A string that can be used for cursor-based pagination

node : EventAuditLogEntry!

The EventAuditLogEntry node.

Back to top

EventAuditLogEntryField

Fields for filtering and ordering Event audit log entries.

id
eventId
occurredAt
Back to top

EventAuditLogEntryFieldGraphFilter

Filter that can be applied to limit which EventAuditLogEntry nodes are returned

field : EventAuditLogEntryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventAuditLogEntryFieldGraphOrder

Specifies the order in which EventAuditLogEntry nodes are returned via the Connection

field : EventAuditLogEntryField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventBreakout

An Event Breakout

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
groups : EventBreakoutGroupConnection!

The Breakout Groups belonging to this Event Breakout

Argument Type Description
filters = [] [EventBreakoutGroupFieldGraphFilter]
order = "__EMPTY__" EventBreakoutGroupFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventBreakoutGroupFieldGraphOrder]
id : ID!

The ID of the Event Breakout

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Event Breakout

Back to top

EventBreakoutField

Fields for filtering and ordering Event Breakouts

id
eventId
name
Back to top

EventBreakoutFieldGraphFilter

Filter that can be applied to limit which EventBreakout nodes are returned

field : EventBreakoutField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventBreakoutFieldGraphOrder

Specifies the order in which EventBreakout nodes are returned via the Connection

field : EventBreakoutField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventBreakoutGroup

An Event Breakout Group

Related types: Node

breakout : EventBreakout!

The Breakout this Group belongs to

Argument Type Description
filters = [] [EventBreakoutFieldGraphFilter]
order = "__EMPTY__" EventBreakoutFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventBreakoutFieldGraphOrder]
capacity : Int

The maximum number of learners this Breakout Group can accommodate

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Event Breakout Group

Argument Type Description
filter CustomFieldFilterInput
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Event Breakout Group

learnerCount : Int!

The number of learners in this Breakout Group. Unnamed learners count as their delegate quantity.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Event Breakout Group

sessions : SessionConnection!

Sessions in this Breakout Group

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
Back to top

EventBreakoutGroupConnection

A connection containing page information and edges for EventBreakoutGroup

edges : [EventBreakoutGroupEdge!]!

The list of EventBreakoutGroup edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventBreakoutGroupEdge

Contains cursor and node information for type EventBreakoutGroup

cursor : String!

A string that can be used for cursor-based pagination

node : EventBreakoutGroup!

The EventBreakoutGroup node.

Back to top

EventBreakoutGroupField

Fields for filtering and ordering Event Breakout Groups

id
breakoutId
name
Back to top

EventBreakoutGroupFieldGraphFilter

Filter that can be applied to limit which EventBreakoutGroup nodes are returned

field : EventBreakoutGroupField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventBreakoutGroupFieldGraphOrder

Specifies the order in which EventBreakoutGroup nodes are returned via the Connection

field : EventBreakoutGroupField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventBreakoutGroupSelectionInput

An Input for choosing the breakout groups for a Learner

id : ID!

ID of the breakout group on whose sessions the Learner should be registered

Back to top

EventBreakoutGroupSessionInput

An Input describing a Session within a Breakout Group. Always carries the Session's full desired state - existing Sessions are updated with exactly these values, not merged with what's already stored.

code : String!

The code used to refer to the Session

title : String!

The title of the Session

start : LocalDateTime!

The start datetime of the Session

end : LocalDateTime!

The end datetime of the Session

sessionId : ID

The ID of an existing Session to update. Omit to create a new Session.

locationId : ID

The location of the Session

venueId : ID

The venue of the Session

timeZoneName : String

The timezone of the Session

minPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Minimum number of booked learners required for the Session

maxPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Maximum number of bookable slots for the Session

lifecycleState : SessionLifecycleState

The lifecycle state of the Session

notes : String

Notes for the Session

customFieldValues : [CustomFieldValueInput]

Custom field values for the Session

Back to top

EventBreakoutMutations

Available Mutations on an Event Breakout

set : EventBreakoutSetResponse!

Creates or updates an Event's Breakout, syncing its Groups and Sessions to exactly the set provided.

Argument Type Description
input EventBreakoutSetInput!

The input type with the values to create or update the Breakout
Back to top

EventBreakoutSetGroupInput

An Input to allow a user to create or update a Group on an Event Breakout

sessions : [EventBreakoutGroupSessionInput]!

The full desired set of Sessions in this Group

name : String!

The name of the Breakout Group

groupId : ID

The ID of the Breakout Group to update. Omit to create a new Group.

capacity : Int

The maximum number of learners this Breakout Group can accommodate

Back to top

EventBreakoutSetInput

An Input to allow a user to create or update an Event Breakout. Groups with a groupId are updated, groups without one are created, and any existing groups not included are removed.

eventId : ID!

The ID of the Event this Breakout belongs to

name : String!

The name of the Breakout

groups : [EventBreakoutSetGroupInput]!

The full desired set of Groups on this Breakout

breakoutId : ID

The ID of the Event Breakout to update. Omit to create a new Breakout.

Back to top

EventBreakoutSetResponse

A Response from creating or updating an Event Breakout

Related types: MutationResponse

breakout : EventBreakout

The Event Breakout that was created or updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

EventBulkUpdateResponse

A Response for an mutation updating a batch of Events

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

events : [Event!]!

The Events that were updated

Back to top

EventChangeActorChannel

Where a change came from, as opposed to who signed it. Read from the acting User rather than the request, so two integrations sharing an API product cannot be told apart.

ui
api
virtualClassroom
system
Back to top

EventChangeAffectedParty

Someone who was attached to the Event at the moment it changed.

Who was attached is snapshotted when the change is recorded, so the list stays true for people who have since cancelled or been unassigned. Their name is not: contactName is read now, so a renamed Contact reads under its current name and a deleted one loses it altogether.

contactId : ID

The Contact behind the registration or booking. Null for an unnamed learner, which is a booked seat with nobody in it yet.

contactName : String

The person's name as it stands now, not as it was when the change happened. Null for an unnamed learner, for a Contact that has since been removed, and for one the reader may not see.

partyType : EventChangePartyType!

Whether this person was on the Event as a learner or as staff.

seats : Int!

How many people this party stands for: one for a named person, and the booked quantity for an unnamed booking, which is one registration holding several places.

Back to top

EventChangePartyType

How a person was attached to the Event when it changed.

learner
staff
Back to top

EventChangeType

The kind of change. Deliberately a closed set: a change type earns its place by being something worth counting, which is why an edit to a title is not here and stays in the audit log.

rescheduled
Back to top

EventConnection

A connection containing page information and edges for Event

edges : [EventEdge!]!

The list of Event edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventCost

A Cost that is incurred due to holding the Event

Related types: Node

amount : Decimal!

The unit amount of the Cost that will be multiplied by the quantity

currency : Currency!

The Currency of the Cost

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
description : String!

A description of the Cost being applied

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Event Cost

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

quantity : Int

For a fixed cost this is the number of times this cost should be applied. For other costs this will be implied by the number of learners or staff on the event.

quantityType : EventCostQuantity!

The type of quantity that the Cost will be multiplied by

Back to top

EventCostConnection

A connection containing page information and edges for EventCost

edges : [EventCostEdge!]!

The list of EventCost edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventCostEdge

Contains cursor and node information for type EventCost

cursor : String!

A string that can be used for cursor-based pagination

node : EventCost!

The EventCost node.

Back to top

EventCostField

Fields for filtering and ordering Events Costs

id
Back to top

EventCostFieldGraphFilter

Filter that can be applied to limit which EventCost nodes are returned

field : EventCostField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventCostFieldGraphOrder

Specifies the order in which EventCost nodes are returned via the Connection

field : EventCostField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventCostInput

An Input for registering a new Cost on an Event

eventId : ID!

The ID of the Event to add the Cost to.

amount : Decimal!

The amount of the Event Cost.

currencyCode : String!

The currency code associated with the Event Cost.

quantityType : EventCostQuantity!

The type of quantity, determining how the total Event Cost amount is calculated.

quantity : Int

For a fixed cost type, this is the number of times this cost amount should be applied. For other costs this will be implied by the number of learners or staff on the event.

description : String

A description for the Event Cost.

Back to top

EventCostQuantity

How the Quantity of the Cost is calculated from the Event

fixed
everyone
learners
staff
Back to top

EventCostResponse

A Response for an Event addCost Mutation

errors : [FieldError!]!

The errors returned by the mutation

event : Event

The Event that was updated

eventCost : EventCost

The EventCost that was updated

Back to top

EventCostUpdateInput

An Input for registering or updating Costs on an Event

amount : Decimal

The amount of the Event Cost.

currencyCode : String

The currency code associated with the Event Cost.

quantityType : EventCostQuantity

The type of quantity, determining how the total Event Cost amount is calculated.

quantity : Int

For a fixed cost type, this is the number of times this cost amount should be applied. For other costs this will be implied by the number of learners or staff on the event.

description : String

A description for the Event Cost.

Back to top

EventCount

Event statistics over the time period specified.

blended : Int!

The number of Blended Events

classroom : Int!

The number of Classroom Events

lms : Int!

The number of LMS Events

private : Int!

The number of Private Events.

public : Int!

The number of Public Events.

Back to top

EventCreateResponse

A Response for an Event Create Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

event : Event

The Event that was created

Back to top

EventDefaultPriceInput

Identifies which of a Course Template's public prices should be set as the Event's default price, in place of the "Normal" price level default.

priceLevelId : ID!

the Price Level of the Course Template price to use as the default

financialUnitId : ID!

the Financial Unit (Currency or Training Token) of the Course Template price to use as the default

Back to top

EventDeletePriceInput

An Input for deleting prices on an Event

eventPriceId : ID!

the ID of the Event Price to delete

Back to top

EventDetails

Event Details on an Interest

reserved : Boolean!

Whether the Interest is reserved

Deprecated fields (3)
existingLearners : [ExistingLearnerDetail]!

The details of existing Learners associated with the Event item on this Opportunity Interest

Removal date: TBD.

Replaced by interestedLearners inside Interest

newLearners : [NewLearnerDetail]!

The details of new Learners associated with the Event item on this Opportunity Interest

Removal date: TBD.

Replaced by interestedLearners inside Interest

unnamedLearners : [UnnamedLearnerDetail]!

The details of unnamed Learners associated with the Event item on this Opportunity Interest

Removal date: TBD.

Replaced by interestedLearners inside Interest

Back to top

EventDetailsAddInput

An Input containing the details required by an Event Interest

Back to top

EventDetailsUpdateInput

An Input containing the details required by an Event Interest

Back to top

EventDiscountabilityRule

Promotion Campaign Discountability Rules related to Events

Related types: PromotionDiscountabilityRule

discountableEvents : EventConnection!

A list of Events part of this discountability rule

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
type : PromotionCriterionType!

The type of Discountability Rule (e.g. Course, Location, etc)

Back to top

EventEdge

Contains cursor and node information for type Event

cursor : String!

A string that can be used for cursor-based pagination

node : Event!

The Event node.

Back to top

EventEditAchievementTypeInput

An Input for editing Achievement Type on an Event

eventAchievementTypeId : ID!

The ID of Event Achievement Type to edit.

autoAward : Boolean!

Setting for whether Achievement should be automatically awarded when Learner passes the Event.

lmsCompletionThreshold : Int

The LMS completion threshold percentage required for the Achievement to be awarded.

Back to top

EventEligibilityRule

Promotion Campaign Eligibility Rules related to Events

Related types: PromotionEligibilityRule

eligibleEvents : EventConnection!

A list of Events eligible for this Promotion rule

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
type : PromotionCriterionType!

The type of Eligibility Rule (e.g. Course, Location, etc)

Back to top

EventField

Fields for filtering and ordering Events

id
displayId
start
startDate
end
endDate
title
code
courseTemplateTitle
courseTemplateCode
courseTemplateVersionNumber
isSoldOut
learningMode
maxPlaces
minPlaces
lifecycleState
status
staffContactId
type
programmeId
achievementTypeIds
achievementTypeNames
learningCategory
bookedPlaces
remainingPlaces
interested
reserved
locationName
regionCode
registerBy
companyId
defaultPrice
bookingAccountName
bookingAccountId
taxTypeId
hasPlacesRemaining
isValidForPortal
timeZonedStart
timeZonedEnd
classroomStart
classroomEnd
lmsStart
lmsEnd
timeZonedLmsStart
timeZonedLmsEnd
timeZonedClassroomStart
timeZonedClassroomEnd
hasRegistrationManagedByContactId
hasRegistrationWithBrandId
hasPricesInCurrency
hasPricesInRegion
textSearch
locationId
sessionStartTime
sessionEndTime
dayOfWeek
hasFreeContent
localeId
updatedAt
createdAt
cancelledAt
isActive
eventOrCourseCodeOrTitle
isValidForContact
isValidForAccount
Back to top

EventFieldGraphFilter

Filter that can be applied to limit which Event nodes are returned

field : EventField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventFieldGraphOrder

Specifies the order in which Event nodes are returned via the Connection

field : EventField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventIssue

An issue surfaced on the dashboard for an Event. Polymorphic on category — concrete subtypes expose category-specific context.

Related types: MissingInstructorIssue InactiveInstructorIssue MissingResourceTypeIssue ResourceConflictIssue InactiveResourceIssue MislocatedResourceIssue MissingStaffRoleIssue InstructorConflictIssue DisqualifiedStaffIssue EventPersonnelIssue EventResourceIssue LowFillRateIssue GenericEventIssue NoticeEventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

EventIssueCategory

Category of an EventIssue surfaced by the dashboard. Mirrors the toggle taxonomy used to filter issues client-side. Members are kept in sync with domain_training.entities.event_issue.EventIssueCategory.

missing_instructor
instructor_conflict
missing_resource
resource_conflict
fill_rate
inactive_instructor
inactive_resource
mislocated_resource
disqualified_staff
missing_staff_role
personnel
resource
notice
generic
Back to top

EventLearningMode

The learning mode of an Event

classroom
lms
blended
Back to top

EventLifecycleChange

One change to an Event worth reporting on.

The audit log answers "what happened to this Event" as field-level diffs. This answers "what kind of change was that, how much notice did it give, and who did it land on", which a diff cannot be made to say.

Related types: Node

actorChannel : EventChangeActorChannel!

Whether a person in the TMS made this change or software did.

actorProduct : String

The API product an api change came through, where one is recorded.

affectedLearnerCount : Int!

How many learners the change landed on, counting every seat of an unnamed booking. Learners who had already cancelled are not counted: they had gone before it happened.

affectedParties : [EventChangeAffectedParty!]!

Everyone attached to the Event when it changed, learners and staff.

affectedStaffCount : Int!

How many staff the change landed on.

changeType : EventChangeType!

The kind of change.

eventId : ID!

The Event the change was recorded against. Moving a Session records the change against that Session, so this is not always the Event whose history is being read.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the change.

leadTimeDays : Int

Days between the change and the start it was moving away from, to the nearest day: the notice the people already booked on it received. Negative where it had already begun, and null where there was no start date to measure against.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

newEnd : TimeZonedDateTime

When it ends after this change. Null where the change did not move the end.

newStart : TimeZonedDateTime

When it starts after this change. Null where the change did not move the start.

occurredAt : TimeZonedDateTime!

When the change happened, in UTC.

previousEnd : TimeZonedDateTime

When the Event or Session ended before this change moved it.

previousStart : TimeZonedDateTime

When the Event or Session started before this change moved it. The earliest of these across an Event's changes is where it was first planned to run.

userName : String

The name of the User who made the change.

Back to top

EventLifecycleChangeConnection

A connection containing page information and edges for EventLifecycleChange

edges : [EventLifecycleChangeEdge!]!

The list of EventLifecycleChange edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventLifecycleChangeEdge

Contains cursor and node information for type EventLifecycleChange

cursor : String!

A string that can be used for cursor-based pagination

node : EventLifecycleChange!

The EventLifecycleChange node.

Back to top

EventLifecycleChangeField

Fields for filtering and ordering Event changes. Filtering eventId with eq on an Event returns its own changes and its Sessions' together, since a Session's move is part of the Event's history. Use in to match one Event or Session exactly.

id
eventId
changeType
occurredAt
leadTimeDays
actorChannel
Back to top

EventLifecycleChangeFieldGraphFilter

Filter that can be applied to limit which EventLifecycleChange nodes are returned

field : EventLifecycleChangeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventLifecycleChangeFieldGraphOrder

Specifies the order in which EventLifecycleChange nodes are returned via the Connection

field : EventLifecycleChangeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventLifecycleState

The lifecycle state of an Event

draft
published
cancelled
Back to top

EventMutations

Available Mutations on an Event

addAchievementType : EventUpdateResponse!

Add Achievement Type to an Event

Argument Type Description
input EventAddAchievementTypeInput!

The input type with Achievement Type details to be added to the event
addCost : EventCostResponse!

Add a cost to an event

Argument Type Description
input EventCostInput!

The input type with cost details to be added to the event
addPrices : EventPriceMutationResponse!

Adds prices to Events

Argument Type Description
input [EventAddPriceInput]!
addRequiredResource : EventUpdateResponse!

Add a Required Resource to an Event

Argument Type Description
input EventResourceRequirementCreateInput!

The Resource Requirement to add
addRequiredStaff : EventUpdateResponse!

Add a Required Staff to an Event

Argument Type Description
input EventStaffRequirementCreateInput!

The Staff Requirement to add
addStaff : EventUpdateResponse!

Add Staff to an Event: For blended or classroom events: Staff is added to the Event's Sessions For LMS events: Staff is added to Event only

Argument Type Description
input EventStaffInput!

Input with Staff details
addStaffBulk : EventBulkUpdateResponse!

Add several Staff to an Event: For blended or classroom events: Staff are added to the Event's Sessions For LMS events: Staff are added to Event only

Argument Type Description
input [EventStaffInput]!

list of Staff details to be added
associateUnnamedLearnerWithContacts : AssociateUnnamedLearnerWithContactsResponse!

Associate an Unnamed Learner with existing Contacts

Argument Type Description
input AssociateUnnamedLearnerWithContactsInput!

The input type with the values used to associate a Learner with existing Contacts
createBlended : EventCreateResponse!

Creates an Blended Event

Argument Type Description
input BlendedEventCreateInput!

The input type with the values to create Blended Event
createClassroom : EventCreateResponse!

Creates a Classroom Event

Argument Type Description
input ClassroomEventCreateInput!

The input type with the values to create Classroom Event
createLMS : EventCreateResponse!

Creates an LMS Event

Argument Type Description
input LMSEventCreateInput!

The input type with the values to create LMS Event
createLmsResource : LmsResourceResponse!

Create an LMS Resource on an Event

Argument Type Description
input CreateLmsResourceInput!

The input type with the LMS Resource to be created on the Event
delete : DeleteMutationResponse!

Deletes a list of Events (only in draft state)

Argument Type Description
input DeleteInput!
deleteCost : EventCostResponse!

Deletes a Cost from an Event

Argument Type Description
costId ID!

The ID of the Cost to delete
deleteLmsResource : DeleteLmsResourceResponse!

Delete an LMS Resource on an Event

Argument Type Description
input DeleteLmsResourceInput!

The input type with the LMS Resource to be Deleted on the Event
deletePrices : EventPriceMutationResponse!

Deletes Event Prices

Argument Type Description
input [EventDeletePriceInput]!
deleteRequiredResource : EventUpdateResponse!

Delete an existing Required Resource on an Event

Argument Type Description
input EventResourceRequirementDeleteInput!

The input specifying the Required Resource to be deleted
deleteRequiredStaff : EventUpdateResponse!

Delete an existing Required Staff on an Event

Argument Type Description
input EventStaffRequirementDeleteInput!

The input specifying the Required Staff to be deleted
editAchievementType : EventUpdateResponse!

Edit Achievement Type on an Event

Argument Type Description
input EventEditAchievementTypeInput!

The input type with Achievement Type details to edit
registerAnonymousLearner : RegisterLearnerResponse!

Register an anonymous learner on an Event

Argument Type Description
eventId ID!

The ID of the Event to register learner on
input RegisterAnonymousLearnerInput!

The input type with details of the anonymous learner to be registered on the Event
registerNamedLearners : [EventRegisterContactsResponse!]!

Register contacts on an Event and specifies individual metadata and breakout group selection

Argument Type Description
input [EventRegisterNamedLearnerInput]!

The input type with the data for each contact to be registered on the Event
registerNewContacts : [EventRegisterContactsResponse!]!

Creates a new Contact for each input (with a new individual Account when individualContact is given) and registers it on the specified Event. A Contact remains persisted when its creation succeeds but its registration fails.

Argument Type Description
input [EventRegisterNewContactInput]!

The input type with the new Contact and registration data
registerPassholder : RegisterLearnerResponse!

Register a Learner on an Event using their Training Pass

Argument Type Description
input RegisterPassholderInput!

The details needed for registration
registerUnnamedLearner : RegisterLearnerResponse!

Register contacts on an Event

Argument Type Description
eventId ID!

The ID of the Event to register contacts on
input EventRegisterUnnamedLearnerInput!

The input type with the contacts to be registered on the Event
removeAchievementType : EventUpdateResponse!

Remove Achievement Type from an Event

Argument Type Description
input EventRemoveAchievementTypeInput!

The input type with Achievement Type details to be removed from an Event
removeStaff : EventUpdateResponse!

Remove staff from an event

Argument Type Description
input RemoveEventStaffInput!

The input type with staff details to be removed from an Event.
setStaffToPrimary : EventUpdateResponse!

Sets the Staff to primary on the Event

Argument Type Description
input SetStaffToPrimaryInput!

The input type with the staffId
update : EventUpdateResponse!

Updates the details of an Event

Argument Type Description
eventId ID!

The ID of the Event being updated
input EventUpdateInput!

The input type with the values to be updated
updateCost : EventCostResponse!

Updates a Cost on an Event

Argument Type Description
costId ID!

The ID of the Cost being updated
input EventCostUpdateInput!

the input type with cost details to be updated
updateCourseTemplateWithCascade : EventUpdateResponse!

Updates an Event using data from the specified Course Template. If no Course Template is specified, the Course Template already specified on the Event will be used.

Argument Type Description
eventId ID!

The ID of the Event being updated
input EventUpdateCourseTemplateWithCascadeInput!

The input type with the fields to pull from the Course Template
updateLearnersLmsAccessEndDate : EventUpdateResponse!

Bulk update LMS Access End Date ('expiresAt' field) for Learners registered on a given Event.

Argument Type Description
input UpdateLearnersLmsAccessEndDateInput!

Input parameters with options to choose an appropriate Learners' subset.
updateLearningMode : EventUpdateResponse!

Updates the Learning Mode of an Event

Argument Type Description
eventId ID!

The ID of the Event being updated
input UpdateEventLearningModeInput!

The input type with the Learning Mode to update the Event to
updateLmsResource : LmsResourceResponse!

Update an LMS Resource on an Event

Argument Type Description
input UpdateLmsResourceInput!

The input type with the LMS Resource to be Updated on the Event
updateLmsResourceCustomFields : LmsResourceResponse!

Update an LMS Resource Custom Fields on an Event

Argument Type Description
input UpdateLmsResourceCustomFieldsInput!

The input type with the LMS Resource Custom Fields to be Updated on the Event
updatePassingRules : EventUpdateResponse!

Updates the Passing Rules of an Event

Argument Type Description
eventId ID!

The ID of the Event being updated
input EventUpdatePassingRulesInput!

The input type with the values to be updated
updatePrices : EventPriceMutationResponse!

Updates Event Prices

Argument Type Description
input [EventUpdatePriceInput]!
updateRequiredResource : EventUpdateResponse!

Update an existing Required Resource on an Event

Argument Type Description
input EventResourceRequirementUpdateInput!

The input values to be updated on the Required Resource
updateRequiredStaff : EventUpdateResponse!

Update an existing Required Staff on an Event

Argument Type Description
input EventStaffRequirementUpdateInput!

The input values to be updated on the Required Staff
updateStaff : EventBulkUpdateResponse!

Update Staff on an Event

Argument Type Description
input [EventUpdateStaffInput]!

The input type with a list of Staff details to be updated on the Event
upsertBlendedEventByExternalId : [EventUpsertByExternalIdResponse!]!

Updates an Event identified by an External ID, or creates an Event with the External ID assigned by batch. There is a limit of 50 per batch submission

Argument Type Description
input [BlendedEventUpsertByExternalIdInput]!

The input type with the list of values to be set on the existing or new Event
upsertClassroomEventByExternalId : [EventUpsertByExternalIdResponse!]!

Updates an Event identified by an External ID, or creates an Event with the External ID assigned by batch. There is a limit of 50 per batch submission

Argument Type Description
input [ClassroomEventUpsertByExternalIdInput]!

The input type with the list of values to be set on the existing or new Event
upsertLMSEventByExternalId : [EventUpsertByExternalIdResponse!]!

Updates an Event identified by an External ID, or creates an Event with the External ID assigned by batch. There is a limit of 50 per batch submission

Argument Type Description
input [LMSEventUpsertByExternalIdInput]!

The input type with the list of values to be set on the existing or new Event
upsertLmsResourceByExternalId : [LmsResourceResponse!]!

Updates an LMS Resource identified by an External ID, or creates an LMS Resource with the External ID assigned by batch. There is a limit of 50 per batch submission

Argument Type Description
input [LmsResourceUpsertByExternalIdInput]!

The input type with the list of values to be set on the existing or new LMS Resource
Deprecated fields (1)
registerContacts : EventRegisterContactsResponse!

Register contacts on an Event

Removal date: 2026-11-25.

Replaced by registerNamedLearners

Argument Type Description
eventId ID!

The ID of the Event to register contacts on
input EventRegisterContactsInput!

The input type with the contacts to be registered on the Event
Back to top

EventNeed

Related types: Node

accountProject : AccountProject

The Account Project for this Event Need (for private schedules)

Argument Type Description
filters = [] [AccountProjectFieldGraphFilter]
order = "__EMPTY__" AccountProjectFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountProjectFieldGraphOrder]
courseTemplate : CourseTemplate!

The Course Template to be used when scheduling the Event

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
eventOrder : Int

The order of this Event Need within its Learning Path, if any

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of Event Need

instanceNumber : Int

The instance number of the Learning Path within the Plan, if any

learningPath : LearningPath

The Learning Path that this Event Need is associated with, if any

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
learningPathNeed : LearningPathNeed

The Learning Path Need that this Event Need belongs to, if any

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

location : Location

The Location for this Event Need. Defaults to the Schedule's Location if not set.

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
remoteMeetingHostContact : Contact

The Contact assigned as the meeting host for this Event Need

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
remoteMeetingHostStaffRole : StaffRole

The Staff Role assigned as the meeting host role for this Event Need

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
remoteMeetingType : String

The virtual classroom meeting provider for this Event Need

remoteMeetingUrl : String

The virtual classroom meeting URL for this Event Need

scheduledEvent : Event

The Event that has been scheduled to meet the Event Need

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
sessionNeeds : [SessionNeed!]!

List of Session Needs detailing which Sessions must be scheduled as part of the Plan

title : String

An optional override for this Event Need's display name. Falls back to the Course Template title when null.

Back to top

EventObjective

An Objective within a Learning Path's learning journey, representing an Event that must be completed in order to complete this Learning Path

Related types: Node LearningObjective

credits : Int

The number of credits that this LearningObjective represents

event : Event!

The Event for this Event Objective

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Event Objective

isMandatory : Boolean!

Denotes whether or not the LearningObjective is mandatory

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningObjective in the set of LearningPath objectives

Deprecated fields (1)
courseTemplate : CourseTemplate

The Course Template that this Event Objective Relates To

Removal date: TBD.

Course template can be queried on event

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
Back to top

EventPassingRules

achievementValidFrom : AchievementValidFromTypes

Determines when Achievements on the Event are valid from

allowedMissedSessions : Int

Number of missed sessions a Learner is allow to qualify as Passed upon Event completion

autoPassLearner : Boolean!

Determines if learners are marked as Passed upon Event completion

requireRegistrationInvoiceToBePaid : Boolean!

Determines if a Learner's registration invoice must be paid for them to qualify as Passed

Back to top

EventPersonnelIssue

One personnel issue on the Event, wrapped so it sits in the Event's issue list. Every personnel issue on the Event is one of these, so counting them counts the Event's personnel issues; personnelIssue carries the issue itself, in full, exactly as personnelIssues reports it. Present only under the Personnel Issues preview, which also takes scheduling conflicts out of InstructorConflictIssue.

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

contactId : ID!

The Contact ID of the personnel member the issue is about. Lives here rather than on personnelIssue, which is reported grouped by Contact elsewhere and so does not always name one itself

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

personnelIssue : PersonnelIssue!

The personnel issue itself — branch on its type for the conflicting booking, a rule's description, or whatever a later category adds

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

EventPrice

A price for an Event

Related types: FinancialAmount

amount : Decimal!

Total value of price

financialUnit : FinancialUnit!

Financial Unit of the Price (Currency or Token Type)

Argument Type Description
filters = [] [TrainingTokenTypeFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTypeFieldGraphOrder]
id : ID!

Id of the event price

priceLevel : PriceLevel

Price Level of the price

Argument Type Description
filters = [] [PriceLevelFieldGraphFilter]
order = "__EMPTY__" PriceLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PriceLevelFieldGraphOrder]
region : Region!

The Region where the Price is used

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

EventPriceConnection

A connection containing page information and edges for EventPrice

edges : [EventPriceEdge!]!

The list of EventPrice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventPriceEdge

Contains cursor and node information for type EventPrice

cursor : String!

A string that can be used for cursor-based pagination

node : EventPrice!

The EventPrice node.

Back to top

EventPriceField

An enumeration.

id
event_id
priceLevelId
Back to top

EventPriceFieldGraphFilter

Filter that can be applied to limit which EventPrice nodes are returned

field : EventPriceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventPriceFieldGraphOrder

Specifies the order in which EventPrice nodes are returned via the Connection

field : EventPriceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventPriceMutationResponse

A Response for mutating Event Prices

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

prices : [EventPrice!]!

The prices that were mutated

Back to top

EventRegisterContactsInput

An Input for registering Contacts on an Event

contacts : [ID]!

A list of Contact IDs to register on the Event

brandId : ID

The brand to set on the new registration. If not specified, each Contact's Account Brand or the System default Brand will be used

notes : String

Some test notes to associate with the Contact Event registration

financialUnitId : ID

The Financial Unit to use for this Learner price (Currency or Token Type ID)

amount : Decimal

The amount of the new Learner Prices

communicationsContactId : ID

An optional Contact ID that will receive all Communications relating to these new Event registrations

priceLevelId : ID

The Price Level to apply to the Learner (requires providing financialUnitId) - if amount is not provided, it will be set to the given Level's.

expiresAt : Date

An optional date when LMS access for this Learner will expire.

ccAddressesOnTriggers : [String]

A list of email addresses that will be CC'd on Trigger communications sent to the Contact

trainingPassTypeId : ID

The ID of a Training Pass Type to use for the registration

orderDate : LocalDateTime

An optional date to set as the Order date for this Registration

Back to top

EventRegisterContactsResponse

A Response for an Event Register Contacts Mutation

errors : [FieldError!]!

The errors returned by the mutation

event : Event

The Event that was updated

learners : [Learner!]

The Learners that were added to the Event

Back to top

EventRegisterNamedLearnerInput

An Input for registering Contacts in batches on an Event

eventId : ID!

The ID of the Event to register contacts on

contactId : ID!

The ID of the Contact to register onto the Event

brandId : ID

The brand to set on the new registration. If not specified, each Contact's Account Brand or the System default Brand will be used

notes : String

Some test notes to associate with the Contact Event registration

financialUnitId : ID

The Financial Unit to use for this Learner price (Currency or Token Type ID)

amount : Decimal

The amount of the new Learner Prices

communicationsContactId : ID

An optional Contact ID that will receive all Communications relating to these new Event registrations

priceLevelId : ID

The Price Level to apply to the Learner (requires providing financialUnitId) - if amount is not provided, it will be set to the given Level's.

expiresAt : Date

An optional date when LMS access for this Learner will expire.

ccAddressesOnTriggers : [String]

A list of email addresses that will be CC'd on Trigger communications sent to the Contact

trainingPassTypeId : ID

The ID of a Training Pass Type to use for the registration

orderDate : LocalDateTime

An optional date to set as the Order date for this Registration

breakoutGroups : [EventBreakoutGroupSelectionInput]

selection of Breakout Groups to assign the learner to

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues to set on the new Learner

accountId : ID

The Account to bill the new registration to, which must be one of the Contact's Accounts. Defaults to the Contact's primary Account

Back to top

EventRegisterNewContactInput

An Input for creating a new Contact and registering it on an Event

eventId : ID!

The ID of the Event to register the new Contact on

contact : ContactCreateInput

The details of the new Contact, who belongs to the given existing Account. Specify either this or individualContact

individualContact : ContactCreateIndividualAccountInput

The details of the new Contact, for whom a new individual Account is created. Specify either this or contact

brandId : ID

The brand to set on the new registration. If not specified, the Contact's Account Brand or the System default Brand will be used

notes : String

Some test notes to associate with the Contact Event registration

financialUnitId : ID

The Financial Unit to use for this Learner price (Currency or Token Type ID)

amount : Decimal

The amount of the new Learner Prices

communicationsContactId : ID

An optional Contact ID that will receive all Communications relating to these new Event registrations

priceLevelId : ID

The Price Level to apply to the Learner (requires providing financialUnitId) - if amount is not provided, it will be set to the given Level's.

expiresAt : Date

An optional date when LMS access for this Learner will expire.

ccAddressesOnTriggers : [String]

A list of email addresses that will be CC'd on Trigger communications sent to the Contact

trainingPassTypeId : ID

The ID of a Training Pass Type to use for the registration

orderDate : LocalDateTime

An optional date to set as the Order date for this Registration

breakoutGroups : [EventBreakoutGroupSelectionInput]

selection of Breakout Groups to assign the learner to

Back to top

EventRegisterUnnamedLearnerInput

An Input for registering Unnamed Learners on an Event

bookingContactId : ID!

The contact these unnamed learners are being booked on behalf of

quantity : Int!
brandId : ID

The brand to set on the new registration. If not specified, each Contact's Account Brand or the System default Brand will be used

notes : String

Some test notes to associate with the Contact Event registration

financialUnitId : ID

The Financial Unit to use for this Learner price (Currency or Token Type ID)

amount : Decimal

The amount of the new Learner Prices

priceLevelId : ID

The Price Level to apply to the Learner (requires providing financialUnitId) - if amount is not provided, it will be set to the given Level's.

expiresAt : Date

An optional date when LMS access for this Learner will expire.

ccAddressesOnTriggers : [String]

A list of email addresses that will be CC'd on Trigger communications sent to the Contact

breakoutGroups : [EventBreakoutGroupSelectionInput]

selection of Breakout Groups to assign the learner to

Back to top

EventRemoveAchievementTypeInput

An Input for removing Achievement Type from an Event

eventAchievementTypeId : ID!

The ID of Event Achievement Type to remove from the event.

Back to top

EventRequirement

Requirement Information on an Event and its sessions, currently only tracks Resource Requirements

code : String

A code used to refer to the Event

end : TimeZonedDateTime

The end TimeZonedDateTime of the event if available

fillRate : Float!

A percentage of how full this event is. If there is no limit to students, we return 1. Calculated with: (bookedPlaces + reserved) / maxPlaces

id : ID!

The Event ID

issues : [EventIssue!]!

Polymorphic list of every issue currently surfaced for this Event. Each entry implements the EventIssue interface; clients can branch on category or use type fragments to read subtype-specific fields. The list is pre-merged by EventIssuesFetcher — combining Administrate's synthesizer output with any Custom Business Rule results for the event — so the resolver just wraps each entry for GraphQL. Under the Personnel Issues preview it also carries the Event's personnel issues, one EventPersonnelIssue each, Custom Business Rules included, and scheduling conflicts arrive that way rather than as InstructorConflictIssue. Resource issues follow suit: one EventResourceIssue each, and booking conflicts, out-of-service and mislocated Resources arrive that way rather than as ResourceConflictIssue, InactiveResourceIssue and MislocatedResourceIssue.

learningMode : EventLearningMode!

The form the training takes for instance classroom or blended

lifecycleState : EventLifecycleState!

The state of the Event in its lifecycle

locationName : String

The name of the Location of the Event

sessions : [SessionRequirement!]!

A list of all sessions, if any, on the Event.

start : TimeZonedDateTime

The start TimeZonedDateTime of the event

targetFillRate : Float!

A target percentage for how much we want the event to be. If the event has a fillRate lower than this, we will display an issue. If this value is 0, no issue will be raised.

title : String!

Title of the Event

type : EventType!

Type of the Event (public/private)

Deprecated fields (8)
disqualifiedStaffContacts : [Contact!]!

The list of Contacts for any Staff that is not qualified to staff the Event

Removal date: 2026-09-15.

Use the issues field instead: a DisqualifiedStaffIssue is present per disqualified contact. Not emitted for LMS events.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
hasAllRequiredResources : Boolean!

True if all sessions have all required resources

Removal date: 2026-09-15.

Use the issues field instead: a MissingResourceTypeIssue is present when resources are missing.

hasInactiveInstructors : Boolean!

True if any session has at least one inactive instructor

Removal date: 2026-09-15.

Use the issues field instead: an InactiveInstructorIssue is present per inactive instructor. Not emitted for LMS events.

hasInactiveResources : Boolean!

True if any session has at least one booking for an inactive Resource

Removal date: 2026-09-15.

Use the issues field instead: an InactiveResourceIssue is present per inactive resource booking, or under the Personnel Issues preview an EventResourceIssue alongside every other resource issue on the Event.

hasInstructorConflicts : Boolean!

True if any session has at least one instructor conflict

Removal date: 2026-09-15.

Use the issues field instead: an InstructorConflictIssue is present per conflict, or under the Personnel Issues preview an EventPersonnelIssue alongside every other personnel issue on the Event.

hasInstructors : Boolean!

True if all sessions have at least one instructor

Removal date: 2026-09-15.

Use the issues field instead: a MissingInstructorIssue is present for each session without an instructor. Not emitted for LMS events, nor when any session on the event defines staff-role requirements (a MissingStaffRoleIssue is emitted instead).

hasMislocatedResources : Boolean!

True if any session has at least one booking for a Resource in a location different from the Session's

Removal date: 2026-09-15.

Use the issues field instead: a MislocatedResourceIssue is present per mislocated resource, or under the Personnel Issues preview an EventResourceIssue alongside every other resource issue on the Event.

hasResourceConflicts : Boolean!

True if any session has at least one Resource booking conflicts

Removal date: 2026-09-15.

Use the issues field instead: a ResourceConflictIssue is present per conflict, or under the Personnel Issues preview an EventResourceIssue alongside every other resource issue on the Event.

Back to top

EventRequirementConnection

A connection containing page information and edges for EventRequirement

edges : [EventRequirementEdge!]!

The list of EventRequirement edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventRequirementEdge

Contains cursor and node information for type EventRequirement

cursor : String!

A string that can be used for cursor-based pagination

node : EventRequirement!

The EventRequirement node.

Back to top

EventRequirementField

An enumeration.

id
rangeStart
rangeEnd
staffContactId
Back to top

EventRequirementFieldGraphFilter

Filter that can be applied to limit which EventRequirement nodes are returned

field : EventRequirementField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventReschedulingConflict

Details of conflicts for a potential Event or Session reschedule

conflictingResourceBookings : ResourceBookingConnection

Returns Resource Bookings which can not be automatically rescheduled because of the conflicts

Argument Type Description
filters = [] [ResourceBookingFieldGraphFilter]
order = "__EMPTY__" ResourceBookingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceBookingFieldGraphOrder]
conflictingStaff : StaffConnection

Returns Staff who can not be automatically rescheduled because of the conflicts

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
hasResourceConflicts : Boolean!

Whether or not there are Resource Booking conflicts

hasStaffConflicts : Boolean!

Whether or not there are Staff conflicts

resourcesWithConflictingBookings : [ResourcesWithConflictingBookings!]!

Returns Resources which can not be automatically rescheduled with their conflicting Resource Bookings

staffWithConflicts : [StaffWithConflicts!]!

Returns Staff who can not be automatically rescheduled with their conflicts

Back to top

EventReschedulingConflictInput

An Input for fetching potential Event rescheduling conflicts

eventId : ID!

The ID of the Event or Session to be rescheduled

startDateTime : LocalDateTime!

Potential new start date of the Event or Session

endDateTime : LocalDateTime!

Potential new end date of the Event or Session

timeZoneName : String!

Potential new time zone name of the Event or Session

status : EventStatus

Potential new Status of the Event or Session

Back to top

EventResourceIssue

One resource issue on the Event, wrapped so it sits in the Event's issue list. Every resource issue on the Event is one of these, so counting them counts the Event's resource issues; resourceIssue carries the issue itself, in full, exactly as resourceIssues reports it. Present only under the Personnel Issues preview, which also takes booking conflicts, out-of-service and mislocated Resources out of ResourceConflictIssue, InactiveResourceIssue and MislocatedResourceIssue.

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

EventResourceRequirement

A Resource Requirement specification for an Event

allSessions : Boolean!

If true, all Event Sessions require this Resource.

id : ID!

ID of the Event Resource Requirement

quantity : Int!

The quantity of Resources Required

resourceType : ResourceType!

The Resource Type required

Argument Type Description
filters = [] [ResourceTypeFieldGraphFilter]
order = "__EMPTY__" ResourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceTypeFieldGraphOrder]
sessions : [Session!]!

The Event Sessions that require this Resource

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
Back to top

EventResourceRequirementCreateInput

An Input for creating a Resource Requirement on an Event

eventId : ID!

The ID of the Event

resourceTypeId : ID!

The ID of the Resource Type required

quantity : Int

The number of Resources required, defaults to 1

sessionIds : [ID]

Optional list of Session IDs to assign required Resources

Back to top

EventResourceRequirementDeleteInput

An Input for deleting a Resource Requirement from an Event

requiredResourceId : ID!

The ID of the Resource Requirement

Back to top

EventResourceRequirementField

Fields for filtering and ordering Event Resource Requirements

id
Back to top

EventResourceRequirementFieldGraphFilter

Filter that can be applied to limit which EventResourceRequirement nodes are returned

field : EventResourceRequirementField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventResourceRequirementFieldGraphOrder

Specifies the order in which EventResourceRequirement nodes are returned via the Connection

field : EventResourceRequirementField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventResourceRequirementUpdateInput

An Input for editing a Resource Requirement on an Event

requiredResourceId : ID!

The ID of the Resource Requirement

resourceTypeId : ID

The ID of the new Resource Type

quantity : Int

The new number of Resources required; null leaves the current quantity unchanged

sessionIds : [ID]

Optional list of new Session IDs to assign required Resources

Back to top

EventSentEmail

An automated Email sent for an Event.

body : String

The Body of the Email.

ccAddresses : String

The addresses the Email was copied to.

id : ID!

The ID of the Email.

sentAt : TimeZonedDateTime

When the Email was sent, in UTC. The rest of the audit trail is offset-bearing UTC. Handing a browser a bare local-looking timestamp would sort this row hours out of place, and the merge decides which page it lands on.

status : String

How the Email ended up: sent, bounced, rejected...

subject : String

The Subject of the Email.

toAddress : String

The address the Email was sent to.

Back to top

EventSentEmailConnection

A connection containing page information and edges for EventSentEmail

edges : [EventSentEmailEdge!]!

The list of EventSentEmail edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventSentEmailEdge

Contains cursor and node information for type EventSentEmail

cursor : String!

A string that can be used for cursor-based pagination

node : EventSentEmail!

The EventSentEmail node.

Back to top

EventSentEmailField

Fields for filtering and ordering an Event's sent Emails.

id
eventId
sentAt
Back to top

EventSentEmailFieldGraphFilter

Filter that can be applied to limit which EventSentEmail nodes are returned

field : EventSentEmailField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventSentEmailFieldGraphOrder

Specifies the order in which EventSentEmail nodes are returned via the Connection

field : EventSentEmailField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventStaffConflict

Details of a member of Staff's conflict

id : ID!

The ID of the Event involved in the conflict

parentId : ID

The ID of the Parent Event to which the Event involved in the conflict belongs

reason : String

The reason for the conflict

timeZonedEnd : TimeZonedDateTime!

The end time of the Event involved in the conflict

timeZonedStart : TimeZonedDateTime!

The start time of the Event involved in the conflict

title : String

The title of the Event involved in the conflict

type : String!

The type of Event involved in the conflict

unconfirmed : Boolean!

Whether attendance to this event is not confirmed

Back to top

EventStaffInput

An Input for adding new Staff to an Event

contactId : ID!

The ID of the Contact to be added as Staff for this Event.

eventId : ID!

The ID of the Event to add the Staff to.

staffRoleId : ID

The ID of the Role this Staff should be added to the Event as.

staffType : StaffType

DEPRECATED (replaced by staffRoleId) - The type of staff to be added

notes : String

The notes about this particular booking of the Staff in question

requiredSessionsOnly : Boolean

If false (default), the Staff will be booked on all the Sessions of the Event. If true, the Staff will be booked only on the Event Sessions that require the Staff Role

customFieldValues : [CustomFieldValueInput]

The list of Custom Fields for this Staff

Back to top

EventStaffRequirement

A staff requirement specification for an Event

achievementTypes : [AchievementType!]!

The achievement types required for this staff requirement

Argument Type Description
filters = [] [AchievementTypeFieldGraphFilter]
order = "__EMPTY__" AchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementTypeFieldGraphOrder]
allSessions : Boolean!

If true, all event sessions require this staff.

id : ID!

ID of the staff requirement

quantity : Int!

The quantity of staff required

sessions : [Session!]!

The session_templates that require this staff

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
staffRole : StaffRole!

The staff role required

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
Back to top

EventStaffRequirementCreateInput

An Input for creating a Staff Requirement on an Event

eventId : ID!

The ID of the Event

staffRoleId : ID!

The ID of the Staff Role required

quantity : Int

The number of Staff required, defaults to 1

sessionIds : [ID]

Optional list of Session IDs to assign required Staff

requiredAchievementTypeIds : [ID]

Optional list of Achievement Type IDs required for staff in this Staff Requirement

Back to top

EventStaffRequirementDeleteInput

An Input for deleting a Staff Requirement from an Event

requiredStaffId : ID!

The ID of the Staff Requirement

Back to top

EventStaffRequirementField

Fields for filtering and ordering Event Staff Requirements

id
Back to top

EventStaffRequirementFieldGraphFilter

Filter that can be applied to limit which EventStaffRequirement nodes are returned

field : EventStaffRequirementField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventStaffRequirementFieldGraphOrder

Specifies the order in which EventStaffRequirement nodes are returned via the Connection

field : EventStaffRequirementField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventStaffRequirementUpdateInput

An Input for editing a Staff Requirement on an Event

requiredStaffId : ID!

The ID of the Staff Requirement

staffRoleId : ID

The ID of the new Staff Role

quantity : Int

The new number of Staff required; null leaves the current quantity unchanged

sessionIds : [ID]

Optional list of new Session IDs to assign required Staff

requiredAchievementTypeIds : [ID]

Optional list of Achievement Type IDs required for staff in this Staff Requirement

Back to top

EventStats

Statistics on events, supports Whole slices

sliceResolution : SliceResolution!

The resolution of time to group the statistics by

slices : [EventStatsSlice!]!

Stub of event slices

timeRange : TimeRange!

The Time Range the statistics will be aggregated over

total : Int!

Total number of non deleted events of any lifecycle in the given filter range

totalSessions : Int!

Total number of non deleted sessions of any lifecycle on the events in the given filter range

Back to top

EventStatsSlice

Slices of Event Statistics, a stub for now

filterFrom : TimeZonedDateTime!

The start time of this slice derived from the time range

filterTo : TimeZonedDateTime!

The end time of this slice derived from the time range

pageInfo : PageInfo!

Information about the pages (batches) of event statistics returned

Back to top

EventStatus

The status of an Event

Draft
Active
Inactive
Cancelled
Back to top

EventTag

A legacy Event Tag.

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Event Tag.

isDeleted : Boolean!

Whether the Event Tag has been deleted.

isDormant : Boolean!

Whether the Event Tag is dormant.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Event Tag.

order : Int!

The display order of the Event Tag.

Back to top

EventTaskCreateInput

An Input for creating an Event Task

taskTypeId : ID!

The ID of the Task Type

name : String!

The name of the Task

eventId : ID!

The ID of the Event the Task is linked to

dueDate : LocalDateTime!

The due date of the Task

timeZoneName : String!

The timezone of the Task

userId : ID

The ID of the User to assign the Task to

staffRoleId : ID

The ID of the Staff Role this Task is for. Task will be assigned to the User for the first Personnel with the role added to the Event

description : String

The description of the Task

status : TaskStatus

The Status of the Task

showOnCalendar : Boolean

Whether to display this Task on the calendar

endDate : LocalDateTime

The end date of the Task

Back to top

EventTemplate

Event Templates are attached to courses to define the structure of the event.

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Event Template

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Event Template

Back to top

EventTemplateConnection

A connection containing page information and edges for EventTemplate

edges : [EventTemplateEdge!]!

The list of EventTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

EventTemplateEdge

Contains cursor and node information for type EventTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : EventTemplate!

The EventTemplate node.

Back to top

EventTemplateField

Fields for filtering and ordering Event Templates

id
name
Back to top

EventTemplateFieldGraphFilter

Filter that can be applied to limit which EventTemplate nodes are returned

field : EventTemplateField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

EventTemplateFieldGraphOrder

Specifies the order in which EventTemplate nodes are returned via the Connection

field : EventTemplateField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

EventType

The type of an Event

public
private
Back to top

EventUpdateCourseTemplateWithCascadeInput

An Input for updating and cascading changes from a Course Template to draft Events

fieldsToCascade : [CascadableFields]!

The list of Course Template fields to pull data from.

courseTemplateId : String

The ID of the Course Template to cascade attributes from. If not specified, the existing Course Template for the Event will be used.

Back to top

EventUpdateInput

An Input for updating an Event

title : String

The title of the Event

code : String

The course code of the Event

locationId : ID

The location of the Event

taxTypeId : ID

The taxation type of the Event

timeZoneName : String

The timezone of the Event

lifecycleState : EventLifecycleState

The lifecycle of the Event

minPlaces : Int

Minimum number of booked learners required for the Event.

maxPlaces : Int

Maximum number of bookable slots for the Event

targetFillRate : Int
achievementTypeId : ID

The achievement type id of the event

achievementValidFrom : AchievementValidFromTypes

Since when the achievement is valid

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Event to update

privateEventDetails : PrivateEventDetailsUpdateInput

Private event details to update

lmsStartDateTime : LocalDateTime

The LMS start date and time (without a timezone). Only Blended and LMS Events can have their LMS dates updated - setting it on a Classroom Event is an error. Applied directly, and the Event's overall start is adjusted to match. Classroom session dates are not changed by this mutation.

lmsEndDateTime : LocalDateTime

The LMS end date and time (without a timezone), or null to clear it. Only Blended and LMS Events can have their LMS dates updated. Applied directly, and the Event's overall end is adjusted to match.

timeZonedLmsStart : TimeZonedDateTime

The same as lmsStartDateTime but with a timezone.

timeZonedLmsEnd : TimeZonedDateTime

The same as lmsEndDateTime but with a timezone, or null to clear it.

registrationDeadline : LocalDateTime

The registration deadline of the Event

registrationOpensAt : LocalDateTime

The date and time Registration for the Event opens

localeId : ID

The locale of the Event

remoteMeetingId : String

The id of the remote meeting

remoteMeetingUrl : String

The url of the remote meeting

remoteMeetingType : RemoteMeetingType

The type of the remote meeting

remoteMeetingHostContactId : ID
remoteMeetingHostStaffRoleId : ID
webConferencingIntegrationId : ID

DEPRECATED - this input does nothing

courseTemplateId : ID

The ID of a Course Template to link this Event to. Only applies to draft events.

isSoldOut : Boolean

Sets if Event is sold out

externalNotes : String

Any external notes for the event

internalNotes : String

Any internal notes for the event

lmsAnnouncements : String

Any notes specifically for the LMS

taskWorkflowGroupIds : [ID]

Optional list of task workflows to add to this event - DEPRECATED (replaced by taskWorkflowIds)

taskWorkflowIds : [ID]

Optional list of task workflows to add to this event

Back to top

EventUpdatePassingRulesInput

An Input for updating Passing Rules on an Event

autoPassLearner : Boolean

Flag to determine if Learners are marked as Passed upon Event completion

allowedMissedSessions : Int

Number of missed sessions a Learner is allowed to qualify as Passed upon Event completion

achievementValidFrom : AchievementValidFromTypes

From when the Achievement is Valid

requireRegistrationInvoiceToBePaid : Boolean
Back to top

EventUpdatePriceInput

An Input for updating an Event's Price amount and/or to set it as the Event's default Price. Changing the Price Level, Currency or Token Type requires deleting the old price and creating a new one

eventPriceId : ID!

the ID of the Event Price to update

amount : Decimal

the price amount (must be a positive Decimal)

isDefault : Boolean

whether to set this Price as a default Price for the Event

Back to top

EventUpdateResponse

A Response for an Event Update Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

event : Event

The Event that was updated

Back to top

EventUpdateStaffInput

An Input for updating Staff on a Event

staffId : ID!

The ID of the Staff being updated

notes : String

Notes on the Staff to be updated

customFieldValues : [CustomFieldValueInput]

The list of Custom Fields for this Staff

Back to top

EventUpsertByExternalIdResponse

A Response for an Event upsertByExternalId Mutation, also exposing the Sessions that were created or updated on the Event.

errors : [FieldError!]!

The errors returned by the mutation

event : Event

The Event that was created

sessions : [Session!]!

The Sessions that were created or updated on the Event

Back to top

ExistingLearnerDetail

Details of existing Learners associated with an Interest

Related types: LearnerDetail

attributes : [CustomFieldValue!]!

The attributes of the Existing Learner

Argument Type Description
filter CustomFieldFilterInput
communicationsCcAddresses : [String!]!

Additional email addresses that will be included as CC in all Learner communications

communicationsContact : Contact

The Contact to whom all communications regarding this Learner will be sent to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
contact : Contact!

The Contact associated with the existing Learner

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
id : ID!

ID of the Content

Back to top

ExistingLearnerOpportunityInterest

An Input containing the contact details to be linked to a new learner

id : ID!

The ID of the contact to be linked to the new learner

notes : String

Notes regarding the new Learner

communicationsContactId : String

The ID of a Contact to whom all communications regarding this Learner will be sent to

communicationsCcAddresses : [String]

Additional email addresses that will be included as CC in all Learner communications

Back to top

ExpiredInterestsRemoveInput

An Input to remove expired Event or Learning Path Interests from an Opportunity

opportunityId : ID!

The ID of the Opportunity for which to remove expired interests

Back to top

ExternalActivityAttempt

Related types: LmsAttempt Node

accompanyingDocumentation : String

Accompanying documentation that is stored along with the progress of this External Activity

completedAt : TimeZonedDateTime

The date and time when the Attempt was completed

completedByAdmin : Boolean!

Whether the Attempt has been manually completed by an Admin

content : LmsContent!

The Attempt's Content

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Attempt

isCompleted : Boolean!

Whether the Attempt has been completed

isPassed : Boolean!

Whether the Attempt has been passed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

updatedAt : TimeZonedDateTime

The date and time when the Attempt was updated

Back to top

ExternalActivityContentResult

A summary of results for a Learner's External Activity

Related types: LearnerContentResult

completedAttempts : Int!

The number of complete attempts the Learner has had on this EventContent

content : LmsContent!

The EventContent this result relates to

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
contentId : ID!

The ID to the piece of EventContent this result relates to

id : ID!

The ID of the LearnerContentResult

isRequired : Boolean

Whether the EventContent is required for the Learner to complete the Event

lastAccessed : TimeZonedDateTime

The date and time when the EventContent was last accessed

latestAttempt : ExternalActivityAttempt

Information on the last attempt the Learner made on the External Activity Content

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
lmsAttempts : LmsAttemptConnection!

The learner attempts on the EventContent

Argument Type Description
filters = [] [LmsAttemptFieldGraphFilter]
order = "__EMPTY__" LmsAttemptFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LmsAttemptFieldGraphOrder]
numberOfAttempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

progress : Decimal

The percentage complete the Learner has achieved on the EventContent

score : Decimal

The score the Learner has achieved on the EventContent

scorePercent : Decimal

The score percent the Learner has achieved on the EventContent

status : ContentResultStatus!

The current status of the EventContent

Deprecated fields (1)
attempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

Removal date: TBD.

Replaced by numberOfAttempts

Back to top

ExternalActivityStatus

An enumeration.

completed
passed
failed
Back to top

ExternalCalendarEvent

An External Calendar Event

Related types: Node ContactBookingEntity

contact : Contact!

The Contact the External Event is for

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
contactId : ID!

ID of the Contact the External Calendar Event is for

end : TimeZonedDateTime!

The UTC End of the External Calendar Event

externalIdentifier : String!

The External ID for the External Calendar Event

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the External Calendar Event

isTentative : Boolean!

Whether the External Calendar Event is tentative

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

sourceIdentifier : String!

The source identifier for the External Calendar Event

start : TimeZonedDateTime!

The UTC Start of the External Calendar Event

title : String

The title of the External Calendar Event

Back to top

ExternalCalendarEventAssignInput

An input for assigning External Calendar Events

contactId : ID!

The contact assigned to the external event

sourceIdentifier : String!

Identifies the source of the external event

externalIdentifier : String!

Uniquely identifies the external event

start : TimeZonedDateTime!

a timezone-aware ISO Datetime specifying the start of the event

end : TimeZonedDateTime!

a timezone-aware ISO Datetime specifying the end of the event

title : String

The title of the external event

isTentative : Boolean

Whether the external event is tentative

Back to top

ExternalCalendarEventConnection

A connection containing page information and edges for ExternalCalendarEvent

edges : [ExternalCalendarEventEdge!]!

The list of ExternalCalendarEvent edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ExternalCalendarEventEdge

Contains cursor and node information for type ExternalCalendarEvent

cursor : String!

A string that can be used for cursor-based pagination

node : ExternalCalendarEvent!

The ExternalCalendarEvent node.

Back to top

ExternalCalendarEventField

Fields for filtering and ordering External Calendar Events If start is not specified, it will default to a year ago from now.

id
contactId
sourceIdentifier
externalIdentifier
start
end
Back to top

ExternalCalendarEventFieldGraphFilter

Filter that can be applied to limit which ExternalCalendarEvent nodes are returned

field : ExternalCalendarEventField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ExternalCalendarEventFieldGraphOrder

Specifies the order in which ExternalCalendarEvent nodes are returned via the Connection

field : ExternalCalendarEventField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ExternalCalendarEventMutationResponse

A response from mutating an External Calendar Event

Related types: MutationResponse

entityIds : [ID!]!

The entity IDs that were updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ExternalCalendarEventRemoveInput

An input for removing External Calendar Events

contactId : ID!

The Contact ID for which the events should be removed

sourceIdentifier : String!

The source identifier of the External Events to remove

eventIds : [ID]

Restricts the removal to these External Calendar Events. When omitted, every event matching the Contact and source identifier is removed

Back to top

ExternalCalendarEventRemoveResponse

A response from removing External Calendar Events

Related types: MutationResponse

count : Int!

The count of the removed calendar events

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ExternalCalendarEventUpdateInput

An input for updating External Calendar Events

id : ID!

The ID of the external event to update

contactId : ID!

The contact assigned to the external event

sourceIdentifier : String!

Identifies the source of the external event

externalIdentifier : String!

Uniquely identifies the external event

start : TimeZonedDateTime!

a timezone-aware ISO Datetime specifying the start of the event

end : TimeZonedDateTime!

a timezone-aware ISO Datetime specifying the end of the event

title : String

The title of the external event

isTentative : Boolean

Whether the external event is tentative

Back to top

ExternalConfiguration

The Configurations of External Integrations

Related types: Node

createdAt : TimeZonedDateTime!

The DateTime this External Configuration was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this External Configuration

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of this External Configuration

updatedAt : TimeZonedDateTime!

The DateTime this External Configuration was updated

value : String!

The name of this External Configuration

Back to top

ExternalConfigurationConnection

A connection containing page information and edges for ExternalConfiguration

edges : [ExternalConfigurationEdge!]!

The list of ExternalConfiguration edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ExternalConfigurationCreateInput

The input type with the External Configuration details to be created

name : String!

The name this External Configuration will be stored as

value : String!

The JSON formatted string that will be stored with this External Configuration

Back to top

ExternalConfigurationEdge

Contains cursor and node information for type ExternalConfiguration

cursor : String!

A string that can be used for cursor-based pagination

node : ExternalConfiguration!

The ExternalConfiguration node.

Back to top

ExternalConfigurationField

Fields for filtering and ordering External Configurations

id
name
Back to top

ExternalConfigurationFieldGraphFilter

Filter that can be applied to limit which ExternalConfiguration nodes are returned

field : ExternalConfigurationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ExternalConfigurationFieldGraphOrder

Specifies the order in which ExternalConfiguration nodes are returned via the Connection

field : ExternalConfigurationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ExternalConfigurationMutations

Mutations for External Configurations

createExternalConfiguration : ExternalConfigurationResponse!

Creates an External Configuration to store configuration details

Argument Type Description
input ExternalConfigurationCreateInput!
updateExternalConfiguration : ExternalConfigurationResponse!

Updates an External Configuration's fields

Argument Type Description
input ExternalConfigurationUpdateInput!
Back to top

ExternalConfigurationResponse

A Response from mutating an External Configuration

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

externalConfiguration : ExternalConfiguration

The External Configuration that was mutated

Back to top

ExternalConfigurationUpdateInput

The input type with the External Configuration details to be updated

id : ID!

The ID of the External Configuration

name : String

The name this External Configuration will be stored as

value : String

The JSON formatted string that will be stored with this External Configuration

Back to top

ExternalId

An identifier which can be associated with a node as an alternative means of lookup

name : String!

A name identifying the External ID

value : String

The value of the identifier provided by the external system

Back to top

ExternalIdDefinition

Defines an External ID that can be associated with a particular type of entity (e.g. a "salesforce_id" External ID for Accounts).

administrateEntity : String!

The Administrate entity string this definition applies to (e.g. Accounts). Matches the value previously returned by the v2.5 /external_ids/schema REST endpoint.

administrateEntityLabel : String!

Titleized label for the Administrate entity (e.g. token_issue -> Token Issue).

id : ID!

The ID of the External ID Definition

label : String!

Human-readable label for this definition. Falls back to the definition name when the underlying label is unset (matches the existing ExternalId.get_label() convention).

name : String!

The name of the External ID definition (e.g. salesforce_id)

Back to top

ExternalIdDefinitionConnection

A connection containing page information and edges for ExternalIdDefinition

edges : [ExternalIdDefinitionEdge!]!

The list of ExternalIdDefinition edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ExternalIdDefinitionEdge

Contains cursor and node information for type ExternalIdDefinition

cursor : String!

A string that can be used for cursor-based pagination

node : ExternalIdDefinition!

The ExternalIdDefinition node.

Back to top

ExternalIdEntity

A container for an External ID result with the External ID value and the entity associated with it

Related types: Node

entity : Node!

The entity associated to the found external ID

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Entity for which the External ID is set

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

A name identifying the External ID

value : String

The value of the identifier provided by the external system

Back to top

ExternalIdEntityConnection

A connection containing page information and edges for ExternalIdEntity

edges : [ExternalIdEntityEdge!]!

The list of ExternalIdEntity edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ExternalIdEntityEdge

Contains cursor and node information for type ExternalIdEntity

cursor : String!

A string that can be used for cursor-based pagination

node : ExternalIdEntity!

The ExternalIdEntity node.

Back to top

ExternalIdInput

An Input for an identifier which can be associated with a node as an alternative means of lookup

name : String!

A name identifying the External ID

value : String!

The value of the identifier provided by the external system

Back to top

ExternalIDMutations

Operations which allow you to associate an identifier with a node as an alternative means of lookup

remove : Node

Disassociate an External ID for a particular definition from an existing record

Argument Type Description
nodeId ID!

The record which has the External ID
name String!

The identifier's type (case insensitive)
store : Node!

Associate an External ID for a particular definition against an existing record

Argument Type Description
nodeId ID!

The record which should store the External ID
name String!

The identifier's type, used for segmentation and to enforce uniqueness (case insensitive)
value String!

How the record will be identified
overwrite = false Boolean

If true replace any existing value with the provided value. If false, attempting to set a value for an existing definition will return an error. Default: false.
Back to top

ExternalIntegrationLogBulkCreateInput

The input type for creating External Integration Logs in bulk. It does not support providing notification emails, which are only supported when creating a single External Log

message : String!

The message of the log

originIdentifier : String!

An identifier used to associate logs from the same external source

nodeId : ID!

The ID of the Node entity to log against

status : ExternalLogTypeStatus

The status of this log

webConferencingIntegrationId : ID

DEPRECATED - this does nothing

payload : String

The JSON containing the data payload of the log

internalLogMetadata : InternalLogMetadataInput

additional log details to record internally for the Log event

Back to top

ExternalIntegrationLogCreateInput

The input type with the values used to create an External Integration Log

message : String!

The message of the log

originIdentifier : String!

An identifier used to associate logs from the same external source

nodeId : ID!

The ID of the Node entity to log against

status : ExternalLogTypeStatus

The status of this log

webConferencingIntegrationId : ID

DEPRECATED - this does nothing

payload : String

The JSON containing the data payload of the log

internalLogMetadata : InternalLogMetadataInput

additional log details to record internally for the Log event

notificationEmails : [String]

if specified, sends an email to the specified addresses with the log message and a link to view the detials in the TMS

Back to top

ExternalLinkIcon

An enumeration.

accessPoint
adjust
airplane
alarm
alignBottom
alignHorizontal
alignLeft
alignRight
alignTop
alignVertical
ambulance
anchor
announcement
apple
archive
arrowDown
arrowLeft
arrowRight
arrowThinDown
arrowThinLeft
arrowThinRight
arrowThinUp
arrowUp
artificialIntelligence
asianFood
audioDescription
audioDescriptionD
ax
axesThreeDimensional
axesTwoDimensional
backpack
badminton
bag
balanceScales
balloon
balloons
bank
banknotes
barbedWire
barcode
barrel
bars
baseball
basket
basketCheck
basketCheckout
basketIn
basketOut
basketball
bath
batteryCharged
batteryCharging
batteryHalf
batteryLow
batteryQuarter
batteryThreeQuarters
beachUmbrella
bed
bedSingle
bedSleeping
beer
beerAlt
bell
bellOff
bellRinging
bicycle
bin
binoculars
biohazard
bishop
bitcoin
blackboard
blacksmith
blender
blockMove
boat
bold
bomb
book
bookAddress
bookLibrary
bookLibrarySearch
bookLog
bookOpen
bookOpenText
bookPlay
bookmark
bowling
brain
brainAi
brickWall
briefcase
briefcaseAlt
brightnessDown
brightnessUp
bringForward
bringToFront
brush
bug
building
buildingsCity
buildingsMixed
buildingsPark
bullets
buoy
bus
cableway
cake
calculator
calendar
call
callData
callIncoming
callIp
callLock
callMusic
callOutgoing
callPause
callRecord
callRedirect
callVideo
camera
campfire
candle
canister
car
carBattery
carRental
carWheel
carWheelDefect
carWheelWrench
carWheelWrenchAlt
cardClubs
cardDiamonds
cardHearts
cardSpades
carrot
cars
cart
cartCheck
cartCheckout
cartIn
cartOut
cashRegister
cashRegisterAlt
cat
cd
certificate
chargingStation
chatConversation
chatConversationLock
chatConversationOff
chatMessage
chatMessageCheck
chatMessageLock
check
chemistry
chemistryAlt
cheque
chequeOff
chevronDown
chevronLastDown
chevronLastLeft
chevronLastRight
chevronLastUp
chevronLeft
chevronRight
chevronUp
circleAlert
circleCheck
circleDown
circleEmpty
circleEmptyAlert
circleEmptyCheck
circleEmptyDown
circleEmptyInfo
circleEmptyLeft
circleEmptyMinus
circleEmptyPlay
circleEmptyPlus
circleEmptyQuestion
circleEmptyRemove
circleEmptyRight
circleEmptyUp
circleHospital
circleInfo
circleLeft
circleMenu
circleMinus
circleMore
circlePlay
circlePlus
circleQuestion
circleRedCross
circleRemove
circleRight
circleSelected
circleUp
clawHammer
clean
clipboard
clock
cloud
cloudAlert
cloudCheck
cloudDownload
cloudOff
cloudPause
cloudRefresh
cloudUpload
cluster
code
coffeeBeans
coffeeMug
coffeeToGo
cogwheel
cogwheels
coins
comments
commentsLock
commentsOff
compass
compound
computer
computerAllInOne
computerNetwork
computerNetworkAlt
computerPcTower
constructionCone
contactless
contactlessLock
contrast
cookie
cookieAlt
cookies
cooksHat
copy
copyDuplicate
corn
cot
courtGavel
courtGavelAlt
credit
creditCard
creditCardOff
creditEmpty
crop
crown
cup
curves
cutlery
dashboard
database
databaseMinus
databasePlus
databaseSearch
diamond
dice
diceFive
diceFour
diceOne
diceSix
diceThree
diceTwo
direction
directionEmpty
directionFull
directions
directionsArrow
directionsSign
disappearing
dishwasher
divingFree
divingScuba
division
dna
dog
dogTags
dollar
door
doorClose
doorOpen
dress
drink
drinkingWater
drinkingWaterOff
drop
dropDown
dropOff
dropPlus
dryer
dumbbell
dustbin
ear
earOff
earphones
education
egg
eject
electricCord
email
envelope
envelopeDown
envelopeEmpty
envelopeFlag
envelopeFull
envelopeLock
envelopeMinus
envelopeNo
envelopePlus
envelopeStar
envelopeUp
equalizerBars
equalizerDots
equals
eraser
euro
exchange
export
eye
eyeOff
eyedropper
fabric
factory
factoryAlt
fan
fastFood
fax
feather
female
fence
file
fileCloud
fileLock
fileMinus
filePlus
fileRefresh
filesQueue
fill
film
filter
filterCogwheel
filterMinus
filterOff
filterPlus
fingerprint
fingerprintCheck
fingerprintLock
fingerprintRemove
fingerprintScan
finishLine
fins
fire
firefighters
fireplace
fireworks
fireworksAlt
fish
fishes
fishesBait
flag
flagTriangle
flagWaving
flash
flashAutomatic
flashNo
flashlight
flower
folder
folderAlert
folderCheck
folderCogwheel
folderLock
folderMinus
folderNo
folderOpen
folderPlus
folderRefresh
folderStar
font
foodService
football
footprints
forest
forklift
forward
forwardEmail
forwardFifteen
forwardFive
forwardTen
forwardThirty
frenchPress
fullscreen
fullscreenOff
gameController
gameControllerWireless
gas
gasStation
gay
gift
glass
glassWine
globe
globeData
golf
golfGreen
government
graphicTablet
graphicTabletWireless
grater
gun
gunOff
hairdresser
hammer
handDislike
handDonate
handHeart
handLike
handOk
handOpen
handOpenAlt
handPointingDown
handPointingLeft
handPointingRight
handPointingUp
handPraying
handshake
hanger
hardDrive
hardDriveCogwheel
hardDriveEject
hardDriveLock
hardDriveNo
hash
header
headphones
headset
heart
heartBroken
heartEmpty
heartbeat
heating
hetero
highway
history
hob
hockey
home
homeFire
homeFlag
homeFlood
homeForSale
honey
honeybee
honeycombs
hourglass
iceCream
iceCreamOff
iceLolly
iceLollyEaten
id
idBadge
idBadgeLanyard
idBadgeVertical
idBinder
import
inbox
inboxDown
inboxLock
inboxMinus
inboxPlus
inboxUp
indentLeft
indentRight
initialLetter
intersex
invoice
italic
kettle
kettlebell
key
keyRounded
keyboard
keyboardWireless
king
kiosk
kioskFood
kioskImmobile
kioskWheels
knight
lamp
lampTable
lasso
lawnMower
layers
layersCogwheel
layersDown
layersLock
layersMinus
layersPlus
layersUp
leaf
leather
legalSectionSign
lesbian
lightBeacon
lightbulb
lighter
linkRemove
list
listLetters
listNumbers
lock
lockOff
lockOpen
logIn
logOut
lp
luggage
luggageAlt
magicWand
magnet
male
map
mapAerial
mapCadastral
mapMarker
mapSatellite
mapTourist
marker
marriage
mc
meat
medal
medicine
memoryCard
memoryCardCogwheel
memoryCardEject
memoryCardLock
memoryCardNo
menu
menuClose
metro
mic
micOff
microchip
microwave
milk
minus
missile
mobilePhone
mobilePhoneAlert
mobilePhoneCheck
mobilePhoneCogwheel
mobilePhoneLock
mobilePhoneOff
mobilePhoneShaking
mobilePhoneVibrations
modalWindow
monitor
monitorRotate
monitorVertical
monitors
moon
more
moreVertical
motorOil
motorbike
mountains
mouse
mouseWireless
multifunctionKnife
multifunctionPrinter
music
musicAlt
nearby
nearbyAlt
neighborhood
newspaper
noSymbol
notebook
notes
nuts
octagonRemove
octagonRemoveEmpty
oneDayDelivery
open
other
oven
oxygenBottles
package
paired
pairedOff
palette
palettePackage
paperclip
paragraphCenter
paragraphJustify
paragraphLeft
paragraphRight
park
parking
parkingMeter
passport
passportAlt
paste
pause
pawn
payment
pen
pencil
personalHygiene
phoneHorizontal
phoneOld
phoneRotate
phoneToHorizontal
picture
piggyBank
piggyBankCoins
pills
pizza
plant
play
playlist
playlistMusic
playlistVideo
plus
podcast
police
pool
pot
pound
power
powerCordPlug
powerCordPlugOff
powerPlantSolar
powerPlantWater
powerPlantWind
presentation
print
progress
projector
pulse
pushPin
puzzle
qrCode
quadBike
queen
rabbit
radar
radio
radioactive
random
receipt
rechargeable
recycling
redo
reflectX
reflectY
refresh
reload
reloadAlt
remoteControl
repeat
repeatOnce
replay
reply
replyAll
resizeHorizontal
resizeVertical
restart
retweet
rewind
rewindFifteen
rewindFive
rewindTen
rewindThirty
road
robot
rook
rotate
rotateHorizontal
rotateVertical
roundabout
route
router
ruble
rugby
ruler
rulers
sailboat
sampler
satellite
satelliteDish
satelliteDishAlt
save
saveAs
saw
sawBlade
scaleKitchen
scalePersonal
scanner
scissors
scissorsCutting
scissorsHorizontal
screwdriver
seafood
search
securityCamera
selfWindingCord
send
sendBackward
sendToBack
server
serverCheck
serverCogwheel
serverFlag
serverLock
serverMinus
serverNo
serverPlus
serverRefresh
set
setDown
setWine
settings
share
shieldCheck
shieldEmptyStar
shieldHalf
shieldQuarter
shieldStar
shirt
shoes
shoesOff
shopDoor
shopWindow
shoppingBag
shower
showerAlt
shredder
simpleTrolley
skipToEnd
skipToNext
skipToPrevious
skipToStart
skull
skullCrossbones
slightlyFrowning
slightlySmiling
smartBracelet
snowflake
sort
sortAlphabetically
sortAlphabeticallyAlt
sortAttributes
sortAttributesAlt
sortNumerically
sortNumericallyAlt
soundSurround
soya
spade
speakers
speechBubbleAlert
speechBubbleInfo
speechBubbleQuestion
spellCheck
spellCheckCheck
spray
squareAlert
squareCheck
squareCheckbox
squareDown
squareDownload
squareEdit
squareEmail
squareEmpty
squareEmptyAlert
squareEmptyCheck
squareEmptyDownload
squareEmptyInfo
squareEmptyLeft
squareEmptyMinus
squareEmptyPlay
squareEmptyPlus
squareEmptyQuestion
squareEmptyRemove
squareEmptyRight
squareEmptyUpload
squareHospital
squareIndeterminate
squareInfo
squareLeft
squareMenu
squareMinus
squareMore
squareNewWindow
squarePlay
squarePlus
squareQuestion
squareRedCross
squareRemove
squareRight
squareSelected
squareTriangleDown
squareTriangleLeft
squareTriangleRight
squareTriangleUp
squareUp
squareUpload
squares
star
starEmpty
starHalf
starOfLife
starOfLifeEmpty
start
stats
statsBars
statsCircle
stepBack
stepForward
stop
stopwatch
strikethrough
stroller
subscript
subtitles
subtitlesMinus
subtitlesOff
subtitlesPlus
suitcaseDoctor
sun
superscript
swimmingPool
switch
switchOff
switchOn
sync
syncAlert
syncCheck
syringe
syringeEmpty
tShirt
tShirtSleeves
tShirtV
table
tableTennis
tablet
tag
tags
target
tasks
taxi
teaLeaves
teaMug
teaPot
temperature
temperatureAlert
temperatureHigh
temperatureLow
temperatureSet
tennis
tent
terminal
terminalEmpty
terminalIsolated
text
textBackground
textBigger
textHeight
textResize
textSmaller
textUnderline
textWidth
theaterMasks
thisSideUp
threeDimensional
threeDimensionalFull
thumbnails
thumbnailsList
thumbnailsSmall
ticket
ticketParking
tie
timer
times
toilet
tornado
tractor
trafficLights
trafficLightsOff
train
tram
transgender
translate
translateAlt
transportMixed
transportTrolley
treeConifer
treeDeciduous
trending
triangleAlert
triangleEmptyAlert
triangleRadioactive
trousers
truck
turtle
tv
tvStreaming
umbrella
underline
underwear
undo
unknown
usbDevice
usbDeviceCogwheel
usbDeviceEject
usbDeviceLock
usbDeviceNo
user
userAlert
userBoy
userChat
userCheck
userChild
userFamily
userFemale
userFlag
userGirl
userGroup
userIncognito
userLock
userMinus
userNo
userParents
userParentsAlt
userPlus
userRounded
userScam
userScamAlt
userSquared
userStar
userVr
userVrMinus
userVrPlus
userWorker
users
vases
vectorPath
vectorPathCircle
vectorPathCurve
vectorPathEdit
vectorPathLine
vectorPathPentagon
verifyCheck
verifyEmpty
video
videoCamera
videoOff
videoPlay
videoPlayEmpty
viewFull
viewHalf
virginFemale
voicemail
volleyball
volumeBluetooth
volumeDown
volumeMax
volumeOff
volumeUp
votingUrn
vr
vrInside
wallet
walletCheck
walletCogwheel
walletLock
walletMinus
walletPlus
warehouse
washingMachine
wastePipe
wastePipeEnd
watch
watchSquared
water
webcam
wheat
wifi
wind
winners
winnersStars
wirelessCharging
worlEast
worldWest
wrench
yen
Back to top

ExternalLinkInput

The input type with values used to associate External Links with a Portal

position : Int!

The order used for positioning the External Link

href : String!

The URL the user will visit when clicking the External Link

displayText : String!

The display text for the External Link

iconName : ExternalLinkIcon

The Glyphicon name for the External Link (without the "glyphicon-" prefix) from: https://www.glyphicons.com/sets/basic/

Back to top

ExternalLog

An External Log to for an Entity

createdAt : TimeZonedDateTime!

The Date and Time this Log was created

entityId : ID!

The ID of the Entity this log is related to

externalLogOrigin : ExternalLogOrigin

The Origin of this External Log

Argument Type Description
filters = [] [ExternalLogOriginFieldGraphFilter]
order = "__EMPTY__" ExternalLogOriginFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogOriginFieldGraphOrder]
id : ID!

The ID of this External Log

message : String!

A Message to denote the state or action to be taken

payload : String

The External Log Payload

status : ExternalLogTypeStatus!

The status report of this Log

Deprecated fields (2)
externalIntegrationId : String

The ID of the External Integration that the External Log is associated with

Removal date: TBD.

Replaced by a connection to External Log Origin

webConferencingIntegrationId : String

DEPRECATED - Always returns null

Removal date: 2026-04-08.

Web Conferencing is being removed

Back to top

ExternalLogBulkMutationResponse

A Response from executing a bulk operation on External Logs

Related types: MutationResponse

entityIds : [ID!]!

The External Log IDs that were mutated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ExternalLogConnection

A connection containing page information and edges for ExternalLog

edges : [ExternalLogEdge!]!

The list of ExternalLog edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ExternalLogCreateInput

The input type with the values used to create an External Log

nodeId : ID!

The ID of the Node entity to log against

message : String!

The message of the log

status : ExternalLogTypeStatus

The status of this log

webConferencingIntegrationId : ID

DEPRECATED - this does nothing

payload : String

The JSON containing the data payload of the log

internalLogMetadata : InternalLogMetadataInput

additional log details to record internally for the Log event

Back to top

ExternalLogEdge

Contains cursor and node information for type ExternalLog

cursor : String!

A string that can be used for cursor-based pagination

node : ExternalLog!

The ExternalLog node.

Back to top

ExternalLogFieldGraphFilter

Filter that can be applied to limit which ExternalLog nodes are returned

field : ExternalLogTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ExternalLogFieldGraphOrder

Specifies the order in which ExternalLog nodes are returned via the Connection

field : ExternalLogTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ExternalLogMutations

Operations which allow you to associate a log entry with a node

create : ExternalLogMutationsResponse!

Associate an External Log for a particular entity

Argument Type Description
input ExternalLogCreateInput!

The Input Type for this mutation
createExternalIntegrationLog : ExternalLogMutationsResponse!

Creates an External Log from an integration which can be viewed from the TMS. The payload parameter allows to provide additional metadata such as API requests, payloads and other messages that are relevant to the log.

Argument Type Description
input ExternalIntegrationLogCreateInput!

The input for this mutation
createExternalIntegrationLogs : ExternalLogBulkMutationResponse!

Creates a batch of External Logs from an integration which can be viewed from the TMS. The payload parameter allows to provide additional metadata such as API requests, payloads and other messages that are relevant to the log.

Argument Type Description
input [ExternalIntegrationLogBulkCreateInput]!

The input for this mutation
Back to top

ExternalLogMutationsResponse

A Response from mutating an ExternalLog

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

externalLog : ExternalLog

The ExternalLog that was mutated

Back to top

ExternalLogOrigin

The Origin for an External Log

id : ID!

The ID of this External Log Origin

name : String!

The name of this External Log Origin

originIdentifier : String!

The Identifier for this logging source

status : ExternalLogOriginTypeStatusEnum

The status of the integration for this Log Origin

statusPageUrl : String

A URL where the user can consult the status or the settings of the integration for this Log Origin

Back to top

ExternalLogOriginConnection

A connection containing page information and edges for ExternalLogOrigin

edges : [ExternalLogOriginEdge!]!

The list of ExternalLogOrigin edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ExternalLogOriginEdge

Contains cursor and node information for type ExternalLogOrigin

cursor : String!

A string that can be used for cursor-based pagination

node : ExternalLogOrigin!

The ExternalLogOrigin node.

Back to top

ExternalLogOriginFieldGraphFilter

Filter that can be applied to limit which ExternalLogOrigin nodes are returned

field : ExternalLogOriginTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ExternalLogOriginFieldGraphOrder

Specifies the order in which ExternalLogOrigin nodes are returned via the Connection

field : ExternalLogOriginTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ExternalLogOriginMutations

Operations relating to External Log Origins

update : ExternalLogOriginMutationsResponse!

Update an External Log Origin

Argument Type Description
input ExternalLogOriginUpdateInput!

The Input Type for this mutation
upsert : ExternalLogOriginMutationsResponse!

Creates or Updates an External Log Origin based on the provided identifier

Argument Type Description
input ExternalLogOriginUpsertInput!

The Input Type for this mutation
Back to top

ExternalLogOriginMutationsResponse

A Response from mutating an ExternalLogOrigin

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

externalLogOrigin : ExternalLogOrigin

The ExternalLogOrigin that was mutated

Back to top

ExternalLogOriginTypeField

Fields for filtering and sorting External Logs

id
name
originIdentifier
Back to top

ExternalLogOriginTypeStatusEnum

The status of the integration related to an External Log Origin

disconnected
initializing
connected
error
actionRequired
Back to top

ExternalLogOriginUpdateInput

The input type with the values used to update an External Log Origin

externalLogOriginId : ID!

The ID of the External Log Origin to be Updated

name : String

The name for the External Log Origin

status : ExternalLogOriginTypeStatusEnum

The status of the integration for this External Log Origin

statusPageUrl : String

The URL of a page the User can check the status or settings of the integration for this External Log Origin

Back to top

ExternalLogOriginUpsertInput

The input type with the values used to create or update an External Log Origin

originIdentifier : String!

A unique identifier used to associate logs from the same external source

name : String

The name for the External Log Origin

status : ExternalLogOriginTypeStatusEnum

The status of the integration for this External Log Origin

statusPageUrl : String

The URL of a page the User can check the status or settings of the integration for this External Log Origin

Back to top

ExternalLogTypeField

Fields for filtering and sorting External Logs

id
entityId
status
createdAt
message
externalIntegrationId
externalLogOriginId
Deprecated values (1)
webConferencingIntegrationId

Removal date: 2026-04-08.

Web Conferencing is being removed

Back to top

ExternalLogTypeStatus

The status of an External Log

pending
success
partial
failed
warning
Back to top

ExternalObjective

An Objective within a Learning Path's learning journey, representing an External Activity that must be completed in order to complete this Learning Path

Related types: Node LearningObjective

credits : Int

The number of credits that this LearningObjective represents

description : String

Information about what the External Objective involves.

expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The unique identifier of the External Objective.

isMandatory : Boolean!

Denotes whether or not the LearningObjective is mandatory

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

A name to help identify the External Objective.

order : Int

The order of this LearningObjective in the set of LearningPath objectives

Deprecated fields (1)
details : String!

Removal date: TBD.

Replaced by description field

Back to top

ExternalOutcome

A Learner's record relating to an External Activity Objective

Related types: Node LearningOutcome

credits : Int

The number of credits that the LearningOutcome represents

details : String!

Further details about the External Outcome.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The unique identifier of the External Outcome.

isCompleted : Boolean

Denotes whether or not the LearningOutcome has been completed by the Learner

isMandatory : Boolean!

Denotes whether or not the LearningOutcome is mandatory

learningObjective : LearningObjective!

The LearningObjective to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
learningPathLearner : LearningPathLearner!

The LearningPathLearner to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningOutcome in the set of LearningAssignment outcomes

Back to top

ExternalResourceBookingDeleteInput

An input for removing External Resource Bookings

resourceId : ID!

The Resource ID for which the bookings should be removed

sourceIdentifier : String!

The source identifier of the External Events to remove

bookingIds : [ID]

Restricts the removal to these External Resource Bookings. When omitted, every external booking matching the Resource and source identifier is removed

Back to top

ExternalResourceBookingInput

An Input for assigning external calendar events as Resource Bookings

resourceId : ID!

the ID of the booked Resource

sourceIdentifier : String!

Identifies the source of the external event

externalIdentifier : String!

Uniquely identifies the external event

start : TimeZonedDateTime!

a timezone-aware ISO Datetime specifying the start of the event

end : TimeZonedDateTime!

a timezone-aware ISO Datetime specifying the end of the event

title : String

The title of the external event

Back to top

ExternalResourceBookingUpdateInput

An Input for updating external calendar events

id : ID!

the ID of the booking

resourceId : ID!

the ID of the booked Resource

sourceIdentifier : String!

Identifies the source of the external event

externalIdentifier : String!

Uniquely identifies the external event

start : TimeZonedDateTime!

a timezone-aware ISO Datetime specifying the start of the event

end : TimeZonedDateTime!

a timezone-aware ISO Datetime specifying the end of the event

title : String

The title of the external event

Back to top

FieldError

An error returned specific to a field

label : String

Attribute the error relates to

message : String!

Error message and resolution hint

value : String

Value that triggered the error

Back to top

FieldMapInput

An input containing the mappings data for updating an LMS Integration field mapping

Back to top

FilterOperation

See https://getadministrate.com/developers/guides/graphql%20basics/filtering/ for details.

eq
ge
gt
like
le
lt
ne
isnull
notnull
wordlike
in
contains
notin
Back to top

FinancialAccount

The accounts found in your Chart of Accounts, used for classifying financial transactions

Related types: Node

code : String!

A numerical identifier assigned to this Financial Account

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

Financial Account ID

isBank : Boolean!

Whether this FinancialAccount is a bank account

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Financial Account

Back to top

FinancialAccountConnection

A connection containing page information and edges for FinancialAccount

edges : [FinancialAccountEdge!]!

The list of FinancialAccount edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

FinancialAccountEdge

Contains cursor and node information for type FinancialAccount

cursor : String!

A string that can be used for cursor-based pagination

node : FinancialAccount!

The FinancialAccount node.

Back to top

FinancialAccountField

Fields for filtering and ordering Financial Account

id
name
code
isBank
textSearch
Back to top

FinancialAccountFieldGraphFilter

Filter that can be applied to limit which FinancialAccount nodes are returned

field : FinancialAccountField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

FinancialAccountFieldGraphOrder

Specifies the order in which FinancialAccount nodes are returned via the Connection

field : FinancialAccountField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

FinancialAmount

An entity that has a currency and an amount and represents a price or cost which could be in a financial currency (e.g. GBP) or in Training Tokens

Related types: EventPrice LearningPathLearnerPrice OpportunityValue LearnerPrice CourseTemplatePrivatePrice CourseTemplatePublicPrice

amount : Decimal!

Numeric value of this financial amount

financialUnit : FinancialUnit!

Unit of value of this financial amount

Back to top

FinancialStats

Financial Statistics over the time period specified

costsOnEvents : Int!

The number of Costs on Events

invoicesRaised : Int!

The number of Invoices raised

itemsSold : Int!

The number of Items Sold

purchaseOrdersRaised : Int!

The number of Purchase Orders Raised

trainingPassesUsedForRegistrations : Int!

The number of Training Passes used to Register onto Training

trainingTokensRedeemed : Int!

The number of Training Tokens Redeemed

Back to top

FinancialUnit

An interface expressing a financial amount's unit of value, for example a Currency or a Training Token type

Related types: Currency TrainingTokenType

id : ID!

The ID for this Financial Unit

name : String!

A short descriptive name for this Financial Unit

Back to top

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Back to top

Folder

Folder

Related types: Node

documents : DocumentConnection!

The list of Documents in this Folder. Translations of a Document are not listed here; read them from Document.translations.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Folder

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Folder

parent : Folder

Parent folder for this folder

Argument Type Description
filters = [] [FolderFieldGraphFilter]
order = "__EMPTY__" FolderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FolderFieldGraphOrder]
parentId : String

The id of the parent Folder

path : String!

The Path of this folder

Back to top

FolderConnection

A connection containing page information and edges for Folder

edges : [FolderEdge!]!

The list of Folder edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

FolderCreateMutationInput

An input for creating a Folder

name : String!

The name of the Folder

parentFolderId : ID

The ID of the parent Folder

Back to top

FolderCreateMutationResponse

The response from a Folder create request

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

folder : Folder

The Folder that was created

Back to top

FolderDeleteMutationInput

An input for deleting a list of Folders

folderIds : [ID]!

The IDs of the folders to delete

Back to top

FolderDeleteMutationResponse

The response from a Folder delete request

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

folders : [String!]!

The Folder Ids that were deleted

Back to top

FolderEdge

Contains cursor and node information for type Folder

cursor : String!

A string that can be used for cursor-based pagination

node : Folder!

The Folder node.

Back to top

FolderFieldGraphFilter

Filter that can be applied to limit which Folder nodes are returned

field : FolderTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

FolderFieldGraphOrder

Specifies the order in which Folder nodes are returned via the Connection

field : FolderTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

FolderMutations

Mutations for Folders

create : FolderCreateMutationResponse!

Create a new Folder

Argument Type Description
input FolderCreateMutationInput!
delete : FolderDeleteMutationResponse!

Delete a list of existing Folders

Argument Type Description
input FolderDeleteMutationInput!
update : FolderUpdateMutationResponse!

Update an existing Folder

Argument Type Description
input FolderUpdateMutationInput!
Back to top

FolderTypeField

Fields for filtering and ordering Folders

id
name
parentId
documentName
Back to top

FolderUpdateMutationInput

An input for updating a Folder

folderId : ID!

The ID of the Folder to update

name : String

The new name of the Folder

parentFolderId : ID

the ID of the parent Folder

Back to top

FolderUpdateMutationResponse

The response from a Folder update request

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

folder : Folder

The Folder that was updated

Back to top

FormSection

Additional Details Information section.

Contact
Event
Path
StockItem
Back to top

FormSubmission

A form submission received by the sales team.

Related types: Node

assignee : User

User assigned to process the Form Submission.

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
contact : Contact

Contact associated with the Form Submission.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : LocalDateTime

Date and time the Form Submission was created.

customFieldValues : [CustomFieldValue!]!

Field labels and values submitted through the form.

deadDescription : String

Reason the Form Submission was marked as dead.

deadReasonId : ID

Dead reason identifier.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
historyEntries : [MessageHistoryEntry!]!

History entries for this Form Submission.

id : ID!

ID of the Form Submission.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

marketingActivity : MarketingActivity

Marketing activity that captured the Form Submission.

Argument Type Description
filters = [] [MarketingActivityFieldGraphFilter]
order = "__EMPTY__" MarketingActivityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MarketingActivityFieldGraphOrder]
opportunity : Opportunity

Opportunity associated with the Form Submission.

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
processed : Boolean!

Whether the Form Submission has been processed.

Back to top

FormSubmissionConnection

A connection containing page information and edges for FormSubmission

edges : [FormSubmissionEdge!]!

The list of FormSubmission edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

FormSubmissionDeleteInput

Input for deleting a Form Submission.

description : String!
deadReasonId : ID!
Back to top

FormSubmissionEdge

Contains cursor and node information for type FormSubmission

cursor : String!

A string that can be used for cursor-based pagination

node : FormSubmission!

The FormSubmission node.

Back to top

FormSubmissionField

An enumeration.

id
createdAt
marketingActivityId
assigneeId
contactId
opportunityId
processed
messageStatus
Back to top

FormSubmissionFieldGraphFilter

Filter that can be applied to limit which FormSubmission nodes are returned

field : FormSubmissionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

FormSubmissionFieldGraphOrder

Specifies the order in which FormSubmission nodes are returned via the Connection

field : FormSubmissionOrderField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

FormSubmissionMarkDeadInput

Input for marking a Form Submission as dead.

description : String!
deadReasonId : ID!
Back to top

FormSubmissionMutateResponse

A response from Form Submission mutations.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

formSubmission : FormSubmission

The Form Submission that was mutated.

Back to top

FormSubmissionMutations

Mutations for Form Submissions.

addToMarketingList : FormSubmissionMutateResponse!

Add the associated contact to a Marketing List.

Argument Type Description
input MessageAddToMarketingListInput!
assign : FormSubmissionMutateResponse!

Assign a Form Submission to a user.

Argument Type Description
input MessageAssignInput!
associateContact : FormSubmissionMutateResponse!

Associate a Form Submission with a contact.

Argument Type Description
input MessageAssociateContactInput!
associateOpportunity : FormSubmissionMutateResponse!

Associate a Form Submission with an opportunity and mark it as processed.

Argument Type Description
input MessageAssociateOpportunityInput!
createTask : FormSubmissionMutateResponse!

Create a Task from a Form Submission.

Argument Type Description
input MessageTaskCreateInput!
delete : FormSubmissionMutateResponse!

Delete a Form Submission.

Argument Type Description
input FormSubmissionDeleteInput!
markDead : FormSubmissionMutateResponse!

Mark a Form Submission as dead.

Argument Type Description
input FormSubmissionMarkDeadInput!
markProcessed : FormSubmissionMutateResponse!

Mark a Form Submission as processed with no further action required.

Argument Type Description
input MessageMarkProcessedInput!
reply : FormSubmissionMutateResponse!

Reply to a Form Submission by email.

Argument Type Description
input MessageReplyInput!
Back to top

FormSubmissionOrderField

An enumeration.

id
createdAt
marketingActivityId
assigneeId
contactId
opportunityId
processed
Back to top

FormTemplateField

A field of a form template, with whether its values are included in search

definitionId : ID!

The identifier for this field's definition

formName : String!

The form template the field belongs to

includeInSearch : Boolean!

Whether values of this field are included in global search

label : String!

The label of the field

Back to top

FormTemplateFieldSearchInput

Sets whether one form template field is included in global search.

definitionId : ID!

The definition ID of the form template field

includeInSearch : Boolean!

Whether its values are included in global search

Back to top

FormTemplateFieldSearchResponse

A Response for changing the search setting of a form template field

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

field : FormTemplateField

The form template field with its setting as now stored

Back to top

FulfilObjectiveForLearnersResponse

A response from fulfiling a Learning Path Objective for learners

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learners : [LearningPathLearner!]

The Learning Path Learners whose Outcome was fulfilled

Back to top

FulfilOutcomeResponse

A response from fulfiling a Learning Path Objective

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learner : LearningPathLearner

The Learning Path Learner whose Outcome was fulfilled

Back to top

GenericCustomField

A Custom Field associated with an entity

Related types: Node

canEdit : Boolean!

Whether the current logged in user can edit this custom field. This is a convenience field that will take into account the current user's permission level, roles, if this field is restricted and to what roles.

definitionLocator : String

Human readable name of the Custom Field

entities : [GenericCustomFieldEntity!]

A List of EntityType related to the custom_field

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
fieldType : GenericCustomFieldType!

A subclass mapping to GenericCustomFieldTypeType

id : ID!

The identifier for this definition

includeInSearch : Boolean!

Whether the values of this custom field are included in global search

isRequired : Boolean!

Whether the custom field is required

isRestricted : Boolean!

Whether the custom field is restricted

label : String!

The label of the CustomFieldDefinition

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

options : [GenericCustomFieldOption!]

Choices to present for a Custom Field with choice options

permissionGrants : [GenericCustomFieldPermission!]!

Role permission grants on editing or viewing this custom field's data

position : Int

The display order of the custom field.

tooltip : String!

The tooltip of the CustomFieldDefinition

Back to top

GenericCustomFieldConnection

A connection containing page information and edges for GenericCustomField

edges : [GenericCustomFieldEdge!]!

The list of GenericCustomField edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

GenericCustomFieldDefinitionInput

An Input for creating a generic/multi-entity CustomField.

label : String!

The label which describes the contents of the Custom Field

fieldType : CustomFieldType!

The format of the value that will be stored (i.e: "Text")

isRequired : Boolean

Whether or not the Custom Field is required, defaults to False

isRestricted : Boolean

Whether or not the Custom Field is restricted, defaults to False

isTranslatable : Boolean

Whether or not the Custom Field's values can be translated, defaults to False

tooltip : String

A description explaining the use of the Custom Field

options : [String]

List of options for choice or multichoice Custom Fields

permissionGrants : [GenericCustomFieldPermissionTypeInput]

User Roles which have permissions to view and/or edit the data

definitionLocator : String

Human readable identifier for the Custom Field in this field (empty means no restrictions)

position : Int
includeInSearch : Boolean

Whether values are included in global search

Back to top

GenericCustomFieldEdge

Contains cursor and node information for type GenericCustomField

cursor : String!

A string that can be used for cursor-based pagination

node : GenericCustomField!

The GenericCustomField node.

Back to top

GenericCustomFieldEntity

description : String

The description of a CustomField related entity

name : String

The name of a CustomField related entity

Back to top

GenericCustomFieldField

Fields for filtering and ordering Custom Fields

id
label
isRequired
isRestricted
tooltip
definitionLocator
fieldType
entities
options
position
Back to top

GenericCustomFieldFieldGraphFilter

Filter that can be applied to limit which GenericCustomField nodes are returned

field : GenericCustomFieldField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

GenericCustomFieldFieldGraphOrder

Specifies the order in which GenericCustomField nodes are returned via the Connection

field : GenericCustomFieldField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

GenericCustomFieldOption

An Option for a Custom Field with choice options

label : String!

The label to display to the user

value : String!

The value to send when storing the Custom Field

Back to top

GenericCustomFieldPermission

permission : GenericCustomFieldPermissionType!

Whether this role has view only or full edit permissions

roleId : ID!

The id of the role bound with this permission

Back to top

GenericCustomFieldPermissionType

An enumeration.

View
Edit
Back to top

GenericCustomFieldPermissionTypeInput

An input type to define permissions for a CustomField

roleId : String!
Back to top

GenericCustomFieldType

name : String!

The name of a Custom Field type

type : String!

The type of a Custom Field type

Back to top

GenericEventIssue

An issue that doesn't fit any specific category, typically from a Custom Business Rule

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

reason : String!

Human-readable description of the issue

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

GenericPermission

A simple View and Edit permission enumeration for permissionGrants input

View
Edit
Back to top

GenericPersonnelIssue

A personnel issue outside Administrate's built-in taxonomy, surfaced by a Custom Business Rule

Related types: PersonnelIssue

category : PersonnelIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the assignment. Count the entries where this is false: that is what PersonnelIssueGroup.issueCount reports and what every badge in Administrate shows.

reason : String!

The rule's description of what is wrong with this personnel assignment

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [PersonnelIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

GenericResourceIssue

A resource issue outside Administrate's built-in taxonomy, surfaced by a Custom Business Rule

Related types: ResourceIssue

category : ResourceIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the booking. Count the entries where this is false: that is what ResourceIssueGroup.issueCount reports and what every badge in Administrate shows.

reason : String!

The rule's description of what is wrong with this Resource

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [ResourceIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

GiftVoucher

Gift Voucher

Related types: Node

activatedAt : TimeZonedDateTime

The date and time that the gift voucher was activated at

balance : Decimal!

The current balance of the Gift Voucher

code : String!

The code of the Gift Voucher

configuration : GiftVoucherConfiguration!

The Gift Voucher Configuration for this Gift Voucher

Argument Type Description
filters = [] [GiftVoucherConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherConfigurationFieldGraphOrder]
createdAt : TimeZonedDateTime

The date and time the Gift Voucher was created

currencyCode : String!

The currency code of the Gift Voucher

deliveryMethod : GiftVoucherDeliveryMethod

The delivery method of the Gift Voucher

expiresAt : TimeZonedDateTime

The date and time that the Gift Voucher expires

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Gift Voucher

initialBalance : Decimal!

The initial balance of the Gift Voucher

intendedBalance : Decimal

The intended balance of the Gift Voucher before activation

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : GiftVoucherLifecycleState!

The lifecycle state of the Gift Voucher

portalEmailTemplate : PortalEmailTemplateMapping

Email Template associated with the Gift Voucher

Argument Type Description
filters = [] [PortalEmailTemplateMappingFieldGraphFilter]
order = "__EMPTY__" PortalEmailTemplateMappingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalEmailTemplateMappingFieldGraphOrder]
recipientDetails : GiftVoucherRecipientDetails

The details associated with the Recipient of the Gift Voucher

Back to top

GiftVoucherActivateInput

giftVoucherId : ID!
balance : Float!
accountId : ID!
regionId : ID!
companyId : ID!
Back to top

GiftVoucherApplyInput

An Input to apply a Gift Voucher to an Opportunity

code : String!

The Code of the Gift Voucher being applied

salesOpportunityId : ID!

The ID of the Opportunity to apply the Gift Voucher to

Back to top

GiftVoucherBatchCreateInput

The input for creating a batch of Gift Vouchers

giftVoucherConfigurationId : ID!

The Id of the Gift Voucher Configuration

quantity : Int

The number of Gift Vouchers to get created

codeLength : Int

The length required for a Gift Voucher code

isActive : Boolean

Whether or not the gift voucher should be created as active or not

codePrefix : String

The prefix for a Gift Voucher code

initialBalance : Float

The initial balance of a Gift Voucher

regionId : ID

The ID of the Region used by the invoice and transactions

accountId : ID

The ID of the Account to assign the invoice to

companyId : ID

The ID of the Company used by the invoice and transactions

expiresAt : TimeZonedDateTime

The expiry date of the vouchers

Back to top

GiftVoucherBatchCreateMutationResponse

A response from creating multiple Gift Vouchers.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

giftVouchers : [GiftVoucher!]

The Gift Vouchers that were created.

Back to top

GiftVoucherConfiguration

The Configuration of a Gift Voucher

Related types: Node InterestItem

currencyCode : String!

The currency code of the Gift Voucher Configuration

deactivatedVoucherAccount : FinancialAccount

The Deactivated Financial Account for deactivated vouchers on the Gift Voucher Configuration

Argument Type Description
filters = [] [FinancialAccountFieldGraphFilter]
order = "__EMPTY__" FinancialAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FinancialAccountFieldGraphOrder]
expiredVoucherAccount : FinancialAccount

The Breakage Financial Account for expired vouchers on the Gift Voucher Configuration

Argument Type Description
filters = [] [FinancialAccountFieldGraphFilter]
order = "__EMPTY__" FinancialAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FinancialAccountFieldGraphOrder]
expiryDurationDays : Int

The number of days after which a Gift Voucher created from this Configuration will expire

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Gift Voucher Configuration

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

liabilityFinancialAccount : FinancialAccount!

The Financial Account for the Gift Voucher Configuration

Argument Type Description
filters = [] [FinancialAccountFieldGraphFilter]
order = "__EMPTY__" FinancialAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FinancialAccountFieldGraphOrder]
linkedItems : GiftVoucherConfigurationLinkedItemConnection!

The Stock Items that are associated with this Gift Voucher Configuration

Argument Type Description
filters = [] [GiftVoucherConfigurationLinkedItemFieldGraphFilter]
order = "__EMPTY__" GiftVoucherConfigurationLinkedItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherConfigurationLinkedItemFieldGraphOrder]
name : String!

The name of the Gift Voucher Configuration

portalConfigurations : GiftVoucherPortalConfigurationConnection!

Portals that this Gift Voucher has been assigned to

Argument Type Description
filters = [] [GiftVoucherPortalConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherPortalConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherPortalConfigurationFieldGraphOrder]
Back to top

GiftVoucherConfigurationAddLinkedItemInput

The input for adding a link between a Gift Voucher Configuration and a Stock Item

giftVoucherConfigurationId : String!
stockItemId : String!
taxTypeId : String
Back to top

GiftVoucherConfigurationConnection

A connection containing page information and edges for GiftVoucherConfiguration

edges : [GiftVoucherConfigurationEdge!]!

The list of GiftVoucherConfiguration edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

GiftVoucherConfigurationCreateInput

The input for creating a Gift Voucher Configuration

Optional for backwards compatibility. Should be fixed after ui deployed

name : String!

The name of the Gift Voucher Configuration

currencyCode : String!

The supported Currency for this Configuration

liabilityFinancialAccountId : ID!

The Financial Account to assign Liabilities for this Gift Voucher Configuration

expiredVoucherAccountId : ID!
deactivatedVoucherAccountId : ID
expiryDurationDays : Int

The number of days after which a Gift Voucher created from this Configuration will expire

Back to top

GiftVoucherConfigurationEdge

Contains cursor and node information for type GiftVoucherConfiguration

cursor : String!

A string that can be used for cursor-based pagination

node : GiftVoucherConfiguration!

The GiftVoucherConfiguration node.

Back to top

GiftVoucherConfigurationField

Fields for filtering and ordering Gift Voucher Configurations

id
name
currencyCode
isValidForPortal
Back to top

GiftVoucherConfigurationFieldGraphFilter

Filter that can be applied to limit which GiftVoucherConfiguration nodes are returned

field : GiftVoucherConfigurationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

GiftVoucherConfigurationFieldGraphOrder

Specifies the order in which GiftVoucherConfiguration nodes are returned via the Connection

field : GiftVoucherConfigurationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

GiftVoucherConfigurationLinkedItem

A Stock Item associated with a Gift Voucher Configuration

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Gift Voucher Configuration Linked Item

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

stockItem : StockItem!

The Stock Item associated with a Gift Voucher Configuration

taxType : TaxType

The Tax Type applicable to the associated Stock Item

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
Back to top

GiftVoucherConfigurationLinkedItemConnection

A connection containing page information and edges for GiftVoucherConfigurationLinkedItem

edges : [GiftVoucherConfigurationLinkedItemEdge!]!

The list of GiftVoucherConfigurationLinkedItem edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

GiftVoucherConfigurationLinkedItemEdge

Contains cursor and node information for type GiftVoucherConfigurationLinkedItem

cursor : String!

A string that can be used for cursor-based pagination

node : GiftVoucherConfigurationLinkedItem!

The GiftVoucherConfigurationLinkedItem node.

Back to top

GiftVoucherConfigurationLinkedItemField

Fields for filtering and ordering Gift Voucher Configuration Linked Items

id
Back to top

GiftVoucherConfigurationLinkedItemFieldGraphFilter

Filter that can be applied to limit which GiftVoucherConfigurationLinkedItem nodes are returned

field : GiftVoucherConfigurationLinkedItemField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

GiftVoucherConfigurationLinkedItemFieldGraphOrder

Specifies the order in which GiftVoucherConfigurationLinkedItem nodes are returned via the Connection

field : GiftVoucherConfigurationLinkedItemField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

GiftVoucherConfigurationMutationResponse

The response from mutating a Gift Voucher Configuration.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

giftVoucherConfiguration : GiftVoucherConfiguration

The Gift Voucher Configuration that was mutated.

Back to top

GiftVoucherConfigurationPortalField

Fields for filtering and ordering Gift Voucher Portal Configuration

id
giftVoucherConfigurationId
Back to top

GiftVoucherConfigurationUpdateInput

The input for updating a Gift Voucher Configuration

name : String

The name of the Gift Voucher Configuration

expiredVoucherAccountId : ID
deactivatedVoucherAccountId : ID
expiryDurationDays : Int
Back to top

GiftVoucherConnection

A connection containing page information and edges for GiftVoucher

edges : [GiftVoucherEdge!]!

The list of GiftVoucher edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

GiftVoucherDeliveryMethod

Denotes the delivery method of a Gift Voucher

Digital
Paper
Back to top

GiftVoucherDetails

Gift Voucher Details on an Interest

expiresAt : TimeZonedDateTime

The expiry date of the Gift Voucher

message : String

The personalized message to be sent to the Recipient with the Gift Voucher

recipientDetails : GiftVoucherRecipientDetails

The details associated with the Recipient of the Gift Voucher

Back to top

GiftVoucherEdge

Contains cursor and node information for type GiftVoucher

cursor : String!

A string that can be used for cursor-based pagination

node : GiftVoucher!

The GiftVoucher node.

Back to top

GiftVoucherField

Fields for filtering and ordering Gift Vouchers

id
code
expiresAt
configurationId
Back to top

GiftVoucherFieldGraphFilter

Filter that can be applied to limit which GiftVoucher nodes are returned

field : GiftVoucherField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

GiftVoucherFieldGraphOrder

Specifies the order in which GiftVoucher nodes are returned via the Connection

field : GiftVoucherField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

GiftVoucherLifecycleState

Denotes the lifecycle state of a Gift Voucher

Active

The Gift Voucher is Active and can be used

Expired

The Gift Voucher has Expired and can not be used

Inactive

The Gift Voucher is Inactive and can not be used until it is Activated

Deactivated

The Gift Voucher has been Deactivated and can not be used

Back to top

GiftVoucherLockInput

An Input to lock or unlock the Gift Vouchers on an Opportunity

opportunityId : ID!

The ID of the Opportunity to lock or unlock the Gift Vouchers on

Back to top

GiftVoucherMutationCommonResponse

The response from mutating a Gift Voucher.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

giftVoucher : GiftVoucher

The Gift Voucher that was mutated.

Back to top

GiftVoucherMutations

activateVoucher : GiftVoucherMutationCommonResponse!

Activates a Gift Voucher.

Argument Type Description
input GiftVoucherActivateInput!
addLinkedItem : GiftVoucherConfigurationMutationResponse!

Add a link between a Gift Voucher Configuration and a Stock Item

Argument Type Description
input GiftVoucherConfigurationAddLinkedItemInput!
createConfiguration : GiftVoucherConfigurationMutationResponse!

Create a Gift Voucher Configuration

Argument Type Description
input GiftVoucherConfigurationCreateInput!
createVouchers : GiftVoucherBatchCreateMutationResponse!

Creates multiple Gift Vouchers depending on the Input.

Argument Type Description
input GiftVoucherBatchCreateInput!
deactivateVoucher : GiftVoucherMutationCommonResponse!

Deactivates a Gift Voucher, ensuring it cannot be used.

Argument Type Description
giftVoucherId ID!
expireVoucher : GiftVoucherMutationCommonResponse!

Sets a Gift Voucher to Expired.

Argument Type Description
giftVoucherId ID!
setExpiry : GiftVoucherMutationCommonResponse!

Sets when a given Gift Voucher should expire.

Argument Type Description
input GiftVoucherSetExpiryInput!
updateConfiguration : GiftVoucherConfigurationMutationResponse!

Update a Gift Voucher Configuration

Argument Type Description
giftVoucherConfigurationId ID!
input GiftVoucherConfigurationUpdateInput!
updateRecipientDetails : GiftVoucherMutationCommonResponse!

Updates the Recipient Details (name, email, address) for a Gift Voucher.

Argument Type Description
giftVoucherId ID!
input GiftVoucherRecipientDetailsUpdateInput!
Back to top

GiftVoucherOpportunityApplication

The Application of a Gift Voucher to an Opportunity

Related types: Node

amount : Decimal!

The amount of the Gift Voucher that was applied to the Opportunity

createdAt : TimeZonedDateTime!

The date and time the Gift Voucher was applied to the Opportunity

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
giftVoucher : GiftVoucher!

The Gift Voucher that was applied to the Opportunity

Argument Type Description
filters = [] [GiftVoucherFieldGraphFilter]
order = "__EMPTY__" GiftVoucherFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherFieldGraphOrder]
id : ID!

The ID of the Gift Voucher Opportunity Application

isLocked : Boolean!

Whether this Gift Voucher amount is locked so that is cannot be taken by another sale

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

opportunity : Opportunity!

The Opportunity that the Gift Voucher was applied to

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
Back to top

GiftVoucherPortalConfiguration

A Portal Configuration associated with a Gift Voucher

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
giftVoucherConfiguration : GiftVoucherConfiguration!

Fetches the Gift Voucher Configuration associated with this Portal

Argument Type Description
filters = [] [GiftVoucherConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherConfigurationFieldGraphOrder]
id : ID!

The ID of the Gift Voucher Portal Configuration

image : Document

The image for the Gift Voucher configuration on this Portal

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

portal : Portal!

The associated Portal for this Gift Voucher Portal Configuration

Argument Type Description
filters = [] [PortalFieldGraphFilter]
order = "__EMPTY__" PortalFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalFieldGraphOrder]
productDescription : String!

The product description of the Gift Voucher Portal Configuration

sendingEmailAddress : SendingEmailAddress!

The Sending Email Address for the Gift Voucher Portal Configuration

Argument Type Description
filters = [] [SendingEmailAddressFieldGraphFilter]
order = "__EMPTY__" SendingEmailAddressFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingEmailAddressFieldGraphOrder]
Back to top

GiftVoucherPortalConfigurationConnection

A connection containing page information and edges for GiftVoucherPortalConfiguration

edges : [GiftVoucherPortalConfigurationEdge!]!

The list of GiftVoucherPortalConfiguration edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

GiftVoucherPortalConfigurationEdge

Contains cursor and node information for type GiftVoucherPortalConfiguration

cursor : String!

A string that can be used for cursor-based pagination

node : GiftVoucherPortalConfiguration!

The GiftVoucherPortalConfiguration node.

Back to top

GiftVoucherPortalConfigurationFieldGraphFilter

Filter that can be applied to limit which GiftVoucherPortalConfiguration nodes are returned

field : GiftVoucherConfigurationPortalField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

GiftVoucherPortalConfigurationFieldGraphOrder

Specifies the order in which GiftVoucherPortalConfiguration nodes are returned via the Connection

field : GiftVoucherConfigurationPortalField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

GiftVoucherRecipientDetails

Details associated with the Recipient of a Gift Voucher

email : String

The email address of the Gift Voucher Recipient

message : String

The personalized message to be sent to the Recipient with the Gift Voucher

name : String

The name of the Gift Voucher Recipient

postalAddressCountry : Country

The Country of the Gift Voucher Recipient's Postal Address

postalAddressLineOne : String

Line One of the Gift Voucher Recipient's Postal Address

postalAddressLineTwo : String

Line Two of the Gift Voucher Recipient's Postal Address

postalAddressPostcode : String

The Postcode of the Gift Voucher Recipient's Postal Address

postalAddressTown : String

The Town of the Gift Voucher Recipient's Postal Address

Back to top

GiftVoucherRecipientDetailsInput

An Input containing the details of a Gift Voucher Recipient

name : String!

The name of the Gift Voucher Recipient being created or updated

email : String

The email of the Gift Voucher Recipient being created or updated

emailConfigurationId : String

The Email Configuration to send to the Recipient

postalAddressLineOne : String

Line One of the Gift Voucher Recipient's Postal Address

postalAddressLineTwo : String

Line Two of the Gift Voucher Recipient's Postal Address

postalAddressTown : String

The Town of the Gift Voucher Recipient's Postal Address

postalAddressPostcode : String

The Postcode of the Gift Voucher Recipient's Postal Address

postalAddressCountryId : String

The Country ID of the Gift Voucher Recipient's Postal Address

message : String

The personalized message to be sent to the Recipient with the Gift Voucher

Back to top

GiftVoucherRecipientDetailsUpdateInput

name : String
email : String
postalAddressLineOne : String
postalAddressLineTwo : String
postalAddressTown : String
postalAddressPostcode : String
postalAddressCountryId : ID
message : String
Back to top

GiftVoucherSetExpiryInput

giftVoucherId : ID!
Back to top

GlobalCustomFieldDefinitionCreateInput

An Input for creating a Global Custom Field

definition : CustomFieldDefinitionInput!

The CustomFieldDefinition input

objectType : SupportsCustomField!

The type of object this Custom Field is stored against

Back to top

GlobalCustomFieldDefinitionRemoveInput

An Input for removing a Global Custom Field from a type

definitionKey : ID!
Back to top

GlobalCustomFieldDefinitionRemoveResponse

A Response for a Custom Field Definition Removal Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

key : ID

The ID of the deleted Custom Field Definition

Back to top

GlobalCustomFieldDefinitionUpdateInput

An Input for updating a Global Custom Field

definitionKey : ID!

The identifier for the Custom Field Definition to update

label : String

The label which describes the contents of the Custom Field

isRequired : Boolean

Whether or not the Custom Field is required, defaults to False

description : String

A description explaining the use of the Custom Field

options : [String]

List of options for choice or multichoice Custom Fields

roles : [ID]

User Roles which have permissions to view and edit the data in this field (empty means no restrictions)

definitionLocator : String

Human readable identifier for the Custom Field

isTranslatable : Boolean

Whether or not the Custom Field's values can be translated; left unchanged when omitted

Back to top

GlobalCustomFieldDefinitionUpdateResponse

A Response for a Custom Field Definition Update Mutation

customFieldDefinition : CustomFieldDefinition

The Custom Field Definition that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

GlobalCustomFieldTemplate

A set of CustomFieldDefinitions for a Type

Related types: CustomFieldTemplate

customFieldDefinitions : [CustomFieldDefinition!]!

The list of CustomFieldDefinitions of the GlobalCustomFieldTemplate

Argument Type Description
filters [CustomFieldDefinitionFilter]
orderBy CustomFieldOrderingOption
name : String!

The name of the GlobalCustomFieldTemplate

Back to top

GlobalStaffUnavailabilityCreateInput

An Input for creating a Global Staff Unavailability

start : LocalDateTime!

Start datetime of the global absence

end : LocalDateTime!

End datetime of the global absence

workingDays : Decimal!

Number of working days

timeZone : String

The absence timezone

description : String

Description of the absence

absenceReasonId : ID

The ID of the Absence Reason

Back to top

Grade

A grade assigned to a LearnerAssessment

gradedAt : LocalDateTime!

When the Grade was supplied

gradedBy : Contact!

The Contact who supplied the Grade

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
learnerAssessment : LearnerAssessment!

The LearnerAssessment this Grade belongs to

Argument Type Description
filters = [] [LearnerAssessmentFieldGraphFilter]
order = "__EMPTY__" LearnerAssessmentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerAssessmentFieldGraphOrder]
value : String

The value of the Grade defined by the GradeTemplate of the Assessment

Back to top

GradeTemplate

The marking scheme for an Assessment

Related types: Node

choices : [String!]!

The range of possible grades within the GradeTemplate

description : String

Description of the GradeTemplate

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the GradeTemplate

isArchived : Boolean!

Whether the GradeTemplate has been archived

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the GradeTemplate

Back to top

GradeTemplateConnection

A connection containing page information and edges for GradeTemplate

edges : [GradeTemplateEdge!]!

The list of GradeTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

GradeTemplateEdge

Contains cursor and node information for type GradeTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : GradeTemplate!

The GradeTemplate node.

Back to top

GradeTemplateField

Fields for filtering and ordering GradeTemplates

name
Back to top

GradeTemplateFieldGraphFilter

Filter that can be applied to limit which GradeTemplate nodes are returned

field : GradeTemplateField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

GradeTemplateFieldGraphOrder

Specifies the order in which GradeTemplate nodes are returned via the Connection

field : GradeTemplateField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

HolidayAllocation

An amount of holidays allocated to this Contact for a particular year

allocation : Float!

The allocation of the holiday

contact_id : ID!

The ID of the contact

year : Int!

The year of the allocation

Back to top

HolidayAllocationConnection

A connection containing page information and edges for HolidayAllocation

edges : [HolidayAllocationEdge!]!

The list of HolidayAllocation edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

HolidayAllocationEdge

Contains cursor and node information for type HolidayAllocation

cursor : String!

A string that can be used for cursor-based pagination

node : HolidayAllocation!

The HolidayAllocation node.

Back to top

HolidayAllocationInput

An Input for Holiday allocation of Contact

year : Int!

The year for the holiday allocation

allocation : Float!

The allocation for the holiday

Back to top

Honorific

A title that can be given to a person

id : ID!

The ID of the Honorific

title : String!

The title of the Honorific

Back to top

ID

A Unique ID

Back to top

IdentityProvider

An Identity Provider e.g. an OAuth2 or SAML service

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Identity Provider

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of this Identity Provider

signOutUrl : URL

The URL that signs out of this Identity Provider

singleSignOnInitiateEndpoint : String!

The endpoint on the SSO service to use to initiate single sign-on using this Identity Provider

type : IdentityProviderType!

The type of this Identity Provider

Back to top

IdentityProviderConnection

A connection containing page information and edges for IdentityProvider

edges : [IdentityProviderEdge!]!

The list of IdentityProvider edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

IdentityProviderEdge

Contains cursor and node information for type IdentityProvider

cursor : String!

A string that can be used for cursor-based pagination

node : IdentityProvider!

The IdentityProvider node.

Back to top

IdentityProviderFieldGraphFilter

Filter that can be applied to limit which IdentityProvider nodes are returned

field : IdentityProviderTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

IdentityProviderFieldGraphOrder

Specifies the order in which IdentityProvider nodes are returned via the Connection

field : IdentityProviderTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

IdentityProviderMutationResponse

A Response from mutating an Identity Provider

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

identityProvider : IdentityProvider

The Identity Provider that was mutated

Back to top

IdentityProviderMutations

Mutations available for Identity Providers

update : IdentityProviderMutationResponse!

Update the details of an Identity Provider

Argument Type Description
input IdentityProviderUpdateInput!

The input type with the values used to update the details of an Identity Provider
Back to top

IdentityProviderType

Types of Identity Provider

OAuth2
SAML
Back to top

IdentityProviderTypeField

Identity Provider Fields for Filtering and Ordering

name
type
Back to top

IdentityProviderUpdateInput

The input type with the values used to update an Identity Provider

identityProviderId : ID!

The ID of the Identity Provider to update

signOutUrl : URL

The edited URL to sign out of the Identity Provider

Back to top

InactiveInstructorIssue

A Session has an instructor whose Contact is inactive

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

contactId : ID!

The Contact ID of the inactive instructor

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

InactiveResourceIssue

A Session has a booking for an inactive Resource

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

resourceId : ID!

The ID of the inactive Resource

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

IndividualAccountCreateInput

An Input for creating an Individual Account

account : AccountCreateInput!

The details of the Account

contact : ContactCreateIndividualAccountInput!

The details of the Contact

Back to top

IndividualAccountUpdateInput

An Input for updating an Individual Account

account : AccountUpdateInput!

The details of the Account to be updated

contact : ContactUpdateInput!

The details of the Contact to be updated

Back to top

Industry

An organisation which groups Contacts together

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Account

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Account

Back to top

IndustryConnection

A connection containing page information and edges for Industry

edges : [IndustryEdge!]!

The list of Industry edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

IndustryEdge

Contains cursor and node information for type Industry

cursor : String!

A string that can be used for cursor-based pagination

node : Industry!

The Industry node.

Back to top

IndustryField

Fields for filtering and ordering Industries

id
name
Back to top

IndustryFieldGraphFilter

Filter that can be applied to limit which Industry nodes are returned

field : IndustryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

IndustryFieldGraphOrder

Specifies the order in which Industry nodes are returned via the Connection

field : IndustryField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

InstructorAbsenceReason

A Reason that can be associate with an Instructor Absence

Related types: Node

createdAt : TimeZonedDateTime!

The Date and Time the Instructor Absence Reason was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Instructor Absence Reason

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Instructor Absence Reason

updatedAt : TimeZonedDateTime!

The Date and Time the Instructor Absence Reason was last updated

Back to top

InstructorAbsenceReasonConnection

A connection containing page information and edges for InstructorAbsenceReason

edges : [InstructorAbsenceReasonEdge!]!

The list of InstructorAbsenceReason edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

InstructorAbsenceReasonCreateInput

An Input for creating an Instructor Absence Reason

name : String!

The Instructor Absence Reason name

Back to top

InstructorAbsenceReasonDeleteInput

An Input for deleting an Instructor Absence Reason

instructorAbsenceReasonId : ID!

The ID of Instructor Absence Reason to be deleted

Back to top

InstructorAbsenceReasonEdge

Contains cursor and node information for type InstructorAbsenceReason

cursor : String!

A string that can be used for cursor-based pagination

node : InstructorAbsenceReason!

The InstructorAbsenceReason node.

Back to top

InstructorAbsenceReasonField

Fields for filtering and ordering Instructor Absence Reasons

id
name
createdAt
updatedAt
Back to top

InstructorAbsenceReasonFieldGraphFilter

Filter that can be applied to limit which InstructorAbsenceReason nodes are returned

field : InstructorAbsenceReasonField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

InstructorAbsenceReasonFieldGraphOrder

Specifies the order in which InstructorAbsenceReason nodes are returned via the Connection

field : InstructorAbsenceReasonField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

InstructorAbsenceReasonMutateResponse

A response from Instructor Absence Reason Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

instructorAbsenceReason : InstructorAbsenceReason

An Instructor Absence Reason that has been mutated

Back to top

InstructorAbsenceReasonMutations

Mutations for an Instructor Absence Reason

create : InstructorAbsenceReasonMutateResponse!

Creates a new Instructor Absence Reason

Argument Type Description
input InstructorAbsenceReasonCreateInput!
delete : InstructorAbsenceReasonMutateResponse!

Deletes an Instructor Absence Reason

Argument Type Description
input InstructorAbsenceReasonDeleteInput!
update : InstructorAbsenceReasonMutateResponse!

Updates an existing Instructor Absence Reason

Argument Type Description
input InstructorAbsenceReasonUpdateInput!
Back to top

InstructorAbsenceReasonUpdateInput

An Input for updating an Instructor Absence Reason

instructorAbsenceReasonId : ID!

The ID of the Instructor Absence Reason being updated

name : String!

The new name for the Instructor Absence Reason

Back to top

InstructorConflict

Contains the conflicts for an instructor on a session, wrapper around ContactBooking

contactId : ID!

The Contact ID this conflict is for

end : TimeZonedDateTime!

When the conflicting booking ends

id : ID!

The ID of the conflicting booking

parentId : ID

If applicable, the parent of the conflicting booking.

reason : String

A given absence reason from a holiday or short explanation of the booking

staffId : ID

If applicable, the ID of the staff member associated with the conflicting booking.

start : TimeZonedDateTime!

When the conflicting booking begins

title : String!

The title of the conflicting booking

type : String!

The type of booking that is conflicting

unconfirmed : Boolean!

Whether this booking is tentative or not. Usually comes from external calendar events that have been synced as tentatively attending

Back to top

InstructorConflictIssue

An instructor booked on a Session has another booking overlapping its time

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

conflictEnd : TimeZonedDateTime!

When the conflicting booking ends

conflictId : ID!

The ID of the conflicting booking

conflictParentId : ID

If applicable, the parent of the conflicting booking

conflictReason : String

Why the conflicting booking exists, where available

conflictStaffId : ID

If applicable, the ID of the staff member associated with the conflicting booking

conflictStart : TimeZonedDateTime!

When the conflicting booking begins

conflictTitle : String

The title of the conflicting booking, if available

conflictType : String!

The type of the conflicting booking (session/event/absence/external_event)

conflictUnconfirmed : Boolean!

Whether the conflicting booking is tentative (e.g. from a synced external calendar)

contactId : ID!

The Contact ID of the instructor with the conflict

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

InstructorCourseRate

A rate for an Instructor on a Course

Related types: Node

contact : Contact!

The Contact (Instructor)

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
courseTemplate : CourseTemplate!

The Course for which the rate will be applied

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
currency : Currency!

The Currency of the rate

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Instructor Course Rate

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

rate : Decimal!

The rate amount

ratePer : InstructorCourseRatePer

The rate period (Hour, Session, Day, Course)

region : Region!

The Region for which the rate will be applied

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

InstructorCourseRateBulkCreateResponse

A response from bulk creating Instructor Course Rates

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

instructorCourseRates : [InstructorCourseRate!]!

The Instructor Course Rates that were created

Back to top

InstructorCourseRateConnection

A connection containing page information and edges for InstructorCourseRate

edges : [InstructorCourseRateEdge!]!

The list of InstructorCourseRate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

InstructorCourseRateCreateInput

An Input for creating an Instructor Course Rate

courseTemplateId : ID!

The ID of the Course Template

contactId : ID!

The ID of the Contact

regionId : ID!

The ID of the Region

currencyId : ID!

The ID of the Currency

rate : Decimal!

The rate amount

ratePer : RatePerEnum!

The rate period (Hour, Session, Day, Course)

Back to top

InstructorCourseRateDeleteInput

An Input for deleting an Instructor Course Rate

instructorCourseRateId : ID!

The ID of the Instructor Course Rate to be deleted

Back to top

InstructorCourseRateEdge

Contains cursor and node information for type InstructorCourseRate

cursor : String!

A string that can be used for cursor-based pagination

node : InstructorCourseRate!

The InstructorCourseRate node.

Back to top

InstructorCourseRateFieldGraphFilter

Filter that can be applied to limit which InstructorCourseRate nodes are returned

field : InstructorCourseRateTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

InstructorCourseRateFieldGraphOrder

Specifies the order in which InstructorCourseRate nodes are returned via the Connection

field : InstructorCourseRateTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

InstructorCourseRateMutateResponse

A response from Instructor Course Rate Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

instructorCourseRate : InstructorCourseRate

An Instructor Course Rate that has been mutated

Back to top

InstructorCourseRateMutations

Mutations for an Instructor Course Rate

create : InstructorCourseRateBulkCreateResponse!

Creates Instructor Course Rates in bulk

Argument Type Description
input [InstructorCourseRateCreateInput]!
delete : InstructorCourseRateMutateResponse!

Deletes an Instructor Course Rate

Argument Type Description
input InstructorCourseRateDeleteInput!
update : InstructorCourseRateMutateResponse!

Updates an existing Instructor Course Rate

Argument Type Description
input InstructorCourseRateUpdateInput!
Back to top

InstructorCourseRatePer

The rate period for an Instructor Course Rate

Hour
Session
Day
Course
Back to top

InstructorCourseRateTypeField

Fields for filtering and ordering Instructor Course Rates

id
contactId
regionId
currencyId
courseTemplateId
ratePer
Back to top

InstructorCourseRateUpdateInput

An Input for updating an Instructor Course Rate

instructorCourseRateId : ID!

The ID of the Instructor Course Rate being updated

contactId : ID

The ID of the Contact

regionId : ID

The ID of the Region

currencyId : ID

The ID of the Currency

rate : Decimal

The rate amount

ratePer : RatePerEnum

The rate period (Hour, Session, Day, Course)

courseTemplateId : ID

The ID of the Course Template

Back to top

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31 - 1) and 2^31 - 1 since represented in JSON as double-precision floating point numbers specifiedby IEEE 754.

Back to top

IntegrationAttemptRetryInput

An input for attempting to retry

retryParams : String!
integrationName : String!
Back to top

IntegrationAttemptRetryResponse

A Response for a Integration Retry Update Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

integrationRetry : IntegrationRetry

The Integration retry that was updated

Back to top

IntegrationRetry

An Integration retry for reattempting jobs

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Integration retry

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Integration retry

url : String!

URL of the retry endpoint

Back to top

IntegrationRetryConnection

A connection containing page information and edges for IntegrationRetry

edges : [IntegrationRetryEdge!]!

The list of IntegrationRetry edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

IntegrationRetryCreateInput

An input for creating an Integration Retry

name : String!

The name of the Integration

url : String!

The URL of the Integration Retry endpoint.

Back to top

IntegrationRetryCreateResponse

A Response for a Integration Retry Create Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

integrationRetry : IntegrationRetry

The Integration Retry that was created

Back to top

IntegrationRetryEdge

Contains cursor and node information for type IntegrationRetry

cursor : String!

A string that can be used for cursor-based pagination

node : IntegrationRetry!

The IntegrationRetry node.

Back to top

IntegrationRetryField

Fields for filtering and ordering Integration Retry

id
name
url
Back to top

IntegrationRetryFieldGraphFilter

Filter that can be applied to limit which IntegrationRetry nodes are returned

field : IntegrationRetryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

IntegrationRetryFieldGraphOrder

Specifies the order in which IntegrationRetry nodes are returned via the Connection

field : IntegrationRetryField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

IntegrationRetryMutations

Updates integration retry information.

create : IntegrationRetryCreateResponse!

Creates a Integration Retry

Argument Type Description
input IntegrationRetryCreateInput!

The input type with the values used to create a Integration Retry
retry : IntegrationAttemptRetryResponse!

Performs a retry of an Integration

Argument Type Description
input IntegrationAttemptRetryInput!

The input type with the values used to perform a retry
update : IntegrationRetryCreateResponse!

Updates a Integration Retry

Argument Type Description
input IntegrationRetryUpdateInput!

The input type with the values used to update a Integration Retry
Back to top

IntegrationRetryUpdateInput

An input for updating a Integration Retry

integrationRetryId : ID!
name : String

The name of the integration

url : String

The url of the integration endpoint to hit

Back to top

Interest

Purchasable items that give an Opportunity value

Related types: Node

childInterests : InterestConnection!

The Interests that are children of this Interest

Argument Type Description
filters = [] [InterestFieldGraphFilter]
order = "__EMPTY__" InterestFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InterestFieldGraphOrder]
discountAmount : Decimal!

The total amount being discounted for all items of this Interest

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
giftVoucherDetails : GiftVoucherDetails

Gift Voucher Details specific to this Interest

id : ID!

ID of the Interest

interestedLearners : [LearnerDetail]!

Learners related specifically to this Interest

isExpired : Boolean!

Whether this Interest reservation has expired

isNewEvent : Boolean

Indicates whether the Interest is a new Event

isPrivateEvent : Boolean

Indicates whether the Interest is a Private Event

isReservable : Boolean!

Whether this Interest can be reserved

isTaxable : Boolean!

Whether this Opportunity Interest is taxable

item : InterestItem

The particular item for this Opportunity Interest (e.g. course, event, training token...)

learningPathDetails : LearningPathDetails

Learning Path Details specific to this Interest

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

opportunity : Opportunity

The opportunity that this Interest is related to

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
plannedPrivateEventStart : Date

Returns the planned start Date for a Private Event Interest

priceLevel : PriceLevel

The Price Level applied to this Interest

Argument Type Description
filters = [] [PriceLevelFieldGraphFilter]
order = "__EMPTY__" PriceLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PriceLevelFieldGraphOrder]
pricingAgreementPrice : PricingAgreementPrice

The Pricing Agreement Price applied to this Interest

Argument Type Description
filters = [] [PricingAgreementPriceFieldGraphFilter]
order = "__EMPTY__" PricingAgreementPriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PricingAgreementPriceFieldGraphOrder]
quantity : Int!

The number of items to be sold

subTotalAmount : Decimal!

The tax exclusive price charged for all items of this Interest

taxAmount : Decimal!

The total amount of tax being charged for all items of this Interest

taxInclusive : Boolean!

Indicates whether the unitAmount specified is inclusive of tax or not

taxType : TaxType

The Tax Type applicable to this Opportunity Interest

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
tokenTransaction : TrainingTokenTransaction

The Token Transaction that issued the Tokens associated with the Interest when winning the Opportunity

Argument Type Description
filters = [] [TrainingTokenTransactionFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTransactionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTransactionFieldGraphOrder]
totalAmount : Decimal!

The tax inclusive price charged for all items of this Interest

unitAmount : Decimal!

The price charged for a single item. Also see: taxInclusive

Deprecated fields (2)
eventDetails : EventDetails

Event Details specific to this Interest

Removal date: TBD.

Replaced by interestedLearners

learners : InterestLearners

Learners related specifically to this Interest

Removal date: TBD.

Replaced by interestedLearners

Back to top

InterestAddInput

An Input to add an Interest to an Opportunity

opportunityId : ID!

The ID of the Opportunity to add the Interest to

interestDetails : InterestDetailsAddInput!

The Input containing the details of the Interest being added to the Opportunity

Back to top

InterestConnection

A connection containing page information and edges for Interest

edges : [InterestEdge!]!

The list of Interest edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

InterestDetailsAddInput

An Input containing the details of an Interest to add to an Opportunity

id : ID!

The ID of the entity to be added as an Interest to an Opportunity

quantity : Int!

The amount of entities of that type to add

reserve : Boolean

If true, places will be reserved for the interest when it is added

parentId : ID
unitAmount : Decimal

The price charged on the Opportunity for this Interest. Also see: taxInclusive

taxInclusive : Boolean

Indicates whether the price specified in unitAmount is inclusive of tax or not

taxId : ID

The ID of the Tax Type to be applied on the price of the Interest

trainingTokenDetails : TrainingTokenDetailsAddInput
eventDetails : EventDetailsAddInput
courseDetails : CourseDetailsAddInput
learningPathDetails : LearningPathDetailsAddInput
trainingPassDetails : TrainingPassDetailsAddInput
pricingAgreementPriceId : ID
priceLevelId : ID

The ID of the Price Level for this Interest

reservationsValidUntil : TimeZonedDateTime

The date and time at which this Interest reservation will expire

Back to top

InterestDetailsUpdateInput

An Input containing the details to update an Interest

quantity : Int

The amount of entities of that type to add

unitAmount : Decimal

The pre-taxed price charged on the Opportunity for this Interest

eventDetails : EventDetailsUpdateInput

The input type containing values required only by Events Interests

courseDetails : CourseDetailsUpdateInput

The input type containing values required only by Course Interests

learningPathDetails : LearningPathDetailsUpdateInput

The input type containing values required only by Learning Path Interests

trainingPassDetails : TrainingPassDetailsUpdateInput
giftVoucherRecipientDetails : GiftVoucherRecipientDetailsInput
pricingAgreementPriceId : ID
Back to top

InterestEdge

Contains cursor and node information for type Interest

cursor : String!

A string that can be used for cursor-based pagination

node : Interest!

The Interest node.

Back to top

InterestField

An enumeration.

id
Back to top

InterestFieldGraphFilter

Filter that can be applied to limit which Interest nodes are returned

field : InterestField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

InterestFieldGraphOrder

Specifies the order in which Interest nodes are returned via the Connection

field : InterestField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

InterestItem

An interface to define the item constituting the interest of an opportunity. This may be a course, event, training token and so on.

Related types: CourseTemplate TrainingPassTypeOption StockItem Event GiftVoucherConfiguration LearningPath TrainingTokenType

id : ID!

ID of the interest item

Back to top

InterestLearners

Learners related to an Interest

Deprecated fields (3)
existingLearners : [ExistingLearnerDetail]!

The details of existing Learners associated with the Event item on this Opportunity Interest

Removal date: TBD.

Replaced by interestedLearners inside Interest

newLearners : [NewLearnerDetail]!

The details of new Learners associated with the Event item on this Opportunity Interest

Removal date: TBD.

Replaced by interestedLearners inside Interest

unnamedLearners : [UnnamedLearnerDetail]!

The details of unnamed Learners associated with the Event item on this Opportunity Interest

Removal date: TBD.

Replaced by interestedLearners inside Interest

Back to top

InterestRemoveInput

An Input to remove an Interest from an Opportunity

opportunityInterestId : ID!

The ID of the Opportunity Interest to remove

Back to top

InterestsRemoveInput

An Input to remove a list of Interests from an Opportunity

opportunityInterestIds : [ID]!

A list of IDs of Opportunity Interests to remove (the must all belong to the same opportunity)

Back to top

InterestUpdateInput

An Input to update an Interest on an Opportunity

interestId : ID!
interestDetails : InterestDetailsUpdateInput!

The Input containing the details of the Interest being Updated

Back to top

InterestUpsertDetailsInput

An Input containing the details of an Interest to upsert on an Opportunity

id : ID!

The ID of the entity this Interest points to (an Event, Course Template, Learning Path, etc). This cannot be changed once an Interest exists - if externalId matches an existing Interest that points to a different entity, the upsert is rejected.

quantity : Int!

The amount of entities of that type to add

externalId : ExternalIdInput

Identifies this Interest for future upsert calls. Omitting it always adds a new Interest, even if one already exists for the same entity.

reserve : Boolean

If true, places will be reserved for the interest. Only applies when creating a new Interest

parentId : ID
unitAmount : Decimal

The price charged on the Opportunity for this Interest. Also see: taxInclusive. Left unchanged on update if omitted

taxInclusive : Boolean

Indicates whether the price specified in unitAmount is inclusive of tax or not. Only applies when creating a new Interest

taxId : ID

The ID of the Tax Type to be applied on the price of the Interest. Left unchanged on update if omitted

trainingTokenDetails : TrainingTokenDetailsAddInput
eventDetails : EventDetailsUpdateInput

The input type containing values required only by Event Interests. Left unchanged on update if omitted

courseDetails : CourseDetailsUpdateInput

The input type containing values required only by Course Interests. Left unchanged on update if omitted

learningPathDetails : LearningPathDetailsUpdateInput

The input type containing values required only by Learning Path Interests. Left unchanged on update if omitted

trainingPassDetails : TrainingPassDetailsUpdateInput

The input type containing values required only by Training Pass Interests. Left unchanged on update if omitted

giftVoucherRecipientDetails : GiftVoucherRecipientDetailsInput

The Gift Voucher Recipient details for a Gift Voucher Interest. Only applies when updating an existing Interest already tagged with an externalId; not supported when creating a new one

pricingAgreementPriceId : ID

The ID of the Pricing Agreement Price for this Interest. Left unchanged on update if omitted

priceLevelId : ID

The ID of the Price Level for this Interest. Only applies when creating a new Interest

reservationsValidUntil : TimeZonedDateTime

The date and time at which this Interest reservation will expire. Only applies when creating a new Interest

Back to top

InternalLogMetadataInput

Additional metadata to record internally for the Log event

category : String!

the main category of the operation that generated this log (e.g. "myIntergration")

subcategory : String!

operation subcategory with optional granularity (e.g. "update:success")

details : JSONEncodedString

additional information to record (encoded as a JSON payload)

Back to top

Invoice

An Invoice containing the information about an order

Related types: SalesDocument Node

account : Account

The Account linked to this Sales Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
accountName : String

The name of the account

billingAddress : PostalAddress

The address details for the invoice

comments : String

Comments saved for the Invoice

company : Company

The Company that issued this Sales Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
companyRegistrationNumber : String

The Registration Number of the company associated with this Invoice

contactName : String

The Name of the Contact associated with the Invoice

createdAt : TimeZonedDateTime!

The date this Invoice was created on

creditNoteAllocations : [InvoiceCreditNoteAllocation!]!

A record of Credit Note allocations made for this Invoice

currency : Currency

The Currency this Sales Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
department : String

The Department of the Contact associated with the Invoice

discount : Discount

The Discount applied to this Sales Document

discountAmount : Decimal!

The total amount of discount applied to this Sales Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
finalisedAt : TimeZonedDateTime

The date at which the Invoice was finalised

id : ID!

The ID of this Sales Document

isPaid : Boolean!

Whether the Invoice has been paid in full

jobRole : String

The Job Role of the Contact associated with the Invoice

learners : LearnerConnection!

A record of Payments made for this Invoice

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : InvoiceLifecycleState!

The lifecycle state of this invoice

lines : [InvoiceLine!]!

A list of lines containing the information about the ordered items

number : String!

The sequence number used to identify this Sales Document

opportunity : Opportunity

The Opportunity associated with this Invoice

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
otherInvoiceRef : String

The Other Reference for this Invoice

paymentStatus : InvoicePaymentStatus!

The payment status of this Invoice

payments : PaymentConnection!

A record of Payments made for this Invoice

Argument Type Description
filters = [] [PaymentFieldGraphFilter]
order = "__EMPTY__" PaymentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PaymentFieldGraphOrder]
purchaseOrderReference : String

The Purchase Order reference the customer may have issued

region : Region

The Region in which the Sales Document is located in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
subTotalAmount : Decimal!

The amount of this Sales Document excluding any Tax or Discount

taxPoint : Date!

The date that this Invoice was issued on

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Sales Document

totalAmount : Decimal!

The total amount of this Sales Document including Tax and Discounts

totalRemaining : Decimal!

The total remaining to pay of this Invoice

updatedAt : TimeZonedDateTime!

The date this Invoice was last updated on

vatNumber : String

VAT Tax Number for the Invoice

Deprecated fields (1)
invoiceDate : Date!

The date that this Invoice was issued on

Removal date: TBD.

Replaced by taxPoint

Back to top

InvoiceAllocation

Details about an allocation to an Invoice

amount : Decimal!

The amount allocated

id : ID!

The ID of this Allocation

invoice : Invoice!

The Invoice allocated to

Argument Type Description
filters = [] [InvoiceFieldGraphFilter]
order = "__EMPTY__" InvoiceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InvoiceFieldGraphOrder]
Back to top

InvoiceAllocationMutateResponse

A Response from allocating to an Invoice

Related types: MutationResponse

allocation : InvoiceAllocation

The allocation to an Invoice that was just made

errors : [FieldError!]!

The errors returned by the mutation

Back to top

InvoiceConnection

A connection containing page information and edges for Invoice

edges : [InvoiceEdge!]!

The list of Invoice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

InvoiceCreateInput

An Input for creating a new Sales Invoice

fromCompanyId : ID!
toAccountId : ID!
regionId : ID!
currencyId : ID!
taxPoint : Date!
discountId : ID
purchaseOrderRef : String
otherInvoiceRef : ID
accountName : String
companyRegistrationNumber : String
vatNumber : String
contactName : String
jobRole : String
department : String
addressLine1 : String
addressLine2 : String
addressLine3 : String
town : String
county : String
postcode : String
countryId : ID
comments : String
Back to top

InvoiceCreateMutationResponse

A response for creating an Invoice

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

invoice : Invoice

The created invoice

Back to top

InvoiceCreditNoteAllocation

Represents the allocation of a Credit Note to an Invoice

amount : Decimal!

The amount of this Allocation

creditNote : CreditNote!

The Credit Note related to this Allocation

Argument Type Description
filters = [] [CreditNoteFieldGraphFilter]
order = "__EMPTY__" CreditNoteFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CreditNoteFieldGraphOrder]
id : ID!

The ID of the Allocation

Back to top

InvoiceCreditNoteAllocationInput

An Input for allocating a Credit Note to an Invoice, so that the amount specified from the Credit Note goes towards the Invoice balance

invoiceId : ID!

The Invoice that the Credit Note is being allocated to

creditNoteId : ID!

The Credit Note being allocated to the Invoice

amount : Decimal!

The amount of credit on the Credit Note being allocated to the Invoice

Back to top

InvoiceDeleteInput

An Input for deleting a Sales Invoice

invoiceId : ID!

The id of the Invoice we wish to delete

Back to top

InvoiceDeleteMutationResponse

A response for deleting an Invoice

errors : [FieldError!]!

The errors returned by the mutation

invoice : Invoice

The deleted invoice

Back to top

InvoiceEdge

Contains cursor and node information for type Invoice

cursor : String!

A string that can be used for cursor-based pagination

node : Invoice!

The Invoice node.

Back to top

InvoiceFieldGraphFilter

Filter that can be applied to limit which Invoice nodes are returned

field : InvoiceTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

InvoiceFieldGraphOrder

Specifies the order in which Invoice nodes are returned via the Connection

field : InvoiceTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

InvoiceFinaliseInput

The input to finalise an Invoice

invoiceId : ID!

The ID of the Invoice to be finalised

Back to top

InvoiceFinaliseMutateResponse

A Response for finalising an Invoice

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

invoice : Invoice

The finalised Invoice

Back to top

InvoiceLifecycleState

Denotes the lifecycle state of an Invoice

Draft

The Invoice is a draft and edits are allowed

Final

The Invoice details have been finalised and only non-financial changes are allowed

Void

The Invoice has been cancelled and is no longer valid

Back to top

InvoiceLine

A line item of an Invoice

description : String

Text which describes what was sold

discount : Discount

The discount applied to each unit

extendedAmount : Decimal!

The amount for all units sold, inclusive of tax

financialAccount : FinancialAccount!

Which account in the Chart of Accounts that line item financial transaction is recorded in

giftVoucher : GiftVoucher

The gift voucher transaction source linked to this line.

id : ID!

The ID of the Invoice

isDiscountable : Boolean!

Whether this line should have invoice discounts applied.

isTaxable : Boolean!

Whether this line should have tax applied.

itemPrice : StockItemPrice

The selected item price used to create this line.

linkedSellable : InterestItem

The Event or Learning Path that is optionally linked to the line for grouping.

quantity : Int!

The number of units which were sold

registerable : Registerable

The Learner or Learning Path Learner associated with this Line Item

Argument Type Description
filters = [] [RegisterableFieldGraphFilter]
order = "__EMPTY__" RegisterableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegisterableFieldGraphOrder]
revenueType : String

The IHT revenue type linked to this line.

sellable : InterestItem

The Interest Item this line represents.

serviceDate : Date

The date of service for the line.

tag : EventTag

The legacy event tag linked to this line.

taxAmount : Decimal!

The amount of tax charged for each unit

taxType : TaxType

The type of tax charged on the line item

tokenTransaction : TrainingTokenTransaction

The token transaction linked to this line.

tokenType : TrainingTokenType

The token type linked to this line.

trainingPassTypeOption : TrainingPassTypeOption

The training pass type option linked to this line.

unitAmount : Decimal!

The price charged for each unit after discount has been applied

value : Decimal!

The original price for each unit without discount or tax

Deprecated fields (1)
linkedEvent : Event

The Event that is optionally linked to the line item

Removal date: TBD.

Replaced by linkedSellable

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
Back to top

InvoiceLineInput

Input for replacing the draft Sales Invoice lines.

id : ID
description : String
quantity : Int
value : Decimal
financialAccountId : ID
taxTypeId : ID
isTaxable : Boolean
isDiscountable : Boolean
serviceDate : Date
sellableId : ID
linkedSellableId : ID
registrationEntryId : ID
itemPriceId : ID
tagId : ID
revenueType : String
tokenTransactionId : ID
tokenTypeId : ID
giftVoucherId : ID
trainingPassTypeOptionId : ID
Back to top

InvoiceMutations

Mutations for Invoices

addPaymentAllocations : InvoicePaymentMutationResponse!

Adds more allocations against invoices to a specified Payment.

Argument Type Description
input AddPaymentAllocationsInput!

Adds allocations to a Payment
allocateCreditNote : InvoiceAllocationMutateResponse!

Allocates an amount of credit from a Credit Note towards paying off an Invoice

Argument Type Description
input InvoiceCreditNoteAllocationInput!

Allocates an amount of credit from a Credit Note towards paying off an Invoice
create : InvoiceCreateMutationResponse!

Creates a new Invoice

Argument Type Description
input InvoiceCreateInput!

Data for creating a new Invoice
delete : InvoiceDeleteMutationResponse!

Deletes an existing Invoice

Argument Type Description
input InvoiceDeleteInput!

Data for deleting an existing Invoice
deletePayment : InvoicePaymentMutationResponse!

Deletes a Payment made against one or more Invoices

Argument Type Description
input InvoicePaymentDeleteInput!

Deletes a Payment against one or more Invoices
deletePaymentAllocations : InvoicePaymentMutationResponse!

Deletes specified allocations for the specified Payment.

Argument Type Description
input DeletePaymentAllocationsInput!

Deletes allocations of a Payment
finalise : InvoiceFinaliseMutateResponse!

Mark an Invoice as final

Argument Type Description
input InvoiceFinaliseInput!

The input type with the Invoice to be finalised
payInvoices : InvoicePaymentMutationResponse!

Makes a Payment against one or more Invoices

Argument Type Description
input InvoicePaymentInput!

Makes a Payment against one or more Invoices
removeCreditNoteAllocation : RemoveCreditNoteAllocationResponse!

Removes an existing Credit Note allocation from an invoice

Argument Type Description
input InvoiceRemoveCreditNoteAllocationInput!

The input containing the ID of the allocation to remove
update : InvoiceUpdateMutationResponse!

Updates an existing Invoice

Argument Type Description
input InvoiceUpdateInput!

Data for updating an existing Invoice
updatePayment : InvoicePaymentMutationResponse!

Update a Payment made against one or more Invoices

Argument Type Description
input InvoicePaymentUpdateInput!

Update a Payment against one or more Invoices
updatePaymentAllocations : InvoicePaymentMutationResponse!

Updates specified allocations for a specified Payment.

Argument Type Description
input UpdatePaymentAllocationsInput!

Updates allocations of a Payment
Back to top

InvoiceNumberingScheme

Available choices for invoice Numbering prefix

region
company
accountCategoryDeprecated
Back to top

InvoiceNumberingSchemeInput

An enumeration.

region
company
Back to top

InvoicePaymentDeleteInput

The input for an Invoice Payment Deletion

paymentId : ID!

The id of the Payment we wish to delete

Back to top

InvoicePaymentInput

The input for an Invoice Payment

allocations : [InvoicesPaymentAllocationInput]!

The list of allocations of this Payment

financialAccountId : ID!

The Account where the Payment funds where deposited

paidOn : Date!

The date when the Payment was made

paymentMethod : PaymentMethodInput!

The Payment Method used

notes : String

Optional additional information about the Payment

Back to top

InvoicePaymentMutationResponse

A Response from paying one or more Invoices

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

payment : Payment

The Payment created by paying the Invoices

Back to top

InvoicePaymentStatus

The payment status types associated with the invoice

unpaid
partiallyPaid
paid
overpaid
Back to top

InvoicePaymentUpdateInput

The input for an Invoice Payment Update

paymentId : ID!

The id of the Payment we wish to update

financialAccountId : ID

The Account where the Payment funds where deposited

paidOn : Date

The date when the Payment was made

paymentMethod : UpdatePaymentMethodInput

The Payment Method used

notes : String

Optional additional information about the Payment

Back to top

InvoiceRemoveCreditNoteAllocationInput

An Input for removing a Credit Note's allocation from an Invoice

creditNoteAllocationId : ID!

The ID of the Credit Note allocation to be removed

Back to top

InvoicesPaymentAllocationInput

Details about the allocation of a Payment to an Invoice

invoiceId : ID!
amount : Decimal!
Back to top

InvoiceTaxSummary

Represents the amount of a certain Tax Type applied to an Invoice

amount : Decimal!

The amount of tax applied to the Invoice for this particular summary

taxType : TaxType!

The Tax Type this summary refers to

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
Back to top

InvoiceTypeField

Fields for filtering and sorting

accountId
companyId
currencyCode
regionId
id
invoiceDate
lifecycleState
number
createdAt
finalisedAt
totalRemaining
purchaseOrderReference
Back to top

InvoiceUpdateInput

An Input for updating a Sales Invoice

invoiceId : ID!
toAccountId : ID
taxPoint : Date
discountId : ID
purchaseOrderRef : String
otherInvoiceRef : ID
accountName : String
companyRegistrationNumber : String
vatNumber : String
contactName : String
jobRole : String
department : String
addressLine1 : String
addressLine2 : String
addressLine3 : String
town : String
county : String
postcode : String
countryId : ID
comments : String
Back to top

InvoiceUpdateMutationResponse

A response for updating an Invoice

errors : [FieldError!]!

The errors returned by the mutation

invoice : Invoice

The created invoice

Back to top

ISODuration

A Duration formatted as an ISO 8601 duration string

Back to top

IssueSource

Provenance metadata for an EventIssue. An issue may carry multiple sources after dedup — for instance, when both Administrate and a Custom Business Rule independently surface the same fact.

annotation : String

Optional one-line note attached by the source — e.g. an explanation from the customer's rule

kind : IssueSourceKind!

Where the source came from: default (Administrate) or rule (a Custom Business Rule)

ruleId : ID

When kind is rule, the ID of the rule that produced the issue

Back to top

IssueSourceKind

Where an EventIssue's data came from. default for issues produced by Administrate's own checks; rule for issues produced by a Custom Business Rule.

default
rule
Back to top

JobRole

A Job Role For Membership Job Roles

Related types: Node

archived : Boolean!

Whether or not the Job Role is archived

archivedAt : TimeZonedDateTime

The Date and Time the Job Role was archived

createdAt : TimeZonedDateTime!

The Date and Time the Job Role was created

default : Boolean!

Whether or not this Job Role is a default for new Memberships

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Job Role

inUse : Boolean!

Whether or not this Job Role is in use

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Job Role

updatedAt : TimeZonedDateTime

The Date and Time the Job Role was updated

Back to top

JobRoleConnection

A connection containing page information and edges for JobRole

edges : [JobRoleEdge!]!

The list of JobRole edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

JobRoleCreateInput

An Input for creating a Job Role

name : String!

The Job Role name

Back to top

JobRoleDeleteInput

An Input for deleting a Job Role

jobRoleId : ID!

The ID of Job Role to be deleted

Back to top

JobRoleEdge

Contains cursor and node information for type JobRole

cursor : String!

A string that can be used for cursor-based pagination

node : JobRole!

The JobRole node.

Back to top

JobRoleField

Fields for filtering and ordering Job Roles

id
name
createdAt
updatedAt
archivedAt
default
Back to top

JobRoleFieldGraphFilter

Filter that can be applied to limit which JobRole nodes are returned

field : JobRoleField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

JobRoleFieldGraphOrder

Specifies the order in which JobRole nodes are returned via the Connection

field : JobRoleField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

JobRoleMutateResponse

A response from Job Role Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

jobRole : JobRole

A Job Role that has been mutated

Back to top

JobRoleMutations

Mutations for a Job Role

create : JobRoleMutateResponse!

Creates a new Job Role

Argument Type Description
input JobRoleCreateInput!

Input fields for creating a new Job Role
delete : JobRoleMutateResponse!

Deletes a Job Role

Argument Type Description
input JobRoleDeleteInput!

Input fields to specify which Job Role to delete
setDefault : JobRoleMutateResponse!

Sets a Job Role as the default one assigned to Contacts

Argument Type Description
input JobRoleSetDefaultInput!

Input fields to specify which Job Role to mark as the default
update : JobRoleMutateResponse!

Updates an existing Job Role

Argument Type Description
input JobRoleUpdateInput!

Input fields for updating an existing Job Role
Back to top

JobRoleSetDefaultInput

An Input for setting a Job Role default

jobRoleId : ID!

The ID of Job Role to be default

Back to top

JobRoleUpdateInput

An Input for updating a Job Role

jobRoleId : ID!

The ID of the Job Role being updated

name : String

The new name for the Job Role

archived : Boolean
Back to top

JSONEncodedString

An arbitrary JSON payload encoded as its string representation

Back to top

JwtPublicKey

JWT Public Key Type

publicKey : String!

The Base64 encoded JWT Public Key to configure the OAuth App

vendor : LmsVendor!

The vendor of the JWT Public Key

Back to top

KryterionAccountResponse

The Response for a Kryterion resource creation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

kryterionAccountExists : Boolean!

Boolean indicating whether a Kryterion Account exists for the learner

learner : Learner

The Learner that we have created a KryterionResource for

Back to top

KryterionActivityContentResult

A summary of results for a Learner's Kryterion Activity

Related types: LearnerContentResult

completedAttempts : Int!

The number of complete attempts the Learner has had on this EventContent

content : LmsContent!

The EventContent this result relates to

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
contentId : ID!

The ID to the piece of EventContent this result relates to

id : ID!

The ID of the LearnerContentResult

isRequired : Boolean

Whether the EventContent is required for the Learner to complete the Event

lastAccessed : TimeZonedDateTime

The date and time when the EventContent was last accessed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
lmsAttempts : LmsAttemptConnection!

The learner attempts on the EventContent

Argument Type Description
filters = [] [LmsAttemptFieldGraphFilter]
order = "__EMPTY__" LmsAttemptFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LmsAttemptFieldGraphOrder]
numberOfAttempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

progress : Decimal

The percentage complete the Learner has achieved on the EventContent

score : Decimal

The score the Learner has achieved on the EventContent

scorePercent : Decimal

The score percent the Learner has achieved on the EventContent

status : ContentResultStatus!

The current status of the EventContent

Deprecated fields (1)
attempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

Removal date: TBD.

Replaced by numberOfAttempts

Back to top

LeadDeadReason

A reason for marking a Lead or Enquiry as dead.

Related types: Node

description : String!

The reason description.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Lead Dead Reason.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

LeadDeadReasonConnection

A connection containing page information and edges for LeadDeadReason

edges : [LeadDeadReasonEdge!]!

The list of LeadDeadReason edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LeadDeadReasonEdge

Contains cursor and node information for type LeadDeadReason

cursor : String!

A string that can be used for cursor-based pagination

node : LeadDeadReason!

The LeadDeadReason node.

Back to top

LeadDeadReasonField

Fields for filtering and ordering Lead Dead Reasons.

id
description
Back to top

LeadDeadReasonFieldGraphFilter

Filter that can be applied to limit which LeadDeadReason nodes are returned

field : LeadDeadReasonField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LeadDeadReasonFieldGraphOrder

Specifies the order in which LeadDeadReason nodes are returned via the Connection

field : LeadDeadReasonField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

Learner

Record of a Learner on an Event

Related types: Node Billable Registerable

achievements : AchievementConnection

The Achievement earned by the Learner

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
attendance : LearnerAttendance

Details of this learner's attendance

bookingContact : Contact

The contact that booked on behalf of the Learner - only populated for Unnamed Learners

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
brandId : String

The brandId for this Learner

breakoutGroups : [EventBreakoutGroup!]!

Returns the Breakout Group selection that was made when registering this learner

Argument Type Description
filters = [] [EventBreakoutGroupFieldGraphFilter]
order = "__EMPTY__" EventBreakoutGroupFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventBreakoutGroupFieldGraphOrder]
cancelledAt : TimeZonedDateTime

Datetime that the Learner was cancelled

cancelledBy : User

User that cancelled the Learner.

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
ccAddressesOnTriggers : [CcAddress!]!

Email addresses to CC on automatic communications

certificateSentOn : Date

The date the Certificate was sent to the Learner

communicationsContact : Contact

An optional Contact that will receive all communications for the Learner

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
contact : Contact

Contact record for the Learner

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
contactId : String

The Learner or LearningPathLearner's contact ID

contentResults : LearnerContentResultConnection

A summary of results for this Learner

Argument Type Description
filters = [] [LearnerContentResultFieldGraphFilter]
order = "__EMPTY__" LearnerContentResultFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerContentResultFieldGraphOrder]
createdAt : TimeZonedDateTime

Date the Learner record was created

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Learner

Argument Type Description
filter CustomFieldFilterInput
description : String!

A short description of this Learner, namely the event code and title.

end : TimeZonedDateTime

The end of the Event the Learner is attending

event : Event

Event for which the Learner is registered

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
expiresAt : TimeZonedDateTime

The date and time from which the Learner can no longer access the Event

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
hasPaid : Boolean

If the Learner has paid either by token or by seeing if the linked invoiced has a net 0 balance

hasPassed : Boolean

Whether the Learner has passed or failed. Returns true if the Learner has passed, false if they have failed and null if a result has not been recorded

id : ID!

ID of the Learner

isActive : Boolean!

Whether the Learner is Active on the Event

isCancelled : Boolean!

Whether the Learner is Active on the Event

isInvoiced : Boolean!

Whether this Learner has an invoice line.

isUnnamed : Boolean!

Denotes whether this is a record for Unnamed Learner(s)

lastUpdatedAt : TimeZonedDateTime

A timestamp of the last time this Learner was updated

learnerPrice : LearnerPrice

Price associated with the registration for this learner

learningPath : LearningPath

The Learning Path for the Event this Learner is registered on

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
learningPathCourseOutcomes : CourseOutcomeConnection

The Course Outcomes that the Learner represents as part of a Learning Path Learner

Argument Type Description
filters = [] [CourseOutcomeFieldGraphFilter]
order = "__EMPTY__" CourseOutcomeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseOutcomeFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : LearnerLifecycleState!

The state of this Learner in its life cycle

lmsLastAccessed : TimeZonedDateTime

The date and time the Learner last accessed this event in the LMS

lmsTitle : String

The Title to show on the LMS for this Learner

lmsTotalSteps : Int!

The total number of currently active and required steps in this Event's LMS

lmsTotalStepsCompleted : Int!

The total number of currently active and required steps the Learner has completed in this Event's LMS

location : String!

The name of the Location of the Event attended by the Learner

notes : String

Notes associated with this Learner

parentId : ID

Parent Learner for a session Learner.

passAccessExpired : Boolean!

If registration was made via a TrainingPass, confirms access is still available

quantity : Int!

The quantity of Learners on this record

registration : Registration

Registration the Learner is assigned to

Argument Type Description
filters = [] [RegistrationFieldGraphFilter]
order = "__EMPTY__" RegistrationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationFieldGraphOrder]
registrationId : String

The Learner or LearningPathLearner's registration ID

result : LearnerResult!

The result recorded for the Learner on the Event

scores : [LearnerScore!]!

Returns the Learner Scores according to the Event Scores Template.

Argument Type Description
highlightedOnly = false Boolean

only returns scores marked as 'highlighted'
session : Session

Session for a session Learner.

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
start : TimeZonedDateTime

The start of the Event the Learner is attending

taxType : TaxType

Tax Type applied to this Learner.

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
tokenTransaction : TrainingTokenTransaction

The Token Transaction associated with the Training Token redemption for this Learner, if applicable

Argument Type Description
filters = [] [TrainingTokenTransactionFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTransactionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTransactionFieldGraphOrder]
trackingIdentifier : String

An External Identifier to identify this Learner

transferredAt : TimeZonedDateTime

When this Learner was transferred to current Event

transferredFrom : Learner

Previous Learner that this Learner was transferred from

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
transferredTo : Learner

Learner that this Learner was transferred to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
Deprecated fields (3)
achievement : Achievement

The Achievement earned by the Learner

Removal date: TBD.

Reason 
Please use achievements field instead.

This field is no longer supported after the introduction of
the multiple achievements
 |

| Removal Date | TBD | | Deprecation Date | TBD |

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
lmsProgress : Decimal!

The total percentage completion across all required Content, divided by the number of required Content items. Note: completed videos are counted as 100%.

Removal date: TBD.

Reason
Please use [lmsTotalStepsCompleted / lmsTotalSteps] to retrieve the percentage of currently active and required items the Learner has completed in this Event's LMS.

The "lmsProgress" field returns surprising and inconsistent results as it counts "scores" for each piece of content ignoring completion status. | | Removal Date | TBD | | Deprecation Date | TBD |

price : Decimal

The price of an individual Learner

Removal date: TBD.

Replaced by learnerPrice

Back to top

LearnerAssessment

An Assessment assigned to a specific Learner that can be given a Grade

Related types: Node

assessment : Assessment!

The Assessment that this LearnerAssessment is an instance of

dueDate : LocalDateTime

This represents an edited due date for a single Learner

event : Event!

The event the assessment is part of

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
grade : Grade

The Grade assigned to this LearnerAssessment if it has been graded

id : ID!

ID of the LearnerAssessment

learner : Learner!

The Learner associated with the Learner Assessment

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

submission : LearnerAssessmentSubmission

The submission uploaded to complete this LearnerAssessment if it has been submitted

Back to top

LearnerAssessmentConnection

A connection containing page information and edges for LearnerAssessment

edges : [LearnerAssessmentEdge!]!

The list of LearnerAssessment edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearnerAssessmentEdge

Contains cursor and node information for type LearnerAssessment

cursor : String!

A string that can be used for cursor-based pagination

node : LearnerAssessment!

The LearnerAssessment node.

Back to top

LearnerAssessmentField

Fields for filtering and ordering LearnerAssessments

id
dueDate
gradableBy
submittableBy
graded
Back to top

LearnerAssessmentFieldGraphFilter

Filter that can be applied to limit which LearnerAssessment nodes are returned

field : LearnerAssessmentField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearnerAssessmentFieldGraphOrder

Specifies the order in which LearnerAssessment nodes are returned via the Connection

field : LearnerAssessmentField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearnerAssessmentMutations

Updates that can be made to LearnerAssessments

giveGrade : LearnerAssessment!

Sets the Grade value for a LearnerAssessment

Argument Type Description
value String!

the value of the Grade that is being given
learnerAssessmentId ID!

The ID of the LearnerAssessment receiving the Grade
gradedByContactId ID!

The ID of the Contact giving the Grade
submit : LearnerAssessment!

Stores a reference to a file uploaded to S3 for a single LearnerAssessment

Argument Type Description
fileName String!

The file name of the file that was uploaded to S3
filePath String!

The file path to the uploaded file in an S3 bucket
learnerAssessmentId ID!

The ID of the LearnerAssessment being submitted
submittedByContactId ID!

The ID of the submitting Contact
Back to top

LearnerAssessmentSubmission

A piece of work submitted by a Learner to complete a LearnerAssessment

fileName : String

The file name of the submission

filePath : String

The file path to the submission in an S3 bucket

learnerAssessment : LearnerAssessment!

The LearnerAssessment this submission belongs to

Argument Type Description
filters = [] [LearnerAssessmentFieldGraphFilter]
order = "__EMPTY__" LearnerAssessmentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerAssessmentFieldGraphOrder]
submittedAt : LocalDateTime!

When the submission was uploaded

Back to top

LearnerAttendance

Details about a learner's attendance

sessionDetail : SessionDetailConnection!

A summary of sessions for this Learner

Argument Type Description
filters = [] [SessionDetailFieldGraphFilter]
order = "__EMPTY__" SessionDetailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionDetailFieldGraphOrder]
sessionsAttended : Int!

The number of sessions the Learner has attended

sessionsMissed : Int!

The number of sessions the Learner has missed

totalSessions : Int!

The total number of sessions for this Learner

Back to top

LearnerAttendanceInput

An input for recording Learner Attendance

learnerId : ID!

The ID of the Learner attending the Event

sessionId : ID!

The ID of the Session being attended

attended : Boolean

If the Learner attended or not

Back to top

LearnerAttendanceStatus

An enumeration.

Present
Absent
Unrecorded
Back to top

LearnerAwardAchievementInput

An input to award an Achievement to a Learner

learnerId : ID!

The ID of the Learner being awarded an Achievement

achievementTypeId : ID!

The ID of the Achievement Type being awarded

achievedAt : Date

(Deprecated) The date when the Achievement is valid from

validFrom : Date

The date when the Achievement is valid from

identifier : String

The identifier of the Acheivement being awarded

Back to top

LearnerBulkMutateResponse

A Response from mutating Learners in bulk

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learners : [Learner!]!

The Learners that were updated

Back to top

LearnerCancelByExternalIdInput

An Input for cancelling a Learner with an ID or External ID

id : ID

The ID of the Learner to cancel. Cannot be used in conjunction with the External ID.

externalId : ExternalIdInput

The External ID of the Learner to cancel. Cannot be used in conjunction with the ID.

Back to top

LearnerConnection

A connection containing page information and edges for Learner

edges : [LearnerEdge!]!

The list of Learner edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearnerContentResult

A summary of results for a Learner on a piece of EventContent

Related types: ResourceContentResult ScormContentResult VideoContentResult ExternalActivityContentResult KryterionActivityContentResult DiscussionTopicContentResult

completedAttempts : Int!

The number of complete attempts the Learner has had on this EventContent

content : LmsContent!

The EventContent this result relates to

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
contentId : ID!

The ID to the piece of EventContent this result relates to

id : ID!

The ID of the LearnerContentResult

isRequired : Boolean

Whether the EventContent is required for the Learner to complete the Event

lastAccessed : TimeZonedDateTime

The date and time when the EventContent was last accessed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
lmsAttempts : LmsAttemptConnection!

The learner attempts on the EventContent

Argument Type Description
filters = [] [LmsAttemptFieldGraphFilter]
order = "__EMPTY__" LmsAttemptFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LmsAttemptFieldGraphOrder]
numberOfAttempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

progress : Decimal

The percentage complete the Learner has achieved on the EventContent

score : Decimal

The score the Learner has achieved on the EventContent

scorePercent : Decimal

The score percent the Learner has achieved on the EventContent

status : ContentResultStatus!

The current status of the EventContent

Deprecated fields (1)
attempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

Removal date: TBD.

Replaced by numberOfAttempts

Back to top

LearnerContentResultConnection

A connection containing page information and edges for LearnerContentResult

edges : [LearnerContentResultEdge!]!

The list of LearnerContentResult edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearnerContentResultEdge

Contains cursor and node information for type LearnerContentResult

cursor : String!

A string that can be used for cursor-based pagination

node : LearnerContentResult!

The LearnerContentResult node.

Back to top

LearnerContentResultField

LearnerContentResult Fields for Filtering and Ordering

lastAccessed
contentId
contentArchived
Back to top

LearnerContentResultFieldGraphFilter

Filter that can be applied to limit which LearnerContentResult nodes are returned

field : LearnerContentResultField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearnerContentResultFieldGraphOrder

Specifies the order in which LearnerContentResult nodes are returned via the Connection

field : LearnerContentResultField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearnerDetail

Related types: ExistingLearnerDetail NewLearnerDetail UnnamedLearnerDetail

attributes : [CustomFieldValue!]!

The attributes of the Existing Learner

Argument Type Description
filter CustomFieldFilterInput
communicationsCcAddresses : [String!]!

Additional email addresses that will be included as CC in all Learner communications

communicationsContact : Contact

The Contact to whom all communications regarding this Learner will be sent to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
id : ID!

ID of the Content

Back to top

LearnerEdge

Contains cursor and node information for type Learner

cursor : String!

A string that can be used for cursor-based pagination

node : Learner!

The Learner node.

Back to top

LearnerField

Fields for filtering and ordering Learners

id
courseTemplateId
event
eventId
contact
contactName
contactId
contactAccountName
contactPrimaryAccountName
contactEmailAddress
contactMobilePhoneNumber
commsEmailAddress
commsMobilePhoneNumber
registration
createdAt
price
hasPassed
name
bookingContactName
bookingContactEmailAddress
bookingContactMobilePhoneNumber
lifecycleState
learningMode
isActive
isCancelled
isSessionLearner
cancelledAt
eventTitle
lmsLastAccessed
brandId
lmsTitle
managedByContactId
eventTimeZonedStart
eventStartDate
eventTimeZonedEnd
eventEndDate
eventLocationName
hasParentLearningPath
isLmsComplete
isUnnamed
trackingIdentifier
lastUpdatedAt
passAccessExpired
invoicePaid
hasPaid
result
Back to top

LearnerFieldGraphFilter

Filter that can be applied to limit which Learner nodes are returned

field : LearnerField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearnerFieldGraphOrder

Specifies the order in which Learner nodes are returned via the Connection

field : LearnerField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearnerLifecycleState

The possible life cycle states of a Learner

active

The Learner is enrolled on the Event

cancelled

The Learner was previously enrolled on the Event, but has since been removed

expired

The Learner was enrolled on the self paced learning Event, but their access window has passed

Back to top

LearnerLifecycleStateUpdateInput

An Input for updating a Learner Lifecycle State

learnerId : ID!

The Learner ID of the Learner being updated

Back to top

LearnerMutateResponse

A Response from mutating a Learner

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learner : Learner

The Learner that was updated

Back to top

LearnerMutations

Mutations for Learners

adminCompleteDiscussion : LearnerMutateResponse!

Completes a discussion comment for a given learner without leaving a comment

Argument Type Description
input AdminCompleteDiscussionInput!

The input type with the content and learner information
adminCompleteScorm : LearnerMutateResponse!

Marks the specified SCORM Content as completed for a learner and sets the completed_by_admin flag to true

Argument Type Description
input AdminCompleteScormInput!

The input type with the learner and content ids to complete
adminCompleteVideo : LearnerMutateResponse!

Marks the specified Video as completed for a learner and sets the completed_by_admin flag to true

Argument Type Description
input AdminCompleteVideoInput!

The input type with the learner and content ids to complete
attemptScorm : LearnerMutateResponse!

Creates an attempt on a piece of SCORM Content

Argument Type Description
input AttemptScormInput!

The input type with the information to create the attempt
awardAchievement : LearnerMutateResponse!

Awards an Achievement to a Learner

Argument Type Description
input LearnerAwardAchievementInput!

The input type with the values used to award an Achievement to the Learner
cancel : LearnerMutateResponse!

Cancels a learner on an event

Argument Type Description
input LearnerLifecycleStateUpdateInput!

The input type for updating learner lifecycle state
cancelByExternalIds : [LearnerMutateResponse!]!

Cancels a batch of Learners on Events by ID or External ID values There is a limit of 100 per batch submission.

Argument Type Description
input [LearnerCancelByExternalIdInput]!

The input type with the list of IDs or External IDs for Learners to cancel
clearResult : LearnerMutateResponse!

Clears the current result and marks a Learner as not completed

Argument Type Description
learnerId ID!

The ID of the Learner that will be marked as not completed
convertAnonymousUser : ConvertedRegistrationsResponse!

Converts all records associated with the provided Tracking Identifier to be associated with the provided Contact ID

Argument Type Description
input ConvertAnonymousLearnerInput!

The input type containing Contact ID and Tracking Identifier
deleteDiscussionComment : LearnerMutateResponse!

Delete a Discussion Comment

Argument Type Description
input DeleteDiscussionCommentInput!

The input type identifying the Discussion Comment to be deleted
ensureKryterionAccount : KryterionAccountResponse!

Creates an account in Kryterion if one does not already exist.

Argument Type Description
input EnsureKryterionAccountInput!

The IDs of the learner and and content we may create an account for.
prepareAchievements : LearnerBulkMutateResponse!

Create achievements for given learners without communications.

Argument Type Description
input LearnerPrepareAchievementsInput!
raiseCreditNote : LearnerRaiseCreditNoteResponse!

Raises a Credit Note for an invoiced Learner, which will be automatically allocated to the Invoice (if unpaid)

Argument Type Description
input LearnerRaiseCreditNoteInput!

the input type for creating the Credit Note
reactivate : LearnerMutateResponse!

Reactivates a cancelled learner on an event

Argument Type Description
input LearnerLifecycleStateUpdateInput!

The input type for updating learner lifecycle state
recordAttendance : LearnerMutateResponse!

Records a learner's attendance

Argument Type Description
input LearnerAttendanceInput!

The input type with the session and attendance details
recordAttendances : [LearnerMutateResponse!]!

Records attendances across multiple sessions and learners A limit of 1000 per submission

Argument Type Description
input [LearnerAttendanceInput]!

A list of attendance details
recordDiscussionComment : LearnerMutateResponse!

Records a Learner's submitted discussion comment

Argument Type Description
input RecordDiscussionCommentInput!

The input type with the discussion comment information
recordExternalContentAccessed : LearnerMutateResponse!

Records when external content is accessed

Argument Type Description
input RecordExternalContentAccessedInput!

The input type with the external content access information
recordExternalProgress : LmsAttemptMutateResponse!

Records a Learner's progress through a piece of External Content

Argument Type Description
input RecordExternalProgressInput!

The input type with the External progress information
recordResourceDownload : LearnerMutateResponse!

Records when a resource or document is downloaded

Argument Type Description
input RecordResourceDownloadInput!

The input type with the download information
recordResult : LearnerMutateResponse!

Sets the Pass/Fail flag for a Learner

Argument Type Description
learnerId ID!

The ID of the Learner that will be marked as passed or failed
hasPassed Boolean!

Whether the Learner has successfully achieved the objectives of the related Event
recordResultWithAchievements : LearnerMutateResponse!

Sets the Pass/Fail flag for a Learner and Issues or Revokes Achievements

Argument Type Description
input LearnerRecordResultWithAchievementInput!

Details of the results to be recorded
recordResultWithAchievementsBulk : LearnerBulkMutateResponse!

Sets the Pass/Fail flag for Learners and Issues or Revokes Achievements

Argument Type Description
input LearnerRecordResultWithAchievementInputTypeBulk!

Details of the Learners and the results to be recorded
recordScormProgress : LearnerMutateResponse!

Records a Learner's progress through a piece of SCORM Content

Argument Type Description
input RecordScormProgressInput!

The input type with the SCORM progress information
recordVideoProgress : LearnerMutateResponse!

Records a Learner's progress through a piece of Video Content

Argument Type Description
input RecordVideoProgressInput!

The input type with the Video progress information
regenerateAchievementDocuments : LearnerBulkMutateResponse!

Force achievement certificates to regenerate. The achievement stays intact.

Argument Type Description
input LearnerRegenerateAchievementDocumentsInput!
saveExternalActivityAccess : LearnerMutateResponse!

Records the result of an External Activity that creates documentation for a Learner and can update their Registration to record the Training Pass if this was required or used for access

Argument Type Description
input SaveExternalActivityAccessInput!

The input type to record access to an External Activity
setExternalActivities : [LearnerMutateResponse!]!

Sets whether an External Activity is complete in bulks of up to 50.

Argument Type Description
input [SetExternalActivityInput]!

The list of inputs to set External Activity completion
setExternalActivity : LearnerMutateResponse!

Sets whether an External Activity is complete

Argument Type Description
input SetExternalActivityInput!

The input type to set an External Activity's completion
storeResult : LearnerMutateResponse!

Stores a result for a Learner

Argument Type Description
input LearnerStoreResultInput!

Details of the Learner and result to be stored
storeResultWithAchievements : LearnerMutateResponse!

Stores a result for a Learner, as well as issuing or revoking achievements

Argument Type Description
input LearnerStoreResultWithAchievementsInput!

Details of the Learner, result and achievements to be stored
storeResultsBatchWithAchievements : LearnerBulkMutateResponse!

Stores results for multiple Learners, as well as issuing or revoking achievements A limit of 1000 per submission

Argument Type Description
input [LearnerStoreResultWithAchievementsInput]!

A list of input types containing details of the Learner results and achievements
transferLearner : TransferLearnerResponse!

The input type with the transfer information

Argument Type Description
input TransferLearnerInput!

The input type with the values to be updated
update : LearnerMutateResponse!

Updates the details for a Learner

Argument Type Description
input LearnerUpdateInput!

The input type with the values to be updated
upsertByExternalIds : [LearnerMutateResponse!]!

Adds or Updates a batch of Learners on Events by External ID values There is a limit of 100 per batch submission

Argument Type Description
input [LearnerUpsertByEventExternalIdInput]!

The input type with the list of values to be set on the existing or new Learner
Back to top

LearnerPrepareAchievementsForALearnerInput

An Input to allow silently adding achievement for given learner. That is an achievement will not be communicated to learner as a result. :param learnerId: The ID of the Learner to receive an achievement :param achievementTypeId: Achievement Type to be issued for the Learner :param validFrom: A date to be set as Achievement's validate from. It is in format "YYYY-MM-DD".

learnerId : ID!
achievementTypeId : ID!
validFrom : Date!
Back to top

LearnerPrepareAchievementsInput

An input type for preparing achievements for learners. Accepts a set of instructions determining learners and achievements to be awarded.

Back to top

LearnerPrice

A price for a Learner on an Event

Related types: FinancialAmount

amount : Decimal!

Total value of price

Argument Type Description
includeDiscount = false Boolean
financialUnit : FinancialUnit!

Currency of price

priceLevel : PriceLevel

The Price Level set for this Learner

Argument Type Description
filters = [] [PriceLevelFieldGraphFilter]
order = "__EMPTY__" PriceLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PriceLevelFieldGraphOrder]
Deprecated fields (1)
priceLevelId : String

The Price Level ID

Removal date: 2024-05-16.

Replaced by priceLevel

Back to top

LearnerRaiseCreditNoteInput

An Input for raising a Credit Note for an invoiced Learner

learnerId : ID!

ID of the Learner for whom to create the Credit Note (they must be invoiced)

Back to top

LearnerRaiseCreditNoteResponse

A Repsonse for raising a Credit Note for a Learner, containing any errors or the newly created Credit Note

Related types: MutationResponse

creditNote : CreditNote

The Credit Note created for the given Learner

errors : [FieldError!]!

The errors returned by the mutation

Back to top

LearnerRecordResultsManualAchievementsInput

An Input for adding or revoking manual Achievements

achievementTypeId : ID!
achieved : Boolean!
Back to top

LearnerRecordResultWithAchievementInput

hasPassed : Boolean!

Whether the Learner has successfully achieved the objectives of the related Event

learnerId : ID

The ID of the Learner that will be marked as passed or failed

learnerExternalId : ExternalIdInput

The External ID of the Learner that will be marked passed or failed

manualAchievements : [LearnerRecordResultsManualAchievementsInput]

Any additional Achievement Types to be issued or revoked for the Learner

Back to top

LearnerRecordResultWithAchievementInputTypeBulk

learners : [LearnerRecordResultWithAchievementInput]!

Learners to update

Back to top

LearnerRegenerateAchievementDocumentsForALearnerInput

An Input to allow forcing documents related to achievements. :param learnerId: The ID of the Learner :param achievementId: Achievement which documents to be regenerated

learnerId : ID!
achievementId : ID!
Back to top

LearnerRegenerateAchievementDocumentsInput

An input type for re-generating achievement documents for learners. Accepts a set of instructions determining learners and achievements.

Back to top

LearnerResult

A result recorded for a Learner on an Event

passed
failed
pending
Back to top

LearnersAdHocEmailInput

An Input for updating Communications

eventId : ID!
learnerIds : [ID]!
templateId : ID!
sendingEmailAddressId : ID!
carbonCopy : [String]
Back to top

LearnerScore

The Score assigned to a Learner

isHighlighted : Boolean!

Whether this Score is considered of particular importance.

label : String!

A description of this Score.

value : String

The value of this Score. Checkbox types will return 'true' or 'false' Date values are in ISO format

Back to top

LearnersStats

All statistics are generated dynamically at runtime, in response to each request.

active : Int!

Number of active learners

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
all : Int!

Total amount of learners

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
cancelled : Int!

Number of learners who cancelled (dropped out)

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
eventId : String!

ID of bound event

failed : Int!

Number of learners who failed the course (not to be confused with those who did not receive a record).

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
inactive : Int!

Number of inactive learners (course access expired)

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
passed : Int!

Number of learners who passed the course

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
Back to top

LearnersStatsConnection

A connection containing page information and edges for LearnersStats

edges : [LearnersStatsEdge!]!

The list of LearnersStats edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearnersStatsEdge

Contains cursor and node information for type LearnersStats

cursor : String!

A string that can be used for cursor-based pagination

node : LearnersStats!

The LearnersStats node.

Back to top

LearnersStatsField

Fields for filtering and ordering LearnersStats

id
targetEventId
contactEmailAddress
contactMobilePhoneNumber
commsEmailAddress
commsMobilePhoneNumber
bookingContactEmailAddress
bookingContactMobilePhoneNumber
isUnnamed
Back to top

LearnersStatsFieldGraphFilter

Filter that can be applied to limit which LearnersStats nodes are returned

field : LearnersStatsField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearnersStatsFieldGraphOrder

Specifies the order in which LearnersStats nodes are returned via the Connection

field : LearnersStatsField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearnerStoreResultInput

An Input for storing a Learner's result

learnerId : ID!

The ID of the Learner that will receive the result

result : LearnerResult!

The result to be stored

Back to top

LearnerStoreResultWithAchievementsInput

An Input for storing a Learner's result and achievements

learnerId : ID!

The ID of the Learner that will receive the result

result : LearnerResult!

The result to be stored

manualAchievements : [LearnerRecordResultsManualAchievementsInput]

Any Achievement Types to be issued or revoked for the Learner

Back to top

LearnerUpdateInput

An Input for updating an Learner

learnerId : ID!

The ID of the Learner being updated

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Learner to update

trackingIdentifier : String

The Tracking Identifier for this Learner to identify them

notes : String

The notes about this Learner

expiresAt : TimeZonedDateTime

The DateTime when the Learner's LMS access will expire

quantity : Int

The number of Unnamed Learners

priceLevelId : ID

The Price Level to apply to the Learner (requires providing financialUnitId) - if amount is not provided, it will be set to the given Level's.

financialUnitId : ID

The Financial Unit to use for the Learner price (Currency or Token Type ID)

amount : Decimal

The amount of the Learner Prices

ccAddressesOnTriggers : [String]

The list of email addresses to be CC'd on any triggered emails

breakoutGroups : [EventBreakoutGroupSelectionInput]

selection of Breakout Groups to assign the learner to. If the list of groups differs from the current selection, the Learner will be removed from the Sessions not part of the provided breakout groups

communicationsContactId : ID

An optional Contact that will receive all Communications for this Learner instead of the Learner's own Contact. Pass null to clear it. Only a named Learner's Communications Contact can be changed; an Unnamed Learner returns an error, as it uses this field for its own booking Contact.

Back to top

LearnerUpsertByEventExternalIdInput

An Input for upserting an Learner with Event External ID

eventId : ID

The ID of the Event the Learner is on

eventExternalId : ExternalIdInput

The External ID of the Event the Learner is on

contactId : ID

ID of the Contact to register onto Event. Required to create if contactExternalId not provided.

contactExternalId : ExternalIdInput

External ID of the Contact to register onto Event. Required to create if contactId not provided.

learnerId : ID

ID of the Learner to update. Required to update if learnerExternalId not provided.

learnerExternalId : ExternalIdInput

External ID of the Learner. Will be added to the learner when creating and used to identify when updating.

notes : String

Notes on the learner

Back to top

LearningCategory

A series of learning categories for Courses and Learning Paths

Related types: Node

description : String

Description of the Learning Category

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the LearningCategory

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the LearningCategory

parentCategory : LearningCategory

The parent LearningCategory

Argument Type Description
filters = [] [LearningCategoryFieldGraphFilter]
order = "__EMPTY__" LearningCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningCategoryFieldGraphOrder]
subcategories : LearningCategoryConnection!

A list of sub-LearningCategories for this LearningCategory

Argument Type Description
filters = [] [LearningCategoryFieldGraphFilter]
order = "__EMPTY__" LearningCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningCategoryFieldGraphOrder]
Back to top

LearningCategoryConnection

A connection containing page information and edges for LearningCategory

edges : [LearningCategoryEdge!]!

The list of LearningCategory edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningCategoryCreateInput

An Input for creating a Learning Category

name : String!

The name given to the Learning Category

parentCategoryId : ID
description : String

A description of the Learning Category

Back to top

LearningCategoryEdge

Contains cursor and node information for type LearningCategory

cursor : String!

A string that can be used for cursor-based pagination

node : LearningCategory!

The LearningCategory node.

Back to top

LearningCategoryField

Fields for filtering and ordering LearningCategories

id
name
parentCategoryId
isValidForPortal
Back to top

LearningCategoryFieldGraphFilter

Filter that can be applied to limit which LearningCategory nodes are returned

field : LearningCategoryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearningCategoryFieldGraphOrder

Specifies the order in which LearningCategory nodes are returned via the Connection

field : LearningCategoryField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearningCategoryMutateResponse

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learningCategory : LearningCategory

The Learning Category that was mutated

Back to top

LearningCategoryMutations

create : LearningCategoryMutateResponse!

Create a new Learning Category

Argument Type Description
input LearningCategoryCreateInput!

The input type with the values to be set on the new Learning Category
Back to top

LearningMode

The learning mode of an Event

classroom
lms
blended
Back to top

LearningObjective

An Objective within a Learning Path's learning journey, representing an item of training that must be completed in order to complete the Learning Path

Related types: CourseObjective DocumentObjective EventObjective ExternalObjective LearningPathObjective URLObjective

credits : Int

The number of credits that this LearningObjective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

id : ID!

The ID of the LearningObjective

isMandatory : Boolean!

Denotes whether or not the LearningObjective is mandatory

order : Int

The order of this LearningObjective in the set of LearningPath objectives

Back to top

LearningObjectiveConnection

A connection containing page information and edges for LearningObjective

edges : [LearningObjectiveEdge!]!

The list of LearningObjective edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningObjectiveEdge

Contains cursor and node information for type LearningObjective

cursor : String!

A string that can be used for cursor-based pagination

node : LearningObjective!

The LearningObjective node.

Back to top

LearningObjectiveField

LearningObjective Fields for Filtering and Ordering

id
order
courseTemplateId
stepId
Back to top

LearningObjectiveFieldGraphFilter

Filter that can be applied to limit which LearningObjective nodes are returned

field : LearningObjectiveField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearningObjectiveFieldGraphOrder

Specifies the order in which LearningObjective nodes are returned via the Connection

field : LearningObjectiveField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearningObjectiveMutationResponse

A Response from mutating an objective

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learningObjective : LearningObjective

The LearningObjective that was mutated

Back to top

LearningObjectiveMutations

Mutations for LearningObjectives

convertCourseObjectiveToEventObjective : LearningObjectiveMutationResponse!

Converts a Course Objective to an Event Objective for the given Event.

Argument Type Description
input LearningPathConvertCourseObjectiveToEventObjectiveInput!
updateEventObjective : LearningObjectiveMutationResponse!

Updates a given Event Objective.

Argument Type Description
input LearningPathUpdateEventObjectiveInput!
Back to top

LearningObjectiveType

An enumeration.

course
event
external
learningPath
Back to top

LearningOutcome

A Learner's record relating to a Learning Objective on a Learning Path

Related types: CourseOutcome ExternalOutcome URLOutcome DocumentOutcome LearningPathOutcome

credits : Int

The number of credits that the LearningOutcome represents

id : ID!

The ID of the LearningObjective

isCompleted : Boolean

Denotes whether or not the LearningOutcome has been completed by the Learner

isMandatory : Boolean!

Denotes whether or not the LearningOutcome is mandatory

learningObjective : LearningObjective!

The LearningObjective to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
learningPathLearner : LearningPathLearner!

The LearningPathLearner to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningOutcome in the set of LearningAssignment outcomes

Back to top

LearningOutcomeConnection

A connection containing page information and edges for LearningOutcome

edges : [LearningOutcomeEdge!]!

The list of LearningOutcome edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningOutcomeEdge

Contains cursor and node information for type LearningOutcome

cursor : String!

A string that can be used for cursor-based pagination

node : LearningOutcome!

The LearningOutcome node.

Back to top

LearningOutcomeField

LearningObjective Fields for Filtering and Ordering

id
Back to top

LearningOutcomeFieldGraphFilter

Filter that can be applied to limit which LearningOutcome nodes are returned

field : LearningOutcomeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearningOutcomeFieldGraphOrder

Specifies the order in which LearningOutcome nodes are returned via the Connection

field : LearningOutcomeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearningOutcomeMutateResponse

A Response from updating a Learning Outcome

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

outcome : LearningOutcome

The Learning Outcome being updated

Back to top

LearningOutcomeMutations

Updates that can be made to Learners on a Learning Path

Deprecated fields (2)
recordDocumentDownload : LearningOutcomeMutateResponse!

Record the download of a document by a Learning Path Learner

Removal date: TBD.

Replaced by learners.recordResourceDownload

Argument Type Description
input LearningOutcomeRecordDocumentDownloadInput!

The input type with the download information
recordUrlVisit : LearningOutcomeMutateResponse!

Record the visit to a URL by a Learning Path Learner

Removal date: TBD.

Replaced by learners.recordExternalContentAccessed

Argument Type Description
input LearningOutcomeRecordUrlVisitInput!

The input type with the visit information
Back to top

LearningOutcomeRecordDocumentDownloadInput

An input for recording a document download

outcomeId : ID!

The Outcome ID of the Document being downloaded

Back to top

LearningOutcomeRecordUrlVisitInput

An input for recording a URL visit

outcomeId : ID!

The Outcome ID of the Url being visited

Back to top

LearningPath

A training offer consisting of several Objectives (courses, events, external activities or other Learning Paths) each of which must be completed.

Related types: Node InterestItem CatalogueItem Bookable TrainingPassTypeContent

account : Account

The Account for this Learning Path which, if set, should be considered private.

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
accountAssociations : AccountAssociationConnection!

The Account Associations for this Learning Path

Argument Type Description
filters = [] [AccountAssociationFieldGraphFilter]
order = "__EMPTY__" AccountAssociationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountAssociationFieldGraphOrder]
achievementType : AchievementType

The ID of the AchievementType that can be earned when the LearningPath is passed

Argument Type Description
filters = [] [AchievementTypeFieldGraphFilter]
order = "__EMPTY__" AchievementTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementTypeFieldGraphOrder]
code : String

The code of the LearningPath

company : Company

The Company of the Learning Path

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
createdAt : LocalDateTime!

The Date and Time the LearningPath was created

creditsRequired : Int

The credits required for a learner to pass a LearningPath

customFieldValues : [CustomFieldValue!]!

Custom Field values for the LearningPath

Argument Type Description
filter CustomFieldFilterInput
description : String

The description of the LearningPath

end : LocalDateTime

The latest End of the Learning Path based on its Learning Objectives

enforceObjectiveOrder : Boolean!

Whether the Learner needs to complete Objectives in order

expectedCompletionDays : Decimal

The expected number of days it will take a Learner to complete a LearningPath

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
featuredInPortals : [WebLinkPortal!]!

The Portals that this Learning Path is featured in

id : ID!

The ID of the LearningPath

imageGallery : DocumentConnection!

The image gallery for this Learning Path

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
includedInPassTypeIds : [ID!]!

Identifiers for Published Training Pass Types that grant access to this Learning Path

isBundle : Boolean!

Dictates if the Learning Path is bundled. A bundled Learning Path contains only Event Objectives and External Objectives

lastUpdatedAt : LocalDateTime!

The Date and Time the LearningPath was last updated

learners : LearningPathLearnerConnection!

The LearningPathLearners on this LearningPath

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
learningCategories : LearningCategoryConnection!

Categories this Learning Path is tagged with

Argument Type Description
filters = [] [LearningCategoryFieldGraphFilter]
order = "__EMPTY__" LearningCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningCategoryFieldGraphOrder]
learningObjectives : LearningObjectiveConnection!

The LearningObjectives of the LearningPath

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
learningPathSteps : LearningPathStepConnection!

The Steps of the LearningPath

Argument Type Description
filters = [] [LearningPathStepFieldGraphFilter]
order = "__EMPTY__" LearningPathStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathStepFieldGraphOrder]
learningTags : LearningTagConnection!

The Learning Tags associated with this Learning Path

Argument Type Description
filters = [] [LearningTagFieldGraphFilter]
order = "__EMPTY__" LearningTagFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningTagFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : LearningPathLifecycleState!

The lifecycle state of the Learning Path

locale : Locale

The Locale of the LearningPath

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
name : String!

The name of the LearningPath

prices : LearningPathPriceConnection!

The prices associated with the LearningPath

Argument Type Description
filters = [] [LearningPathPriceFieldGraphFilter]
order = "__EMPTY__" LearningPathPriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathPriceFieldGraphOrder]
progressionType : LearningPathProgression!

The progression type of the LearningPath

purchaseRequiresReview : Boolean!

Dictates if a Cart that contains this Learning Path will be submitted for review before checkout in a Weblink Portal. Requires the orderReviewStep and orderRetrievalStep to be defined in the Weblink Portal's Opportunity Steps.

registration : Registration

The unique Registration of a Private Learning Path, or null if not applicable.

Argument Type Description
filters = [] [RegistrationFieldGraphFilter]
order = "__EMPTY__" RegistrationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationFieldGraphOrder]
registrationDeadline : LocalDateTime

The earliest Registration Deadline for the Learning Path based on its Learning Objectives

remainingPlaces : Int

Minimum number of Learner places remaining on an Event Objective for this Learning Path

requireObjectiveFulfillment : Boolean!

Dictates if a Learner must fulfill all the course objectives with concrete objectives to be registered on this Learning Path

start : LocalDateTime

The earliest Start of the Learning Path based on its Learning Objectives

triggers : [Trigger!]!

List of Triggers configured for this Learning Path.

Argument Type Description
filters = [] [TriggerFieldGraphFilter]
order = "__EMPTY__" TriggerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerFieldGraphOrder]
type : LearningPathType!

Type of the Learning Path (public/private)

Deprecated fields (3)
image : Document

The image for this Learning Path

Removal date: TBD.

Replaced by imageGallery

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
includedInTrainingPasses : TrainingPassTypeConnection!

Published Training Pass Types that grants access to this Learning Path

Removal date: TBD.

Deprecated in favour of includedInPassTypeIds

Argument Type Description
filters = [] [TrainingPassTypeFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeFieldGraphOrder]
region : Region

"The Region of the LearningPath"

Removal date: TBD.

Learning Paths do not require a Region

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

LearningPathAddAccountAssociationInput

An Input to allow a user to add an Account Association to a Learning Path

learningPathId : ID!

The Learning Path

accountId : ID!

The Account to associate with the Learning Path

accountAssociationTypeId : ID!

The Account Association Type which defines the association

Back to top

LearningPathAddPriceDetailsInput

The Input containing the details of the LearningPathPrice being added to the LearningPath

regionId : String!

The ID of the Region of the Learning Path Price

amount : String!

The amount of the Learning Path Price

priceLevelId : String!

The ID of the Price Level of the Learning Path Price

currencyCode : String

The ID of the Currency of the Learning Path Price, mutually exclusive with tokenTypeId

tokenTypeId : String

The ID of the Token Type of the Learning Path Price, mutually exclusive with currencyCode

validFrom : String

The date and time the Learning Path Price is valid from

validUntil : String

The date and time the Learning Path Price is valid to

taxInclusive : Boolean
Back to top

LearningPathAddPriceInput

The input type with the values used to add a LearningPathPrice to the LearningPath

learningPathId : String!

The ID of the LearningPath on which to add the LearningPathPrice

priceDetails : LearningPathAddPriceDetailsInput!

The Input containing the details of the LearningPathPrice being added to the LearningPath

Back to top

LearningPathAddTagsInput

An Input to allow a user to add Learning Tags to a Learning Path

learningPathId : ID!

The Learning Path

learningTagIds : [ID]!

The Learning Tags to add to the Learning Path

Back to top

LearningPathBulkDeleteInput

An Input for deleting a list of Learning Paths

learningPathIds : [ID]!

The list of Learning Path IDs to delete

Back to top

LearningPathBulkMutateResponse

A Response for a mutation a list of Learning Paths

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learningPaths : [LearningPath!]!

The Learning Paths that were deleted

Back to top

LearningPathCancellationInput

An Input containing the details to cancel a Learning Path Learner

learningPathLearnerId : ID!

The Learning Path Learner to cancel

Back to top

LearningPathCancellationsInput

An Input containing the details to cancel multiple Learning Path Learners

learnerIds : [LearningPathLearnerInput]!

A list of Learning Path Learner IDs, max of 50 allowed at once

Back to top

LearningPathCancellationsResponse

A response from cancelling one or more learners from a Learning Path

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learners : [LearningPathLearner!]!

The Learners who were cancelled from the path

Back to top

LearningPathConnection

A connection containing page information and edges for LearningPath

edges : [LearningPathEdge!]!

The list of LearningPath edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningPathConvertCourseObjectiveToEventObjectiveInput

An Input to allow a user to update a Course Objective on a Learning Path

objectiveId : ID!

The Course Objective that we are updating

eventId : ID

The Event that this Course Objective refers to

Back to top

LearningPathCreateEventObjectiveInput

An Input to allow a user to create an Event Objective on a Learning Path

learningPathId : ID!

The ID of the Learning Path on which to add the Event Objective

credits : Int!

The number of credits that this Event Objective represents

order : Int!

The order the Objective appears on the Learning Path

isMandatory : Boolean!

Denotes whether or not the Event Objective is mandatory

expectedCompletionDays : Decimal!

The expected time in days required to complete the Event Objective

courseTemplateId : ID!

The Course Template that must be completed to complete this Objective

eventId : ID!

The Event that this Event Objective refers to

Back to top

LearningPathCreateInput

An Input to create a new Learning Path

name : String!

The name given to the LearningPath

code : String

The code given to the LearningPath

description : String

The description of the LearningPath

regionId : ID

DEPRECATED - The Region of the LearningPath

accountId : ID

IF set, it will create a Private Learning Path for the given Account

accountProjectId : ID

The Project to associate the Private Learning Path with

achievementTypeId : ID

The ID of the AchievementType that can be earned when the LearningPath is passed

expectedCompletionDays : Decimal

The expected number of days it will take a Learner to complete a Learning Path

lifecycleState : LearningPathLifecycleState

The lifecycle state of the LearningPath

enforceObjectiveOrder : Boolean

Whether the Learner needs to complete Objectives in order

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the LearningPath to create

learningCategories : [ID]

The list of LearningCategories of the LearningPath to update

learningTags : [ID]

The list of LearningTag IDs to create the LearningPath with

learningObjectives : [LearningPathCreateLearningObjectivesInput]

The list of Learning Objectives to create the Learning Path with

imageDocumentId : ID

The Document to use for the Learning Path Image

imageDocumentIds : [ID]

The list of Image Documents to set for the Learning Path Images

purchaseRequiresReview : Boolean

Whether the Learning Path requires a review before purchase through a Weblink Portal

requireObjectiveFulfillment : Boolean

Whether the Learning Path requires all Objectives to be fulfilled when registering a Learner

progressionType : LearningPathProgression

The type of Progression of the LearningPath

creditsRequired : Int

The number of Credits required to complete the LearningPath

localeId : ID

The Locale of the Learning Path

featuredInPortals : [ID]

The list of Weblink Portal ID's this Learning Path is featured in

companyId : ID

The ID of the Company the Learning Path belongs to

privatePriceDetails : LearningPathPriceDetailsInput

The pricing details (mandatory if an Account ID is supplied, i.e. this is a Private Learning Path)

Back to top

LearningPathCreateLearningObjectivesInput

An Input for the creation of a new Learning Objective on a Learning Path

type : LearningObjectiveType!

The type of Objective

courseTemplateId : ID

The ID of the Course Template for a Course Objective

eventId : ID

The ID of the Event for an Event Objective

learningPathId : ID

The ID of the Learning Path for a Learning Path Objective

name : String

The name of an External Objective

description : String

The description of an External Objective

selectableEventIds : [ID]

The IDs of the Events that can be selected to fulfil the Objective. An empty list signifies that any Event for the Objective's Course Template can be selected.

Back to top

LearningPathDeleteObjectiveInput

An Input containing the details to delete an objective

objectiveId : ID!

The Learning Path Objective to be deleted

Back to top

LearningPathDetails

Learning Path Details specific to this Interest

existingLearners : [ExistingLearnerDetail!]!

List of Existing Interest Learner Details

newLearners : [NewLearnerDetail!]!

List of New Interest Learner Details

objectives : [PathInterestObjectiveAssignment!]!

List of Path Interest Objectives Assignment

reserved : Boolean!

Whether the Interest is reserved

unnamedLearners : [UnnamedLearnerDetail!]!

List of Unnamed Interest Learner Details

Back to top

LearningPathDetailsAddInput

An Input containing the details required by a Learning Path Interest

Back to top

LearningPathDetailsUpdateInput

An Input containing the details required by a Learning Path Interest

Back to top

LearningPathDiscountabilityRule

Promotion Campaign Discountability Rules related to Learning Paths

Related types: PromotionDiscountabilityRule

discountableLearningPaths : LearningPathConnection

A list of Learning Path part of this discountability rule

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
type : PromotionCriterionType!

The type of Discountability Rule (e.g. Course, Location, etc)

Back to top

LearningPathDuplicateInput

An Input for duplicating a Learning Path

code : String

The unique code for the new Learning Path (optional)

name : String

The name for the new Learning Path (defaults to "{original} (Copy)")

isPrivate : Boolean

Whether the duplicate should be a Private Learning Path. When omitted, the source's privacy is inherited. Set false to duplicate a private path as public. If the source is public and the duplicate is private, accountId and privatePriceDetails must be provided.

accountId : ID

The Account for the Private Learning Path (required when duplicating a public path as private)

accountProjectId : ID

The Project to associate the Private Learning Path with

privatePriceDetails : LearningPathPriceDetailsInput

The pricing details (required when duplicating a public path as private)

Back to top

LearningPathEdge

Contains cursor and node information for type LearningPath

cursor : String!

A string that can be used for cursor-based pagination

node : LearningPath!

The LearningPath node.

Back to top

LearningPathEligibilityRule

Promotion Campaign Eligibility Rules related to Learning Paths

Related types: PromotionEligibilityRule

eligibleLearningPaths : LearningPathConnection!

A list of Learning Paths eligible for this Promotion rule

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
type : PromotionCriterionType!

The type of Eligibility Rule (e.g. Course, Location, etc)

Back to top

LearningPathEventSelectionInput

An Input specifying an event selection that fulfils a Learning Path Course Objective

courseObjectiveId : String!

The ID of the Course Objective being fulfilled by the selection

eventId : String!

The ID of the Event selected to fulfill the CourseObjective

Back to top

LearningPathEventSelectionOption

A combination of an Event and the CourseObjective it satisfies

Related types: Node

courseObjective : CourseObjective!

The CourseObjective associated with the LearningPathEventSelectionOption

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
event : Event!

The Event associated with the LearningPathEventSelectionOption

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the LearningPathEventSelectionOption

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

LearningPathEventSelectionOptionConnection

edges : [LearningPathEventSelectionOptionEdge!]!

The list of LearningPathEventSelectionOption edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningPathEventSelectionOptionEdge

cursor : String!

A string that can be used for cursor-based pagination

node : LearningPathEventSelectionOption!

The LearningPathEventSelectionOption node.

Back to top

LearningPathField

Fields for filtering and ordering LearningPaths

id
name
description
progressionType
lifecycleState
createdAt
lastUpdatedAt
start
end
isValidForPortal
isValidForScheduler
isBundle
hasRegistrationManagedByContactId
hasRegistrationWithBrandId
hasCourseLearningObjectives
isBeforeRegistrationDeadline
eventObjectiveRegionCode
eventObjectiveLocationName
eventObjectiveEventId
courseObjectiveCourseId
learnerTrackingIdentifier
textSearch
localeId
remainingPlaces
learningCategoryName
requireObjectiveFulfillment
code
accountId
type
hasPricesInCurrency
hasPricesInRegion
Back to top

LearningPathFieldGraphFilter

Filter that can be applied to limit which LearningPath nodes are returned

field : LearningPathField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearningPathFieldGraphOrder

Specifies the order in which LearningPath nodes are returned via the Connection

field : LearningPathField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearningPathFulfilObjectiveForLearnersInput

An Input containing the details to fulfil an objective

learningPathLearnerIds : [ID]!

The Learning Path Learners whose Objective will be fulfilled

objectiveId : ID!

The Learning Path Objective to be fulfilled

eventId : ID!

The Event that will fulfil this Objective

communicationsContactId : ID

The communications contact that will be used on the event when fulfilling this Objective

notes : String

The notes that will be added to the event when fulfilling this Objective

Back to top

LearningPathFulfilObjectiveInput

An Input containing the details to fulfil an objective

learningPathLearnerId : ID!

The Learning Path Learner whose Objective will be fulfilled

objectiveId : ID!

The Learning Path Objective to be fulfilled

eventId : ID!

The Event that will fulfil this Objective

Back to top

LearningPathInterestObjectiveAddInput

An Input containing the specific Event to link the Objective to

objectiveId : ID!

The Learning Path Objective to be fulfilled

eventId : ID!

The specific Event that will fulfil this Objective

Back to top

LearningPathInterestObjectiveUpdateInput

An Input containing the specific Event to link the Objective to

objectiveId : ID!

The Learning Path Objective to be fulfilled

eventId : ID!

The specific Event that will fulfil this Objective

Back to top

LearningPathLearner

Record of a Learner on a Learning Path

Related types: Node Billable Registerable

achievements : AchievementConnection

The Achievement earned by the Learner

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
brandId : String

The brandId for this LearningPathLearner

cancelledAt : LocalDateTime

Datetime that the Learning Path Learner was cancelled.

completedObjectiveCount : Int

The count of Learning Path Objectives completed by the Learner (Nested Learning Paths are counted as a single Objective)

contact : Contact

The Contact who is undertaking the LearningPath

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
contactId : String

The Learner or LearningPathLearner's contact ID

createdAt : LocalDateTime!

The date a LearningPathLearner was created and therefore registered on a LearningPath

customFieldValues : [CustomFieldValue!]!

Custom Field values for this Learning Path Learner

Argument Type Description
filter CustomFieldFilterInput
expectedProgress : Decimal

The exptected progress as a percentage that a Learner is expected to complete based on the current date and the path start date

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the LearningPathLearner

isActive : Boolean!

Whether the Learning Path Learner is enrolled and in progress on the Learning Path

isCancelled : Boolean!

Whether the Learning Path Learner is cancelled on the Learning Path

learningOutcomes : LearningOutcomeConnection!

The LearningOutcomes associated with the LearningPathLearner

Argument Type Description
filters = [] [LearningOutcomeFieldGraphFilter]
order = "__EMPTY__" LearningOutcomeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningOutcomeFieldGraphOrder]
learningPath : LearningPath

The LearningPath which this LearningPathLearner is undertaking

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
learningPathLearnerPrice : LearningPathLearnerPrice

Price associated with the Registration for this Learning Path Learner

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : LearningPathLearnerLifecycleState!

The Lifecycle State of the Learning Path Learner

lmsLastAccessed : TimeZonedDateTime

The date a LearningPathLearner last viewed the Learning Path through the LMS

lmsTitle : String

The Title to show on the LMS for this Learning Path Learner

notes : String

Notes about the LearningPathLearner

passAccessExpired : Boolean!

If registration was made via a TrainingPass, confirms access is still available

priceLevel : PriceLevel

Price Level of the price

progress : Decimal!

Deprecated: Prefer progress_made. This will be removed once all currently callers are updated. The amount a Learner has completed on the Learning Path across all Learning Path Outcomes

quantity : Int!

The total number of Learners that are a part of this LearningPathLearner

registeredByRule : RegistrationRule

The Registration Rule (if any) that first automatically assigned this learner to the learning path

registration : Registration

The Registration for the LearningPathLearner

Argument Type Description
filters = [] [RegistrationFieldGraphFilter]
order = "__EMPTY__" RegistrationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationFieldGraphOrder]
registrationId : String

The Learner or LearningPathLearner's registration ID

startDate : LocalDateTime

The start date of the LearningPathLearner

taxType : TaxType

Tax Type applied to this Learning Path Learner.

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
totalObjectiveCount : Int

The count of Learning Path Objectives required for the Learner to complete the Learning Path

trackingIdentifier : String

An External Identifier to identify this Learning Path Learner

Deprecated fields (2)
achievement : Achievement

The Achievement earned by the Learner

Removal date: TBD.

Reason 
Please use achievements field instead.

This field is no longer supported after the introduction of
the multiple achievements
 |

| Removal Date | TBD | | Deprecation Date | TBD |

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
progressMade : Decimal

The amount a Learner has completed on the Learning Path across all Learning Path Outcomes

Removal date: TBD.

Deprecated in favour of completedObjectiveCount and totalObjectiveCount

Back to top

LearningPathLearnerConnection

A connection containing page information and edges for LearningPathLearner

edges : [LearningPathLearnerEdge!]!

The list of LearningPathLearner edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningPathLearnerEdge

Contains cursor and node information for type LearningPathLearner

cursor : String!

A string that can be used for cursor-based pagination

node : LearningPathLearner!

The LearningPathLearner node.

Back to top

LearningPathLearnerField

Fields for filtering and ordering LearningPathLearners

id
startDate
contactId
contactName
lmsLastAccessed
learningPathId
learningPathName
createdAt
notes
progress
lifecycleState
isActive
isCancelled
brandId
lmsTitle
managedByContactId
accountId
trackingIdentifier
isAnonymous
workingPatternRotationId
Back to top

LearningPathLearnerFieldGraphFilter

Filter that can be applied to limit which LearningPathLearner nodes are returned

field : LearningPathLearnerField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearningPathLearnerFieldGraphOrder

Specifies the order in which LearningPathLearner nodes are returned via the Connection

field : LearningPathLearnerField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearningPathLearnerInput

Specifies a learner directly by ID or via an External ID

id : ID

GQL ID of a learning path learner, if using this field then omit external name and value

externalId : ExternalIdInput

The External ID to use to identify the path learner, if using this omit id

Back to top

LearningPathLearnerLifecycleState

An enumeration.

active
cancelled
completed
Back to top

LearningPathLearnerLmsLastAccessedInput

An Input containing the details to update a Learning Path Learner's lmsLastAccessed datetime

learningPathLearnerId : ID!

The Learning Path Learner to update the lmsLastAccessed for

lmsLastAccessed : TimeZonedDateTime!

The date and time the Learner Path Learner's lmsLastAccessed should be set to

Back to top

LearningPathLearnerPrice

A price for a Learner on a Learning Path

Related types: FinancialAmount

amount : Decimal!

Total value of price

financialUnit : FinancialUnit!

Currency of price

Back to top

LearningPathLearnerRegistrationInput

An Input supplying a new Learning Path Learner details for registration

contactId : String

The ID of the Contact to be registered on the LearningPath. Cannot be used with contactExternalId.

contactExternalId : ExternalIdInput

The External ID of the Contact to be registered on the Learning Path. Cannot be used with contactId.

amount : Decimal

The amount the LearningPathLearner will pay for the LearningPath

regionId : String

The ID of the Region in which the LearningPathLearner will be registered. Cannot be used with regionExternalId.

regionExternalId : ExternalIdInput

The External ID of the Region in which the Learning Path Learner will be registered. Cannot be used with regionId.

financialUnitId : ID

The ID of the Currency or Training Token Type that the LearningPathLearner will use to pay

notes : String

Notes about the LearningPathLearner being registered

selectedEvents : [LearningPathEventSelectionInput]

A list of LearningPathEventSelectionInputs. One for each Course Objective

brandId : ID

The ID of the Brand to use when registering this Contact onto the LearningPath. Cannot be used with brandExternalId.

brandExternalId : ExternalIdInput

The External ID of the Brand to use when registering this Contact onto the Learning Path. Cannot be used with brandId.

quantity : Int

The number of learners represented by the LearningPathLearner. This should only be greater than one if the LearningPathLearner represents a block of unnamed learners

bookingContactId : String

The ID of the Contact making the booking. This is only required if the LearningPathLearner represents a block of unnamed learners. Cannot be used with bookingContactExternalId.

bookingContactExternalId : ExternalIdInput

The External ID of the Contact making the booking. This is only required if the LearningPathLearner represents a block of unnamed learners. Cannot be used with bookingContactId.

trackingId : String

The Tracking Identifier that you specify instead of the Contact ID if you want to register an Anonymous Learner. They are being uniquely identified solely by this field.

trainingPassTypeId : String

TrainingPassType id to be used for the registration. Cannot be used with trainingPassTypeExternalId.

trainingPassTypeExternalId : ExternalIdInput

Training Pass Type External ID to be used for the registration. Cannot be used with trainingPassTypeId.

learnerExternalId : ExternalIdInput

The External ID to be stored against the new learner.

priceLevelId : String

The Price Level ID to be stored against the new learner.

accountId : ID

The Account to bill the new registration to, which must be one of the Contact's Accounts. Defaults to the Contact's primary Account

taxTypeId : ID

The Tax Type ID to apply to the new learner.

Back to top

LearningPathLearnerResponse

A Response from updating a Learning Path Learner

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learner : LearningPathLearner

The Learning Path Learner who was updated

Back to top

LearningPathLearnerUpdateInput

An Input containing the details to update a Learning Path Learner

learningPathLearnerId : ID!

The Learning Path Learner to update

customFieldValues : [CustomFieldValueInput]

The Custom Field Values for the Learning Path Learner

quantity : Int

The total number of Learners to update this Learning Path Learner to

Back to top

LearningPathLifecycleState

The possible lifecycle states of a LearningPath

draft
active
cancelled
archived
Back to top

LearningPathMutateResponse

A Response from mutating a LearningPath

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learningPath : LearningPath

The LearningPath that was mutated

Back to top

LearningPathMutations

Mutations for LearningPath

addAccountAssociation : LearningPathMutateResponse!

Add an Account Association to a Learning Path

Argument Type Description
input LearningPathAddAccountAssociationInput!

An input for adding an Account Association to a Learning Path
addPrice : LearningPathMutateResponse!

Adds a LearningPathPrice to a LearningPath

Argument Type Description
input LearningPathAddPriceInput!

The input type with the values used to add a LearningPathPrice to the LearningPath
addTags : LearningPathMutateResponse!

Add Learning Tags to a Learning Path

Argument Type Description
input LearningPathAddTagsInput!

An input for adding Learning Tags to a Learning Path
associateUnnamedWithContacts : AssociateUnnamedWithContactsResponse!

Associate an Unnamed Learning Path Learner with existing Contacts

Argument Type Description
input AssociateUnnamedWithContactsInput!

The input type with the values used to associate a Learner with existing Contacts
cancelLearner : LearningPathLearnerResponse!

Cancel a Learner on a Learning Path

Argument Type Description
input LearningPathCancellationInput!

The input type with the values used to Cancel a Learning Path Learner
cancelLearners : LearningPathCancellationsResponse!

Cancels one or more learners on a LearningPath, max of 50 learners may be processed at one time

Argument Type Description
input LearningPathCancellationsInput!

An Input for cancelling one or more learners from a LearningPath
create : LearningPathMutateResponse!

Create a new LearningPath

Argument Type Description
input LearningPathCreateInput!

The input type with the values to be set on the new LearningPath
createEventObjective : LearningObjectiveMutationResponse!

Creates an Event Objective for the Learning Path.

Argument Type Description
input LearningPathCreateEventObjectiveInput!
delete : LearningPathBulkMutateResponse!

Deletes a list of Learning Paths (only in draft state)

Argument Type Description
input LearningPathBulkDeleteInput!
deleteObjective : LearningPathMutateResponse!

Delete Learning Objective

Argument Type Description
input LearningPathDeleteObjectiveInput!

The input type with the values used to delete an Objective from a Learning Path
deletePrice : LearningPathMutateResponse!

Delete a LearningPathPrice of a LearningPath

Argument Type Description
input LearningPathPriceDeleteInput!

The input type with the values used to delete a LearningPathPrice of the LearningPath
duplicate : LearningPathMutateResponse!

Creates a Learning Path which is a duplicate of the specified Learning Path

Argument Type Description
learningPathId ID!

The ID of the Learning Path being duplicated
input LearningPathDuplicateInput!

The input type with options for the duplicated Learning Path
fulfilObjective : FulfilOutcomeResponse!

Fulfil an abstract Learning Objective with a concrete objective for a Learning Path Learner

Argument Type Description
input LearningPathFulfilObjectiveInput!

Fulfil an abstract Learning Objective with a concrete objective for a Learning Path Learner
fulfilObjectiveForLearners : FulfilObjectiveForLearnersResponse!

Fulfil an abstract Learning Objective with a concrete objective for one or more Learning Path Learners

Argument Type Description
input LearningPathFulfilObjectiveForLearnersInput!

Fulfil an abstract Learning Objective with a concrete objective for one or more Learning Path Learners
reactivateLearner : LearningPathLearnerResponse!

Reactivate a Cancelled Learner on a Learning Path

Argument Type Description
input LearningPathReactivationInput!

The input type with the values used to reactivate a Learner
registerLearners : LearningPathRegistrationResponse!

Registers one or more learners on a LearningPath

Argument Type Description
input LearningPathRegisterLearnersInput!

An Input for registering one or more learners onto a LearningPath
removeAccountAssociation : LearningPathMutateResponse!

Remove an Account Association from a Learning Path

Argument Type Description
input LearningPathRemoveAccountAssociationInput!

An input for removing an Account Association from a Learning Path
removeTags : LearningPathMutateResponse!

Remove Learning Tags from a Learning Path

Argument Type Description
input LearningPathRemoveTagsInput!

An input for removing Learning Tags from a Learning Path
setObjectiveCompletionForLearners : LearningPathSetObjectiveCompletionForLearnersResponse!

Sets the isCompleted status of the Learning Outcomes associated to a Learning Objective for one or more Learners

Argument Type Description
input LearningPathSetObjectiveCompletionForLearnersInput!

An Input for setting the status of Learners' Learning Outcomes associated to a Learning Objective
setOutcomeIsCompleted : LearningPathSetOutcomeIsCompletedResponse!

Set the isCompleted status of a Learning Outcome

Argument Type Description
input LearningPathSetOutcomeIsCompletedInput!

An Input for setting a Learner's Outcome for an Objective
setTags : LearningPathMutateResponse!

Set Learning Tags on a Learning Path. Will overwrite any existing Learning Tags on this Learning Path.

Argument Type Description
input LearningPathSetTagsInput!

An input for setting Learning Tags on a Learning Path
steps : LearningPathStepMutations!

Mutations for Learning Path Steps

update : LearningPathMutateResponse!

Updates an existing LearningPath

Argument Type Description
input LearningPathUpdateInput!

The input type with the values to be set on the existing LearningPath
updateCourseObjective : LearningPathLearnerResponse!

Update a fulfilled Course Objective for a Learning Path to a different Event

Argument Type Description
input UpdateObjectiveInput!

The input type with the values used to update an Objective for a Learning Path Learner
updateLearner : LearningPathLearnerResponse!

Update a Learner on a Learning Path

Argument Type Description
input LearningPathLearnerUpdateInput!

The input type with the values used to update a Learning Path Learner
updateLmsLastAccessed : LearningPathLearnerResponse!

Update the datetime for when the Learning Path Learner accessed the Learning Path

Argument Type Description
input LearningPathLearnerLmsLastAccessedInput!

The input type with the values used set the Learning Path Learner's last accessed date
updatePrice : LearningPathMutateResponse!

Updates a LearningPathPrice of a LearningPath

Argument Type Description
input LearningPathPriceUpdateInput!

The input type with the values used to update a LearningPathPrice of the LearningPath
Back to top

LearningPathNeed

Details of the Learning Paths that must be fulfilled as part of a Plan.

Related types: Node

account : Account

The Account associated with this Learning Path Need, if any.

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
accountProject : AccountProject

The Account Project associated with this Learning Path Need, if any.

Argument Type Description
filters = [] [AccountProjectFieldGraphFilter]
order = "__EMPTY__" AccountProjectFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountProjectFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of Learning Path Need

learningPath : LearningPath!

The Learning Path that this Learning Path Need is for.

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String

The display name for the Learning Path Need. Defaults to the name of the linked Learning Path.

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
Back to top

LearningPathObjective

An Objective within a Learning Path's learning journey, representing another Learning Path that must be completed in order to complete this Learning Path

Related types: Node LearningObjective

credits : Int

The number of credits that this LearningObjective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The unique identifier of this Learning Path Objective.

isMandatory : Boolean!

Denotes whether or not the LearningObjective is mandatory

learningPath : LearningPath!

The Learning Path this Objective belongs to.

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningObjective in the set of LearningPath objectives

Back to top

LearningPathOutcome

A Learner's record relating to a Learning Path Objective

Related types: Node LearningOutcome

credits : Int

The number of credits that the LearningOutcome represents

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The unique identifier of the Learning Path Outcome.

isCompleted : Boolean

Denotes whether or not the LearningOutcome has been completed by the Learner

isMandatory : Boolean!

Denotes whether or not the LearningOutcome is mandatory

learningObjective : LearningObjective!

The LearningObjective to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
learningPath : LearningPath!

The Learning Path this Outcome belongs to.

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
learningPathLearner : LearningPathLearner!

The LearningPathLearner to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningOutcome in the set of LearningAssignment outcomes

Back to top

LearningPathPrice

A price for a Learning Path

Related types: Node

amount : Decimal!

The amount.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
financialUnit : FinancialUnit!

Currency of price

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
id : ID!

The ID of the LearningPathPrice

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

priceLevel : PriceLevel

The PriceLevel for the LearningPathPrice

Argument Type Description
filters = [] [PriceLevelFieldGraphFilter]
order = "__EMPTY__" PriceLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PriceLevelFieldGraphOrder]
region : Region

The Region for which the LearningPathPrice applies

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
taxInclusive : Boolean

Whether the price is inclusive of tax or not.

validFrom : LocalDateTime

The date and time the price is valid from

validUntil : LocalDateTime

The date and time the price is valid until

Back to top

LearningPathPriceConnection

A connection containing page information and edges for LearningPathPrice

edges : [LearningPathPriceEdge!]!

The list of LearningPathPrice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningPathPriceDeleteInput

An Input to delete a LearningPathPrice of a LearningPath

learningPathPriceId : String!

The ID of the LearningPathPrice being deleted

Back to top

LearningPathPriceDetailsInput

The Input containing the details of a LearningPathPrice

regionId : String!

The ID of the Region of the Learning Path Price

amount : String!

The amount of the Learning Path Price

currencyCode : String

The ID of the Currency of the Learning Path Price, mutually exclusive with tokenTypeId

tokenTypeId : String

The ID of the Token Type of the Learning Path Price, mutually exclusive with currencyCode

Back to top

LearningPathPriceEdge

Contains cursor and node information for type LearningPathPrice

cursor : String!

A string that can be used for cursor-based pagination

node : LearningPathPrice!

The LearningPathPrice node.

Back to top

LearningPathPriceField

An enumeration.

id
regionName
regionId
financialUnit
priceLevelName
validFrom
validUntil
amount
priceLevelId
taxInclusive
Back to top

LearningPathPriceFieldGraphFilter

Filter that can be applied to limit which LearningPathPrice nodes are returned

field : LearningPathPriceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearningPathPriceFieldGraphOrder

Specifies the order in which LearningPathPrice nodes are returned via the Connection

field : LearningPathPriceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearningPathPriceUpdateInput

An Input to update a LearningPathPrice of a LearningPath

learningPathPriceId : String!

The ID of the LearningPathPrice being updated

regionId : String

The ID of the Region of the LearningPathPrice

currencyCode : String

The ID of the Currency of the Learning Path Price, mutually exclusive with tokenTypeId

tokenTypeId : String

The ID of the Token Type of the Learning Path Price, mutually exclusive with currencyCode

amount : String

The amount of the LearningPathPrice

priceLevelId : String

The ID of the Price Level of the LearningPathPrice

validFrom : String

The date and time the LearningPathPrice is valid from

validUntil : String

The date and time the LearningPathPrice is valid until

Back to top

LearningPathProgression

The possible progression types of a LearningPath

serial
grouped
Back to top

LearningPathReactivationInput

An input to reactivate a cancelled Learning Path Learner

learningPathLearnerId : ID!

The Learning Path Learner to reactivate

Back to top

LearningPathRegisterLearnersInput

An Input for registering Learners on a Learning Path

learners : [LearningPathLearnerRegistrationInput]!

A list of LearningPathLearnerRegistrationInputs

learningPathId : String

The ID of the Learning Path to register learners onto. Required if learningPathExternalId not provided.

learningPathExternalId : ExternalIdInput

The External ID of the Learning Path to register learners onto. Required if learningPathId not provided.

registrationId : ID

The existing Registration to add these learners to. If omitted, each learner gets a new Registration.

Back to top

LearningPathRegistrationResponse

A Response from registering one or more learners on a LearningPath

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learners : [LearningPathLearner!]

The learners that were registered

Back to top

LearningPathRemoveAccountAssociationInput

An Input to allow a user to remove an Account Association from a Learning Path

accountAssociationId : ID!

The Account Association to remove

learningPathId : ID!

The Learning Path to remove the Account Association from

Back to top

LearningPathRemoveTagsInput

An Input to allow a user to remove Learning Tags from a Learning Path

learningPathId : ID!

The Learning Path

learningTagIds : [ID]!

The Learning Tags to remove from the Learning Path

Back to top

LearningPathSetObjectiveCompletionForLearnersInput

An Input for setting the status of Learners' Learning Outcomes associated to a Learning Objective

objectiveId : ID!

The Objective associated to the Outcomes on which the isCompleted status is being set

learningPathLearnerIds : [ID]!

A list of Learning Path Learner IDs to set the Objective's status for

isCompleted : Boolean!

Whether or not the Outcome is completed

Back to top

LearningPathSetObjectiveCompletionForLearnersResponse

A response from setting the isCompleted status of Learners' Learning Outcomes associated with an Objective

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learningOutcomes : [LearningOutcome!]

The Learning Outcomes on which isCompleted is set

Back to top

LearningPathSetOutcomeIsCompletedInput

An Input to allow a user to set a Learning Outcome as completed

learningOutcomeId : ID!

The Outcome on which the isCompleted status is being set

isCompleted : Boolean!

Whether or not the Outcome is completed

Back to top

LearningPathSetOutcomeIsCompletedResponse

A response from setting the isCompleted of a Learning Outcome

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learningOutcome : LearningOutcome

The Learning Outcome on which isCompleted is set

Back to top

LearningPathSetStepInput

An Input to allow a user to create or update a Step on a Learning Path

learningObjectives : [LearningPathUpdateLearningObjectivesInput]!

The Learning Objectives to set on this Step. Include existing objectives (with id) to retain/update them, omit to delete them, or include new objectives (without id) to create them.

numRequired : Int

The number of objectives required to complete this Step. Takes precedence over hoursRequired: if both are supplied, only numRequired is used and the Step is a count-based Step.

hoursRequired : Decimal

The number of hours (summed CPE of completed Course/Event objectives) required to complete this Step. Used only when numRequired is omitted.

nestedLearningPathId : ID

The nested learning path this step points to, if any.

stepId : ID

The ID of the Learning Path Step to update. Omit to create a new Step.

Back to top

LearningPathSetStepsInput

An Input to allow a user to sync Steps on a Learning Path. Steps with an id are updated, steps without an id are created, and any existing steps not included are deleted. Step order will be updated to the same order as the list provided, with the first element having order=1.

learningPathId : ID!

The ID of the Learning Path whose Steps to sync

steps : [LearningPathSetStepInput]!

The full desired set of Steps

Back to top

LearningPathSetStepsMutationResponse

A Response from updating multiple Learning Path Steps

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

steps : [LearningPathStep!]!

The steps that were updated

Back to top

LearningPathSetTagsInput

An Input to allow a user to set Learning Tags on a Learning Path.

learningPathId : ID!

The Learning Path

learningTagIds : [ID]!

The Learning Tags to set on the Learning Path

Back to top

LearningPathStep

A step in a Learning Path that groups one or more objectives.

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
hoursRequired : Decimal

Number of hours (summed CPE of completed Course/Event objectives) required to complete this step. Null for count-based steps.

id : ID!

The ID of the LearningPathStep.

isGroup : Boolean!

Whether this step groups multiple objectives.

isRequired : Boolean!

Whether this step requires at least one objective.

learningObjectives : LearningObjectiveConnection!

The LearningObjectives of this step of the LearningPath

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

nestedLearningPath : LearningPath

The nested Learning Path this step points to, if present. All objectives within this step are from that learning path.

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
nestedLearningPathId : ID

Temporary addition. The ID of the nested Learning Path this step points to, if present. All objectives within this step are from that learning path.

numRequired : Int

Number of objectives required to complete this step. Null for hours-based steps (satisfied by hoursRequired instead).

order : Int!

Position of the step in the Learning Path.

Back to top

LearningPathStepConnection

A connection containing page information and edges for LearningPathStep

edges : [LearningPathStepEdge!]!

The list of LearningPathStep edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningPathStepEdge

Contains cursor and node information for type LearningPathStep

cursor : String!

A string that can be used for cursor-based pagination

node : LearningPathStep!

The LearningPathStep node.

Back to top

LearningPathStepField

Fields for filtering and ordering Learning Path Steps.

id
learningPathId
order
numRequired
Back to top

LearningPathStepFieldGraphFilter

Filter that can be applied to limit which LearningPathStep nodes are returned

field : LearningPathStepField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearningPathStepFieldGraphOrder

Specifies the order in which LearningPathStep nodes are returned via the Connection

field : LearningPathStepField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearningPathStepMutations

Mutations for Learning Path Steps

setSteps : LearningPathSetStepsMutationResponse!

Update one or more Steps on a Learning Path.

Argument Type Description
input LearningPathSetStepsInput!
Back to top

LearningPathType

The type of a Learning Path

public
private
Back to top

LearningPathUpdateEventObjectiveInput

An Input to allow a user to update an Event Objective on a Learning Path

objectiveId : ID!

The ID of the Objective that is being updated

learningPathId : ID!

The ID of the Learning Path on which to add the Event Objective

credits : Int!

The number of credits that this Event Objective represents

order : Int!

The order the Objective appears on the Learning Path

isMandatory : Boolean!

Denotes whether or not the Event Objective is mandatory

expectedCompletionDays : Decimal!

The expected time in days required to complete the Event Objective

courseTemplateId : ID!

The Course Template that must be completed to complete this Objective

eventId : ID!

The Event that this Event Objective refers to

Back to top

LearningPathUpdateInput

An Input to update a Learning Path basic metadata

learningPathId : ID!

The id given to the LearningPath

name : String

The name given to the LearningPath

code : String

The code given to the LearningPath

description : String

The description of the LearningPath

lifecycleState : LearningPathLifecycleState

The lifecycle state of the LearningPath

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Learner to update

learningCategories : [ID]

The list of LearningCategories of the LearningPath to update

learningTags : [ID]

The list of LearningTags of the LearningPath to update

expectedCompletionDays : Decimal

The expected number of days it will take a Learner to complete a Learning Path

enforceObjectiveOrder : Boolean

Whether the Learner needs to complete Objectives in order

learningObjectives : [LearningPathUpdateLearningObjectivesInput]

The list of Learning Objectives to update the Learning Path with

achievementTypeId : ID

The ID of the AchievementType that can be earned when the LearningPath is passed

imageDocumentId : ID

The Document to use for the Learning Path Image

imageDocumentIds : [ID]

The Image Documents to use for the Learning Path Images

purchaseRequiresReview : Boolean

Whether the Learning Path requires a review before purchase through a Weblink Portal

requireObjectiveFulfillment : Boolean

Whether the Learning Path requires all Objectives to be fulfilled when registering a Learner

progressionType : LearningPathProgression

The type of Progression of the LearningPath

creditsRequired : Int

The number of Credits required to complete the LearningPath

localeId : ID

The Locale of the Learning Path

featuredInPortals : [ID]

The list of Weblink Portal ID's this Learning Path is featured in

companyId : ID

The ID of the Company the Learning Path belongs to

accountId : ID

The ID of the Account that a Private Learning Path is for. This field can only be updated if it was originally non-null on Learning Path creation, and cannot be unset, as it is not possible to change a Public Learning path to a Private one or vice versa.

accountProjectId : ID

The Project to associate the Private Learning Path with

Back to top

LearningPathUpdateLearningObjectivesInput

An Input for updating an existing Learning Objective on a Learning Path

type : LearningObjectiveType!

The type of Objective

id : ID

The ID of the Learning Objective if it has already been created

courseTemplateId : ID

The ID of the Course Template for a Course Objective

eventId : ID

The ID of the Event for an Event Objective

learningPathId : ID

The ID of the Learning Path for a Learning Path Objective

name : String

The name of an External Objective

description : String

The description of an External Objective

selectableEventIds : [ID]

The IDs of the Events that can be selected to fulfil the Objective. An empty list signifies that any Event for the Objective's Course Template can be selected.

Back to top

LearningTag

Related types: Node

content : ContentConnection!

Any LMS Content associated with the Learning Tag.

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
courseTemplates : CourseTemplateConnection!

Any Course Templates associated with the Learning Tag.

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the LearningTag

learningPaths : LearningPathConnection!

Any Learning Paths associated with the Learning Tag.

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the LearningTag

Back to top

LearningTagConnection

A connection containing page information and edges for LearningTag

edges : [LearningTagEdge!]!

The list of LearningTag edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LearningTagDeleteInput

An input for deleting a Learning Tag

learningTagId : ID!

The ID of the Learning Tag to be deleted

Back to top

LearningTagEdge

Contains cursor and node information for type LearningTag

cursor : String!

A string that can be used for cursor-based pagination

node : LearningTag!

The LearningTag node.

Back to top

LearningTagField

Fields for filtering and ordering Learning Tags

id
name
Back to top

LearningTagFieldGraphFilter

Filter that can be applied to limit which LearningTag nodes are returned

field : LearningTagField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LearningTagFieldGraphOrder

Specifies the order in which LearningTag nodes are returned via the Connection

field : LearningTagField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LearningTagInput

An input for creating a Learning Tag

name : String!

The name given to the Learning Tag

Back to top

LearningTagMutations

Mutations for Learning Tags

create : LearningTagTypeMutateResponse!

Creates a Learning Tag

Argument Type Description
input [LearningTagInput]!

The input type with the values to be set on the new Learning Tag
delete : LearningTagTypeDeleteResponse!

Deletes a Learning Tag

Argument Type Description
input LearningTagDeleteInput!

The input type with the Learning Tag ID to delete
update : LearningTagTypeUpdateResponse!

Edits a Learning Tag

Argument Type Description
input LearningTagUpdateInput!

The input type with the Learning Tag ID and values to update
Back to top

LearningTagTypeDeleteResponse

A Response from deleting a Learning Tag Type

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

LearningTagTypeMutateResponse

A Response from mutating an LearningTag Type

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learningTags : [LearningTag!]

The Learning Tags that were created or found

Back to top

LearningTagTypeUpdateResponse

A Response from updating a Learning Tag Type

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learningTag : LearningTag

The Learning Tag that was updated

Back to top

LearningTagUpdateInput

An input for updating a Learning Tag

name : String!

The name for the Learning Tag to be updated to

learningTagId : ID!

The ID of the Learning Tag to be updated

Back to top

LifecycleState

An enumeration.

active
archived
Back to top

LinkDocumentAccountInput

An Input to link a Document to an Account

accountId : ID!

The ID of the Account to link the Document to

documentId : ID!

The ID of the Document to be linked to the Account

Back to top

LinkDocumentContactInput

An Input to link a Document to a Contact

contactId : ID!

The ID of the Contact to link the Document to

documentId : ID!

The ID of the Document to be linked to the Contact

Back to top

LinkDocumentOpportunityInput

An Input to link a Document to an Opportunity

opportunityId : ID!

The ID of the Opportunity to link the Document to

documentId : ID!

The ID of the Document to be linked to the Opportunity

Back to top

LMSAccess

Access details for the lms

hasCredentials : Boolean!

Describes whether Contact has been issued with credentials to log into the LMS

lastLogin : TimeZonedDateTime

Get the Contact last login date

Back to top

LmsAttempt

Related types: ScormAttempt ExternalActivityAttempt DiscussionTopicCommentAttempt VideoResourceAttempt ResourceAttempt

completedAt : TimeZonedDateTime

The date and time when the Attempt was completed

completedByAdmin : Boolean!

Whether the Attempt has been manually completed by an Admin

content : LmsContent!

The Attempt's Content

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
id : ID!

ID of the Attempt

isCompleted : Boolean!

Whether the Attempt has been completed

isPassed : Boolean!

Whether the Attempt has been passed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
updatedAt : TimeZonedDateTime

The date and time when the Attempt was updated

Back to top

LmsAttemptConnection

A connection containing page information and edges for LmsAttempt

edges : [LmsAttemptEdge!]!

The list of LmsAttempt edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LmsAttemptEdge

Contains cursor and node information for type LmsAttempt

cursor : String!

A string that can be used for cursor-based pagination

node : LmsAttempt!

The LmsAttempt node.

Back to top

LmsAttemptField

AttemptField Fields for Filtering and Ordering

attemptId
contentId
updatedAt
Back to top

LmsAttemptFieldGraphFilter

Filter that can be applied to limit which LmsAttempt nodes are returned

field : LmsAttemptField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LmsAttemptFieldGraphOrder

Specifies the order in which LmsAttempt nodes are returned via the Connection

field : LmsAttemptField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LmsAttemptMutateResponse

A Response from mutating an Attempt

Related types: MutationResponse

attempt : LmsAttempt

The Attempt that was updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

LmsCompatibleEntity

The entity the field is associated with

course
event
contact
learner
Back to top

LMSConfiguration

Configuration for the LMS

defaultTimeZone : String

Default time zone for the LMS

name : String

The name of the Instance's LMS

Back to top

LmsConnection

LMS Connection Type

Related types: Node

accountSyncMode : AccountSyncMode

The Account sync mode of the connection

clientId : String!

The client ID for the connection

domain : String!

The domain for the connection

errors : [String!]!

Any errors associated with the connection

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the connection

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

notificationEmails : [String!]!

Emails to notify when Integration events occur

pauseHealing : Boolean

Whether self-healing is paused for the connection

resourceTypes : [ResourceType!]!

The resource types synced for this connection

Argument Type Description
filters = [] [ResourceTypeFieldGraphFilter]
order = "__EMPTY__" ResourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceTypeFieldGraphOrder]
status : LmsConnectionStatus!

The status of the connection

username : String!

The username for the connection

vendor : LmsVendor!

The vendor of the connection

vendorAccounts : [VendorAccount!]!

The accounts for the connection on the vendor side

vendorCustomFields : [VendorCustomField!]!

Vendor custom fields for the connection

vendorTargetAccountId : String

The ID of the target default vendor Account to which Accounts are synced

virtualMeetingLinkHost : VirtualMeetingLinkHost

The virtual meeting link host of the connection

Back to top

LmsConnectionStatus

The status of a LMS Connection

initializing
connected
disconnected
error
unknown
pendingFieldMap
Back to top

LmsContent

LMS specific content

Related types: Content Node

autoComplete : Boolean!

Flag indicating if the content should be auto completed on learner access

comments : ContentCommentConnection!

The Comments related to this Content

Argument Type Description
filters = [] [ContentCommentFieldGraphFilter]
order = "__EMPTY__" ContentCommentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentCommentFieldGraphOrder]
customFieldValues : [CustomFieldValue!]!

Custom Field values for the Content

Argument Type Description
filter CustomFieldFilterInput
displayName : String

The main display name of the content

document : Document

The document associated with this piece of LmsContent

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
event : Event!

The Event this Content is a part of

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
externalActivityInstructionsForLearner : String

Instructions for engaging with an External Activity rendered for the Specific Learner

Argument Type Description
learnerId ID!

The Learner who will be Engaging with this External Activity
externalActivityUrl : String

URL for the Learner to Engage with External Activity

externalActivityUrlForLearner : String

URL for the specific Learner to Engage with

Argument Type Description
learnerId ID!

The Learner who will be engaging with this content
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
hasAttempts : Boolean!

Flag indicating if any student recorded interactions with this content

htmlDescription : String

Optional description of LMS Content. Contains HTML.

id : ID!

ID of the Content

includedInPassTypeIds : [String!]!

Training Pass Type IDs that grant access to this content

isArchived : Boolean!

Whether or not the LmsContent is archived

isHidden : Boolean!

Whether or not the LmsContent is hidden

isPremium : Boolean!

If the content requires a Training Pass to access it

isPublic : Boolean!

Public LMS Resources can be displayed to learners outside of an Administrate Portal in an embedded context

isRequired : Boolean

Whether or not the LmsContent is required for the Learner to complete the Event

kryterionCourseId : String

The ID of the associated Kryterion content

kryterionUrl : String

URL for the Learner to Engage with the Kryterion content

learningTags : LearningTagConnection!

The Learning Tags associated with this Lms Resource

Argument Type Description
filters = [] [LearningTagFieldGraphFilter]
order = "__EMPTY__" LearningTagFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningTagFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

maxAttempts : Int

The maximum number of attempts permitted for this piece of LmsContent

order : Int!

The order in which the LmsContent should be displayed

thumbnailDocument : Document

The thumbnail Document specified for this piece of Content

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
type : ContentType!

Type of the Content

Deprecated fields (4)
description : String

A description of the LmsContent

Removal date: TBD.

Deprecated in favour of htmlDescription for content of type Separator, Discussion, Kryterion, and External. Otherwise in favour of displayName.

externalActivityInstructions : String

Instructions for engaging with an External Activity and Discussion Topic

Removal date: TBD.

Deprecated in favor of instructions

instructions : String

Instructions for engaging with an External Activity, Discussion Topic or Kryterion Activity

Removal date: TBD.

Deprecated in favour of htmlDescription

name : String

Name of the Content

Removal date: TBD.

Deprecated in favour of displayName

Back to top

LmsDuration

A duration related to LMS courses described by a duration and unit (e.g. 6 weeks)

unit : ScheduleDuration!

Offset unit

value : Int!

Offset value

Back to top

LmsDurationInput

value : Int!
Back to top

LMSEventCreateInput

An Input for creating a LMS Event

eventType : EventType!
timeZoneName : String!
lmsStartDateTime : LocalDateTime

The LMS start date and time (without a timezone). Required, unless you give timeZonedLmsStart instead (don't provide both). Used exactly as given; Course Templates and schedules do not change it.

lmsEndDateTime : LocalDateTime

The LMS end date and time (without a timezone). Optional. Used exactly as given.

timeZonedLmsStart : TimeZonedDateTime

The same as lmsStartDateTime but with a timezone. Use this instead of the version without a timezone, not both.

timeZonedLmsEnd : TimeZonedDateTime

The same as lmsEndDateTime but with a timezone. Optional.

title : String
location : ID
locationId : ID
taxType : ID
taxTypeId : ID
timeZone : String
courseCode : String
code : String
lifecycleState : EventLifecycleState
status : EventStatus
minPlaces : Int
maxPlaces : Int
targetFillRate : Int
achievementTypeId : ID
achievementValidFrom : AchievementValidFromTypes
courseTemplateId : ID
courseTemplateVersionId : ID

Experimental. Pin the Event to a frozen version of the Course Template given in courseTemplateId, so its content is taken from that version instead of the current one. Requires the Course Template versioning feature.

privateEventDetails : PrivateEventDetailsCreateInput
registrationDeadline : LocalDateTime
registrationOpensAt : LocalDateTime
localeId : ID
customFieldValues : [CustomFieldValueInput]
venueId : ID
externalNotes : String
internalNotes : String
lmsAnnouncements : String
taskWorkflowGroupIds : [ID]
taskWorkflowIds : [ID]
Back to top

LMSEventUpsertByExternalIdInput

An input to Create or Update a LMS Event based on a provided External ID

externalId : ExternalIdInput!

The External ID used to identify the Event to upsert. If an Event does not exist, this External ID is set on the created Event.

event : LMSEventUpsertInput!

The details with which to create or update the Event.

Back to top

LMSEventUpsertInput

An Input for upserting a LMS Event

eventType : EventType!
timeZoneName : String!
lmsStartDateTime : LocalDateTime

The LMS start date and time (without a timezone). Used as in LMSEventCreateInput when this upsert creates a new Event.

lmsEndDateTime : LocalDateTime

The LMS end date and time (without a timezone). Optional. Used as in LMSEventCreateInput when this upsert creates a new Event.

timeZonedLmsStart : TimeZonedDateTime

The same as lmsStartDateTime but with a timezone; use this instead of the version without a timezone, not both.

timeZonedLmsEnd : TimeZonedDateTime

The same as lmsEndDateTime but with a timezone. Optional.

title : String
location : ID
locationId : ID
taxType : ID
taxTypeId : ID
timeZone : String
courseCode : String
code : String
lifecycleState : EventLifecycleState
status : EventStatus
minPlaces : Int
maxPlaces : Int
targetFillRate : Int
achievementTypeId : ID
achievementValidFrom : AchievementValidFromTypes
courseTemplateId : ID
privateEventDetails : PrivateEventDetailsCreateInput
registrationDeadline : LocalDateTime
registrationOpensAt : LocalDateTime
localeId : ID
customFieldValues : [CustomFieldValueInput]
venueId : ID
externalNotes : String
internalNotes : String
lmsAnnouncements : String
taskWorkflowGroupIds : [ID]
taskWorkflowIds : [ID]
Back to top

LmsIntegrationFieldMappingInput

An input for updating an LMS Integration field mapping

vendor : LmsVendor!
Back to top

LmsIntegrationFieldMappingResponse

A Response for an LMS Integration Field Mapping Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

vendorCustomFields : [VendorCustomField!]!

Custom fields for an LMS integration vendor with mappings to an Administrate Custom Field

Back to top

LmsIntegrationSettings

LMS Integration Settings Type

jwtPublicKeys : [JwtPublicKey!]!

The JWT Public Key for the OAuth App configuration

lmsConnections : [LmsConnection!]!

List of LMS connections

Argument Type Description
filters [LmsIntegrationSettingsFieldGraphFilter]
Back to top

LmsIntegrationSettingsCreateInput

An input for creating an LMS Integration connection

vendor : LmsVendor!

The LMS vendor for this integration connection

clientId : String!

The client ID for the OAuth2 app

domain : String!

The domain for the external LMS instance

username : String!

The external LMS username

notificationEmails : [String]

Email addresses to notify of any integration issues

Back to top

LmsIntegrationSettingsDeleteInput

An input for deleting an LMS Integration connection

vendor : LmsVendor!

The LMS vendor whose integration connection should be deleted

Back to top

LmsIntegrationSettingsField

Fields for filtering and ordering LMS Integration Settings

currentUser
vendor
Back to top

LmsIntegrationSettingsFieldGraphFilter

Filter that can be applied to limit which LmsIntegrationSettings nodes are returned

field : LmsIntegrationSettingsField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LmsIntegrationSettingsMutations

Updates LMS integration connection information.

createConnection : LmsIntegrationSettingsResponse!

Creates an LMS Integration connection

Argument Type Description
input LmsIntegrationSettingsCreateInput!

The input type with the values used to set LMS Integration connection
deleteConnection : LmsIntegrationSettingsResponse!

Delete an LMS Integration connection

Argument Type Description
input LmsIntegrationSettingsDeleteInput!

The input type with the values used to delete the LMS Integration connection
updateConnection : LmsIntegrationSettingsResponse!

Update an LMS Integration connection

Argument Type Description
input LmsIntegrationSettingsUpdateInput!

The input type with the values used to update the LMS Integration connection
updateFieldMapping : LmsIntegrationFieldMappingResponse!

Updates an LMS Integration field mapping - this overrides the current mappings, any fields not specified will be unmapped.

Argument Type Description
input LmsIntegrationFieldMappingInput!
Back to top

LmsIntegrationSettingsResponse

A Response for a LMS Integration Settings Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

settings : LmsIntegrationSettings!

The LMS Integration Settings

Back to top

LmsIntegrationSettingsUpdateInput

An input for updating an LMS Integration connection

vendor : LmsVendor!

The LMS vendor for this integration connection

clientId : String

The client ID for the OAuth2 app

domain : String

The domain for the external LMS instance

username : String

The external LMS username

accountSyncMode : AccountSyncMode

The account sync mode

vendorTargetAccountId : String

The ID of the chosen default vendor account

notificationEmails : [String]

Email addresses to notify of any integration issues

resourceTypeIds : [String]

The resource type IDs to sync for this connection

virtualMeetingLinkHost : VirtualMeetingLinkHost

The virtual meeting link host

pauseHealing : Boolean

Whether to pause self-healing for this connection

Back to top

LMSPortal

A separate website that Contacts can access for example: An LMS or Web Store

Related types: Node Portal

analyticsConfiguration : PortalAnalyticsConfiguration!

Configuration for any data analytics providers configured for this portal

autoProvisionLearnersViaSingleSignOn : Boolean!

Indicates if new contacts and contact credentials are created when unknown learners log in via Single Sign On

availabilityState : PortalAvailabilityState!

The current availability of this Portal

brand : Brand!

The Brand that owns this Portal

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
categories : [LearningCategory]!

The Learning Categories associated with this Portal

courseDetailsCustomFieldMap : [PortalCourseDetailsFieldMapping]!

Custom Field Mappings that define how fields on a Course Template map to fields on a Portal Course

customFieldFilters : PortalCustomFieldFilterConnection!

Custom Field Mappings for the filters available on this Portal

Argument Type Description
filters = [] [PortalCustomFieldFilterFieldGraphFilter]
order = "__EMPTY__" PortalCustomFieldFilterFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalCustomFieldFilterFieldGraphOrder]
customFieldTemplate : PortalCustomFieldTemplate!

Fetches the Custom Field Template associated with this Portal for a type

Argument Type Description
type SupportsCustomFieldPortalEntities!
emailTemplateMappings : PortalEmailTemplateMappingConnection!

Fetches the mapping between Portals and Communication Templates

Argument Type Description
filters = [] [PortalEmailTemplateMappingFieldGraphFilter]
order = "__EMPTY__" PortalEmailTemplateMappingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalEmailTemplateMappingFieldGraphOrder]
emptyPortalRedirectUrl : URL

The URL that the Contact is redirected to if they log in with no content to view

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
externalOriginsAllowList : [String!]!

Origin URLs allowed to send events from

giftVoucherConfigurationMapping : GiftVoucherPortalConfiguration

Fetches the Gift Voucher Configuration that is mapped to this Portal

Argument Type Description
filters = [] [GiftVoucherPortalConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherPortalConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherPortalConfigurationFieldGraphOrder]
giftVoucherConfigurations : GiftVoucherConfigurationConnection!

Fetches the Gift Voucher Configurations associated with this Portal

Argument Type Description
filters = [] [GiftVoucherConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherConfigurationFieldGraphOrder]
id : ID!

The ID of this Portal

identityProviders : IdentityProviderConnection!

The Identity Providers for this Portal

Argument Type Description
filters = [] [IdentityProviderFieldGraphFilter]
order = "__EMPTY__" IdentityProviderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [IdentityProviderFieldGraphOrder]
isApprovalPortal : Boolean!

Dictates if Approval Portal behaviours are enabled for this Portal

isBookingPortal : Boolean!

Dictates if Booking Portal behaviours are enabled for this Portal

isSelfRegistrationPortal : Boolean!

Dictates if Self-Registration behaviours are enabled for this Portal

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

linkedWebLinkPortals : [WebLinkPortal!]!

The WebLink Portals associated with this Portal

priceLevels : [PriceLevel]!

The Price Levels associated with this Portal

profileSettings : LMSProfileSettings!

Dictates if Booking Portal behaviours are enable for this Portal

singleSignOnOnly : Boolean!

Indicates if Contacts can log into this Portal only by Single Sign On

termsAndConditions : String

The terms and conditions for Portal checkout flow

url : URL!

The URL of this Portal

vanityUrl : URL

The URL that proxies to this Portal, usually for branding

Deprecated fields (1)
analyticsEnabled : Boolean!

Whether the analytics are enabled on the instance hosting the portal.

Removal date: TBD.

Feature removed, always returns false

Back to top

LMSProfileSettings

allowEditEmail : Boolean!

Is the Learner is allowed to edit the Profile email

allowEditJobTitle : Boolean!

Is the Learner allowed to edit the Profile Job Title

allowEditName : Boolean!

Is the Learner allowed to edit the Profile Name

showJobTitle : Boolean!

Is the Learner allowed to view the Profile Job Title

Back to top

LmsResourceCommon

An enumeration.

document
quiz
presentation
resource
scorm
video
Back to top

LmsResourceResponse

A response for creating an LMS Resource

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

lmsContent : LmsContent

The LMS Resource that was created on the Event

Back to top

LmsResourceTypeExternalInput

An input type for adding LMS Resources of type external to a Course Template

description : String!

A description for the LMS Resource.

externalActivityDescription : String!

The Description for external activity LMS Resource in html.

order : Int

The LMS Resource's position in the list of LMS Resource.

isRequired : Boolean

Is the LMS Resource required to complete the course.

isHidden : Boolean

Hidden LMS Resources can not be displayed to users outside of an administrate portal in an embedded context. Defaults to false.

isArchived : Boolean

Archived LMS Resources can not be displayed to users in any context. Defaults to false.

autoComplete : Boolean

Flag to automatically mark Content Complete for Learner once accessed.

Back to top

LmsResourceTypeExternalUpdateInput

An input type for updating LMS Resources of type external to a Course Template

description : String

A description for the LMS Resource.

externalActivityDescription : String

The Description for external activity LMS Resource in html.

order : Int

The LMS Resource's position in the list of LMS Resource.

isRequired : Boolean

Is the LMS Resource required to complete the course.

isHidden : Boolean

Hidden LMS Resources can not be displayed to users outside of an administrate portal in an embedded context. Defaults to false.

isArchived : Boolean

Archived LMS Resources can not be displayed to users in any context. Defaults to false.

autoComplete : Boolean

Flag to automatically mark Content Complete for Learner once accessed.

Back to top

LmsResourceTypeResourceInput

An input type for adding LMS Resources of type resource to a Course Template

description : String!

A description for the LMS Resource.

documentId : ID!

The ID of the DMS Document to add as LMS Resource.

resourceType : LmsResourceCommon!
order : Int

The LMS Resource's position in the list of LMS Resource.

isRequired : Boolean

Is the LMS Resource required to complete the course.

isHidden : Boolean

Hidden LMS Resources can not be displayed to users outside of an administrate portal in an embedded context. Defaults to false.

isArchived : Boolean

Archived LMS Resources can not be displayed to users in any context. Defaults to false.

Back to top

LmsResourceTypeSeparatorInput

An input type for adding LMS Resources of type separator to a Course Template

description : String!

A description for the LMS Resource.

order : Int

The LMS Resource's position in the list of LMS Resource.

Back to top

LmsResourceUpsertByExternalIdInput

An input to Create or Update an LMS Resource on an Event based on a provided External ID

externalId : ExternalIdInput!

The External ID used to identify the LMS Resource to upsert. If an LMS Resource does not exist, this External ID is set on the created LMS Resource.

lmsResource : LmsResourceUpsertInput!

The details with which to create or update the LMS Resource.

Back to top

LmsResourceUpsertInput

Input Class for creating or updating an LMS Resource

resourceType : ContentType!

The LMS Resource type.

displayName : String!

A name for the LMS Resource.

eventId : ID

The ID of the Event the LMS Resource is on.

eventExternalId : ExternalIdInput

The External ID of the Event the LMS Resource is on.

htmlDescription : String

A description for the LMS Resource.

ordering : Int

The LMS Resource's position in the list of LMS Resource.

maxCompletions : Int

The maximum number of attempts on this piece of LMS Resource.

externalActivityURL : String

The URL for external activity LMS Resource.

isRequired : Boolean

Is the LMS Resource required to complete the Event.

documentId : ID

The ID of the DMS Document to add as LMS Resource.

isPublic : Boolean

Public LMS Resources can be displayed to learners outside of an Administrate Portal in an embedded context.

thumbnailDocumentId : ID

The ID of Image from DMS Documents that should be used as a thumbnail.

learningTags : [ID]

The list of LearningTag IDs to create this Event with.

customFieldValues : [CustomFieldValueInput]

The list of Custom Fields to create this LMS Resource with.

autoComplete : Boolean

Flag if the resource will be auto completed after a learner has accessed it

Back to top

LmsSchedule

A schedule for the event tied to the Course

Related types: Schedule

accessDuration : LmsDuration

The access duration of the LMS course

courseDuration : LmsDuration

The course duration of the LMS course

registrationDeadlineOffset : RegistrationDeadlineOffset

The Schedule registration deadline offset

Back to top

LmsScheduleInput

An input to set LMS Schedule on a Course Template

registrationDeadlineOffset : RegistrationDeadlineOffsetInput
accessDuration : LmsDurationInput
courseDuration : LmsDurationInput
Back to top

LmsScheduleOffset

A time offset described by a duration and context (e.g. 1 day 'after start')

context : ScheduleOffsetContext!

Offset context

unit : ScheduleDuration!

Offset unit

value : Int!

Offset value

Back to top

LmsScheduleOffsetInput

value : Int!
Back to top

LmsVendor

The vendor of a LMS Connection

docebo
Back to top

LocalDateTime

A date and time as an ISO 8601 formatted string without time zone information

Back to top

Locale

A Locale for Communication Templates

Related types: Node

code : String!

Code of the Locale

default : Boolean!

Whether or not this Locale is the default

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
fullName : String!

Language with details

hasMissingCommunicationTemplateTranslations : Boolean!

Whether or not this Locale has missing Communication Templates

id : ID!

ID of the Locale

language : String!

Language of the Locale

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

missingCommunicationTemplateTranslations : CommunicationTemplateConnection!

Communication Templates that are missing translation for this Locale

Argument Type Description
filters = [] [CommunicationTemplateFieldGraphFilter]
order = "__EMPTY__" CommunicationTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CommunicationTemplateFieldGraphOrder]
name : String!

Name of the Locale. In the format "language" when only one system variant or "language (details)" when multiple.

supported : Boolean!

Whether or not this Locale is supported on this instance

Back to top

LocaleConnection

A connection containing page information and edges for Locale

edges : [LocaleEdge!]!

The list of Locale edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LocaleEdge

Contains cursor and node information for type Locale

cursor : String!

A string that can be used for cursor-based pagination

node : Locale!

The Locale node.

Back to top

LocaleField

Fields for filtering and ordering Locales

id
name
code
supported
default
hasMissingCommunicationTemplateTranslations
Back to top

LocaleFieldGraphFilter

Filter that can be applied to limit which Locale nodes are returned

field : LocaleField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LocaleFieldGraphOrder

Specifies the order in which Locale nodes are returned via the Connection

field : LocaleField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LocaleMutateResponse

A response from Locale Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

locale : Locale

A Locale that has been mutated

Back to top

LocaleMutations

Mutations for a Locale

setDefault : LocaleMutateResponse!
Argument Type Description
input LocaleSetDefaultInput!
setSupported : LocaleMutateResponse!
Argument Type Description
input LocaleSetSupportedInput!
Back to top

LocaleSetDefaultInput

An Input for setting a Locale default

localeId : ID!

The ID of Locale to be default

Back to top

LocaleSetSupportedInput

An Input for setting a Locale's supported flag

localeId : ID!

The ID of the Locale being updated

supported : Boolean!

Whether the Locale is supported or not

Back to top

Location

A particular place used for training

Related types: Node

address : Address

The address of the location

code : String

The code of the Location

defaultTaxType : TaxType

The default tax type for this location

description : String

The description for this location

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Location

latitude : Coordinate

The latitude of the location

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

longitude : Coordinate

The longitude of the location

name : String!

Name of the Location

region : Region

Region of the Location

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
status : String

The status of the Location

timeZone : String

The time zone for this location

url : String

The website of the Location

Back to top

LocationConnection

A connection containing page information and edges for Location

edges : [LocationEdge!]!

The list of Location edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

LocationCreateInput

regionId : ID!

The region this location resides in

name : String!

The name for this location

addressId : ID

The address this location resides in

code : String

A specific code for this location

url : String

A website for this location

status : LocationStatus

The current status of this location (Active/Inactive) - active by default

description : String

A long form description for the location

taxTypeId : ID

The default tax type for this location

timeZone : String

The time zone for this location

latitude : Coordinate

The latitude of this location

longitude : Coordinate

The longitude of this location

Back to top

LocationDeleteInput

An input for deleting a Location

locationId : ID!

The ID of the Location to delete

Back to top

LocationDiscountabilityRule

Promotion Campaign Discountability Rules related to Locations

Related types: PromotionDiscountabilityRule

discountableLocations : LocationConnection!

A list of Event Locations that affect this discountability rule

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
type : PromotionCriterionType!

The type of Discountability Rule (e.g. Course, Location, etc)

Back to top

LocationEdge

Contains cursor and node information for type Location

cursor : String!

A string that can be used for cursor-based pagination

node : Location!

The Location node.

Back to top

LocationEligibilityRule

Promotion Campaign Eligibility Rules related to Locations

Related types: PromotionEligibilityRule

eligibleLocations : LocationConnection!

A list of Event Locations eligible for this Promotion rule

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
type : PromotionCriterionType!

The type of Eligibility Rule (e.g. Course, Location, etc)

Back to top

LocationField

Fields for filtering and ordering Locations

id
name
code
description
regionId
addressId
regionName
defaultTaxName
addressCountryName
status
hasActiveEventForCourseId
Back to top

LocationFieldGraphFilter

Filter that can be applied to limit which Location nodes are returned

field : LocationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

LocationFieldGraphOrder

Specifies the order in which Location nodes are returned via the Connection

field : LocationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

LocationMutateResponse

A Response from mutating a Location

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

location : Location

The Location that was mutated

Back to top

LocationMutations

Mutations for Locations

create : LocationMutateResponse!

Creates a new Location

Argument Type Description
input LocationCreateInput!

Incoming new address
delete : LocationMutateResponse!

Delete a Location

Argument Type Description
input LocationDeleteInput!

The ID of the Location to delete
update : LocationMutateResponse!

Updates a Location

Argument Type Description
input LocationUpdateInput!

The fields to update in the Address
Back to top

LocationStatus

Types location statuses available

active
inactive
Back to top

LocationUpdateInput

locationId : ID!

The Location ID to update

regionId : ID

The region this location resides in

name : String

The name for this location

description : String

A long form description for the location

addressId : ID

The address this location resides in

code : String

A specific code for this location

url : String

A website for this location

status : LocationStatus

The current status of this location (Active/Inactive) - active by default

taxTypeId : ID

The default tax type of this location

timeZone : String

The time zone of this location

latitude : Coordinate

The latitude of this location

longitude : Coordinate

The longitude of this location

Back to top

LowFillRateIssue

The Event's current fill rate is below its configured target

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

current : Float!

Current fill rate of the Event as a ratio (0–1)

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

target : Float!

Target fill rate configured on the Event as a percentage (0–100)

Back to top

MappedContactField

An enumeration.

JobRole
Department
EmailAddress
FirstName
MiddleName
LastName
AddressTown
AddressRegion
AddressPostcode
AddressCountry
AddressStreet1
AddressStreet2
AddressStreet3
ProvinceCode
FaxPhoneNumber
HomePhoneNumber
MobilePhoneNumber
OfficePhoneNumber
Back to top

MappedField

An entity type and field mapping

entityType : String!

The mapped entity type

field : String!

The mapped field

Back to top

MappedFieldInput

An Input for specifying the Mapped Field for a Point of Sale Field

entityType : EntityType!

The Entity Type the field mapping refers to

customFieldDefinitionKey : String

The Definition Key of the Custom Field to map to

contactField : MappedContactField

The field on a Contact to map to

Back to top

MapResourceCalendarsInput

An input for mapping an External Calendar to a Resource

calendarId : String!

ID for the External Calendar to be mapped

resourceId : String!

The ID of the Resource to map the External Calendar to

Back to top

MarkContactWelcomedInput

An Input for marking a Contact has having received the Welcome Message

contactId : ID!

The ID of the Contact these Credentials are for

brandId : ID!

The ID of the Brand these Credentials are for

Back to top

MarketingActivity

A Marketing Activity

Related types: Node

campaign : MarketingCampaign

Campaign of the Marketing Activity

code : String

Code of the Marketing Activity

description : String

Description of the Marketing Activity

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Marketing Activity

isFinished : Boolean!

Whether the Marketing Activity is finished or not

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

title : String

Title of the Marketing Activity

Back to top

MarketingActivityConnection

A connection containing page information and edges for MarketingActivity

edges : [MarketingActivityEdge!]!

The list of MarketingActivity edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

MarketingActivityEdge

Contains cursor and node information for type MarketingActivity

cursor : String!

A string that can be used for cursor-based pagination

node : MarketingActivity!

The MarketingActivity node.

Back to top

MarketingActivityField

Fields for filtering and ordering Marketing Activities

id
isFinished
Back to top

MarketingActivityFieldGraphFilter

Filter that can be applied to limit which MarketingActivity nodes are returned

field : MarketingActivityField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

MarketingActivityFieldGraphOrder

Specifies the order in which MarketingActivity nodes are returned via the Connection

field : MarketingActivityField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

MarketingCampaign

A Marketing Campaign

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Marketing Campaign

isFinished : Boolean!

Whether the Marketing Campaign is finished or not

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

MarketingList

A list of contacts used for marketing communications.

Related types: Node

description : String

Description of the Marketing List.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Marketing List.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Marketing List.

Back to top

MarketingListConnection

A connection containing page information and edges for MarketingList

edges : [MarketingListEdge!]!

The list of MarketingList edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

MarketingListEdge

Contains cursor and node information for type MarketingList

cursor : String!

A string that can be used for cursor-based pagination

node : MarketingList!

The MarketingList node.

Back to top

MarketingListField

An enumeration.

id
name
Back to top

MarketingListFieldGraphFilter

Filter that can be applied to limit which MarketingList nodes are returned

field : MarketingListField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

MarketingListFieldGraphOrder

Specifies the order in which MarketingList nodes are returned via the Connection

field : MarketingListField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

MarketingSource

Represents a Marketing Source

details : String

The details of this Marketing Source

type : MarketingSourceType

The type of this Marketing Source

Back to top

MarketingSourceInput

An Input for a MarketingSource

marketingSourceTypeId : ID

The ID of the Marketing Source Type

details : String

The details of the Marketing Source

Back to top

MarketingSourceType

Channels by which prospects are referred

Related types: Node

companies : CompanyConnection

Companies that can use this Marketing Source

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Marketing Source

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of this Marketing Source

Back to top

MarketingSourceTypeConnection

A connection containing page information and edges for MarketingSourceType

edges : [MarketingSourceTypeEdge!]!

The list of MarketingSourceType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

MarketingSourceTypeEdge

Contains cursor and node information for type MarketingSourceType

cursor : String!

A string that can be used for cursor-based pagination

node : MarketingSourceType!

The MarketingSourceType node.

Back to top

MarketingSourceTypeField

Fields for filtering and ordering Marketing Source types

id
name
companyId
Back to top

MarketingSourceTypeFieldGraphFilter

Filter that can be applied to limit which MarketingSourceType nodes are returned

field : MarketingSourceTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

MarketingSourceTypeFieldGraphOrder

Specifies the order in which MarketingSourceType nodes are returned via the Connection

field : MarketingSourceTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

Membership

A Membership describing Contact and Account relation

Related types: Node

account : Account!

The Account related to this Membership

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
contact : Contact!

The Contact related to this Membership

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime!

The Date and Time the Membership was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Membership

isActive : Boolean!

Whether or not this Membership has an active Job Role

isPrimary : Boolean!

Whether or not this Membership is primary for the Contact

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

membershipJobRoles : MembershipJobRoleConnection!

Job Roles assigned to this Membership

Argument Type Description
filters = [] [MembershipJobRoleFieldGraphFilter]
order = "__EMPTY__" MembershipJobRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MembershipJobRoleFieldGraphOrder]
Back to top

MembershipActivateInput

An Input for activating a Membership

membershipId : ID!

The ID of Membership to be activated

Back to top

MembershipAddInput

An Input for adding a Membership and specifying Job Role.

contactId : ID!

The Contact ID of the Membership

accountId : ID!

The Account ID of the Membership

startDate : TimeZonedDateTime!

The start date of the Job Role

jobRoleId : ID

The Job Role of the Membership

endDate : TimeZonedDateTime

The end date of the Job Role

lineManager : ID

The Line Manager of the Job Role

Back to top

MembershipConnection

A connection containing page information and edges for Membership

edges : [MembershipEdge!]!

The list of Membership edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

MembershipCreateInput

An Input for creating a Membership

contactId : ID!

The Contact ID of the Membership

accountId : ID!

The Account ID of the Membership

Back to top

MembershipDeactivateInput

An Input for deactivating a Membership

membershipId : ID!

The ID of Membership to be deactivated

Back to top

MembershipDeleteInput

An Input for deleting a Membership

membershipId : ID!

The ID of Membership to be deleted

Back to top

MembershipEdge

Contains cursor and node information for type Membership

cursor : String!

A string that can be used for cursor-based pagination

node : Membership!

The Membership node.

Back to top

MembershipField

An enumeration.

id
accountId
contactId
isPrimary
createdAt
deletedAt
isActive
contactName
accountName
hasDescendantAccountId
Back to top

MembershipFieldGraphFilter

Filter that can be applied to limit which Membership nodes are returned

field : MembershipField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

MembershipFieldGraphOrder

Specifies the order in which Membership nodes are returned via the Connection

field : MembershipField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

MembershipJobRole

Related types: Node

createdAt : TimeZonedDateTime!

Date and Time the Membership Job Role was created

endDate : TimeZonedDateTime

The end date for the Membership Job Role

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

Unique identifier for the Membership Job Role

isActive : Boolean!

Flag indicating if the Membership Job Role is active

isPrimary : Boolean!

Flag indicating whether it is the Primary Membership Job Role

jobRole : JobRole!

The Job Role related to the Membership Job Role

Argument Type Description
filters = [] [JobRoleFieldGraphFilter]
order = "__EMPTY__" JobRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [JobRoleFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lineManager : Contact

The related Contact of the Line Manager for the Membership Job Role

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
membership : Membership!

The Membership related to the Membership Job Role describing the Contact and Account Relation

Argument Type Description
filters = [] [MembershipFieldGraphFilter]
order = "__EMPTY__" MembershipFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MembershipFieldGraphOrder]
startDate : TimeZonedDateTime!

The start date for the Membership Job Role

updatedAt : TimeZonedDateTime!

Date and Time the Membership Job Role was updated

Back to top

MembershipJobRoleAssignInput

An Input for assigning a Job Role to a Membership

membershipId : ID!

The ID of the Membership

jobRoleId : ID!

The ID of the Job Role

startDate : TimeZonedDateTime!

The start date of the Role

endDate : TimeZonedDateTime

The end date of the Role

isPrimary : Boolean

Whether or not the Job Role is primary

lineManager : ID

Line manager for the Job Role

Back to top

MembershipJobRoleConnection

A connection containing page information and edges for MembershipJobRole

edges : [MembershipJobRoleEdge!]!

The list of MembershipJobRole edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

MembershipJobRoleEdge

Contains cursor and node information for type MembershipJobRole

cursor : String!

A string that can be used for cursor-based pagination

node : MembershipJobRole!

The MembershipJobRole node.

Back to top

MembershipJobRoleField

An enumeration.

id
jobRoleId
membershipId
startDate
endDate
isPrimary
lineManagerId
createdAt
updatedAt
isActive
Back to top

MembershipJobRoleFieldGraphFilter

Filter that can be applied to limit which MembershipJobRole nodes are returned

field : MembershipJobRoleField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

MembershipJobRoleFieldGraphOrder

Specifies the order in which MembershipJobRole nodes are returned via the Connection

field : MembershipJobRoleField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

MembershipJobRoleMakePrimaryInput

An Input for making a Job Role primary

membershipJobRoleId : ID!

The ID of the membershipJobRole to be primary

Back to top

MembershipJobRoleRemoveInput

An Input for removing a Job Role from a Membership

membershipJobRoleId : ID!

The ID of the membershipJobRole to be deleted

Back to top

MembershipJobRoleUpdateInput

An Input for updating a Job Role on a Membership

membershipJobRoleId : ID!

The ID of the Membership Job Role

jobRoleId : ID

The ID of the new Job Role

startDate : TimeZonedDateTime

The new start date of the Role

endDate : TimeZonedDateTime

The new end date of the Role

lineManager : ID

New line manager for the Job Role

Back to top

MembershipMutateResponse

A response from Contact Account Membership Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

membership : Membership

A Contact Account Membership that has been mutated

Back to top

MembershipMutations

Mutations for Membership

activate : MembershipMutateResponse!

Activates Membership by setting Job Role active

Argument Type Description
input MembershipActivateInput!

The input type with the values used to make Membership active
add : MembershipMutateResponse!

Adds a Contact Account Membership with a Job Role.

Argument Type Description
input MembershipAddInput!

The input type with the values to create a Contact Account Membership with a Job Role
addJobRole : MembershipMutateResponse!

Adds Job Role to a Contact Account Membership

Argument Type Description
input MembershipJobRoleAssignInput!

The input type with the values used to add a Job Role to a Contact Account Membership
deactivate : MembershipMutateResponse!

Deactivates Membership by setting end date on Job Roles

Argument Type Description
input MembershipDeactivateInput!

The input type with the values used to make Membership inactive
delete : MembershipMutateResponse!

Deletes an existing Contact Account Membership

Argument Type Description
input MembershipDeleteInput!

The input type with the values used to delete a Contact Account Membership
makeJobRolePrimary : MembershipMutateResponse!

Makes Job Role primary

Argument Type Description
input MembershipJobRoleMakePrimaryInput!

The input type with the values used to make Job Role primary
removeJobRole : MembershipMutateResponse!

Removes a Job Role from a Contact Account Membership

Argument Type Description
input MembershipJobRoleRemoveInput!

The input type with the values used to remove Job Role
updateJobRole : MembershipMutateResponse!

Updates a Job Role on a Contact Account Membership

Argument Type Description
input MembershipJobRoleUpdateInput!

The input type with the values used to update Job Role
Deprecated fields (1)
create : MembershipMutateResponse!

Creates a Contact Account Membership

Removal date: TBD.

Replaced by add

Argument Type Description
input MembershipCreateInput!

The input type with the values used to create a Contact Account Membership
Back to top

MessageAddToMarketingListInput

Input for adding a message contact to a Marketing List.

marketingListId : String!
Back to top

MessageAssignInput

Input for assigning a message to a user.

userId : String!
Back to top

MessageAssociateContactInput

Input for associating a message with a contact.

contactId : String!
Back to top

MessageAssociateOpportunityInput

Input for associating a message with an opportunity.

opportunityId : String!
Back to top

MessageHistoryEntry

UI-safe history row for a message.

detail : String!

User-facing history detail.

id : ID!

ID of the history row.

linkText : String

Text for the related record link, when relevant.

linkUrl : String

URL for the related record link, when the current app has one.

timestamp : LocalDateTime!

When the history row was recorded.

user : User

User who performed the action.

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

MessageMarkProcessedInput

Input for marking a message as processed.

Back to top

MessageReplyInput

Input for replying to a message by email.

subject : String!
body : String!
sendingAddressId : String
ccList : [String!]
bccList : [String!]
attachmentDocumentId : String
Back to top

MessageTaskCreateInput

Input for creating a Task from a message.

taskTypeId : ID!
userId : ID!
name : String!
timeZoneName : String!
description : String
status : TaskStatus
Back to top

MislocatedResourceIssue

A Session has a Resource booked whose Location differs from the Session's location

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

resourceId : ID!

The ID of the mislocated Resource

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

MissingInstructorIssue

A Session has no instructors assigned

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

MissingResourceType

Simplified ResourceType object with the id and name of the resource type that is missing on a session

id : ID!

The id of the resource type that is missing

name : String!

The name of the resource type that is missing

numMissing : Int!

The number of resources of this type that are missing

Back to top

MissingResourceTypeIssue

A Session is missing one or more Resources of a given Resource Type

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

numMissing : Int!

How many Resources of this type are missing on the Session

resourceTypeId : ID!

The ID of the missing Resource Type

resourceTypeName : String!

The name of the missing Resource Type

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

MissingStaffRoleIssue

A Session is missing one or more Personnel with a required Staff Role

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

numBooked : Int!

The number of Personnel with the role currently booked on the Session

numMissing : Int!

How many additional Personnel with the role the Session still needs

numRequired : Int!

The number of Personnel with the role required on the Session

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

staffRoleId : ID!

The ID of the Staff Role that is under-fulfilled

staffRoleName : String!

The name of the Staff Role that is under-fulfilled

Back to top

Month

Enumerates the 12 months of the year

JAN
FEB
MAR
APR
MAY
JUN
JUL
AUG
SEP
OCT
NOV
DEC
Back to top

MonthYear

Defines a given year and month for time ranges. Ex: "Jan 2024", "Mar 2016"

month : Month!

The month specified using the Month enum

year : Int!

The year

Back to top

MonthYearInput

Specifies a Month and a Year. When used in a range, the start is from the first moment of the first month and the end is from the first moment of the next month. For example the range [Jan 2023, Jan 2023] would have a range from: "2023-01-01" to "2023-02-01"

month : Month!
year : Int!
Back to top

MutationResponse

An interface modelling the response expected from a mutation

Related types: AccountPricingAgreementResponse AccountProjectMutateResponse AccountMutateResponse AccountPricingAgreementPriceResponse AccountAssociationTypeMutateResponse AchievementMutateResponse AchievementNumberSequenceMutateResponse AchievementTypeMutateResponse AddressMutateResponse AdhocSmsMutationsResponse CreateClientCredentialResponse RevokeClientCredentialResponse AutomatorAutomationCreateResponse AutomatorConnectionCreateResponse AutomatorUserCreateResponse AutomatorUserDeleteResponse AutomatorSsoPayloadResponse AutomatorRegisterResponse AutomatorAutomationUpdateResponse AutomatorConnectionUpdateResponse AutomatorUserUpdateResponse BrandMutationResponse BulkAdhocEmailMutationsResponse CalendarIntegrationAddRoomCalendarResponse CalendarIntegrationMapResourceCalendarsResponse RemoveCalendarsResponse CalendarIntegrationRemoveRoomCalendarResponse CalendarIntegrationSendSetupEmailResponse SyncCalendarsResponse CalendarIntegrationSettingsResponse CancellationReasonMutationResponse CancellationRequestMutationResponse CertificateTypeMutateResponse CommunicationMutationResponse CommunicationTemplateMutateResponse CompanyMutationResponse MembershipMutateResponse ContactMutateResponse ExternalCalendarEventMutationResponse ExternalCalendarEventRemoveResponse ContactAdhocEmailMutationsResponse ContactCredentialsMutationResponse ContactCredentialsBulkMutateResponse ContactCredentialsGeneratedPassResetCodeMutationResponse ContactCredentialsGeneratedPasswordMutationResponse ContactCredentialsRemoveMutationResponse CourseTemplateMutationResponse CourseTemplateBulkResponse CourseTemplateAddLmsResourcesResponse CourseTemplatePriceMutationResponse SessionTemplateResponse CourseTemplateCreateResponse CourseTemplateResponse CourseTemplateSetScheduleResponse CourseTemplateLmsContentResponse CourseTemplateSetImageResponse CourseTemplateUpdateResponse CourseTemplateUpdateLmsResourcesResponse CreditNoteMutationReponse CreditNoteRefundMutationResponse GlobalCustomFieldDefinitionRemoveResponse PointOfSaleFieldRemoveResponse FormTemplateFieldSearchResponse CustomTranslationMutateResponse DataImportCreateResponse DataImportGetColumnsResponse DataImportGenerateUploadUrlResponse DiscountPromotionCodeMutationResponse DiscountMutationResponse DocumentCategoryMutateResponse DocumentTemplateMutationResponse DocumentUploadRequestResponse DocumentUpdateMutationResponse EmailAccountMutationResponse EnquiryMutateResponse EventUpdateResponse EventPriceMutationResponse EventBulkUpdateResponse AssociateUnnamedLearnerWithContactsResponse EventCreateResponse LmsResourceResponse DeleteMutationResponse DeleteLmsResourceResponse RegisterLearnerResponse EventBreakoutSetResponse ExternalConfigurationResponse ExternalLogMutationsResponse ExternalLogBulkMutationResponse ExternalLogOriginMutationsResponse FolderCreateMutationResponse FolderDeleteMutationResponse FolderUpdateMutationResponse FormSubmissionMutateResponse GiftVoucherMutationCommonResponse GiftVoucherConfigurationMutationResponse GiftVoucherBatchCreateMutationResponse IdentityProviderMutationResponse InstructorAbsenceReasonMutateResponse InstructorCourseRateBulkCreateResponse InstructorCourseRateMutateResponse IntegrationRetryCreateResponse IntegrationAttemptRetryResponse InvoicePaymentMutationResponse InvoiceAllocationMutateResponse InvoiceCreateMutationResponse InvoiceFinaliseMutateResponse RemoveCreditNoteAllocationResponse JobRoleMutateResponse LearnerMutateResponse ConvertedRegistrationsResponse KryterionAccountResponse LearnerBulkMutateResponse LearnerRaiseCreditNoteResponse LmsAttemptMutateResponse TransferLearnerResponse LearningCategoryMutateResponse LearningObjectiveMutationResponse LearningOutcomeMutateResponse LearningPathMutateResponse AssociateUnnamedWithContactsResponse LearningPathLearnerResponse LearningPathCancellationsResponse LearningPathBulkMutateResponse FulfilOutcomeResponse FulfilObjectiveForLearnersResponse LearningPathRegistrationResponse LearningPathSetObjectiveCompletionForLearnersResponse LearningPathSetOutcomeIsCompletedResponse LearningPathSetStepsMutationResponse LearningTagTypeMutateResponse LearningTagTypeDeleteResponse LearningTagTypeUpdateResponse LmsIntegrationSettingsResponse LmsIntegrationFieldMappingResponse LocaleMutateResponse LocationMutateResponse OpportunityMutateResponse OpportunityUpdateFinancialUnitResponse OpportunityAttributeMutateResponse OpportunityStepMutateResponse OpportunityTransitionMutationResponse PlanMutateResponse SessionNeedMutateResponse PortalMutationResponse OrderPointOfSaleFieldMutateResponse PriceLevelMutationResponse PromotionCampaignMutateResponse PurchaseCreditNoteAllocationMutationResponse PurchasePaymentMutationResponse RegionMutationResponse RegistrationActionResponse RegistrationCreateForAccountResponse RegistrationDeleteResponse RegistrationUpdateResponse RegistrationRuleMutationResponse ResourceBookingBulkMutateResponse ResourceBookingMutateResponse ResourceBookingBulkDeleteResponse ResourceBookingReasonMutateResponse ResourceTypeMutateResponse SendingEmailAddressResponse SessionMutationResponse BulkSessionMutationResponse SessionDuplicateResponse StaffRoleMutationResponse StaffUnavailabilityMutateResponse StockItemUpdateResponse SummaryIntegrationTokenResponse SummaryIntegrationResponse SystemSettingsUpdateResponse TaskTemplateMutateResponse TaskWorkflowGroupMutateResponse TaskWorkflowMutateResponse TaskMutateResponse TaxTypeMutationReponse DigitalTaxMutationResponse TrainingPassTypeMutateResponse TrainingPassMutateResponse TrainingPassTypeOptionMutateResponse TrainingPassTypeOptionPriceMutateResponse TokenBalanceAdjustmentResponse TokenIssueMutationResponse TokenTransactionResponse TriggerMutationResponse TriggerCommunicationInputMutationsResponse UserMutateResponse WebhookCreateResponse WebhookUpdateResponse WebhookManualTriggerResponse WelcomeMessageMutateResponse WorkingPatternMutationResponse WorkplaceMutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

NewLearnerDetail

Details of new Learners associated with an Interest

Related types: LearnerDetail

attributes : [CustomFieldValue!]!

The attributes of the Existing Learner

Argument Type Description
filter CustomFieldFilterInput
communicationsCcAddresses : [String!]!

Additional email addresses that will be included as CC in all Learner communications

communicationsContact : Contact

The Contact to whom all communications regarding this Learner will be sent to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
email : String!

The email of the Learner

firstName : String!

The first name of the Learner

id : ID!

ID of the Content

lastName : String!

The last name of the Learner

Back to top

NewLearnerOpportunityInterest

A list of input types containing the details of the contact to be created and linked to the new learner

firstName : String!

The first name of the Contact being created

lastName : String!

The last name of the Contact being created

email : String!

The email of the Contact being created

notes : String

Notes regarding the new Learner

communicationsContactId : String

The ID of a Contact to whom all communications regarding this Learner will be sent to

communicationsCcAddresses : [String]

Additional email addresses that will be included as CC in all Learner communications

Back to top

Node

Node

Related types: AccountAssociationType Account Contact Achievement AchievementCertificateDocument CertificateType Brand Document DocumentCategory Company CompanyBankDetail TaxType FinancialAccount Locale CommunicationTemplate CertificateTemplate CourseTemplate TrainingPassType TrainingPassTypeOption TrainingPassTypeOptionPrice Region AccountAssociation CourseTemplateAchievementType AchievementType AchievementNumberSequence CourseItem Location Address StockItem LearningCategory StockItemPrice EventTemplate Event EventAchievementType EventCost PriceLevel Email Invoice Discount CreditNote GiftVoucher GiftVoucherConfiguration GiftVoucherConfigurationLinkedItem GiftVoucherPortalConfiguration PortalCustomFieldFilter PortalEmailTemplateMapping IdentityProvider SendingEmailAddress EventTag TrainingTokenTransaction TrainingTokenIssue Opportunity GiftVoucherOpportunityApplication Interest PricingAgreementPrice LearningPath WebLinkPortal LMSPortal OpportunityStep OpportunityStage DocumentTemplate MarketingSourceType TrainingTokenType LearningPathLearner RegistrationRule JobRole Workplace Registration AccountProject LearningPathStep LearningTag LearningPathPrice Trigger StaffRole SendingPhoneNumber PricingAgreement User CalendarEntry TaskType Task UserRole DiscountPromotionCode TrainingTokenAccount TrainingTokenReceiptLine TrainingTokenReceipt Refund Learner Session EventBreakoutGroup EventBreakout ResourceBooking ResourceBookingReason Resource CalendarIntegration ResourceType Staff LearnerAssessment GradeTemplate LmsContent ContentComment CourseOutcome Payment Survey WebConferencingIntegration Webhook WebhookLog WebhookType CourseLevel CourseTemplateLmsContent PricingBand SessionTemplate CourseBreakoutGroup CourseBreakout CustomTemplate StaffException TaskWorkflow TaskTemplate Folder ContactCredentials BrandIdentityProviderConfiguration WelcomeMessage CertificateGenerationLog ExternalCalendarEvent MembershipJobRole Membership MarketingActivity MarketingCampaign TrainingPass TrainingPassAssignment Industry WorkingPattern AutomatorAutomation AutomatorConnection AutomatorUser AutomatorWebhookMapping CancellationReason CancellationRequest GenericCustomField CustomTranslation DataImport DigitalTax Enquiry EventAuditLogEntry EventLifecycleChange ExternalConfiguration ExternalIdEntity FormSubmission PurchaseCreditNote PurchaseInvoice PurchaseOrder Report InstructorAbsenceReason InstructorCourseRate IntegrationRetry LeadDeadReason LearningPathEventSelectionOption CourseObjective LmsConnection MarketingList OpportunityAttribute OpportunitySection OpportunityTransition OrderPointOfSaleField PaymentRegion Plan EventNeed LearningPathNeed PortalLoginHistory PromotionCampaign StaffUnavailability Summary SystemSetting TaskAuditLogEntry TaskWorkflowGroup EmailGroup PurchasePayment CustomBusinessRuleExecutionLog AchievementDMSDocument AchievementDocumentURL SalesOrder SalesPayment DocumentObjective EventObjective ExternalObjective LearningPathObjective URLObjective ExternalOutcome URLOutcome DocumentOutcome LearningPathOutcome ScormAttempt ScormAttemptInteraction ExternalActivityAttempt DiscussionTopicCommentAttempt VideoResourceAttempt ResourceAttempt OpportunityEmailLog

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

A unique identifier for a specific Node in the format base64(NodeType:NumericID) (e.g. base64(Contact:1))

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

NodeConnection

A connection containing page information and edges for Node

edges : [NodeEdge!]!

The list of Node edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

NodeEdge

Contains cursor and node information for type Node

cursor : String!

A string that can be used for cursor-based pagination

node : Node!

The Node node.

Back to top

NoticeEventIssue

Something worth telling the reader about this Event that is not a problem with it, surfaced by a Custom Business Rule. Never counted — isNotice is true

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

message : String!

What the rule wants the reader to know

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

NoticePersonnelIssue

Something worth telling the reader about this personnel member that is not a problem with assigning them, surfaced by a Custom Business Rule. Never counted — isNotice is true

Related types: PersonnelIssue

category : PersonnelIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the assignment. Count the entries where this is false: that is what PersonnelIssueGroup.issueCount reports and what every badge in Administrate shows.

message : String!

What the rule wants the reader to know

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [PersonnelIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

NoticeResourceIssue

Something worth telling the reader about this Resource that is not a problem with booking it, surfaced by a Custom Business Rule. Never counted — isNotice is true

Related types: ResourceIssue

category : ResourceIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the booking. Count the entries where this is false: that is what ResourceIssueGroup.issueCount reports and what every badge in Administrate shows.

message : String!

What the rule wants the reader to know

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [ResourceIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

OpportunitiesMergeInput

An Input to merge Opportunity Interests together

sourceOpportunityId : ID!

The Opportunity ID to copy the Interests from and delete

targetOpportunityId : ID!

The Opportunity ID to move the Interests to

Back to top

Opportunity

A qualified sales lead

Related types: Node

account : Account

The Company associated with this Opportunity

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
activeInvoiceId : ID

Invoice ID for this order. This field is more efficient to use than "salesDocument" if you just need the Invoice ID.

attributes : [CustomFieldValue!]!

The attributes of the Opportunity

Argument Type Description
filter CustomFieldFilterInput
ownPortalOnly = false Boolean
brand : Brand

The Brand associated with the Opportunity

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
closedAt : TimeZonedDateTime

The date and time this Opportunity has been closed

closingDate : Date

The projected date this Opportunity will close

company : Company

The Company associated with this Opportunity

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
contact : Contact

The Contact associated with this Opportunity

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime

The date and time this Opportunity has been saved for the first time

customerReference : String

The customer reference of the Opportunity

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
financialUnit : FinancialUnit

The Currency of the Opportunity

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
giftVoucherApplications : [GiftVoucherOpportunityApplication!]!

Gift Vouchers that have been applied to the Opportunity

id : ID!

The ID of the Opportunity

interests : InterestConnection!

The Interests that belong to the Opportunity

Argument Type Description
filters = [] [InterestFieldGraphFilter]
order = "__EMPTY__" InterestFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InterestFieldGraphOrder]
isReservationValid : Boolean!

Whether any Event reservations part of this Opportunity's interests are still valid

learningCategories : [LearningCategory!]!

The Learning Categories of the Interests in the Opportunity

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

logs : OpportunityLogConnection

The Logs which are associated with the Opportunity

Argument Type Description
filters = [] [OpportunityLogFieldGraphFilter]
order = "__EMPTY__" OpportunityLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityLogFieldGraphOrder]
marketingSourceType : MarketingSourceType

The method by which the prospect was referred

Argument Type Description
filters = [] [MarketingSourceTypeFieldGraphFilter]
order = "__EMPTY__" MarketingSourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MarketingSourceTypeFieldGraphOrder]
name : String

The name of the Opportunity

owner : User

The User assigned as the owner of this Opportunity

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
paymentCodeApplications : [OpportunityPaymentCodeApplication!]!

Payment Codes that have been applied to the Opportunity

portal : Portal

The portal this Opportunity was created from

promotionalCodes : [DiscountPromotionCode!]!

Promotional Codes that have been applied to the Opportunity

Argument Type Description
filters = [] [DiscountPromotionCodeFieldGraphFilter]
order = "__EMPTY__" DiscountPromotionCodeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DiscountPromotionCodeFieldGraphOrder]
purchaseRequiresReview : Boolean!

Dictates if a Cart that contains Items requiring review will be submitted for review before checkout in a Weblink Portal. Requires the orderReviewStep and orderRetrievalStep to be defined in the Weblink Portal's Opportunity Steps.

region : Region

The Region in which the Opportunity is located in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
registration : Registration

The Registration associated with the Opportunity

Argument Type Description
filters = [] [RegistrationFieldGraphFilter]
order = "__EMPTY__" RegistrationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationFieldGraphOrder]
reservationsValidUntil : TimeZonedDateTime

The date and time at which any Event reservations part of this Opportunity's interests will expire

resources : DocumentConnection!

The Resources which are associated with the Opportunity

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
salesDocument : SalesDocument

The Financial Document representing the order the customer is placing

secureIdentifier : String

An obfuscated identifier to locate opportunities by

step : OpportunityStep!

The Opportunity Step describing the progress of this Opportunity in the sales pipeline

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
tokenIssues : [TrainingTokenIssue!]!

The Training Token Issues created by this Opportunity

updatedAt : TimeZonedDateTime

The date and time this Opportunity was last updated

value : OpportunityValue

The total value of this Opportunity

Argument Type Description
excludeExpiredInterests = false Boolean

whether to exclude interests that have expired from the total calculations
Back to top

OpportunityAdHocEmailInput

An Input for updating Communications

opportunityId : ID!
documentTemplateId : ID!
sendingEmailAddressId : ID!
subject : String!
emailOverride : String
carbonCopy : [String]
includeInvoice : Boolean
Back to top

OpportunityApplyPaymentCodeInput

An Input for applying a Payment Code to an Opportunity

opportunityId : ID!

The ID of the Opportunity to apply the Payment Code to

paymentCode : String!

The Payment Code to apply to the Opportunity

Back to top

OpportunityAttribute

Opportunity Attributes that can be added to opportunity transitions

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Opportunity Attribute

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

mapping : OpportunityAttributeMapping

The mapping of the Opportunity Attribute

name : String!

Name of the Opportunity Attribute

options : [Option!]

Options of the Opportunity Attribute

section : OpportunitySection!

The Section of which this Opportunity Attribute belongs to

Argument Type Description
filters = [] [OpportunitySectionFieldGraphFilter]
order = "__EMPTY__" OpportunitySectionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunitySectionFieldGraphOrder]
type : OpportunityAttributeTypeNodeEnum!

The type of the Opportunity Attribute

Back to top

OpportunityAttributeConnection

A connection containing page information and edges for OpportunityAttribute

edges : [OpportunityAttributeEdge!]!

The list of OpportunityAttribute edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

OpportunityAttributeCreateInput

An Input for creating an Opportunity Attribute

name : String!

The name given to the Opportunity Attribute

sectionId : ID!

The ID of the Opportunity Section to which the Opportunity Attribute belongs to

type : OpportunityAttributeTypes

The type of the Opportunity Attribute (default is String)

options : [String]

The options for the Opportunity Attribute (only valid with types Choice and Multichoice)

Back to top

OpportunityAttributeEdge

Contains cursor and node information for type OpportunityAttribute

cursor : String!

A string that can be used for cursor-based pagination

node : OpportunityAttribute!

The OpportunityAttribute node.

Back to top

OpportunityAttributeField

An enumeration.

name
id
Back to top

OpportunityAttributeFieldGraphFilter

Filter that can be applied to limit which OpportunityAttribute nodes are returned

field : OpportunityAttributeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

OpportunityAttributeFieldGraphOrder

Specifies the order in which OpportunityAttribute nodes are returned via the Connection

field : OpportunityAttributeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

OpportunityAttributeMappedEntity

An enumeration.

account
contact
invoice
Back to top

OpportunityAttributeMapping

entity : OpportunityAttributeMappedEntity

The Mapped Entity of this Opportunity Attribute

Back to top

OpportunityAttributeMutateResponse

A Response from mutating an Opportunity Attribute

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

opportunityAttribute : OpportunityAttribute

The Opportunity Attribute that was mutated

Back to top

OpportunityAttributeMutations

Mutations for Opportunity Attributes

create : OpportunityAttributeMutateResponse!

Create a new Opportunity Attribute

Argument Type Description
input OpportunityAttributeCreateInput!

The input type with the values to be set on the new Opportunity Attribute
update : OpportunityAttributeMutateResponse!

Update an existing Opportunity Attribute

Argument Type Description
input OpportunityAttributeUpdateInput!

The input type with the values to be set on the Opportunity Attribute
Back to top

OpportunityAttributeTypeNodeEnum

The type of the attribute

string
text
email
integer
number
url
country
province
language
location
locations
contact
contacts
date
datetime
time
checkbox
choice
multichoice
document
html
Back to top

OpportunityAttributeTypes

The opportunity attribute type

Boolean
Choice
Date
Datetime
Emai
Website
Multichoice
Number
String
Text
Time
Back to top

OpportunityAttributeUpdateInput

An Input for updating an Opportunity Attribute

opportunityAttributeId : ID!

The ID of the Opportunity Attribute to update

name : String

The name to update the Opportunity Attribute with

options : [String]

The options to update for the Opportunity Attribute (only valid with types Choice and Multichoice)

Back to top

OpportunityBookingsCount

Statistics for number of bookings within a time period

automatedBookings : Int!

The number of Automated Bookings.

manualBookings : Int!

The number of Manual Bookings

redeemedPromotionalCodes : Int!

The number of Redeemed Promotional Codes.

Back to top

OpportunityConnection

A connection containing page information and edges for Opportunity

edges : [OpportunityEdge!]!

The list of Opportunity edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

OpportunityCreateInput

An Input for creating an Opportunity

name : String!

The name given to the Opportunity

regionId : ID!

The ID of the Region in which the Opportunity is based

financialUnitId : ID

The Code of the Currency or Training Token Type ID that the Opportunity will be priced in

attributes : [CustomFieldValueInput]

The list of CustomFieldValues of the Opportunity

accountId : ID

An existing Account associated with this Opportunity

contactId : ID

An existing Contact associated with this Opportunity

interestDetails : [InterestDetailsAddInput]

The list of Interests to be added when this Opportunity is created

entryStepId : ID

The id of the Entry Step this Opportunity should start in when created

customerReference : String

The Customer Reference of the Opportunity

brandId : ID

An existing Brand associated with this Opportunity

portalId : ID

The Portal this Opportunity is created from

marketingSourceTypeId : ID

The method by which the prospect was referred

ownerId : ID

The ID of a User who owns this Opportunity

Back to top

OpportunityDeleteInput

An Input for Deleting an Opportunity

opportunityId : ID!

The ID of the Opportunity that will be deleted

Back to top

OpportunityEdge

Contains cursor and node information for type Opportunity

cursor : String!

A string that can be used for cursor-based pagination

node : Opportunity!

The Opportunity node.

Back to top

OpportunityEmailLog

The step in the sales pipeline an Opportunity is currently in

Related types: Node OpportunityLog

email : Email!

The Email associated with the Opportunity Email Log

Argument Type Description
filters = [] [EmailFieldGraphFilter]
order = "__EMPTY__" EmailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EmailFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Opportunity Email Log

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

timestamp : TimeZonedDateTime!

UTC Timestamp for when the Opportunity Email Log was created.

type : OpportunityLogType!

The Log type of the Opportunity Email Log.

user : User

The User associated with the Opportunity Email Log

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

OpportunityField

Fields for filtering and ordering Opportunities

id
name
createdAt
updatedAt
value
companyId
companyName
ownerId
ownerName
regionCode
regionName
accountName
winProbability
daysToWin
state
stageName
stageOrder
stepId
stepName
learningCategoryName
learningCategoryNameList
accountId
contactId
brandId
isValidForPortalApprovalFlow
isAwaitingApprovalInPortalApprovalFlow
isTrainingRequest
hasEventInterestForCourse
secureIdentifier
portalId
marketingSourceTypeId
Back to top

OpportunityFieldGraphFilter

Filter that can be applied to limit which Opportunity nodes are returned

field : OpportunityField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

OpportunityFieldGraphOrder

Specifies the order in which Opportunity nodes are returned via the Connection

field : OpportunityField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

OpportunityForecast

Forecasts for an opportunity step

daysToWin : Decimal

Days in which an opportunity in this step is expected to be won

winProbability : Decimal

Probability the opportunity at this step will be won

Back to top

OpportunityLog

An interface to define Opportunity Logs

Related types: OpportunityEmailLog

id : ID!

ID of the Opportunity Log

timestamp : TimeZonedDateTime!

UTC Timestamp for when the Opportunity Log was created.

type : OpportunityLogType!

The Log type of the Opportunity Log.

user : User

The User associated with the Opportunity Log

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

OpportunityLogConnection

A connection containing page information and edges for OpportunityLog

edges : [OpportunityLogEdge!]!

The list of OpportunityLog edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

OpportunityLogEdge

Contains cursor and node information for type OpportunityLog

cursor : String!

A string that can be used for cursor-based pagination

node : OpportunityLog!

The OpportunityLog node.

Back to top

OpportunityLogFieldGraphFilter

Filter that can be applied to limit which OpportunityLog nodes are returned

field : OpportunityLogTypeFields!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

OpportunityLogFieldGraphOrder

Specifies the order in which OpportunityLog nodes are returned via the Connection

field : OpportunityLogTypeFields!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

OpportunityLogType

The log type of the opportunity logs.

OutboundEmail
Back to top

OpportunityLogTypeFields

Fields for filtering and ordering Opportunity Logs

id
opportunityId
userId
type
timestamp
Back to top

OpportunityMutateResponse

A Response from mutating an Opportunity

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

interests : [Interest!]

The Interests that were mutated

opportunity : Opportunity

The Opportunity that was mutated

Back to top

OpportunityMutations

Mutations for Opportunities

addChildInterest : OpportunityMutateResponse!

Adds a child of a Gift Voucher Interest to an Opportunity

Argument Type Description
input InterestAddInput!

Adds a child of a Gift Voucher Interest to an Opportunity
addInterest : OpportunityMutateResponse!

Adds an Interest to an Opportunity

Argument Type Description
input InterestAddInput!

Adds an Interest to an Opportunity
applyGiftVoucher : OpportunityMutateResponse!

Apply a Gift Voucher to an Opportunity

Argument Type Description
input GiftVoucherApplyInput!

The Input that specifies the Gift Voucher and Amount to apply to the Opportunity
applyPaymentCode : OpportunityMutateResponse!

Apply a Payment Code to an Opportunity

Argument Type Description
input OpportunityApplyPaymentCodeInput!

The Input that specifies the Payment Code and the Opportunity to apply it to
applyPromotionCode : OpportunityMutateResponse!

Apply a promotion code on a Opportunity

Argument Type Description
input PromotionCodeApplyInput!

The Input to apply a promotion code to an Opportunity
create : OpportunityMutateResponse!

Create a new Opportunity owned by you

Argument Type Description
input OpportunityCreateInput!

The input type with the values to be set on the new Opportunity
createTrainingRequest : OpportunityMutateResponse!

Create a new Training Request Opportunity owned by you

Argument Type Description
input TrainingRequestCreateInput!

The input type with the values to be set on the new Opportunity
delete : OpportunityMutateResponse!

Deletes an Opportunity and any Opportunity Interests associated with that Opportunity.

Argument Type Description
input OpportunityDeleteInput!

The input type with the values used to delete the Opportunity
extendReservations : OpportunityMutateResponse!

Updates the date and time at which an Opportunity's Event interest reservations will expire. If an Event interest reservation cannot be renewed (for example, because the Event does not have enough spaces available), then its reservation will be voided and its reserved flag will be set to false

Argument Type Description
input OpportunityReservationsValidUntilInput!

the Input specifying the opportunity ID and the new reservation validity
linkDocument : OpportunityMutateResponse!

Links a Document to an Opportunity

Argument Type Description
input LinkDocumentOpportunityInput!

The input type with the values used to link a Document to the Opportunity
lockGiftVouchers : OpportunityMutateResponse!

Lock the Gift Vouchers applied to an Opportunity. This will prevent them being redeemed by another sale until they are unlocked or redeemed on this opportunity.

Argument Type Description
input GiftVoucherLockInput!

The Input that specifies the opportunity
mergeOpportunities : OpportunityMutateResponse!

Move over Interests from source Opportunity to the target and delete the source

Argument Type Description
input OpportunitiesMergeInput!

The Input with the source and target Opportunity ID
progress : OpportunityMutateResponse!

Progress an Opportunity to another Step in the workflow

Argument Type Description
input OpportunityProgressInput!

The input type with the values used to progress an Opportunity
removeExpiredInterests : OpportunityMutateResponse!

Remove all Event or Learning Path Interests that have expired on an Opportunity

Argument Type Description
input ExpiredInterestsRemoveInput!
removeInterest : OpportunityMutateResponse!

Remove an Interest from an Opportunity

Argument Type Description
input InterestRemoveInput!

"The input type with the value used to remove an Interest from the Opportunity"
removeInterests : OpportunityMutateResponse!

Remove a list of Interests from an Opportunity

Argument Type Description
input InterestsRemoveInput!

The input type with the values used to remove a list of Interests from the Opportunity
removePromotionCode : OpportunityMutateResponse!

Clear all Promotion Codes on an Opportunity

Argument Type Description
input PromotionCodeRemoveInput!

The Input to clear Promotion Codes on an Opportunity
repriceOpportunity : OpportunityMutateResponse!

Recalculate the prices on an Opportunity and its associated Interests

Argument Type Description
input RepriceOpportunityInput!

The Input to recalculate the prices on an Opportunity and its associated Interests
reservePlacesForInterests : OpportunityMutateResponse!

Reserves places on objective Events from Opportunity Interests

Argument Type Description
input ReservePlacesForInterestsInput!

The Input to reserve places on Events from Opportunity Interests
unapplyGiftVoucher : OpportunityMutateResponse!

Unapply a Gift Voucher from an Opportunity

Argument Type Description
input GiftVoucherApplyInput!

The Input that specifies the Gift Voucher to unapply from the Opportunity
unlockGiftVouchers : OpportunityMutateResponse!

Unlock the Gift Vouchers applied on an Opportunity. This will allow them be applied to another sale when their value has not been redeemed.

Argument Type Description
input GiftVoucherLockInput!

The Input that specifies the opportunity
update : OpportunityMutateResponse!

Update an Opportunity

Argument Type Description
input OpportunityUpdateInput!

An Input for updating an Opportunity
updateFinancialUnit : OpportunityUpdateFinancialUnitResponse!

Updates an Opportunity to be in a different Financial Unit. A new Opportunity will be created. Any Interests on the existing Opportunity that are not applicable for the new Financial Unit will be removed and returned in the removedInterests field. Only Token Financial Units are currently supported.

Argument Type Description
input UpdateFinancialUnitInput!

The Input that specifies the current Opportunity and the new Financial Unit.
updateInterest : OpportunityMutateResponse!

The input type with the values used to update an Interest on the Opportunity

Argument Type Description
input InterestUpdateInput!

The input type with the values used to update an Interest on the Opportunity
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
upsertByExternalId : OpportunityMutateResponse!

Updates an Opportunity identified by an External ID, or creates an Opportunity with the External ID assigned

Argument Type Description
input OpportunityUpsertByExternalIdInput!

The input type with the values to be set on the existing or new Opportunity
Deprecated fields (1)
reservePlacesForEventInterest : OpportunityMutateResponse!

Reserves places on an Event from an Opportunity Event Interest

Removal date: TBD.

Replaced by reservePlacesForInterest which also handles Path Interests

Argument Type Description
input ReservePlacesForEventInterestInput!

The Input to reserve places on an Event from an Opportunity Event Interest
Back to top

OpportunityPaymentCodeApplication

The Application of a Payment Code to an Opportunity

paymentCode : String!

The Payment Code applied to the Opportunity

tokenIssueBalance : Int!

The balance of the Token Issue the applied Payment Code is for

Back to top

OpportunityProgressInput

An Input for progressing an Opportunity

opportunityId : ID!

The ID of the Opportunity to progress

stepId : ID!

The Opportunity Step to Progress to

Back to top

OpportunityReservationsValidUntilInput

An Input to specify the date and time at which an Opportunity's Event reservations will expire.

opportunityId : ID!

The ID of the Opportunity on which to set the new reservation validity

reservationsValidUntil : TimeZonedDateTime

The date and time at which the Opportunity's Event interest reservations will expire, or null to unset any previously set expiry

Back to top

OpportunitySection

A Section in the Opportunity

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Opportunity Section

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Opportunity Section

Back to top

OpportunitySectionConnection

A connection containing page information and edges for OpportunitySection

edges : [OpportunitySectionEdge!]!

The list of OpportunitySection edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

OpportunitySectionEdge

Contains cursor and node information for type OpportunitySection

cursor : String!

A string that can be used for cursor-based pagination

node : OpportunitySection!

The OpportunitySection node.

Back to top

OpportunitySectionFieldGraphFilter

Filter that can be applied to limit which OpportunitySection nodes are returned

field : OpportunitySectionFields!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

OpportunitySectionFieldGraphOrder

Specifies the order in which OpportunitySection nodes are returned via the Connection

field : OpportunitySectionFields!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

OpportunitySectionFields

Fields for filtering and ordering Opportunity Sections

id
name
Back to top

OpportunityStage

Provides more detail about the stage in the sales pipeline an Opportunity is in

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Opportunity Stage

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Opportunity Stage

state : OpportunityState!

The state an Opportunity in this Stage is in (can be Open, Lost, Won or Archived)

Back to top

OpportunityStageConnection

A connection containing page information and edges for OpportunityStage

edges : [OpportunityStageEdge!]!

The list of OpportunityStage edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

OpportunityStageEdge

Contains cursor and node information for type OpportunityStage

cursor : String!

A string that can be used for cursor-based pagination

node : OpportunityStage!

The OpportunityStage node.

Back to top

OpportunityStageField

An enumeration.

name
state
Back to top

OpportunityStageFieldGraphFilter

Filter that can be applied to limit which OpportunityStage nodes are returned

field : OpportunityStageField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

OpportunityStageFieldGraphOrder

Specifies the order in which OpportunityStage nodes are returned via the Connection

field : OpportunityStageField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

OpportunityState

An enumeration.

Open
Won
Lost
Archived
Back to top

OpportunityStep

The step in the sales pipeline an Opportunity is currently in

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
forecast : OpportunityForecast!

This OpportunityStep's Forecast, includes a % estimate to win, and an estimated number of days until it is won.

id : ID!

ID of the OpportunityStep

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the OpportunityStep

stage : OpportunityStage!

The OpportunityStage provides information about the step the Opportunity is in

Argument Type Description
filters = [] [OpportunityStageFieldGraphFilter]
order = "__EMPTY__" OpportunityStageFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStageFieldGraphOrder]
Back to top

OpportunityStepConnection

A connection containing page information and edges for OpportunityStep

edges : [OpportunityStepEdge!]!

The list of OpportunityStep edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

OpportunityStepCreateInput

An Input for creating an Opportunity Step

name : String!

The name given to the Opportunity Step

stageId : ID!

The ID of the Opportunity Stage this Step will be in

attributeIds : [ID]

A list of opportunity attribute IDs that will be shown for this Step

Back to top

OpportunityStepEdge

Contains cursor and node information for type OpportunityStep

cursor : String!

A string that can be used for cursor-based pagination

node : OpportunityStep!

The OpportunityStep node.

Back to top

OpportunityStepField

An enumeration.

name
Back to top

OpportunityStepFieldGraphFilter

Filter that can be applied to limit which OpportunityStep nodes are returned

field : OpportunityStepField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

OpportunityStepFieldGraphOrder

Specifies the order in which OpportunityStep nodes are returned via the Connection

field : OpportunityStepField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

OpportunityStepMutateResponse

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

opportunityStep : OpportunityStep

The Opportunity Step that was mutated

Back to top

OpportunityStepMutations

create : OpportunityStepMutateResponse!

Create a new Opportunity Step

Argument Type Description
input OpportunityStepCreateInput!

The input type with the values to be set on the new Opportunity Step
Back to top

OpportunityTaskCreateInput

An Input for creating an Opportunity Task

taskTypeId : ID!

The ID of the Task Type

userId : ID!

The ID of the User to assign the Task to

name : String!

The name of the Task

opportunityId : ID!

The ID of the Opportunity the Task is linked to

dueDate : LocalDateTime!

The due date of the Task

timeZoneName : String!

The timezone of the Task

description : String

The description of the Task

status : TaskStatus

The Status of the Task

showOnCalendar : Boolean

Whether to display this Task on the calendar

endDate : LocalDateTime

The end date of the Task

Back to top

OpportunityTax

totalAmount : Decimal!

The total amount of this Tax on this Opportunity"

type : TaxType!

The Type of Tax on this Opportunity

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
Back to top

OpportunityTransition

A Transition that allows progressing an Opportunity from one Step to another.

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
fromStep : OpportunityStep!

From Step of the OpportunityTransition

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
id : ID!

ID of the OpportunityTransition

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the OpportunityTransition

requiredAttributes : OpportunityAttributeConnection

The list of required attributes for this OpportunityTransition that must be provided before transitioning to the next step of the Opportunity workflow

Argument Type Description
filters = [] [OpportunityAttributeFieldGraphFilter]
order = "__EMPTY__" OpportunityAttributeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityAttributeFieldGraphOrder]
toStep : OpportunityStep!

To Step of the OpportunityTransition

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
triggers : OpportunityTransitionTrigger

Triggers set on the OpportunityTransition

Back to top

OpportunityTransitionConnection

A connection containing page information and edges for OpportunityTransition

edges : [OpportunityTransitionEdge!]!

The list of OpportunityTransition edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

OpportunityTransitionCreateInput

An Input for creating an Opportunity Transition

name : String!

The name given to the Opportunity Transition

fromStepId : ID!

The ID of the Opportunity Step to transition from

toStepId : ID!

The ID of the Opportunity Step to transition to

triggers : OpportunityTransitionTriggerInput

The triggers we want to set for this transition

requiredAttributeIds : [ID]

The Ids of the attributes we want to set for this transition

Back to top

OpportunityTransitionEdge

Contains cursor and node information for type OpportunityTransition

cursor : String!

A string that can be used for cursor-based pagination

node : OpportunityTransition!

The OpportunityTransition node.

Back to top

OpportunityTransitionField

An enumeration.

name
id
Back to top

OpportunityTransitionFieldGraphFilter

Filter that can be applied to limit which OpportunityTransition nodes are returned

field : OpportunityTransitionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

OpportunityTransitionFieldGraphOrder

Specifies the order in which OpportunityTransition nodes are returned via the Connection

field : OpportunityTransitionField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

OpportunityTransitionMutationResponse

A Response for updating Opportunity Transitions

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

opportunityTransition : OpportunityTransition

The Opportunity Transition that was mutated

Back to top

OpportunityTransitionMutations

Mutations for Opportunity Transitions

create : OpportunityTransitionMutationResponse!

Create a new Opportunity Transition

Argument Type Description
input OpportunityTransitionCreateInput!

The input type with the values to be set on the new Document Template
Back to top

OpportunityTransitionTrigger

The trigger on the transition

awardTrainingPass : Boolean!

If this transition triggers awarding a Training Pass

createAccount : Boolean!

If this transition triggers creating an Account

createContact : Boolean!

If this transition triggers creating a Contact

createGiftVoucherAccount : Boolean!

If this transition triggers creating a Gift Voucher Account

createInvoice : Boolean!

If this transition triggers creating an Invoice

createRegistration : Boolean!

If this transition triggers creating a Registration

createTokenIssue : Boolean!

If this transition triggers Issues a Token

redeemGiftVouchers : Boolean!

If this transition triggers redeeming gift vouchers

Back to top

OpportunityTransitionTriggerInput

A specification of which trigger actions have to be executed as part of an opportunity transition

createContact : Boolean
createAccount : Boolean
createTokenIssue : Boolean
createInvoice : Boolean
createRegistration : Boolean
redeemGiftVouchers : Boolean
createGiftVoucherAccount : Boolean
awardTrainingPass : Boolean
Back to top

OpportunityUpdateFinancialUnitResponse

A Response from updating an Opportunity Financial Unit. A new Opportunity will be created. Any Interests on the existing Opportunity that are not applicable for the new Financial Unit will be removed and returned in the removedInterests field.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

opportunity : Opportunity

The Opportunity that was created with the previous Opportunity details

removedInterests : [Interest!]

The Interests that were removed due to not having a price in the Financial Unit

Back to top

OpportunityUpdateInput

An Input for updating an Opportunity

id : ID!

The ID of the Opportunity

name : String

The name given to the Opportunity

regionId : ID

The ID of the Region in which the Opportunity is based

financialUnitId : ID

The Code of the Currency or Training Token Type ID that the Opportunity will be priced in

attributes : [CustomFieldValueInput]

The list of CustomFieldValues of the Opportunity

accountId : ID

An existing Account associated with this Opportunity

contactId : ID

An existing Contact associated with this Opportunity

brandId : ID

An existing Brand associated with this Opportunity

portalId : ID

The Portal this Opportunity is created from

marketingSourceTypeId : ID

The method by which the prospect was referred

customerReference : String

The Customer Reference of the Opportunity

ownerId : ID

The ID of a User who owns this Opportunity

Back to top

OpportunityUpsertByExternalIdInput

An Input for upserting an Opportunity by External ID

externalId : ExternalIdInput!

The External ID used to identify the Opportunity to update. If an Opportunity does not exist, this External ID is set on the created Opportunity

opportunity : OpportunityUpsertInput!

The details with which to update or create the Opportunity

Back to top

OpportunityUpsertInput

An Input for upserting an Opportunity

name : String!

The name given to the Opportunity

regionId : ID!

The ID of the Region in which the Opportunity is based

financialUnitId : ID

The Code of the Currency or Training Token Type ID that the Opportunity will be priced in

attributes : [CustomFieldValueInput]

The list of CustomFieldValues of the Opportunity

accountId : ID

An existing Account associated with this Opportunity

contactId : ID

An existing Contact associated with this Opportunity

interestDetails : [InterestUpsertDetailsInput]

The list of Interests to be upserted on this Opportunity. Give an Interest an externalId to update it in place on future calls; without one, a new Interest is always added

entryStepId : ID

The id of the Entry Step this Opportunity should start in when created

customerReference : String

The Customer Reference of the Opportunity

brandId : ID

An existing Brand associated with this Opportunity

portalId : ID

The Portal this Opportunity is created from

marketingSourceTypeId : ID

The method by which the prospect was referred

ownerId : ID

The ID of a User who owns this Opportunity

Back to top

OpportunityValue

The value of an opportunity

Related types: FinancialAmount

amount : Decimal!

Total value of the opportunity

discountTotal : Decimal!

The total value of the discount applied to the grand total on this Opportunity

financialUnit : FinancialUnit!

Financial Unit in which this value is expressed

giftVoucherTotal : Decimal!

The total value of all Gift Vouchers that have been applied to this Opportunity

grandTotal : Decimal!

The value of this Opportunity inclusive of tax and discount

payableTotal : Decimal!

The total value of this Opportunity to be paid. Calculated as the grand total minus the gift voucher total

subTotal : Decimal!

The value of this Opportunity exclusive of tax and discount

taxTotal : Decimal!

The total amount of tax for the Opportunity

taxes : [OpportunityTax]!

A breakdown of the taxes that make up the grand total on this Opportunity

Back to top

Option

An Option for a Custom Field with choice options

label : String!

The label to display to the user

value : String!

The value to send when storing the Custom Field

Back to top

OrderDirection

The directions used for sorts asc - Ascending desc - Descending

asc
desc
Back to top

OrderPointOfSaleField

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Order Point of Sale field

isRequired : Boolean!

Whether this field is required: true if any transition reachable from the portal entry step requires this field, false otherwise.

label : String!

Display label of the Order Point of Sale field

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

opportunityAttribute : OpportunityAttribute!

The Opportunity Attribute this Order Point of Sale field maps to

Argument Type Description
filters = [] [OpportunityAttributeFieldGraphFilter]
order = "__EMPTY__" OpportunityAttributeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityAttributeFieldGraphOrder]
portal : Portal!

The Portal this Order Point of Sale will be displayed on

Argument Type Description
filters = [] [PortalFieldGraphFilter]
order = "__EMPTY__" PortalFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalFieldGraphOrder]
position : Int

Display order of the Order Point of Sale field

Back to top

OrderPointOfSaleFieldConnection

A connection containing page information and edges for OrderPointOfSaleField

edges : [OrderPointOfSaleFieldEdge!]!

The list of OrderPointOfSaleField edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

OrderPointOfSaleFieldCreateInput

An Input for creating an Order Point of Sale Field

opportunityAttributeId : ID!

The ID of the linked Opportunity Attribute

portalId : ID!

The ID of the linked Portal

label : String

The label given to the Order Point of Sale Field (if not specified, it will match the Opportunity attribute label)

position : Int

The display order of this Order Point of Sale Field

Back to top

OrderPointOfSaleFieldDeleteInput

An Input for deleting an Order Point of Sale Field

orderPointOfSaleFieldIds : [ID]!

A list of IDs of the Order Point of Sale Fields to be deleted

Back to top

OrderPointOfSaleFieldEdge

Contains cursor and node information for type OrderPointOfSaleField

cursor : String!

A string that can be used for cursor-based pagination

node : OrderPointOfSaleField!

The OrderPointOfSaleField node.

Back to top

OrderPointOfSaleFieldFieldGraphFilter

Filter that can be applied to limit which OrderPointOfSaleField nodes are returned

field : OrderPointOfSaleFieldTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

OrderPointOfSaleFieldFieldGraphOrder

Specifies the order in which OrderPointOfSaleField nodes are returned via the Connection

field : OrderPointOfSaleFieldTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

OrderPointOfSaleFieldMutateResponse

The Response to a mutation with the updated Order Point of Sale field.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

orderPointOfSaleField : OrderPointOfSaleField

The Order Point of Sale Field that was mutated

Back to top

OrderPointOfSaleFieldTypeField

An enumeration.

portalId
position
Back to top

OrderPointOfSaleFieldUpdateInput

An Input for updating an Order Point of Sale Field

orderPointOfSaleFieldId : ID!

The ID of the Order Point of Sale Field to be updated

label : String

The label given to the Order Point of Sale Field

position : Int

The position for the Order Point of Sale Field to be displayed

Back to top

PageInfo

Information about the pages (batches) of data returned in a query

endCursor : String!

The cursor of the last record returned

hasNextPage : Boolean!

There are more results on a page ahead

hasPreviousPage : Boolean!

There are more results on a page behind

startCursor : String!

The cursor of the first record returned

totalRecords : Int!

The number of records available for the filters

Back to top

ParentEventReschedulingConflictInput

An Input for fetching potential Event rescheduling conflicts

eventId : ID!

The ID of the parent Event

startDateTime : LocalDateTime!

Potential new start date of the Event or Session

timeZoneName : String!

Potential new time zone name of the Event or Session

endDateTime : LocalDateTime

Potential new end date of the Event or Session

Back to top

PathInterestObjectiveAssignment

event : Event

The Event assigned to this Learning Objective

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
learningPathObjective : LearningObjective

The LearningPath objective

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
Back to top

Payment

A Payment recorded in the financial system

Related types: Node

account : Account!

The Account which made the Payment

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
allocations : [InvoiceAllocation!]!

A list describing how this Payment is allocated to each of the Invoices it covers

amount : PaymentAmount!

Details about the Payment amount

company : Company!

The Company that received the Payment

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
createdAt : TimeZonedDateTime!

The creation date of the Payment

createdByUser : User

The User who created the Payment

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
financialAccount : FinancialAccount!

The Financial Account where the Payment was made

Argument Type Description
filters = [] [FinancialAccountFieldGraphFilter]
order = "__EMPTY__" FinancialAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FinancialAccountFieldGraphOrder]
id : ID!

Unique identifier for this Payment

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

notes : String

A list describing how this Payment is allocated to each of the Invoices it covers

number : String!

Unique number that identifies the Payment

paidOn : Date!

The date when the Payment was made

paymentMethod : PaymentMethod

Details about how the Payment was made

updatedAt : TimeZonedDateTime!

The last updated date of the Payment

updatedByUser : User

The User who updated the Payment

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

PaymentAmount

Details about a Payment's amount and Currency

amount : Decimal!

The total amount of the Payment

financialUnit : Currency!

The Currency the Payment was made in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
Back to top

PaymentConnection

A connection containing page information and edges for Payment

edges : [PaymentEdge!]!

The list of Payment edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PaymentEdge

Contains cursor and node information for type Payment

cursor : String!

A string that can be used for cursor-based pagination

node : Payment!

The Payment node.

Back to top

PaymentFieldGraphFilter

Filter that can be applied to limit which Payment nodes are returned

field : PaymentTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PaymentFieldGraphOrder

Specifies the order in which Payment nodes are returned via the Connection

field : PaymentTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PaymentMethod

Details about how a Payment was made

reference : String

Identifying information about this Payment

type : PaymentMethodType

The method of payment that was used

Back to top

PaymentMethodInput

A method of payment

id : ID!

Unique identifier for this Payment Method

reference : String

Identifying information about this Payment Method

Back to top

PaymentMethodType

A method of payment

id : ID!

Unique identifier for this Payment Method

name : String!

A descriptive name for this Payment Method

Back to top

PaymentRegion

A Payment Region. The linking of a specific Currency to a Region.

Related types: Node

currency : Currency!

The Currency of the Payment Region

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Payment Region

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

region : Region!

The Region of the Payment Region

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

PaymentRegionConnection

A connection containing page information and edges for PaymentRegion

edges : [PaymentRegionEdge!]!

The list of PaymentRegion edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PaymentRegionEdge

Contains cursor and node information for type PaymentRegion

cursor : String!

A string that can be used for cursor-based pagination

node : PaymentRegion!

The PaymentRegion node.

Back to top

PaymentRegionFieldGraphFilter

Filter that can be applied to limit which PaymentRegion nodes are returned

field : PaymentRegionTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PaymentRegionFieldGraphOrder

Specifies the order in which PaymentRegion nodes are returned via the Connection

field : PaymentRegionTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PaymentRegionTypeField

Fields for filtering and ordering Payment Regions

id
Back to top

PaymentTypeField

Fields for filtering and ordering Payments

id
companyId
companyName
invoiceId
number
accountId
paidOn
createdAt
amount
currencyCode
paymentMethodReference
Back to top

PeopleStats

Statistics about people over the time period specified

administratorsOnFutureEvents : Int!

The number of Administrators assigned onto Future Events

instructorsOnFutureEvents : Int!

The number of Instructors assigned onto Future Events

studentsOnFutureEvents : Int!

The number of Students registered onto Future Events

studentsOnPathsFromAutoRegistration : Int!

The number of Students registered onto Paths using Automatic Registration

Back to top

PersonalName

A personal name

firstName : String

The first name of the person

lastName : String

The last name of the person

middleName : String

The middle name of the person

name : String

The full name of the person

title : Honorific

The title of the person

Back to top

PersonalNameCreateInput

An Input for a Personal Name of a newly created entity

firstName : String!

The first name of the person

lastName : String!

The last name of the person

middleName : String

The middle name of the person

honorificId : String

The ID of the Honorific for the person

Back to top

PersonalNameUpdateInput

An Input for updating a Personal Name

honorificId : String

The ID of the new Honorific for the person

firstName : String

The new first name of the person

middleName : String

The new middle name of the person

lastName : String

The new last name of the person

Back to top

PersonalStaffUnavailabilityCreateInput

An Input for creating a Personal Staff Unavailability

start : LocalDateTime!

Start datetime of the absence

end : LocalDateTime!

End datetime of the absence

contactId : ID!

The ID of the Contact that will be absent

workingDays : Decimal!

Number of working days

timeZone : String

The absence timezone

description : String

Description of the absence

absenceReasonId : ID

The ID of the Absence Reason

Back to top

PersonnelConflictIssue

A Contact assigned as personnel on a Session has another booking overlapping its time

Related types: PersonnelIssue

category : PersonnelIssueCategory!

The category this issue belongs to, used for client-side filtering

conflictEnd : TimeZonedDateTime!

When the conflicting booking ends

conflictId : ID!

The ID of the conflicting booking

conflictParentId : ID

If applicable, the parent of the conflicting booking

conflictReason : String

Why the conflicting booking exists, where available

conflictStaffId : ID

If applicable, the ID of the staff member associated with the conflicting booking

conflictStart : TimeZonedDateTime!

When the conflicting booking begins

conflictTitle : String

The title of the conflicting booking, if available

conflictType : String!

The type of the conflicting booking (session/event/absence/external_event)

conflictUnconfirmed : Boolean!

Whether the conflicting booking is tentative (e.g. from a synced external calendar)

contactId : ID!

The Contact ID of the personnel member with the conflict

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the assignment. Count the entries where this is false: that is what PersonnelIssueGroup.issueCount reports and what every badge in Administrate shows.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [PersonnelIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

PersonnelIssue

An issue surfaced when evaluating a Contact's assignment as personnel on an Event. Polymorphic on category — concrete subtypes expose category-specific context.

Related types: PersonnelConflictIssue GenericPersonnelIssue NoticePersonnelIssue

category : PersonnelIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the assignment. Count the entries where this is false: that is what PersonnelIssueGroup.issueCount reports and what every badge in Administrate shows.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [PersonnelIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

PersonnelIssueCategory

Category of a PersonnelIssue surfaced when evaluating personnel assignments on an Event. Members are kept in sync with domain_training.entities.personnel_issue.PersonnelIssueCategory.

conflict
notice
generic
Back to top

PersonnelIssueGroup

A Contact and every personnel issue detected for them on a given Event.

contact : Contact!

The Contact this group of issues applies to

issueCount : Int!

How many issues were detected for this Contact. Notices are not issues and are not counted, though issues still reports them — branch on isNotice to tell the two apart

issues : [PersonnelIssue!]!

Every personnel issue detected for this Contact on the Event, and any notice raised about them — isNotice says which is which

Back to top

PersonnelIssueSource

Provenance metadata for a PersonnelIssue. An issue may carry multiple sources after dedup — for instance, when both Administrate and a Custom Business Rule independently surface the same fact.

annotation : String

Optional one-line note attached by the source

kind : PersonnelIssueSourceKind!

Where the source came from: default (Administrate) or rule (a Custom Business Rule)

ruleId : ID

When kind is rule, the ID of the rule that produced the issue

Back to top

PersonnelIssueSourceKind

Where a PersonnelIssue's data came from. default for issues produced by Administrate's own checks; rule for issues produced by a Custom Business Rule.

default
rule
Back to top

PersonnelRuleCheck

Advisory custom-rule result for one proposed member of Personnel.

personnel : Contact!

The proposed member of Personnel evaluated by the rule.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
reason : String

The reported issue's annotation, or why evaluation was deferred.

ruleId : ID!

The custom business rule which was evaluated or deferred.

status : PersonnelRuleCheckStatus!

Whether the rule reported an issue, or needs a real Event.

Back to top

PersonnelRuleCheckStatus

Outcome of a custom availability rule for proposed Personnel. Only FAILED and DEFERRED are reported: the rules return the issues they find, so Personnel with no reported issue simply have no check. PASSED is retained for backwards compatibility and is never returned.

passed
failed
deferred
Back to top

Plan

A Plan detailing training requirements to be scheduled

Related types: Node

account : Account

The Account for this Plan which, if set, should be considered private.

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
accountProject : AccountProject

The associated Project for this Plan

Argument Type Description
filters = [] [AccountProjectFieldGraphFilter]
order = "__EMPTY__" AccountProjectFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountProjectFieldGraphOrder]
constraintWeightings : [PlanConstraintWeighting!]!

Constraint Weightings

end : LocalDateTime!

End of Plan

eventNeeds : [EventNeed!]!

List of Event Needs detailing which Events must be scheduled as part of the Plan

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of Plan

learningPathNeeds : [LearningPathNeed!]!

List of Learning Path Needs detailing which Learning Paths must be fulfilled as part of the Plan.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

location : Location!

Location of the Plan

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
name : String!

Name of Plan

resourceRequirementsSummary : PlanResourceRequirementSummary!

Returns a summary of the current status of Resource Requirements on the Plan

resources : PlanResourceConnection!

The list of Resources that should be considered when Scheduling Courses within the Plan.

Argument Type Description
filters = [] [PlanResourceFieldGraphFilter]
order = "__EMPTY__" PlanResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PlanResourceFieldGraphOrder]
scheduleBounds : PlanScheduleBounds!

Specifies the days of the week, and the times within those days, when Events are allowed to be scheduled.

staff : PlanStaffConnection!

The list of Staff that should be considered when Scheduling Courses within the Plan.

Argument Type Description
filters = [] [PlanStaffFieldGraphFilter]
order = "__EMPTY__" PlanStaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PlanStaffFieldGraphOrder]
start : LocalDateTime!

Start of Plan

status : PlanStatus!

Contains status information of the current Plan

type : PlanType!

Type of the Plan (public/private)

Back to top

PlanAddEventNeedsInput

The Input for adding new Event Needs to an existing Plan

planId : ID!

The ID of the Plan to add the Event Needs

eventNeeds : [PlanEventNeedsInput]!

The list of Event Needs that will be added to the Plan

Back to top

PlanAddInstructorsInput

The Input for adding Instructors to an existing Plan

planId : ID!

The ID of the existing Plan to add new Instructor

contactIds : [ID]!

The list of instructor Contacts that will be added to the Plan

staffRoleId : ID

The staff role ID of the staff member being added

Back to top

PlanAddInventoryInput

The Input for adding multiple Item Types to an existing Plan's Inventory

planId : ID!

The ID of the existing Plan to have new Inventory added

eventNeeds : [PlanEventNeedsInput]

The list of Event Needs that will be added to the Plan

instructorContactIds : [ID]

The list of Instructor Contacts that will be added to the Plan

resourceIds : [ID]

The list of Resources that will be added to the Plan

Back to top

PlanAddLearningPathsInput

The Input for adding new Learning Paths to an existing Plan

planId : ID!

The ID of the Plan to add Learning Paths to

learningPaths : [PlanLearningPathsInput]!

The list of Learning Paths that will be added to the Plan

Back to top

PlanAddResourcesInput

The Input for adding Resources to an existing Plan

planId : ID!

The ID of the existing Plan to add new Resources

resourceIds : [ID]!

The list of Resources that will be added to the Plan

Back to top

PlanArchiveInput

The Input for archiving an existing Plan

planId : ID!

The ID of the Plan that is to be archived

Back to top

PlanCancelSolveInput

The Input for cancelling an in-progress solve on a Plan

planId : ID!

The ID of the Plan whose in-progress solve should be cancelled

Back to top

PlanConnection

A connection containing page information and edges for Plan

edges : [PlanEdge!]!

The list of Plan edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PlanConstraintWeighting

The Type for Constraint Configurations

name : ConstraintName!

The name of the constraint - must exist in the system

weight : Int!

How much impact the constraint should have on a solve (relative to other weightings)

Back to top

PlanConstraintWeightingInput

The Input for updating Constraint Configurations on an existing Plan

name : ConstraintName!

The name of the constraint

weight : Int!

How much impact the constraint should have on a solve

Back to top

PlanCourseTemplateValidation

A Plan Validation specific to one particular Course Template on the Plan

Related types: PlanValidation

courseTemplate : CourseTemplate!

The Course Template that the Plan Validation message refers to

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
message : String!

The message describing the Plan Validation

sessionNeedDetails : SessionNeed

If this Course Template Validation issue relates to a specific Session Need on the Plan, then this field contains the details of that Session Need. For example, if a specific Session Need is not assigned an Approved Instructor specified on the Course Template, then this field will contain the relevant Session Need.

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanCreateInput

The Input for creating a new Plan

name : String!

The name of the Plan

start : LocalDateTime!

The start date of the Plan. Events will not be created before this date.

end : LocalDateTime!

The end date of the Plan. Events will not be created after this date.

locationId : ID!

The ID of the Location associated with the Plan.

scheduleBounds : PlanCreateScheduleBoundsInput

Specifies the days of the week, and the times within those days, when Events are allowed to be scheduled.

constraintWeightings : [PlanConstraintWeightingInput]

Specifies the configuration of each constraint.

accountId : ID

The ID of the Account associated with the Plan. Should only be populated for private Plans.

accountProjectId : ID

The ID of the Project associated with the Plan. Should only be populated for private Plans.

Back to top

PlanCreateScheduleBoundsInput

The Input for setting Schedule Bounds when creating a new Plan

days : [Day]

A list of days of the week that Sessions are allowed to take place on

startTime : Time

The earliest time in the day when a Session may be allowed to start

endTime : Time

The latest time in the day when a Session may be allowed to end

Back to top

PlanDeleteInput

The Input for deleting an existing Plan

planId : ID!

The ID of the Plan that is to be deleted

Back to top

PlanDuplicateInput

The Input for duplicating an existing Plan

planId : ID!

The ID of the Plan that is to be duplicated

Back to top

PlanEdge

Contains cursor and node information for type Plan

cursor : String!

A string that can be used for cursor-based pagination

node : Plan!

The Plan node.

Back to top

PlanEventNeedsInput

The Input specifying a Plan Event Need

courseTemplateId : ID!

The ID of the Course Template that the Event Need must satisfy, i.e. we need Event(s) of this Course Template type

quantity : Int

The number of Events that are required to satisfy the Event Need

startDate : Date

The date at which to begin adding Sessions

startTime : Time

Optional time override for sessions. If provided, session times will be shifted by the offset between this time and the earliest session template start time

locationId : ID

The Location ID override for this Event Need

accountProjectId : ID

The Account Project ID for this Event Need (private schedules)

remoteMeetingType : String

The virtual classroom meeting provider

remoteMeetingUrl : String

The virtual classroom meeting URL (for custom provider)

remoteMeetingHostContactId : ID

The ID of the Contact assigned as meeting host

remoteMeetingHostStaffRoleId : ID

The ID of the Staff Role assigned as meeting host role

Back to top

PlanEventNeedsValidation

A Plan Validation for all Plan Event Needs in general, not specific to one particular Plan Event Need

Related types: PlanValidation

message : String!

The message describing the Plan Validation

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanField

Fields for filtering and ordering Plans

id
name
locationId
isArchived
isScheduled
start
end
solveStatus
lifecycleState
accountId
type
Back to top

PlanFieldGraphFilter

Filter that can be applied to limit which Plan nodes are returned

field : PlanField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PlanFieldGraphOrder

Specifies the order in which Plan nodes are returned via the Connection

field : PlanField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PlanImportEventSessionsInput

The Input for importing historic sessions as new Event Needs to an existing Plan

planId : ID!

The ID of the Plan to add the Event Needs

eventIds : [ID]!

The IDs of the Events to copy as Event Needs to the Plan

importStart : TimeZonedDateTime!

The timezoned start of the date range on the Schedule to import the Events as Event Needs

offsetStart : TimeZonedDateTime

The timezoned date against which the historic Events will be offset when copied. Defaults to start of the earliest Event if not provided

Back to top

PlanInstructorAvailabilityValidation

A Plan Validation specific to availability of one Instructor on the Plan.

Related types: PlanValidation

conflictingSessionNeed : SessionNeed

If this availability validation conflict is caused by another Session Need on the Plan, then this field contains the details of that other Session Need involved in the conflict.

instructor : Contact!

The Instructor that the Plan Validation message refers to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
message : String!

The message describing the Plan Validation

sessionNeed : SessionNeed!

The Session Need that contains this availabilty validation conflict

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanInstructorQualificationValidation

A Plan Validation specific to whether a Contact is qualified to Staff a SessionNeed on the Plan.

Related types: PlanValidation

instructor : Contact!

The Instructor that the Plan Validation message refers to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
message : String!

The message describing the Plan Validation

sessionNeed : SessionNeed!

The Session Need this qualification issue relates to

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanInstructorsValidation

A Plan Validation for all Plan Instructors in general, not specific to one particular Plan Instructor

Related types: PlanValidation

message : String!

The message describing the Plan Validation

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanInstructorValidation

A Plan Validation specific to one particular Staff on the Plan

Related types: PlanValidation

instructor : Contact!

The Staff Contact that the Plan Validation message refers to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
message : String!

The message describing the Plan Validation

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanLearningPathsInput

The Input specifying a Plan Learning Path

learningPathId : ID!

The ID of the Learning Path that the Event Needs must satisfy, i.e. we need Event(s) satisfying this learning path

startDate : Date

The date at which to begin adding Event Needs

Back to top

PlanLifecycleState

An enumeration.

DRAFT
SCHEDULED
ARCHIVED
Back to top

PlanLocationValidation

A Plan Validation specific to the Location of the Plan

Related types: PlanValidation

location : Location!

The Location associated with the Plan

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
message : String!

The message describing the Plan Validation

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanMutateResponse

A Response from mutating a Plan

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

plan : Plan

The Plan output by the mutation

Back to top

PlanMutations

Mutations for Plans

addEventNeeds : PlanMutateResponse!

Add Event Needs to a Schedule

Argument Type Description
input PlanAddEventNeedsInput!

Input fields to add event needs to a Schedule
addInstructors : PlanMutateResponse!

Add Instructors to a Schedule

Argument Type Description
input PlanAddInstructorsInput!

Input fields to add instructors to a Schedule
addInventory : PlanMutateResponse!

Add Inventory to a Schedule (Event Needs, Instructors, Resources)

Argument Type Description
input PlanAddInventoryInput!

Input fields to add inventory to a Schedule
addLearningPaths : PlanMutateResponse!

Add Learning Paths with Course Objectives to a Plan as Event Needs

Argument Type Description
input PlanAddLearningPathsInput!
addResources : PlanMutateResponse!

Add Resources to a Schedule

Argument Type Description
input PlanAddResourcesInput!

Input fields to add resources to a Schedule
archive : PlanMutateResponse!

Archive an existing Schedule

Argument Type Description
input PlanArchiveInput!

Input fields to archive a Schedule
cancelSolve : PlanMutateResponse!

Cancel a Solve on a Schedule

Argument Type Description
input PlanCancelSolveInput!

Input fields to cancel a solve on a Schedule
create : PlanMutateResponse!

Create a new Schedule

Argument Type Description
input PlanCreateInput!

Input fields to create a new Schedule
delete : PlanMutateResponse!

Delete an existing Schedule

Argument Type Description
input PlanDeleteInput!

Input fields to delete a Schedule
duplicate : PlanMutateResponse!

Duplicate an existing Schedule

Argument Type Description
input PlanDuplicateInput!

Input fields to duplicate a Schedule
importEventSessions : PlanMutateResponse!

Import historic Events to a Schedule

Argument Type Description
input PlanImportEventSessionsInput!

Input fields to import historic events to a Schedule
removeAccount : PlanMutateResponse!

Remove the account from a Schedule, making it public

Argument Type Description
input PlanRemoveAccountInput!

Input fields to remove the account from a Schedule
removeEventNeeds : PlanMutateResponse!

Remove Event Needs from a Schedule

Argument Type Description
input PlanRemoveEventNeedsInput!

Input fields to remove event needs from a Schedule
removeInstructors : PlanMutateResponse!

Remove Instructors from a Schedule

Argument Type Description
input PlanRemoveInstructorsInput!

Input fields to remove instructors from a Schedule
removeLearningPath : PlanMutateResponse!

Remove Learning Path Event Needs from a Plan

Argument Type Description
input PlanRemoveLearningPathInput!
removeResources : PlanMutateResponse!

Remove Resources from a Schedule

Argument Type Description
input PlanRemoveResourcesInput!

Input fields to remove resources from a Schedule
schedule : PlanMutateResponse!

Create Events and Book from a Schedule

Argument Type Description
input PlanScheduleInput!

Input fields to create events and book from a Schedule
solve : PlanMutateResponse!

Solve a Schedule

Argument Type Description
input PlanSolveInput!

Input fields to solve a Schedule
unarchive : PlanMutateResponse!

Unarchive an archived Schedule

Argument Type Description
input PlanUnArchiveInput!

Input fields to unarchive a Schedule
update : PlanMutateResponse!

Update an existing Schedule

Argument Type Description
input PlanUpdateInput!

Input fields to update a Schedule
updateEventNeed : PlanMutateResponse!

Update an Event Need's properties

Argument Type Description
input PlanUpdateEventNeedInput!

Input fields to update an event need
updateEventNeedSessions : PlanMutateResponse!

Update all Session Needs on an Event Need

Argument Type Description
input PlanUpdateEventNeedSessionsInput!

Input fields to update all session needs on an event need
updateLearningPathNeed : PlanMutateResponse!

Update a Learning Path Need's properties

Argument Type Description
input PlanUpdateLearningPathNeedInput!

Input fields to update a learning path need
updateSessionNeed : SessionNeedMutateResponse!

Update a Session Need

Argument Type Description
input PlanSessionNeedUpdateInput!

Input fields to update a session need
Back to top

PlanRemoveAccountInput

The Input for removing the account from a Plan

planId : ID!

The ID of the Plan that is to be made public

Back to top

PlanRemoveEventNeedsInput

The Input for removing existing Event Needs from a Plan

planId : ID!

The ID of the Plan to add the Event Needs

eventNeedIds : [ID]!

The list of Event Needs IDs to be removed from the Plan

Back to top

PlanRemoveInstructorsInput

The Input for removing Instructors from an existing Plan

planId : ID!

The ID of the existing Plan to remove the Instructor

contactIds : [ID]!

The list instructor Contacts to remove from the Plan

Back to top

PlanRemoveLearningPathInput

The Input for removing Learning Paths from an existing Plan

planId : ID!

The ID of the existing Plan to remove Learning Paths

learningPathId : ID!

The ID of the Learning Path that will be removed from the Plan

instanceNumber : Int!

The instance number of the Learning Path to remove

Back to top

PlanRemoveResourcesInput

The Input for removing Resources from an existing Plan

planId : ID!

The ID of the existing Plan to remove the Resources

resourceIds : [ID]!

The list Resources to remove from the Plan

Back to top

PlanResource

Details of the Resources assigned to a Plan

hoursInUse : Float!

The number of hours this Resource is in use on the given Plan

resource : Resource!

The Resource associated with the Plan Resource

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
Back to top

PlanResourceAvailabilityValidation

A Plan Validation specific to one particular Resource's availability on the Plan

Related types: PlanValidation

conflictingSessionNeed : SessionNeed

If this availability validation conflict is caused by another Session Need on the Plan, then this field contains the details of that other Session Need involved in the conflict.

message : String!

The message describing the Plan Validation

resource : Resource!

The Resource that the Plan Validation message refers to

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
sessionNeed : SessionNeed!
severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanResourceConnection

A connection containing page information and edges for PlanResource

edges : [PlanResourceEdge!]!

The list of PlanResource edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PlanResourceEdge

Contains cursor and node information for type PlanResource

cursor : String!

A string that can be used for cursor-based pagination

node : PlanResource!

The PlanResource node.

Back to top

PlanResourceField

An enumeration.

resourceId
resourceName
Back to top

PlanResourceFieldGraphFilter

Filter that can be applied to limit which PlanResource nodes are returned

field : PlanResourceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PlanResourceFieldGraphOrder

Specifies the order in which PlanResource nodes are returned via the Connection

field : PlanResourceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PlanResourceRequirementByType

numberAdded : Int!

The number of Resources added to the Plan in order to satisfy the Resource Type Requirement

numberRequired : Int!

The number of Plan Resources required in order to satisfy the Resource Type Requirement

resourceType : ResourceType!

The Resource Type required

Argument Type Description
filters = [] [ResourceTypeFieldGraphFilter]
order = "__EMPTY__" ResourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceTypeFieldGraphOrder]
Back to top

PlanResourceRequirementSummary

areRequirementsMet : Boolean!

A flag showing whether or not enough Resources have been added to the Plan to satisfy the current requirements.

resourceRequirementByType : [PlanResourceRequirementByType!]!

A list of each required Resource Type for the Plan, detailing how many are required, and how many have been added

Back to top

PlanResourcesValidation

A Plan Validation for all Plan Resources in general, not specific to one particular Plan Resource

Related types: PlanValidation

message : String!

The message describing the Plan Validation

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanResourceTypeValidation

A Plan Validation specific to one particular Resource Type on the Plan

Related types: PlanValidation

message : String!

The message describing the Plan Validation

resourceType : ResourceType!

The Resource Type that the Plan Validation message refers to

Argument Type Description
filters = [] [ResourceTypeFieldGraphFilter]
order = "__EMPTY__" ResourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceTypeFieldGraphOrder]
severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanResourceValidation

A Plan Validation specific to one particular Resource on the Plan

Related types: PlanValidation

message : String!

The message describing the Plan Validation

resource : Resource!

The Resource that the Plan Validation message refers to

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanScheduleBounds

days : [Day!]!

A list of days of the week that Events are allowed to take place on

endTime : Time!

The latest time in the day when an Event may be allowed to end

startTime : Time!

The earliest time in the day when an Event may be allowed to start

Back to top

PlanScheduleInput

The Input for scheduling Events from an existing, solved Plan

planId : ID!

The ID of the Plan that should be scheduled

createAsActive : Boolean

A flag indicating whether created Events and Sessions should be marked as Active (true) or Draft (false). If not specified, defaults to false.

Back to top

PlanSessionNeedUpdateInput

Input for updating an existing Session Need.

sessionNeedId : ID!

ID of session need to update.

start : LocalDateTime

The start time of the Session Need solution.

end : LocalDateTime

The end time of the Session Need solution. If not provided, the end re-derives from the start and the session's duration.

resourceIds : [ID]

Sets the list of Resources on the Session Need solution. If not provided, no resource changes will be applied. If empty, all resources will be removed.

moveAllEventSessions : Boolean

Whether or not to move all of the parent Event Need's Session Needs relative to the new start.

moveAllLearningPathSessions : Boolean

Whether or not to move all of the parent Learning Path's Session Needs relative to the new start.

staff : [StaffNeed]

The list of staff to set for all sessions. If not provided, no staff changes will be applied. If empty, all staff will be removed.

Back to top

PlanSolveInput

The Input for triggering a solve on an existing Plan

planId : ID!

The ID of the Plan that should be solved

useExactSessionTemplateTimes : Boolean

A flag indicating whether the solution should respect the exact session times as specified on the corresponding Course Template. If false, the solution will respect the session durations, but the exact times of the sessions may deviate from those specified in the Course Template. If flag not specified, we default to be true.

Back to top

PlanStaff

Details of the Staff assigned to a Plan

contact : Contact!

The Contact associated with the Plan Staff

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
hoursInUse : Float!

The number of hours this Staff is in use on the given Plan

staffRole : StaffRole!

The Staff Role associated with the Plan Staff

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
Back to top

PlanStaffConnection

A connection containing page information and edges for PlanStaff

edges : [PlanStaffEdge!]!

The list of PlanStaff edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PlanStaffEdge

Contains cursor and node information for type PlanStaff

cursor : String!

A string that can be used for cursor-based pagination

node : PlanStaff!

The PlanStaff node.

Back to top

PlanStaffField

An enumeration.

contactId
contactFirstName
contactLastName
contactName
Back to top

PlanStaffFieldGraphFilter

Filter that can be applied to limit which PlanStaff nodes are returned

field : PlanStaffField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PlanStaffFieldGraphOrder

Specifies the order in which PlanStaff nodes are returned via the Connection

field : PlanStaffField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PlanStatus

Contains the status information of the Plan

archivedAt : LocalDateTime

The date and time when the Plan was Archived

explainScore : String

A verbose explanation of the hard constraint violations of the last solution

isBookable : Boolean!

A Boolean indicating whether EventNeeds within a Plan can be created and booked as real Events.

isSolvable : Boolean!

A boolean indicating whether of not the Plan can be solved

issues : [PlanValidation!]!

Contains Validation Issue messages for the Plan

Argument Type Description
filters = [] [PlanValidationFieldGraphFilter]
order = "__EMPTY__" PlanValidationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PlanValidationFieldGraphOrder]
lastScore : Int

The score of the last solution (higher is better, zero is best)

lifecycleState : PlanLifecycleState!

The lifecycle state of the Plan

scheduledAt : LocalDateTime

The date and time when Events were scheduled from a Plan

solveError : String

The error message from the last solve attempt if it failed

solveStatus : SolveStatus!

The status of the solve

solvedAt : LocalDateTime

The date and time when the Plan was last solved

Back to top

PlanType

The type of a Plan

public
private
Back to top

PlanUnArchiveInput

The Input for un-archiving an existing Plan

planId : ID!

The ID of the Plan that is to be un-archived

Back to top

PlanUpdateEventNeedInput

The Input for updating an Event Need's properties

eventNeedId : ID!

The ID of the Event Need to update

title : String

The display name override for this Event Need. If null, the Course Template title is used.

locationId : ID

The Location ID override for this Event Need

accountProjectId : ID

The Account Project ID for this Event Need (private schedules)

remoteMeetingType : String

The virtual classroom meeting provider

remoteMeetingUrl : String

The virtual classroom meeting URL (for custom provider)

remoteMeetingHostContactId : ID

The ID of the Contact assigned as meeting host

remoteMeetingHostStaffRoleId : ID

The ID of the Staff Role assigned as meeting host role

Back to top

PlanUpdateEventNeedSessionsInput

The Input for updating all of an EventNeed's sessions

eventNeedId : ID!

The parent EventNeed ID of the SessionNeeds to update

resourceIds : [ID]

The list of Resource IDs to set for all sessions. If not provided, no resource changes will be applied. If empty, all resources will be removed.

requiredSessionsOnly : Boolean

If false (default), the Resource will be assigned on all SessionNeeds for the EventNeed. If true, the Resource will be assigned only on the SessionNeed that require the Resource's type according to the Course Template requirements

staff : [StaffNeed]

The list of staff to set for all sessions. If not provided, no staff changes will be applied. If empty, all staff will be removed.

Back to top

PlanUpdateInput

The Input for updating an existing Plan

planId : ID!

The ID of the Plan that is to be updated

name : String

The name of the Plan

start : LocalDateTime

The start date of the Plan. Events will not be created before this date.

end : LocalDateTime

The end date of the Plan. Events will not be created after this date.

scheduleBounds : PlanUpdateScheduleBoundsInput

Specifies the days of the week, and the times within those days, when Events are allowed to be scheduled.

locationId : ID

Specifies the Location associated with the Plan

accountId : ID

Specifies the Account associated with the Plan if it is a private Plan

accountProjectId : ID

Specifies the Project associated with the Plan if it is a private Plan

constraintWeightings : [PlanConstraintWeightingInput]

Specifies the configuration of each constraint - full list of desired weightings needs to be supplied.

Back to top

PlanUpdateLearningPathNeedInput

The Input for updating a Learning Path Need's properties

learningPathNeedId : ID!

The ID of the Learning Path Need to update

name : String

The display name override for this Learning Path Need. If null, the Learning Path name is used.

accountId : ID

The Account ID override for this Learning Path Need

accountProjectId : ID

The Account Project ID override for this Learning Path Need

Back to top

PlanUpdateScheduleBoundsInput

The Input for updating Schedule Bounds on an existing Plan

days : [Day]

A list of days of the week that Sessions are allowed to take place on

startTime : Time

The earliest time in the day when a Session may be allowed to start

endTime : Time

The latest time in the day when a Session may be allowed to end

Back to top

PlanValidation

Contains a validation message for the Plan

Related types: PlanInstructorValidation PlanCourseTemplateValidation PlanResourceValidation PlanResourcesValidation PlanInstructorsValidation PlanEventNeedsValidation PlanResourceTypeValidation PlanLocationValidation PlanInstructorAvailabilityValidation PlanInstructorQualificationValidation PlanResourceAvailabilityValidation

message : String!

The message describing the Plan Validation

severity : PlanValidationSeverity!

The severity of the current Plan Validation message

Back to top

PlanValidationField

Fields for filtering and ordering Plan Validations

sessionNeedId
Back to top

PlanValidationFieldGraphFilter

Filter that can be applied to limit which PlanValidation nodes are returned

field : PlanValidationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PlanValidationFieldGraphOrder

Specifies the order in which PlanValidation nodes are returned via the Connection

field : PlanValidationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PlanValidationSeverity

Severity of Plan Valdations

warning
error
Back to top

PointOfSaleCustomFieldType

An enumeration.

string
text
email
integer
number
url
country
province
language
location
locations
date
datetime
time
checkbox
choice
multichoice
html
Back to top

PointOfSaleFieldCourseInput

An Input for Adding/Removing Courses on a Point of Sale Field

definitionKey : ID!

The identifier for the Point of Sale Field

courseTemplateIds : [ID]

The Course Template IDs to modify

Back to top

PointOfSaleFieldCreateInput

An Input for creating a Point of Sale Field

definition : PointOfSaleFieldDefinitionInput!

The CustomFieldDefinition input

objectType : SupportsPointOfSaleField!

The type of object this Custom Field is stored against

Back to top

PointOfSaleFieldCreateResponse

A response from creating a Point of Sale Field

errors : [FieldError!]!

The errors returned by the mutation

pointOfSaleFieldDefinition : PointOfSaleFieldDefinition

The Point of Sale Field that was created

Back to top

PointOfSaleFieldDefinition

A Point of Sale field

Related types: CustomFieldDefinition

canEdit : Boolean!

Whether the custom field can be edited by the current user

courseTemplates : [ID!]!

The Course Templates that this Point of Sale Field is restricted to

definitionLocator : String

Human readable name of the Custom Field

description : String

A description explaining the use of the Custom Field

includeInSearch : Boolean!

Whether values of this custom field are included in global search

isRequired : Boolean!

Whether the custom field is required

isRestricted : Boolean!

Whether the custom field is required

key : ID!

The identifier for this definition

label : String!

The label of the CustomFieldDefinition

mappedField : MappedField

The mapping between an entity type and a field

options : [Option!]

Choices to present for a Custom Field with choice options

permissionGrants : [CustomFieldDefinitionPermission!]!

Role permission grants on editing or viewing this custom field's data

portals : [ID!]!

The Portals that this Point of Sale Field is restricted to

roles : [ID!]!

User Roles which have permissions to view and edit the data in this field (empty means no restrictions)

section : FormSection

The Learner Details Information section that this definition should be displayed in

type : CustomFieldType!

The type of value allowed for this Custom Field

Back to top

PointOfSaleFieldDefinitionInput

An Input for a Point of Sale Field Definition

label : String!

The label for the Point of Sale Field

type : PointOfSaleCustomFieldType

The type for the Point of Sale Field

isRequired : Boolean

Whether or not the Point of Sale Field is required

mappedField : MappedFieldInput

The field which the Point of Sale Field maps to

position : Int

The relative position for the Point of Sale Field to be displayed

section : FormSection

The Section to display the Point of Sale Field in

options : [String]

List of options for choice or multichoice Custom Fields

courseTemplateIds : [ID]

List of Course Template IDs to Restrict this Field to

portalIds : [ID]

List of Portal IDs to Restrict this Field to

stockItemIds : [ID]

List of Stock Item IDs to Restrict this Field to

Back to top

PointOfSaleFieldRemoveInput

An Input for removing a Point of Sale Field

definitionKey : ID!

The identifier for the Point of Sale Field to remove

Back to top

PointOfSaleFieldRemoveResponse

A response from removing a Point of Sale Field

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

key : ID

The ID of the deleted Point of Sale Field

Back to top

PointOfSaleFieldUpdateInput

An Input for updating a Point of Sale Field

definitionKey : ID!

The identifier for the Point of Sale Field to update

label : String

The label for the Point of Sale Field

isRequired : Boolean

Whether or not the Point of Sale Field is required

mappedField : MappedFieldInput

The field which the Point of Sale Field maps to

position : Int

The relative position for the Point of Sale Field to be displayed

section : FormSection

The Section to display the Point of Sale Field in

options : [String]

List of options for choice or multichoice Custom Fields

courseTemplateIds : [ID]

List of Course Template IDs to Restrict this Field to

portalIds : [ID]

List of Portal IDs to Restrict this Field to

stockItemIds : [ID]
Back to top

PointOfSaleFieldUpdateResponse

A response from updating a Point of Sale Field

errors : [FieldError!]!

The errors returned by the mutation

pointOfSaleFieldDefinition : PointOfSaleFieldDefinition

The Point of Sale Field that was updated

Back to top

Portal

A separate website that Contacts can access, for example: An LMS or Web Store

Related types: WebLinkPortal LMSPortal

analyticsConfiguration : PortalAnalyticsConfiguration!

Configuration for any data analytics providers configured for this portal

autoProvisionLearnersViaSingleSignOn : Boolean!

Indicates if new contacts and contact credentials are created when unknown learners log in via Single Sign On

availabilityState : PortalAvailabilityState!

The current availability of this Portal

brand : Brand!

The Brand that owns this Portal

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
categories : [LearningCategory]!

The Learning Categories associated with this Portal

courseDetailsCustomFieldMap : [PortalCourseDetailsFieldMapping]!

Custom Field Mappings that define how fields on a Course Template map to fields on a Portal Course

customFieldFilters : PortalCustomFieldFilterConnection!

Custom Field Mappings for the filters available on this Portal

Argument Type Description
filters = [] [PortalCustomFieldFilterFieldGraphFilter]
order = "__EMPTY__" PortalCustomFieldFilterFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalCustomFieldFilterFieldGraphOrder]
customFieldTemplate : PortalCustomFieldTemplate!

Fetches the Custom Field Template associated with this Portal for a type

Argument Type Description
type SupportsCustomFieldPortalEntities!
emailTemplateMappings : PortalEmailTemplateMappingConnection!

Fetches the mapping between Portals and Communication Templates

Argument Type Description
filters = [] [PortalEmailTemplateMappingFieldGraphFilter]
order = "__EMPTY__" PortalEmailTemplateMappingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalEmailTemplateMappingFieldGraphOrder]
externalOriginsAllowList : [String!]!

Origin URLs allowed to send events from

giftVoucherConfigurationMapping : GiftVoucherPortalConfiguration

Fetches the Gift Voucher Configuration that is mapped to this Portal

Argument Type Description
filters = [] [GiftVoucherPortalConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherPortalConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherPortalConfigurationFieldGraphOrder]
giftVoucherConfigurations : GiftVoucherConfigurationConnection!

Fetches the Gift Voucher Configurations associated with this Portal

Argument Type Description
filters = [] [GiftVoucherConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherConfigurationFieldGraphOrder]
id : ID!

The ID of this Portal

identityProviders : IdentityProviderConnection!

The Identity Providers for this Portal

Argument Type Description
filters = [] [IdentityProviderFieldGraphFilter]
order = "__EMPTY__" IdentityProviderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [IdentityProviderFieldGraphOrder]
isBookingPortal : Boolean!

Dictates if Booking Portal behaviours are enabled for this Portal

isSelfRegistrationPortal : Boolean!

Dictates if Self-Registration behaviours are enabled for this Portal

priceLevels : [PriceLevel]!

The Price Levels associated with this Portal

singleSignOnOnly : Boolean!

Indicates if Contacts can log into this Portal only by Single Sign On

termsAndConditions : String

The terms and conditions for Portal checkout flow

url : URL!

The URL of this Portal

vanityUrl : URL

The URL that proxies to this Portal, usually for branding

Deprecated fields (1)
analyticsEnabled : Boolean!

Whether the analytics are enabled on the instance hosting the portal.

Removal date: TBD.

Feature removed, always returns false

Back to top

PortalAddCustomFieldFilterInput

The input type with the values used to create a Custom Field Filter for a Portal

portalId : ID!

The ID of the Portal to link the Custom Field Filter to

label : String!

The label of the Custom Field Filter

type : CustomFieldFilterType!

The type of Custom Field Filter

mappedCustomFieldIds : [ID]!

The list of Custom Field IDs that are mapped to this Custom Field Filter

Back to top

PortalAddIdentityProviderInput

The input type with the values used to add an Identity Provider on a Portal

portalId : ID!

The ID of the Portal to add an Identity Provider to

identityProviderId : ID!

The ID of the Identity Provider to add to the Portal

Back to top

PortalAnalyticsConfiguration

Configuration of Analytics providers for a portal

googleTagManagerContainerId : String

The identifier for the Google Tag Manager container to send analytics events to

Back to top

PortalAnalyticsConfigurationInput

The input type for configuring analytics providers on a Portal

googleTagManagerContainerId : String

The identifier of a Google Tag Manager container to send analytics events to

Back to top

PortalAvailabilityState

Availability states for Portals

enabled
disabled
Back to top

PortalConnection

A connection containing page information and edges for Portal

edges : [PortalEdge!]!

The list of Portal edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PortalCourseDetailsField

Types of Course Details Custom Fields

teaserDescription
description
prerequisites
topicsCovered
faqs
outcomes
Back to top

PortalCourseDetailsFieldMapping

Course Template Custom Field IDs that are used to map to fields on a Portal Course

courseTemplateCustomFieldDefinition : ID!

The Course Template Custom Field ID that is mapped to the corresponding Portal Course Field

id : ID!

The ID of this Portal Course Details Field Mapping

portalCourseDetailsField : PortalCourseDetailsField!

The Portal Course Field that is mapped to the corresponding Course Template Custom Field ID

Back to top

PortalCourseField

The mappable Course fields for a Portal

description
faqs
outcomes
prerequisites
teaserDescription
topicsCovered
Back to top

PortalCourseFieldMapInput

The input type with the values used to map Course Description Fields to a Portal

portalId : ID!

The ID of the Portal to map the Course Custom Field to

courseCustomFieldMappings : [CourseCustomFieldMappings]!

The list of Course Custom Field Mappings to process

Back to top

PortalCreateInput

The input type with the values used to create a Portal

brandId : ID!

The ID of the Brand that new Portal will belong to

suffix : String!

The suffix applied to your TMS subdomain to create the URL for the new Portal. Can only contain letters, numbers and '-'.

type : PortalType!

The type of the new Portal

vanityUrl : URL

The URL that proxies to the new Portal

singleSignOnOnly : Boolean

Denotes whether Contacts are limited to using Single Sign On for this Portal

regionCode : String

The Code of the Region that a new WebLink Portal will belong to

currencyCode : String

The Code of the Currency that a new WebLink Portal uses

indexable : Boolean

Denotes whether this WebLink Portal is indexable by search engines

taxInclusive : Boolean

Denotes whether this WebLink Portal should display prices inclusive of tax

googleAnalyticsCode : String

The Google Analytics code for this WebLink Portal

defaultErrorMessage : String

The default error message to be used for this WebLink Portal

emptyPortalRedirectUrl : URL

The URL to redirect to if a Contact signs in to the LMS Portal with no content to view

termsAndConditions : String

The Terms & Conditions that can be shown to the user during checkout flow for this WebLink Portal

linkedWebLinkPortalIds : [String]

The IDs of WebLink Portals to be linked to this Portal

confirmEmails : Boolean

Denotes whether the WebLink Portal will display 'Confirm Email' fields on booking forms

autoProvisionLearnersViaSingleSignOn : Boolean

Denotes if new contacts and contact credentials are created when unknown learners log in via SSO

hidePrices : Boolean

Denotes whether the WebLink Portal will hide prices for catalog items

catalogLinkedPortalId : ID

The Optional LMS Portal linked to this WebLink Portal where learners will be redirected to when clicking on a Catalog Item

cartlessCheckout : Boolean

Denotes whether the WebLink Portal will bypass the add to cart step so a course could be purchased directly

isApprovalPortal : Boolean

Denotes whether the LMS Portal facilitates Learners requesting training that requires approval from an Administrator

isBookingPortal : Boolean

Denotes whether the Weblink Portal facilitates Coordinators booking Contacts that they manage onto training

isSelfRegistrationPortal : Boolean

Denotes whether the Weblink Portal facilitates authenticated individuals booking themselves through the LMS

reservationValiditySeconds : Int

Denotes how long event seat reservations will be valid for when items are added to the Weblink Portal's Cart

requireLearnerDetails : Boolean

Denotes whether the WebLink Portal will not require Learner Details to be entered at checkout (default: true). Any learners whose details have not been submitted prior to checkout will be registered as 'Unnamed Learners'.

requireAuthentication : Boolean

Denotes whether the WebLink Portal will be publicly accessible

requireLoginOnCheckout : Boolean

Denotes whether returning users will have to sign In to complete a purchase

hidePricesBeforePricingAgreementApplied : Boolean

Denotes whether the WebLink Portal will hide prices for catalog items before the checkout stage where Pricing Agreements are applied.

showEventsWithNoRemainingPlaces : Boolean

Denotes whether Events with no remaining places should be displayed in the WebLink Portal

hideCompanyFieldForBooker : Boolean

Denotes whether the Company field should be displayed during the checkout process on the WebLink Portal.

catalogueOverrideUrl : String

Configure an override URL to redirect to on visiting the Catalogue

cartOverrideUrl : String

Configure an override URL to redirect to on visiting the Cart

orderConfirmation : WeblinkPortalOrderConfirmationInput

Default Weblink Order Confirmation details used to email a buyer after booking

cancellationMessage : String

The optional message displayed when attempting to cancel a Booking

transferMessage : String

The optional message displayed when attempting to transfer a Booking

canSelfCheckoutByInvoice : Boolean

Denotes whether the B2B Portal this Weblink Portal is linked to can be used to self-checkout using an Invoice Payment Provider

splitUnnamedLearners : Boolean

Denotes whether the WebLink Portal will split Unnamed Learners into separate records when registering onto Events (default: false). This setting only has effect if requireLearnerDetails is true.

showPrivateTraining : Boolean

Denotes whether the WebLink Portal will show Private Training the User can access via their Account.

Back to top

PortalCustomFieldFilter

A Custom Field Filter for a Portal used for filtering the Catalog These are associated with a Portal and can also be associated with multiple Course or Learning Path Custom Fields

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Custom Field Filter

label : String!

The label for the Custom Field Filter

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

mappedCustomFields : [CustomFieldDefinition!]!

The underlying Course or Learning Path Custom Fields which are mapped to this Custom Field Filter

type : String!

The type of the Custom Field Filter

Back to top

PortalCustomFieldFilterConnection

A connection containing page information and edges for PortalCustomFieldFilter

edges : [PortalCustomFieldFilterEdge!]!

The list of PortalCustomFieldFilter edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PortalCustomFieldFilterEdge

Contains cursor and node information for type PortalCustomFieldFilter

cursor : String!

A string that can be used for cursor-based pagination

node : PortalCustomFieldFilter!

The PortalCustomFieldFilter node.

Back to top

PortalCustomFieldFilterField

Fields for filtering and ordering Portal Custom Field Filters

id
label
type
Back to top

PortalCustomFieldFilterFieldGraphFilter

Filter that can be applied to limit which PortalCustomFieldFilter nodes are returned

field : PortalCustomFieldFilterField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PortalCustomFieldFilterFieldGraphOrder

Specifies the order in which PortalCustomFieldFilter nodes are returned via the Connection

field : PortalCustomFieldFilterField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PortalCustomFieldTemplate

A set of CustomFieldDefinitions for a Type on a Portal

customFieldDefinitions : [CustomFieldDefinition!]!

The list of CustomFieldDefinitions of the GlobalCustomFieldTemplate

name : String!

The name of the GlobalCustomFieldTemplate

Back to top

PortalDisableInput

The input type with the values used to disable a Portal

portalId : ID!

The ID of the Portal to disable

Back to top

PortalEdge

Contains cursor and node information for type Portal

cursor : String!

A string that can be used for cursor-based pagination

node : Portal!

The Portal node.

Back to top

PortalEditCustomFieldFilterInput

The input type with the values used to edit a Custom Field Filter for a Portal

portalId : ID!

The ID of the Portal that the Custom Field Filter is linked to.

customFieldFilterId : ID!

The ID of the Custom Field Filter.

label : String

The new label of the Custom Field Filter.

mappedCustomFieldIds : [ID]

The new list of Custom Field IDs that are mapped to this Custom Field Filter. All mapped Custom Fields need to be specified, any existing ones not provided will be removed.

Back to top

PortalEmailTemplateMapInput

The input type with the values used to map a Communication Template to a Portal

name : String!

The name of the mapping

label : String!

The label shown in the UI for the mapping. e.g. Voucher Language (English)

portalId : ID!

The ID of the Portal to map the Communication Template to

emailTemplateId : ID!

The ID of the Communication Template to map

Back to top

PortalEmailTemplateMapping

The Mapping between a Portal and a Communication Template

Related types: Node

communicationTemplate : CommunicationTemplate!

The Communication Template linked to by the Mapping

Argument Type Description
filters = [] [CommunicationTemplateFieldGraphFilter]
order = "__EMPTY__" CommunicationTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CommunicationTemplateFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Mapping

label : String!

The label of the Mapping

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Mapping

Back to top

PortalEmailTemplateMappingConnection

A connection containing page information and edges for PortalEmailTemplateMapping

edges : [PortalEmailTemplateMappingEdge!]!

The list of PortalEmailTemplateMapping edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PortalEmailTemplateMappingEdge

Contains cursor and node information for type PortalEmailTemplateMapping

cursor : String!

A string that can be used for cursor-based pagination

node : PortalEmailTemplateMapping!

The PortalEmailTemplateMapping node.

Back to top

PortalEmailTemplateMappingField

Fields for filtering and ordering Email Template Mappings

id
name
label
Back to top

PortalEmailTemplateMappingFieldGraphFilter

Filter that can be applied to limit which PortalEmailTemplateMapping nodes are returned

field : PortalEmailTemplateMappingField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PortalEmailTemplateMappingFieldGraphOrder

Specifies the order in which PortalEmailTemplateMapping nodes are returned via the Connection

field : PortalEmailTemplateMappingField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PortalEnableInput

The input type with the values used to enable a Portal

portalId : ID!

The ID of the Portal to enable

Back to top

PortalFieldGraphFilter

Filter that can be applied to limit which Portal nodes are returned

field : PortalTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PortalFieldGraphOrder

Specifies the order in which Portal nodes are returned via the Connection

field : PortalTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PortalGenerateLmsPreviewTokenInput

The input type with the values used to generate an LMS Preview Token

portalId : ID!

The ID of the Portal to generate the LMS Preview Token for

eventId : ID!

The ID of the Event to preview in the LMS Portal

permissions : PortalGenerateLmsPreviewTokenPermissions!

Permissions to add while generating lms preview token

Back to top

PortalGenerateLmsPreviewTokenPermissions

Permissions Objects to add while generating lms preview token

canDeleteDiscussionComments : Boolean!

Permission to delete discussion comment in LMS

Back to top

PortalGiftVoucherConfigurationMapInput

The input type with additional values required to create or update a Gift Voucher Configuration Portal mapping

giftVoucherConfigurationId : ID!

The ID of the Gift Voucher Configuration to map

portalId : ID!

The ID of the Portal to map the Gift Voucher Configuration to

sendingAddressId : ID!

The ID of the Email Sending Address to use with this mapping

productDescription : String!

The description of the Gift Voucher Configuration mapped to the Portal

imageId : ID

The ID of a DMS Document image for display on the Portal catalog

Back to top

PortalGiftVoucherConfigurationMapInputBase

The input type with the common values used for all mapping operations of a Gift Voucher Configuration to a Portal

giftVoucherConfigurationId : ID!

The ID of the Gift Voucher Configuration to map

portalId : ID!

The ID of the Portal to map the Gift Voucher Configuration to

Back to top

PortalGiftVoucherConfigurationMapUpdateInput

The input type with the values for updating a Gift Voucher Configuration Portal mapping

giftVoucherConfigurationMappingId : ID!

The ID of the Gift Voucher Configuration mapping to update

productDescription : String

The description of the Gift Voucher Configuration mapped to the Portal

sendingAddressId : ID

The ID of the Email Sending Address to use with this mapping

imageId : ID

The ID of a DMS Document image for display on the Portal catalog

Back to top

PortalLearningCategoryInput

The input type with the values used to set Learning Categories as available to a Portal

portalId : ID!

The ID of the Portal

learningCategoryIds : [ID]!

The list of Learning Categories to make available to the Portal

Back to top

PortalLmsPreviewTokenResponse

A Response from generating an LMS Preview Token for an LMS Portal

administrateIdentityProviderPreviewUrl : String

Administrate's Identity Provider Preview URL

errors : [FieldError!]!

The errors returned by the mutation

portal : Portal

The Portal that was mutated

previewToken : String

The LMS Preview Token generated by the mutation

Back to top

PortalLoginHistory

History of Portal Logins

Related types: Node

brand : Brand!

The Brand that was signed in to

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
contact : Contact

The Contact that signed in

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the PortalLoginHistory

identityProviderName : String!

The Name of the Identity Provider used to sign in

identityProviderType : String!

The Type of the Identity Provider used to sign in

lastActiveAt : TimeZonedDateTime!

The last time a user was active

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

signedInAt : TimeZonedDateTime!

The time the successful sign in happened

username : String!

The username used to sign in

Back to top

PortalLoginHistoryConnection

A connection containing page information and edges for PortalLoginHistory

edges : [PortalLoginHistoryEdge!]!

The list of PortalLoginHistory edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PortalLoginHistoryEdge

Contains cursor and node information for type PortalLoginHistory

cursor : String!

A string that can be used for cursor-based pagination

node : PortalLoginHistory!

The PortalLoginHistory node.

Back to top

PortalLoginHistoryField

Fields for filtering and ordering Portal Login History

id
brandId
contactId
signedInAt
identityProviderName
identityProviderType
Back to top

PortalLoginHistoryFieldGraphFilter

Filter that can be applied to limit which PortalLoginHistory nodes are returned

field : PortalLoginHistoryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PortalLoginHistoryFieldGraphOrder

Specifies the order in which PortalLoginHistory nodes are returned via the Connection

field : PortalLoginHistoryField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PortalMutationResponse

A Response from mutating a Portal

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

portal : Portal

The Portal that was mutated

Back to top

PortalMutations

Mutations available for Portals

addCustomFieldDefinition : PortalMutationResponse!

Link a Custom Field Definition to a Portal

Argument Type Description
input PortalToCustomFieldDefinitionLinkInput!

The input type with the values used to link the Custom Field Definition to the Portal
addCustomFieldFilter : PortalMutationResponse!

Create a Custom Field Filter for a Portal

Argument Type Description
input PortalAddCustomFieldFilterInput!

The input type with the values used to Create the Custom Field Filter for the Portal and link it to some Custom Fields
addFieldToTrainingRequestWorkflow : PortalMutationResponse!

Adds a Field to the Portal Training Request Workflow

Argument Type Description
input WebLinkPortalTrainingRequestWorkflowAddFieldInput!

The input type with the values outlining the Field to add to the Portal Training Request Workflow
addIdentityProvider : PortalMutationResponse!

Add an Identity Provider to a Portal

Argument Type Description
input PortalAddIdentityProviderInput!

The input type with the values used to add an Identity Provider on a Portal
addWebLinkPaymentProviderDefinitions : PortalMutationResponse!

Add an Attribute Definition to a WebLink Portal Payment Provider

Argument Type Description
input AddWebLinkPaymentProviderDefinitionsInput!

The input type with the values used to add an Attribute Definition to a WebLink Portal Payment Provider
create : PortalMutationResponse!

Creates an enabled Portal

Argument Type Description
input PortalCreateInput!

The input type with the values used to create a Portal
createOrderPointOfSaleField : OrderPointOfSaleFieldMutateResponse!

Create a new Order Point of Sale Field

Argument Type Description
input OrderPointOfSaleFieldCreateInput!

The input type with the values to be set on the new Order Point of Sale Field
deleteCustomFieldFilter : PortalMutationResponse!

Delete a Custom Field Filter for a Portal

Argument Type Description
input DeleteCustomFieldFilterInput!

The ID of the Custom Field Filter to delete
deleteFieldFromTrainingRequestWorkflow : PortalMutationResponse!

Deletes a Field from Portal Training Request Workflow

Argument Type Description
input WebLinkPortalTrainingRequestWorkflowDeleteFieldInput!

The input type with the Field to delete from the Portal Training Request Workflow
deleteOrderPointOfSaleFields : OrderPointOfSaleFieldMutateResponse!

Delete existing Order Point of Sale Fields

Argument Type Description
input OrderPointOfSaleFieldDeleteInput!

The input type with the list of Order Point of Sale Fields to be deleted
disable : PortalMutationResponse!

Disable a Portal

Argument Type Description
input PortalDisableInput!

The input type with the values used to disable a Portal
editCustomFieldFilter : PortalMutationResponse!

Edit a Custom Field Filter for a Portal

Argument Type Description
input PortalEditCustomFieldFilterInput!

The input type with the values used to Edit a Portal Custom Field Filter for the Portal
editFieldOnTrainingRequestWorkflow : PortalMutationResponse!

Edits a Field on the Portal Training Request Workflow

Argument Type Description
input WebLinkPortalTrainingRequestWorkflowEditFieldInput!

The input type with the values outlining the Field to edit on the Portal Training Request Workflow
enable : PortalMutationResponse!

Enable a Portal

Argument Type Description
input PortalEnableInput!

The input type with the values used to enable a Portal
generateLmsPreviewToken : PortalLmsPreviewTokenResponse!

Generate a token to preview an Event in an LMS Portal

Argument Type Description
input PortalGenerateLmsPreviewTokenInput!

The input type with the values used to generate an LMS Preview TokenThe input type with the values used to generate an LMS Preview Token
mapCourseFields : PortalMutationResponse!

Map Course Description Fields from the TMS to Portal

Argument Type Description
input PortalCourseFieldMapInput!

The input type with the values used to map Course Description Fields to a Portal
mapEmailTemplate : PortalMutationResponse!

Map a Communication (Email) Template to a Portal

Argument Type Description
input PortalEmailTemplateMapInput!

The input type with the values used to map a Communication Template to a Portal
mapGiftVoucherConfiguration : PortalMutationResponse!

Map a Gift Voucher Configuration to a Portal

Argument Type Description
input PortalGiftVoucherConfigurationMapInput!

The input type with the values used to map a Gift Voucher Configuration to a Portal
mapPostalCountries : PortalMutationResponse!

Map a list of Postal Countries to a Portal

Argument Type Description
input PortalPostalCountriesMapInput!

The input type with the values used to map Postal Countries to a Portal
removeCustomFieldDefinition : PortalMutationResponse!

Remove a Custom Field Definition from a Portal

Argument Type Description
input PortalToCustomFieldDefinitionLinkInput!

The input type with the values used to link the Custom Field Definition to the Portal
removeEmailTemplateMapping : PortalMutationResponse!

Remove a mapping of a Communication (Email) Template to a Portal

Argument Type Description
input RemovePortalEmailTemplateMapInput!

The input type with the value use to remove the mapping of a Communication Template to a Portal
removeGiftVoucherConfigurationMapping : PortalMutationResponse!

Removes a Gift Voucher Configuration mapping from a portal

Argument Type Description
input PortalGiftVoucherConfigurationMapInputBase!

The details of the configuration to remove
removeIdentityProvider : PortalMutationResponse!

Remove an Identity Provider from a Portal

Argument Type Description
input PortalRemoveIdentityProviderInput!

The input type with the values used to remove an Identity Provider from a Portal
removeWebLinkPaymentProvider : PortalMutationResponse!

Removes a configured Payment Provider

Argument Type Description
input RemoveWebLinkPaymentProviderInput!

The input type with the ID of the Payment Provider to remove
removeWebLinkPaymentProviderDefinitions : PortalMutationResponse!

Remove an Attribute Definition from a WebLink Portal Payment Provider

Argument Type Description
input RemoveWebLinkPaymentProviderDefinitionsInput!

The input type with the values used to remove an Attribute Definition from a WebLink Portal Payment Provider
reorderTrainingRequestWorkflowFields : PortalMutationResponse!

Allows to change the order of the Training Request fields

Argument Type Description
input WebLinkPortalTrainingRequestWorkflowReorderFieldsInput!

New field order configuration
setFeaturedItems : PortalMutationResponse!

Sets certain Catalogue items as featured for a certain Portal, meaning they will get extra visibility on the Catalogue views.

Argument Type Description
input WeblinkPortalSetFeaturedItemsInput!

Details of the items to be displayed as featured
setPortalCategories : PortalMutationResponse!

Set Learning Categories as available to a Portal

Argument Type Description
input PortalLearningCategoryInput!

The input type with the values used to set Learning Categories as available to a Portal
setPortalPriceLevels : PortalMutationResponse!

Set Price Levels as available to a Portal

Argument Type Description
input PortalPriceLevelInput!

The input type with the values used to set Price Levels as available to a Portal
setTrainingRequestWorkflow : PortalMutationResponse!

Set Portal Training Request Workflow configuration

Argument Type Description
input WebLinkPortalSetTrainingRequestWorkflowInput!

The input type with the values used to set the Training Request Workflow configuration
setWebLinkApprovalPaymentProvider : PortalMutationResponse!

Adds an Approval Payment method to a WebLink Portal

Argument Type Description
input WebLinkApprovalPaymentProviderInput!

The input type with the values to configure the Approval payment method
setWebLinkBookingTerms : PortalMutationResponse!

Set booking terms for a Weblink Portal

Argument Type Description
input WebLinkPortalBookingTermsInput!

The input type with the values used to set the Weblink Portal Booking Terms
setWebLinkCheckPaymentProvider : PortalMutationResponse!

Adds the possibility of paying by Check to a WebLink Portal

Argument Type Description
input WebLinkCheckPaymentProviderInput!

The input type with the configuration of the Check payment method
setWebLinkConvergePaymentProvider : PortalMutationResponse!

Add a Converge Payment Provider to a WebLink Portal

Argument Type Description
input WebLinkConvergePaymentProviderInput!

The input type with the values used to set Converge as a Payment Provider on a WebLink Portal
setWebLinkInvoicePaymentProvider : PortalMutationResponse!

Adds the possibility of paying by Invoice to a WebLink Portal

Argument Type Description
input WebLinkInvoicePaymentProviderInput!

The input type with the configuration of the Invoice payment method
setWebLinkMultiSafepayPaymentProvider : PortalMutationResponse!

Add a MultiSafepay Payment Provider to a WebLink Portal

Argument Type Description
input WebLinkMultiSafepayPaymentProviderInput!

The input type with the values used to set MultiSafepay as a Payment Provider on a WebLink Portal
setWebLinkOpportunitySteps : PortalMutationResponse!

Set the Opportunity Steps used by a WebLink Portal

Argument Type Description
input WebLinkPortalOpportunityStepsInput!

The input type with the values used to set the Opportunity Steps on a WebLink Portal
setWebLinkStripePaymentProvider : PortalMutationResponse!

Add a Stripe Payment Provider to a WebLink Portal

Argument Type Description
input WebLinkStripePaymentProviderInput!

The input type with the values used to set Stripe as a Payment Provider on a WebLink Portal
setWebLinkWorldpayPaymentProvider : PortalMutationResponse!

Add a Worldpay Payment Provider to a WebLink Portal

Argument Type Description
input WebLinkWorldpayPaymentProviderInput!

The input type with the values used to set Worldpay as a Payment Provider on a WebLink Portal
update : PortalMutationResponse!

Update the details of a Portal

Argument Type Description
input PortalUpdateInput!

The input type with the values used to update the details of a Portal
updateGiftVoucherConfigurationMapping : PortalMutationResponse!

Updates the details of an existing Portal Gift Voucher configuration mapping

Argument Type Description
input PortalGiftVoucherConfigurationMapUpdateInput!

The input type with the values to update
updateOrderPointOfSaleField : OrderPointOfSaleFieldMutateResponse!

Update an existing Order Point of Sale Field

Argument Type Description
input OrderPointOfSaleFieldUpdateInput!

The input type with the values to be set on the updated Order Point of Sale Field
Back to top

PortalPaymentRegion

A Payment Region attached to a Weblink Portal. Contains the Payment Region and the Payment Providers available to use during checkout within that Payment Region on the Weblink Portal.

currency : Currency!

The Currency of the Payment Region

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
id : ID!

The ID of the Portal Payment Region

paymentProviders : [WebLinkPaymentProvider!]!

The Payment Providers available for the Payment Region

Argument Type Description
filters = [] [WebLinkPaymentProviderFieldGraphFilter]
order = "__EMPTY__" WebLinkPaymentProviderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WebLinkPaymentProviderFieldGraphOrder]
region : Region!

The Region of the Payment Region

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

PortalPostalCountriesMapInput

The input type with the values used to map Postal Countries to a Portal

portalId : ID!

The ID of the Portal to map the Postal Countries to

countryIds : [ID]!

The list of the Country IDs to map to the Portal as Postal Countries

Back to top

PortalPriceLevelInput

The input type with the values used to set Price Levels as available to a Portal

portalId : ID!

The ID of the Portal

priceLevelIds : [ID]!

The list of Price Levels to make available to the Portal

Back to top

PortalRemoveIdentityProviderInput

The input type with the values used to remove an Identity Provider from a Portal

portalId : ID!

The ID of the Portal to remove an Identity Provider from

identityProviderId : ID!

The ID of the Identity Provider to remove from the Portal

Back to top

PortalTerm

The Portal Term for a Weblink Portal

languageCode : String

The Term two letter language code e.g. "en"

text : String!

The Term section text

title : String!

The Term section title

Back to top

PortalToCustomFieldDefinitionLinkInput

The input type with the values used to link a Custom Field Definition with a Portal

portalId : ID!

The ID of the Portal to link the Custom Field Definition to

definitionKey : ID!

The Key of the Custom Field Definition to be linked to the Portal

entityType : SupportsCustomFieldPortalEntities!

The entity type that the Custom Field will be associated with

Back to top

PortalType

Types of Portal

lms
Back to top

PortalTypeField

Portal Fields for Filtering and Ordering

availabilityState
brandId
brandName
hasCredentialsForContactId
id
type
supportsOrderRetrieval
currencyCode
regionId
supportsCurrencyCode
Back to top

PortalUpdateInput

The input type with the values used to update the details of a Portal

portalId : ID!

The ID of the Portal to update

suffix : String

The edited suffix applied to your TMS subdomain to create the URL for the Portal. Can only contain letters, numbers and '-'.

vanityUrl : URL

The edited URL that proxies to the Portal

singleSignOnOnly : Boolean

Denotes whether Contacts are limited to using Single Sign On for this Portal

regionCode : String

The Code of the Region that a WebLink Portal belongs to

currencyCode : String

The Code of the Currency that a WebLink Portal uses

indexable : Boolean

Denotes whether this WebLink Portal is indexable by search engines

taxInclusive : Boolean

Denotes whether this WebLink Portal should display prices inclusive of tax

googleAnalyticsCode : String

The Google Analytics code for this WebLink Portal

defaultErrorMessage : String

The default error message to be used for this WebLink Portal

emptyPortalRedirectUrl : URL

The URL to redirect to if a Contact signs in to the LMS Portal with no content to view

termsAndConditions : String

The Terms & Conditions that can be shown to the user during checkout flow for this WebLink Portal

linkedWebLinkPortalIds : [String]

The IDs of WebLink Portals to be linked to this Portal

confirmEmails : Boolean

Denotes whether the WebLink Portal will display 'Confirm Email' fields on booking forms

autoProvisionLearnersViaSingleSignOn : Boolean

Denotes if new contacts and contact credentials are created when unknown learners log in via SSO

hidePrices : Boolean

Denotes whether the WebLink Portal will hide prices for catalog items

catalogLinkedPortalId : ID

The Optional LMS Portal linked to this WebLink Portal where learners will be redirected to when clicking on a Catalog Item

cartlessCheckout : Boolean

Denotes whether the WebLink Portal will bypass the add to cart step so a course could be purchased directly

isApprovalPortal : Boolean

Denotes whether the LMS Portal facilitates Learners requesting training that requires approval from an Administrator

isBookingPortal : Boolean

Denotes whether the Weblink Portal facilitates Coordinators booking Contacts that they manage onto training

isSelfRegistrationPortal : Boolean

Denotes whether the Weblink Portal facilitates authenticated individuals booking themselves through the LMS

reservationValiditySeconds : Int

Denotes how long event seat reservations will be valid for when items are added to the Weblink Portal's Cart

requireLearnerDetails : Boolean

Denotes whether the WebLink Portal will not require Learner Details to be entered at checkout

requireAuthentication : Boolean

Denotes whether the WebLink Portal is publicly accessible

requireLoginOnCheckout : Boolean

Denotes whether returning users will have to sign In to complete a purchase

hidePricesBeforePricingAgreementApplied : Boolean

Denotes whether the WebLink Portal will hide prices for catalog items before the checkout stage where Pricing Agreements are applied.

showEventsWithNoRemainingPlaces : Boolean

Denotes whether Events with no remaining places should be displayed in the WebLink Portal.

hideCompanyFieldForBooker : Boolean

Denotes whether the Company field should be displayed during the checkout process on the WebLink Portal.

catalogueOverrideUrl : String

Configure an override URL to redirect to on visiting the Catalogue

cartOverrideUrl : String

Configure an override URL to redirect to on visiting the Cart

orderConfirmation : WeblinkPortalOrderConfirmationInput

Default Weblink Order Confirmation details used to email a buyer after booking

cancellationMessage : String

The optional message displayed when attempting to cancel a Booking

transferMessage : String

The optional message displayed when attempting to transfer a Booking

canSelfCheckoutByInvoice : Boolean

Denotes whether the B2B Portal this Weblink Portal is linked to can be used to self-checkout using an Invoice Payment Provider

analyticsConfiguration : PortalAnalyticsConfigurationInput

Any configuration of analytics providers for the Portal

externalOriginsAllowList : [String]

Origin URLs allowed to send events from

splitUnnamedLearners : Boolean

Denotes whether the WebLink Portal will split Unnamed Learners into separate records when registering onto Events

showPrivateTraining : Boolean

Denotes whether the WebLink Portal will show Private Training the User can access via their Account.

Back to top

PostalAddress

A postal address

contactPerson : String

The Contact Person linked to the Address

country : Country

The Country the address is within

label : String

A label identifying the address, for example "shipping", "billing", "default" etc.

lines : [String]!

The first 1 - 3 lines of the address typically including street and street number, ignoring any blank lines.

postcode : String

The postal code or zipcode

province : Province

The State/Province of the Address

region : String

The region, county or state

streetAddress1 : String

The first line of the address, typically unit, street number, or intended recipient

streetAddress2 : String

The second line of the address, typically street/building/residence address

streetAddress3 : String

The third line of the address, typically locality, or further miscellaneous address information

town : String

The city or town

Deprecated fields (2)
city : String

The city or town

Removal date: TBD.

Replaced by town field.

provinceCode : String

The State/Province Code of the Address

Removal date: TBD.

Replaced by province

Back to top

PostalAddressInput

An Input for mutating a PostalAddress

lines : [String]

The first 1 - 3 lines of the address, typically including street and building number

town : String

The town name of the PostalAddress

region : String

The region name of the PostalAddress

postcode : String

The postcode of the PostalAddress

countryId : ID

The ID of the Country of the PostalAddress

provinceCode : String

The code of the State/Province of the PostalAddress

Back to top

PostalAddressWithContactPersonInput

An Input for mutating a PostalAddress on an Account

lines : [String]

The first 1 - 3 lines of the address, typically including street and building number

town : String

The town name of the PostalAddress

region : String

The region name of the PostalAddress

postcode : String

The postcode of the PostalAddress

countryId : ID

The ID of the Country of the PostalAddress

provinceCode : String

The code of the State/Province of the PostalAddress

contactPerson : String

The named Contact Person Details for this Postal Address

Back to top

PriceLevel

A user-definable category of price, for example 'Early Bird'

Related types: Node

description : String

The description of the PriceLevel

expiryOffset : Int

Number of days prior to start date when the price will expire

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the PriceLevel

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the PriceLevel

Back to top

PriceLevelConnection

A connection containing page information and edges for PriceLevel

edges : [PriceLevelEdge!]!

The list of PriceLevel edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PriceLevelCreateInput

The input for creating a Price Level

name : String!
description : String
expiryOffset : Int
Back to top

PriceLevelDeleteInput

The input for deleting a Price Level

priceLevelId : ID!
Back to top

PriceLevelEdge

Contains cursor and node information for type PriceLevel

cursor : String!

A string that can be used for cursor-based pagination

node : PriceLevel!

The PriceLevel node.

Back to top

PriceLevelField

Fields for filtering and ordering PriceLevels

id
name
description
expiryOffset
Back to top

PriceLevelFieldGraphFilter

Filter that can be applied to limit which PriceLevel nodes are returned

field : PriceLevelField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PriceLevelFieldGraphOrder

Specifies the order in which PriceLevel nodes are returned via the Connection

field : PriceLevelField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PriceLevelMutationResponse

A Response for mutating a Price Level

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

priceLevel : PriceLevel

The Price Level that was mutated

Back to top

PriceLevelMutations

Mutations for Price Levels

create : PriceLevelMutationResponse!

Creates a Price Level

Argument Type Description
input PriceLevelCreateInput!
delete : PriceLevelMutationResponse!

Deletes a Price Level

Argument Type Description
input PriceLevelDeleteInput!
update : PriceLevelMutationResponse!

Updates a Price Level

Argument Type Description
input PriceLevelUpdateInput!
Back to top

PriceLevelUpdateInput

The input for updating a Price Level

priceLevelId : ID!
name : String!
description : String
expiryOffset : Int
Back to top

PricingAgreement

Related types: Node

account : Account

The Account with which the Pricing Agreement is associated

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
archivedAt : TimeZonedDateTime

The date and time the Pricing Agreement was archived

end : TimeZonedDateTime!

The date and time the Pricing Agreement ends

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Pricing Agreement

isInheritedByChildAccounts : Boolean!

Whether or not the Pricing Agreement should be inherited by child accounts

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : PricingAgreementLifecycleState!

The lifecycle state of the Pricing Agreement

name : String!

The name of the Pricing Agreement

prices : PricingAgreementPriceConnection!

A list of Prices that are associated with this Pricing Agreement

Argument Type Description
filters = [] [PricingAgreementPriceFieldGraphFilter]
order = "__EMPTY__" PricingAgreementPriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PricingAgreementPriceFieldGraphOrder]
start : TimeZonedDateTime!

The date and time the Pricing Agreement starts

timeZoneName : String!

The Time Zone for the Start and End DateTime to respect for this Pricing Agreement

Back to top

PricingAgreementConnection

A connection containing page information and edges for PricingAgreement

edges : [PricingAgreementEdge!]!

The list of PricingAgreement edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PricingAgreementEdge

Contains cursor and node information for type PricingAgreement

cursor : String!

A string that can be used for cursor-based pagination

node : PricingAgreement!

The PricingAgreement node.

Back to top

PricingAgreementField

Fields for filtering and ordering Pricing Agreements

id
name
accountId
start
end
lifecycleState
isInheritedByChildAccounts
Back to top

PricingAgreementFieldGraphFilter

Filter that can be applied to limit which PricingAgreement nodes are returned

field : PricingAgreementField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PricingAgreementFieldGraphOrder

Specifies the order in which PricingAgreement nodes are returned via the Connection

field : PricingAgreementField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PricingAgreementLifecycleState

An enumeration.

active
archived
Back to top

PricingAgreementPrice

Related types: Node

archivedAt : TimeZonedDateTime

The date and time the Pricing Agreement Price was archived

courseTemplate : CourseTemplate

The CourseTemplate that this Pricing Agreement Price applies to.

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
currencyCode : String!

The currency code of the Pricing Agreement Price

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Pricing Agreement Price

item : StockItem

The Stock Item that this Pricing Agreement Price applies to.

Argument Type Description
filters = [] [StockItemFieldGraphFilter]
order = "__EMPTY__" StockItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StockItemFieldGraphOrder]
learningPath : LearningPath

The Learning Path that this Pricing Agreement Price applies to.

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : PricingAgreementPriceLifecycleState!

The lifecycle state of the Pricing Agreement Price

price : Decimal!

The Price of the Pricing Agreement Price

priceLevel : PriceLevel

The Price Level of this Pricing Agreement price

Argument Type Description
filters = [] [PriceLevelFieldGraphFilter]
order = "__EMPTY__" PriceLevelFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PriceLevelFieldGraphOrder]
pricingAgreement : PricingAgreement!

The Pricing Agreement of this Pricing Agreement Price

Argument Type Description
filters = [] [PricingAgreementFieldGraphFilter]
order = "__EMPTY__" PricingAgreementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PricingAgreementFieldGraphOrder]
region : Region

The Region that this Pricing Agreement Price applies to.

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
sellableType : SellableType!

The type of sellable associated with this Pricing Agreement Price

taxType : TaxType

The Tax Type of the Pricing Agreement

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
Back to top

PricingAgreementPriceConnection

A connection containing page information and edges for PricingAgreementPrice

edges : [PricingAgreementPriceEdge!]!

The list of PricingAgreementPrice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PricingAgreementPriceEdge

Contains cursor and node information for type PricingAgreementPrice

cursor : String!

A string that can be used for cursor-based pagination

node : PricingAgreementPrice!

The PricingAgreementPrice node.

Back to top

PricingAgreementPriceField

Fields for filtering and ordering Pricing Agreement Prices

id
currencyCode
courseTemplateID
regionCode
sellableType
learningPathId
itemId
lifecycleState
priceLevelId
Back to top

PricingAgreementPriceFieldGraphFilter

Filter that can be applied to limit which PricingAgreementPrice nodes are returned

field : PricingAgreementPriceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PricingAgreementPriceFieldGraphOrder

Specifies the order in which PricingAgreementPrice nodes are returned via the Connection

field : PricingAgreementPriceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PricingAgreementPriceLifecycleState

An enumeration.

active
archived
Back to top

PricingBand

Pricing bands are used to categorize the pricing of courses.

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Pricing Band

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Pricing Band

Back to top

PricingBandConnection

A connection containing page information and edges for PricingBand

edges : [PricingBandEdge!]!

The list of PricingBand edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PricingBandEdge

Contains cursor and node information for type PricingBand

cursor : String!

A string that can be used for cursor-based pagination

node : PricingBand!

The PricingBand node.

Back to top

PricingBandField

Fields for filtering and ordering Pricing Bands

id
name
Back to top

PricingBandFieldGraphFilter

Filter that can be applied to limit which PricingBand nodes are returned

field : PricingBandField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PricingBandFieldGraphOrder

Specifies the order in which PricingBand nodes are returned via the Connection

field : PricingBandField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PrivateEventDetailsCreateInput

Additional details required to create Private Events

accountId : ID!

the Account for the Private Event's Registration

regionId : ID!

the Region used for the Private Event's Registration

financialUnitId : ID

the Financial Unit for the Private Event's price (Currency or Training Token)

price : Decimal

the amount for this Event's price. If a pricing agreement exists and matches for this Event, this value will be overridden by the pricing agreement price.

customLocationName : String

the name of the custom location for the Private Event

expectedStudents : Int

the number of expected students for the Private Event

dateContractSent : Date

the date the contract was Sent

dateContractSigned : Date

the date the contract was Signed

Back to top

PrivateEventDetailsUpdateInput

Additional details required to update Private Events

accountId : ID

the Account for the Private Event's Registration

regionId : ID

the Region used for the Private Event's Registration

financialUnitId : ID

the Financial Unit for the Private Event's price (Currency or Training Token)

price : Decimal

the amount for this Event's price

customLocationName : String

the name of the custom location for the Private Event

expectedStudents : Int

the number of expected students for the Private Event

dateContractSent : Date

the date the contract was sent

dateContractSigned : Date

the date the contract was signed

Back to top

PromoCampaignDiscountabilityRulesCreateInput

An input for creating Discountability Rules for a Promotion Campaign

courseIds : [ID]

The Events Courses that will be discounted when a Promotion Code is applied

locationIds : [ID]

The Locations of Events that will be discounted when a Promotion Code is applied

eventIds : [ID]

The Events that will be discounted when a Promotion Code is applied

categoryIds : [ID]

The Categories of an Event that will be discounted when a Promotion Code is applied

associatedAccountIds : [ID]

The Event Course or Learning Path partnered Accounts that will be discounted when a Promotion Code is applied

learningPathIds : [ID]

The Learning Paths that will be discounted when a Promotion Code is applied

courseCustomFieldValues : [CustomFieldValueInput]

The list of Course Custom Field Values will be discounted when a Promotion Code is applied

Back to top

PromoCampaignDiscountabilityRulesUpdateInput

An input for updating Discountability Rules for a Promotion Campaign

courseIds : [ID]

The Events Courses that will be discounted when a Promotion Code is applied

locationIds : [ID]

The Locations of Events that will be discounted when a Promotion Code is applied

eventIds : [ID]

The Events that will be discounted when a Promotion Code is applied

categoryIds : [ID]

The Categories of the Event that will be discounted when a Promotion Code is applied

associatedAccountIds : [ID]

The Event Course or Learning Path partnered Accounts that will be discounted when a Promotion Code is applied

learningPathIds : [ID]

The Learning Paths that will be discounted when a Promotion Code is applied

courseCustomFieldValues : [CustomFieldValueInput]

The list of Course Custom Field Values that will be discounted when a Promotion Code is applied

Back to top

PromoCampaignEligibilityRulesCreateInput

An input for creating Eligibility Rules for a Promotion Campaign

courseIds : [ID]

A list of IDs for Courses that is required in order to apply the Promotion Code

locationIds : [ID]

A list of IDs for Locations that is required in order to apply the Promotion Code

eventIds : [ID]

A list of IDs for Courses that is required in order to apply the Promotion Code

categoryIds : [ID]

A list of IDs for Categories that is required in order to apply the Promotion Code

associatedAccountIds : [ID]

A list of IDs for Accounts associated with a course or a learning path that is required in order to apply the Promotion Code

learningPathIds : [ID]

A list of IDs for Learning Paths that is required in order to apply the Promotion Code

courseCustomFieldValues : [CustomFieldValueInput]

The list of Course Custom Field Values required to apply the Promotion Code

Back to top

PromoCampaignEligibilityRulesUpdateInput

An input for updating Eligibility Rules for a Promotion Campaign

courseIds : [ID]

A list of IDs for Courses that is required in order to apply the Promotion Code

locationIds : [ID]

A list of IDs for Locations that is required in order to apply the Promotion Code

eventIds : [ID]

A list of IDs for Courses that is required in order to apply the Promotion Code

categoryIds : [ID]

A list of IDs for Categories that is required in order to apply the Promotion Code

associatedAccountIds : [ID]

A list of IDs for Accounts associated with a course or learning path that is required in order to apply the Promotion Code

learningPathIds : [ID]

A list of IDs for Learning Paths that is required in order to apply the Promotion Code

courseCustomFieldValues : [CustomFieldValueInput]

The list of Course Custom Field Values required to apply the Promotion Code

Back to top

PromotionCampaign

A Promotion Campaign used for generating promotion codes in bulk

Related types: Node

buyXGetYRules : BuyXGetYRule

The Rules governing the applicability of Buy X Get Y promotions

discount : Discount!

The discount the Promotion Campaign is associated with.

discountabilityRules : [PromotionDiscountabilityRule!]!

The Discountability Rules applied against this Promotion Campaign When a Promotion Campaign code is applied, it is applied only to items that meet all Discountability Rules

eligibilityRules : [PromotionEligibilityRule!]!

The Eligibility Rules applied against this Promotion Campaign A Promotion Campaign code may be applied when all Eligibility Rules are met

expiresAt : Date

The date on which the Promotion Campaign and the codes associated to it become expired.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Promotion Campaign

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : PromotionCampaignLifecycleState!

The lifecycle state of the Discount Promotion Code

minTotalValue : Decimal

The minimum total value of a basket for the promotion code to be applied

name : String!

The name given to the Promotion Campaign.

promotionCodes : DiscountPromotionCodeConnection!

The Promotion Codes belonging to this Promotion Campaign

Argument Type Description
filters = [] [DiscountPromotionCodeFieldGraphFilter]
order = "__EMPTY__" DiscountPromotionCodeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DiscountPromotionCodeFieldGraphOrder]
validFrom : Date

The date from which the Promotion Campaign and the codes associated to it become valid.

Back to top

PromotionCampaignConnection

A connection containing page information and edges for PromotionCampaign

edges : [PromotionCampaignEdge!]!

The list of PromotionCampaign edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PromotionCampaignCreateInput

An input for creating a Promotion Campaign

name : String!

The name given to the Promotion Campaign.

discountType : DiscountType!

The discount type used for the Promotion Campaign (e.g. percentage based, or fixed value discount). Must be provided with discountRate.

discountRate : Decimal!

The value of the discount to apply for the Promotion Campaign. Its true meaning will depend on the discountType. Must be provided with discountType.

discountMaxValue : Decimal

The maximum value of a discount for the Promotion Campaign. It is only valid for percentage based discounts.

validFrom : Date

The date from which the Promotion Campaign and the codes associated to it become valid.

expiresAt : Date

The date on which the Promotion Campaign and the codes associated to it become expired.

deactivatedAt : TimeZonedDateTime

The datetime on which the Promotion Campaign was deactivated.

eligibilityRules : PromoCampaignEligibilityRulesCreateInput

Purchases that satisfy these rules must be present in order to apply the Discount.

discountabilityRules : PromoCampaignDiscountabilityRulesCreateInput

Only purchases that satisfy these rule are able to be discounted.

buyXGetYRules : BuyXGeyYRulesCreateInput

The buy-X-get-Y rules used when applying discounts to purchases.

minTotalValue : Decimal

The minimum total value of a basket for the promotion code to be applied.

Back to top

PromotionCampaignEdge

Contains cursor and node information for type PromotionCampaign

cursor : String!

A string that can be used for cursor-based pagination

node : PromotionCampaign!

The PromotionCampaign node.

Back to top

PromotionCampaignFieldGraphFilter

Filter that can be applied to limit which PromotionCampaign nodes are returned

field : PromotionCampaignTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PromotionCampaignFieldGraphOrder

Specifies the order in which PromotionCampaign nodes are returned via the Connection

field : PromotionCampaignTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PromotionCampaignGenerateCodesInput

An input for generating a Promotion Campaign Codes

campaignId : ID!

the Promotion Campaign ID where the codes will be generated for

redemptionLimit : Int

the maximum number of redemption for each generated Promotion Code

prefix : String

the prefix for the manually generated Promotion Campaign Code string

length : Int

the Promotion Campaign Code string length (excluded the prefix)

quantity : Int

the quantity of generated Promotion Campaign Codes

Back to top

PromotionCampaignLifecycleState

An enumeration.

active
deactivated
expired
inactive
Back to top

PromotionCampaignMutateResponse

A Response from mutating a Promotion Campaign

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

promotionCampaign : PromotionCampaign

The Promotion Campaign that was mutated

Back to top

PromotionCampaignMutations

Mutations for Promotion Campaign

activate : PromotionCampaignMutateResponse!

Activates a Promotion Campaign

Argument Type Description
input PromotionCampaignUpdateActivationInput!

Details of the Promotion Campaign to activate
create : PromotionCampaignMutateResponse!

Creates a Promotion Campaign

Argument Type Description
input PromotionCampaignCreateInput!

The input type with the values to create the Promotion Campaign
deactivate : PromotionCampaignMutateResponse!

Deactivates a Promotion Campaign

Argument Type Description
input PromotionCampaignUpdateActivationInput!

Details of the Promotion Campaign to deactivate
generateCodes : PromotionCampaignMutateResponse!

Generates the Discount Codes associated with the Promotion Campaign

Argument Type Description
input PromotionCampaignGenerateCodesInput!

details about the codes to be generated
update : PromotionCampaignMutateResponse!

Updates a Promotion Campaign

Argument Type Description
input PromotionCampaignUpdateInput!

The input type with the values to be set on the updated Achievement Number Sequence
Back to top

PromotionCampaignTypeField

Fields for filtering and sorting Promotion Campaigns

id
name
lifecycleState
promoCodeValue
Back to top

PromotionCampaignUpdateActivationInput

An input for (de)activating a Promotion Campaign

id : ID!

The ID of the Promotion Campaign being (de)activated

Back to top

PromotionCampaignUpdateInput

An input for updating a Promotion Campaign

id : ID!

The ID of the Promotion Campaign being updated

name : String

The name given to the Promotion Campaign.

validFrom : Date

The date from which the Promotion Campaign and the codes associated to it become valid.

expiresAt : Date

The date on which the Promotion Campaign and the codes associated to it become expired.

deactivatedAt : TimeZonedDateTime

The datetime on which the Promotion Campaign was deactivated.

discountType : DiscountType

The discount type used for the Promotion Campaign (e.g. percentage based, or fixed value discount).

discountRate : Decimal

The value of the discount to apply for the Promotion Campaign. Its true meaning will depend on the discountType.

discountMaxValue : Decimal

The maximum value of a discount for the Promotion Campaign. It is only valid for percentage based discounts.

eligibilityRules : PromoCampaignEligibilityRulesUpdateInput

The Eligibility Rules associated with the Promotion Campaign

discountabilityRules : PromoCampaignDiscountabilityRulesUpdateInput

The Discountability Rules associated with the Promotion Campaign

buyXGetYRules : BuyXGeyYRulesUpdateInput

The buy-X-get-Y rules used when applying discounts to purchases.

minTotalValue : Decimal

The minimum value of a basket for the promotion code to be applied.

Back to top

PromotionCodeApplyInput

An Input to apply a promotion code to an Opportunity

opportunityId : ID!

The ID of the Opportunity to link the promotion code to

promotionCode : String!

The code of a Promotion Code

Back to top

PromotionCodeRemoveInput

An Input to remove a Promotion Code from an Opportunity

opportunityId : ID!

The ID of the Opportunity from which the Promotion Code should be removed

promotionCode : String!

The code of a Promotion Code to remove

Back to top

PromotionCriterionType

The type of Promotion Criterion (e.g. Course, Location, etc)

course
location
event
category
associatedAccount
learningPath
courseCustomField
Back to top

PromotionDiscountabilityRule

Discountability Rule for a Promotion Campaign

Related types: CourseDiscountabilityRule LocationDiscountabilityRule EventDiscountabilityRule CategoryDiscountabilityRule AssociatedAccountDiscountabilityRule LearningPathDiscountabilityRule CourseCustomFieldDiscountabilityRule

type : PromotionCriterionType!

The type of Discountability Rule (e.g. Course, Location, etc)

Back to top

PromotionEligibilityRule

Eligibility Rule for a Promotion Campaign

Related types: CourseEligibilityRule LocationEligibilityRule EventEligibilityRule CategoryEligibilityRule AssociatedAccountEligibilityRule LearningPathEligibilityRule CourseCustomFieldEligibilityRule

type : PromotionCriterionType!

The type of Eligibility Rule (e.g. Course, Location, etc)

Back to top

Province

An administrative subdivision of a nation with a designated ISO code

code : String!

ISO designated province code

countryCode : String!

Country Code of the where the province is

name : String!

Name of the Province

Back to top

PurchaseCreditNote

A Purchase Credit Note

Related types: PurchaseDocument Node

account : Account

The Account associated with this Purchase Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
approvedDate : Date

The date on which the Purchase Document was approved

company : Company

The Company associated with this Purchase Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Purchase Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
date : Date

The tax point date of the Purchase Document

discountAmount : Decimal!

The total amount of discount applied to this Purchase Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Purchase Document (Invoice, Order or Credit Note)

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lines : [PurchaseLine!]!

The line items of the Purchase Document

number : String!

The number of the Purchase Document (e.g. PI123, PO456, PC789)

status : PurchaseDocumentStatus

Payment or allocation status for this Purchase Document

subTotalAmount : Decimal!

The amount of this Purchase Document excluding any Tax or Discount

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Purchase Document

totalAmount : Decimal!

The total amount of this Purchase Document including Tax and Discounts

totalRemaining : Decimal!

Amount of this Purchase Document remaining to pay or allocate

Back to top

PurchaseCreditNoteAllocationInput

The input for allocating a Purchase Credit Note to a Purchase Invoice

purchaseInvoiceId : ID!
purchaseCreditNoteId : ID!
amount : Decimal!
Back to top

PurchaseCreditNoteAllocationMutationResponse

A Response from allocating a Purchase Credit Note to a Purchase Invoice

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

PurchaseCreditNoteConnection

A connection containing page information and edges for PurchaseCreditNote

edges : [PurchaseCreditNoteEdge!]!

The list of PurchaseCreditNote edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PurchaseCreditNoteEdge

Contains cursor and node information for type PurchaseCreditNote

cursor : String!

A string that can be used for cursor-based pagination

node : PurchaseCreditNote!

The PurchaseCreditNote node.

Back to top

PurchaseCreditNoteFieldGraphFilter

Filter that can be applied to limit which PurchaseCreditNote nodes are returned

field : PurchaseCreditNoteTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PurchaseCreditNoteFieldGraphOrder

Specifies the order in which PurchaseCreditNote nodes are returned via the Connection

field : PurchaseCreditNoteTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PurchaseCreditNoteMutations

Mutations for Purchase Credit Notes

allocateToInvoice : PurchaseCreditNoteAllocationMutationResponse!

Allocate a Purchase Credit Note to a Purchase Invoice

Argument Type Description
input PurchaseCreditNoteAllocationInput!
createRefund : PurchasePaymentMutationResponse!

Create a Refund against a Purchase Credit Note

Argument Type Description
input PurchaseRefundInput!
deleteRefund : PurchasePaymentMutationResponse!

Delete a Refund against a Purchase Credit Note

Argument Type Description
input PurchasePaymentDeleteInput!
updateRefund : PurchasePaymentMutationResponse!

Update a Refund against a Purchase Credit Note

Argument Type Description
input PurchaseRefundUpdateInput!
Back to top

PurchaseCreditNoteTypeField

Fields for filtering and ordering Purchase Credit Notes

id
number
date
accountId
companyId
totalRemaining
Back to top

PurchaseDocument

A Purchase Document - one of a Purchase Invoice, Purchase Order or Purchase Credit Note

Related types: PurchaseCreditNote PurchaseInvoice PurchaseOrder PurchasePayment

account : Account

The Account associated with this Purchase Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
approvedDate : Date

The date on which the Purchase Document was approved

company : Company

The Company associated with this Purchase Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Purchase Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
date : Date

The tax point date of the Purchase Document

discountAmount : Decimal!

The total amount of discount applied to this Purchase Document excluding any Tax

id : ID!

The ID of the Purchase Document (Invoice, Order or Credit Note)

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lines : [PurchaseLine!]!

The line items of the Purchase Document

number : String!

The number of the Purchase Document (e.g. PI123, PO456, PC789)

status : PurchaseDocumentStatus

Payment or allocation status for this Purchase Document

subTotalAmount : Decimal!

The amount of this Purchase Document excluding any Tax or Discount

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Purchase Document

totalAmount : Decimal!

The total amount of this Purchase Document including Tax and Discounts

totalRemaining : Decimal!

Amount of this Purchase Document remaining to pay or allocate

Back to top

PurchaseDocumentConnection

A connection containing page information and edges for PurchaseDocument

edges : [PurchaseDocumentEdge!]!

The list of PurchaseDocument edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PurchaseDocumentEdge

Contains cursor and node information for type PurchaseDocument

cursor : String!

A string that can be used for cursor-based pagination

node : PurchaseDocument!

The PurchaseDocument node.

Back to top

PurchaseDocumentFieldGraphFilter

Filter that can be applied to limit which PurchaseDocument nodes are returned

field : PurchaseDocumentTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PurchaseDocumentFieldGraphOrder

Specifies the order in which PurchaseDocument nodes are returned via the Connection

field : PurchaseDocumentTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PurchaseDocumentStatus

Payment or allocation status for Purchase Ledger documents

Unpaid
PartPaid
Paid
Overpaid
Uncleared
Cleared
Unallocated
PartAllocated
Allocated
Back to top

PurchaseDocumentTypeField

Fields for filtering and ordering Purchase Ledger entries

id
number
date
accountId
companyId
type
totalRemaining
Back to top

PurchaseInvoice

A Purchase Invoice

Related types: PurchaseDocument Node

account : Account

The Account associated with this Purchase Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
approvedDate : Date

The date on which the Purchase Document was approved

company : Company

The Company associated with this Purchase Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Purchase Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
date : Date

The tax point date of the Purchase Document

discountAmount : Decimal!

The total amount of discount applied to this Purchase Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Purchase Document (Invoice, Order or Credit Note)

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lines : [PurchaseLine!]!

The line items of the Purchase Document

number : String!

The number of the Purchase Document (e.g. PI123, PO456, PC789)

status : PurchaseDocumentStatus

Payment or allocation status for this Purchase Document

subTotalAmount : Decimal!

The amount of this Purchase Document excluding any Tax or Discount

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Purchase Document

totalAmount : Decimal!

The total amount of this Purchase Document including Tax and Discounts

totalRemaining : Decimal!

Amount of this Purchase Document remaining to pay or allocate

Back to top

PurchaseInvoiceConnection

A connection containing page information and edges for PurchaseInvoice

edges : [PurchaseInvoiceEdge!]!

The list of PurchaseInvoice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PurchaseInvoiceEdge

Contains cursor and node information for type PurchaseInvoice

cursor : String!

A string that can be used for cursor-based pagination

node : PurchaseInvoice!

The PurchaseInvoice node.

Back to top

PurchaseInvoiceFieldGraphFilter

Filter that can be applied to limit which PurchaseInvoice nodes are returned

field : PurchaseInvoiceTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PurchaseInvoiceFieldGraphOrder

Specifies the order in which PurchaseInvoice nodes are returned via the Connection

field : PurchaseInvoiceTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PurchaseInvoiceMutations

Mutations for Purchase Invoices

createPayment : PurchasePaymentMutationResponse!

Create a Payment against a Purchase Invoice

Argument Type Description
input PurchasePaymentInput!
deletePayment : PurchasePaymentMutationResponse!

Delete a Payment against a Purchase Invoice

Argument Type Description
input PurchasePaymentDeleteInput!
updatePayment : PurchasePaymentMutationResponse!

Update a Payment against a Purchase Invoice

Argument Type Description
input PurchasePaymentUpdateInput!
Back to top

PurchaseInvoiceTypeField

Fields for filtering and ordering Purchase Invoices

id
number
date
accountId
companyId
totalRemaining
Back to top

PurchaseLine

A line item of a Purchase Document

description : String

Text which describes what was sold

discount : Discount

The discount applied to each unit

extendedAmount : Decimal!

The amount for all units sold, inclusive of tax

financialAccount : FinancialAccount!

Which account in the Chart of Accounts that line item financial transaction is recorded in

giftVoucher : GiftVoucher

The gift voucher transaction source linked to this line.

id : ID!

The ID of the Invoice

isDiscountable : Boolean!

Whether this line should have invoice discounts applied.

isTaxable : Boolean!

Whether this line should have tax applied.

itemPrice : StockItemPrice

The selected item price used to create this line.

linkedSellable : InterestItem

The Event or Learning Path that is optionally linked to the line for grouping.

quantity : Int!

The number of units which were sold

registerable : Registerable

The Learner or Learning Path Learner associated with this Line Item

Argument Type Description
filters = [] [RegisterableFieldGraphFilter]
order = "__EMPTY__" RegisterableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegisterableFieldGraphOrder]
revenueType : String

The IHT revenue type linked to this line.

sellable : InterestItem

The Interest Item this line represents.

serviceDate : Date

The date of service for the line.

tag : EventTag

The legacy event tag linked to this line.

taxAmount : Decimal!

The amount of tax charged for each unit

taxType : TaxType

The type of tax charged on the line item

tokenTransaction : TrainingTokenTransaction

The token transaction linked to this line.

tokenType : TrainingTokenType

The token type linked to this line.

trainingPassTypeOption : TrainingPassTypeOption

The training pass type option linked to this line.

unitAmount : Decimal!

The price charged for each unit after discount has been applied

value : Decimal!

The original price for each unit without discount or tax

Deprecated fields (1)
linkedEvent : Event

The Event that is optionally linked to the line item

Removal date: TBD.

Replaced by linkedSellable

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
Back to top

PurchaseOrder

A Purchase Order

Related types: PurchaseDocument Node

account : Account

The Account associated with this Purchase Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
approvedDate : Date

The date on which the Purchase Document was approved

company : Company

The Company associated with this Purchase Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Purchase Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
date : Date

The tax point date of the Purchase Document

discountAmount : Decimal!

The total amount of discount applied to this Purchase Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Purchase Document (Invoice, Order or Credit Note)

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lines : [PurchaseLine!]!

The line items of the Purchase Document

number : String!

The number of the Purchase Document (e.g. PI123, PO456, PC789)

status : PurchaseDocumentStatus

Payment or allocation status for this Purchase Document

subTotalAmount : Decimal!

The amount of this Purchase Document excluding any Tax or Discount

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Purchase Document

totalAmount : Decimal!

The total amount of this Purchase Document including Tax and Discounts

totalRemaining : Decimal!

Amount of this Purchase Document remaining to pay or allocate

Back to top

PurchaseOrderConnection

A connection containing page information and edges for PurchaseOrder

edges : [PurchaseOrderEdge!]!

The list of PurchaseOrder edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

PurchaseOrderEdge

Contains cursor and node information for type PurchaseOrder

cursor : String!

A string that can be used for cursor-based pagination

node : PurchaseOrder!

The PurchaseOrder node.

Back to top

PurchaseOrderFieldGraphFilter

Filter that can be applied to limit which PurchaseOrder nodes are returned

field : PurchaseOrderTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

PurchaseOrderFieldGraphOrder

Specifies the order in which PurchaseOrder nodes are returned via the Connection

field : PurchaseOrderTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

PurchaseOrderTypeField

Fields for filtering and ordering Purchase Orders

id
number
date
accountId
companyId
totalRemaining
Back to top

PurchasePayment

A payment row in a Purchase full ledger

Related types: PurchaseDocument Node

account : Account

The Account associated with this Purchase Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
allocations : [PurchasePaymentAllocation!]!

A list describing how this payment is allocated to purchase documents

approvedDate : Date

Payment rows do not have an approved date

clearedOn : Date

The date when the payment cleared

company : Company

The Company associated with this Purchase Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Purchase Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
date : Date

The tax point date of the Purchase Document

discountAmount : Decimal!

The total amount of discount applied to this Purchase Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
financialAccount : FinancialAccount

The Financial Account where the Payment was made

Argument Type Description
filters = [] [FinancialAccountFieldGraphFilter]
order = "__EMPTY__" FinancialAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FinancialAccountFieldGraphOrder]
id : ID!

The ID of the Purchase Document (Invoice, Order or Credit Note)

isRefund : Boolean!

Whether this payment row is a refund

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lines : [PurchaseLine!]!

The line items of the Purchase Document

notes : String

Notes recorded against the payment

number : String!

The number of the Purchase Document (e.g. PI123, PO456, PC789)

paymentMethod : PaymentMethod

Details about how the Payment was made

status : PurchaseDocumentStatus

Clearing status for this payment row

subTotalAmount : Decimal!

The amount of this Purchase Document excluding any Tax or Discount

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Purchase Document

totalAmount : Decimal!

Signed amount for this payment row.

totalRemaining : Decimal!

Payment rows do not carry a remaining document balance.

Back to top

PurchasePaymentAllocation

Details about the allocation of a Purchase Payment to a Purchase Document

amount : Decimal!

The amount covered

id : ID!

The ID of this Allocation

purchaseDocument : PurchaseDocument!

The Purchase Document covered

Argument Type Description
filters = [] [PurchaseDocumentFieldGraphFilter]
order = "__EMPTY__" PurchaseDocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PurchaseDocumentFieldGraphOrder]
Back to top

PurchasePaymentDeleteInput

The input for deleting a Purchase Payment or Refund

paymentId : ID!
Back to top

PurchasePaymentInput

The input for creating a Purchase Invoice Payment

purchaseInvoiceId : ID!
amount : Decimal!
financialAccountId : ID!
paidOn : Date!
paymentMethod : PaymentMethodInput!
clearedOn : Date
notes : String
Back to top

PurchasePaymentMutationResponse

A Response from mutating a Purchase Payment

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

payment : PurchasePayment

The mutated Purchase Payment

Back to top

PurchasePaymentUpdateInput

The input for updating a Purchase Invoice Payment

paymentId : ID!
purchaseInvoiceId : ID
amount : Decimal
financialAccountId : ID
paidOn : Date
clearedOn : Date
notes : String
Back to top

PurchaseRefundInput

The input for creating a Purchase Credit Note Refund

purchaseCreditNoteId : ID!
amount : Decimal!
financialAccountId : ID!
processedOn : Date!
paymentMethod : PaymentMethodInput!
clearedOn : Date
notes : String
Back to top

PurchaseRefundUpdateInput

The input for updating a Purchase Credit Note Refund

paymentId : ID!
purchaseCreditNoteId : ID
amount : Decimal
financialAccountId : ID
processedOn : Date
clearedOn : Date
notes : String
Back to top

RatePerEnum

The rate classification

hour
session
day
course
Back to top

RecordDiscussionCommentInput

An input for recording a discussion comment submitted by a Learner

learnerId : ID!

The ID of the Learner submitting the discussion comment

contentId : ID!

The ID of the Discussion Content

comment : String!

The actual comment submitted by the Learner

completedByAdmin : Boolean

True if manually completed by an Admin

Back to top

RecordExternalContentAccessedInput

An input for recording external content being accessed

learnerId : ID!

The ID of the Learner with the External Activity

contentId : ID!

The ID of the External Activity

completedByAdmin : Boolean

Flag to determine if the content has been marked completed by an Admin

Back to top

RecordExternalProgressInput

An input for recording External progress

attemptId : ID!

The ID of the LMS Attempt to record progress for

status : ExternalActivityStatus!

The status of the External Activity

accompanyingDocumentation : String

Up to 64kb of data to store relevant to this External Activity

Back to top

RecordResourceDownloadInput

An input for recording a resource download

learnerId : ID!

The ID of the Learner downloading the resource

contentId : ID!

The ID of the Content being downloaded

completedByAdmin : Boolean

Flag if the content was manually marked as downloaded by an Admin

Back to top

RecordScormProgressInput

An input for recording SCORM progress

learnerId : ID!

The ID of the Learner progressing the SCORM Content

contentId : ID!

The ID of the Content being progressed

attemptId : ID!

The ID of the LMS Attempt to record progress for

data : String!

The data associated with the SCORM progress

sessionFinished : Boolean

Flag indicating the end of SCORM session (LMSFinish/Terminate call)

completedByAdmin : Boolean

Flag indicating if the SCORM has been manually completed by an Admin

Back to top

RecordVideoProgressInput

An input for recording video progress

learnerId : ID!

The ID of the Learner viewing the Video

contentId : ID!

The ID of the Content being viewed

data : String!

The data associated with the Video progress

completedByAdmin : Boolean

Flag to determine if the content has been marked as completed by an Admin

Back to top

Refund

A Refund recorded in the financial system

Related types: Node

account : Account!

The Account which made the Refund

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
allocations : [RefundCreditNoteAllocation!]!

A list describing how this Refund is allocated to each of the Credit Notes it covers

amount : RefundAmount!

Details about the Refund amount

clearedOn : Date

The date when the Refund was cleared

company : Company!

The Company that received the Refund

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
createdAt : TimeZonedDateTime!

The creation date of the Refund

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
financialAccount : FinancialAccount!

The Financial Account where the Refund was made

Argument Type Description
filters = [] [FinancialAccountFieldGraphFilter]
order = "__EMPTY__" FinancialAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FinancialAccountFieldGraphOrder]
id : ID!

Unique identifier for this Refund

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

notes : String

User inputted notes about the Refund

number : String!

Unique number that identifies the Refund

paymentMethod : PaymentMethod

Details about how the Refund Payment was made

processedOn : Date

The date when the Refund was processed

Back to top

RefundAmount

Details about a Refunds's amount and Currency

amount : Decimal!

The total amount of the Refund

financialUnit : Currency!

The Currency the Refund was made in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
Back to top

RefundConnection

A connection containing page information and edges for Refund

edges : [RefundEdge!]!

The list of Refund edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

RefundCreditNoteAllocation

Details about the allocation of a Refund to an Credit Note

amount : Decimal!

The amount covered

creditNote : CreditNote!

The Credit Note covered

Argument Type Description
filters = [] [CreditNoteFieldGraphFilter]
order = "__EMPTY__" CreditNoteFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CreditNoteFieldGraphOrder]
id : ID!

The ID of this Allocation

Back to top

RefundEdge

Contains cursor and node information for type Refund

cursor : String!

A string that can be used for cursor-based pagination

node : Refund!

The Refund node.

Back to top

RefundFieldGraphFilter

Filter that can be applied to limit which Refund nodes are returned

field : RefundTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

RefundFieldGraphOrder

Specifies the order in which Refund nodes are returned via the Connection

field : RefundTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

RefundTypeField

Fields for filtering and ordering Refunds

id
number
companyId
accountId
processedOn
createdAt
amount
currencyCode
Back to top

Region

Regions are used to create financial zones that you trade in. Regions need not be geographical.

Related types: Node

code : String!

Code of the Region

company : Company

Company of the Region

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
countries : [Country!]!

The Countries linked to a Region

defaultTax : TaxType

The Default Tax for a Region

Argument Type Description
filters = [] [TaxTypeFieldGraphFilter]
order = "__EMPTY__" TaxTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaxTypeFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Region

invoiceNumbering : InvoiceNumberingScheme!

The Invoice Numbering Scheme

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Region

Back to top

RegionConnection

A connection containing page information and edges for Region

edges : [RegionEdge!]!

The list of Region edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

RegionCreateInput

An Input for Creating a Region

code : String!

The Code of the Region

name : String!

The name of the Region

companyId : ID!

Company ID linked to the Region

invoiceNumbering : InvoiceNumberingSchemeInput

Invoice numbering type name linked to a Region

defaultTaxTypeId : ID

Tax Type ID linked to the Region

countryIds : [ID]

IDs of countries mapped to this Region

Back to top

RegionEdge

Contains cursor and node information for type Region

cursor : String!

A string that can be used for cursor-based pagination

node : Region!

The Region node.

Back to top

RegionField

Fields for filtering and ordering Regions

id
name
code
companyId
Back to top

RegionFieldGraphFilter

Filter that can be applied to limit which Region nodes are returned

field : RegionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

RegionFieldGraphOrder

Specifies the order in which Region nodes are returned via the Connection

field : RegionField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

RegionMutationResponse

A Response for a Region Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

region : Region

The region that was updated

Back to top

RegionMutations

Available Mutations on a Region

create : RegionMutationResponse!

Create a Region

Argument Type Description
input RegionCreateInput!

The input type with the values to create a Region
Back to top

Registerable

Related types: LearningPathLearner Learner

achievements : AchievementConnection

The Achievement earned by the Learner

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
brandId : String

The brandId for this Registerable

contactId : String

The Learner or LearningPathLearner's contact ID

id : ID!

The ID of the Registerable

isActive : Boolean!

The Learner or LearningPathLearner's active status

isCancelled : Boolean!

The Learner or LearningPathLearner's cancelled status

lmsLastAccessed : TimeZonedDateTime

The last datetime a Learner or LearningPathLearner accessed the LMS

lmsTitle : String

The Title to show on the LMS for this Registerable

passAccessExpired : Boolean!

If registration was made via a TrainingPass, confirms access is still available

registrationId : String

The Learner or LearningPathLearner's registration ID

trackingIdentifier : String

An External Identifier to identify this Registerable instead of Contact

Deprecated fields (1)
achievement : Achievement

The Achievement earned by the Learner

Removal date: TBD.

Reason 
Please use achievements field instead.

This field is no longer supported after the introduction of
the multiple achievements
 |

| Removal Date | TBD | | Deprecation Date | TBD |

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
Back to top

RegisterableConnection

A connection containing page information and edges for Registerable

edges : [RegisterableEdge!]!

The list of Registerable edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

RegisterableEdge

Contains cursor and node information for type Registerable

cursor : String!

A string that can be used for cursor-based pagination

node : Registerable!

The Registerable node.

Back to top

RegisterableFieldGraphFilter

Filter that can be applied to limit which Registerable nodes are returned

field : RegisterableTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

RegisterableFieldGraphOrder

Specifies the order in which Registerable nodes are returned via the Connection

field : RegisterableTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

RegisterableTypeField

Fields for filtering and ordering Registerables

id
isActive
contactId
hasParent
hasEventEnded
isCancelled
isComplete
brandId
lmsLastAccessed
lmsTitle
registrationId
trackingIdentifier
passAccessExpired
Back to top

RegisterAnonymousLearnerInput

An Input for registering an anonymous learner on an Event

trackingId : String!

The Identifier for the anonymous Learner to be registered.

brandId : ID!

The ID of the Brand for the Registration.

Back to top

RegisterLearnerResponse

A response from registering a Learner on an Event

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learner : Learner

The Learner that was registered on the Event or None in case of registration error

Back to top

RegisterPassholderInput

An Input for registering a training passholder on an Event

eventId : ID!

The ID of the Event to create a Registration for.

trainingPassId : ID!

The ID of the held Training Pass to be used for Registration.

brandId : ID!

The ID of the Brand for the Registration.

Back to top

Registration

An order used to purchase training and materials

Related types: Node

account : Account

The Account responsible for the order, who will receive the invoice if one is created

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
billableItems : [RegistrationItem!]

The Billable Items of the Registration

bookingContact : Contact

The Contact that is responsible for this Registration

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
brand : Brand

Brand used by the Registration.

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
company : Company

Company that owns the Registration.

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
createdAt : LocalDateTime

Datetime the Registration was created at

currency : Currency

The Currency of the Registration

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
discount : Discount

Discount applied to the Registration.

Argument Type Description
filters = [] [DiscountFieldGraphFilter]
order = "__EMPTY__" DiscountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DiscountFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Registration

invoiceId : String

ID of the Invoice linked to this Registration, if any.

invoiceIssued : Boolean!

Flag to show if Invoice for Registration has been issued

invoicePaid : Boolean!

Flag to show if Invoice for Registration has been paid

lastUpdatedAt : LocalDateTime

Datetime the Registration was last updated

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

notes : String

Notes recorded against the Registration.

orderDate : LocalDateTime

Order date of the Registration

project : AccountProject

The Project associated with this Registration

Argument Type Description
filters = [] [AccountProjectFieldGraphFilter]
order = "__EMPTY__" AccountProjectFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountProjectFieldGraphOrder]
region : Region

The Region the Registration was created for

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
registerables : RegisterableConnection!

The Registerables of the Registrations

Argument Type Description
filters = [] [RegisterableFieldGraphFilter]
order = "__EMPTY__" RegisterableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegisterableFieldGraphOrder]
registrationNumber : String

A number other than the automatically generated unique ID used to reference the registration

salesDocument : SalesDocument

The Sales Document of the Registration

Argument Type Description
filters = [] [InvoiceFieldGraphFilter]
order = "__EMPTY__" InvoiceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InvoiceFieldGraphOrder]
sourceOpportunity : Opportunity

The Opportunity that triggered the Registration

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
tokenType : TrainingTokenType

Training Token Type used to pay for the Registration.

Argument Type Description
filters = [] [TrainingTokenTypeFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTypeFieldGraphOrder]
total : Decimal

Total price of the Registration

trainingPassType : TrainingPassType

The Training Pass Type used for payment of the Registration

Argument Type Description
filters = [] [TrainingPassTypeFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeFieldGraphOrder]
Deprecated fields (1)
regionId : String

The ID of the Region the Registration was created for

Removal date: TBD.

Replaced by region

Back to top

RegistrationActionResponse

Result of an action on a Registration or one of its Registerables.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

RegistrationConnection

A connection containing page information and edges for Registration

edges : [RegistrationEdge!]!

The list of Registration edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

RegistrationCreateForAccountInput

An Input for creating a Registration for an Account

accountId : ID!
regionId : ID!
financialUnitId : ID!
bookingContactId : ID
brandId : ID
trainingPassId : ID
notes : String
orderDate : LocalDateTime
discountId : ID
Back to top

RegistrationCreateForAccountResponse

A Response for creating a Registration

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

registration : Registration

The Registration that was created

Back to top

RegistrationDeadlineOffset

A registration time offset described by a duration and context (e.g. 1 day 'after start')

context : RegistrationDeadlineOffsetContext!

Offset context

unit : ScheduleDuration!

Offset unit

value : Int!

Offset value

Back to top

RegistrationDeadlineOffsetContext

An enumeration.

before_start
after_start
before_end
Back to top

RegistrationDeadlineOffsetInput

value : Int!
Back to top

RegistrationDeleteInput

An Input for deleting a Registration

registrationId : ID!
Back to top

RegistrationDeleteResponse

A Response for deleting a Registration

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

registration : Registration

The Registration that was deleted

Back to top

RegistrationDetailsUpdateInput

Registration detail values to update.

registrationId : ID!
accountId : ID
registrationNumber : String
orderDate : LocalDateTime
notes : String
regionId : ID
brandId : ID
financialUnitId : ID
Back to top

RegistrationEdge

Contains cursor and node information for type Registration

cursor : String!

A string that can be used for cursor-based pagination

node : Registration!

The Registration node.

Back to top

RegistrationField

Fields for filtering and ordering Events

id
account
orderDate
registrationNumber
total
projectId
invoicePaid
createdAt
lastUpdatedAt
Back to top

RegistrationFieldGraphFilter

Filter that can be applied to limit which Registration nodes are returned

field : RegistrationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

RegistrationFieldGraphOrder

Specifies the order in which Registration nodes are returned via the Connection

field : RegistrationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

RegistrationIdInput

Identifies a Registration.

registrationId : ID!
Back to top

RegistrationItem

An Item on a Registration

Related types: RegistrationPrivateEvent RegistrationPrivateLearningPath RegistrationStockItem

description : String

The Description of the Registration Item

id : ID!

The ID of the Registration Item

name : String!

The Name of the Registration Item

price : Decimal!

The Price of the Registration Item

quantity : Int!

The Quantity of the Registration Item

total : Decimal!

The Total Amount of the Registration Item

Back to top

RegistrationLearnerIdInput

Identifies an Event Learner.

learnerId : ID!
Back to top

RegistrationLearnerReissueInvoiceInput

Identifies an Event Learner and its replacement invoice amount.

learnerId : ID!
amount : Decimal!
Back to top

RegistrationMutations

Available Mutations on a Registration

createFollowUpInvoiceForLearner : RegistrationActionResponse!

Create a follow-up Invoice for an Event Learner's Invoice line.

Argument Type Description
input RegistrationLearnerIdInput!
createForAccount : RegistrationCreateForAccountResponse!

Create a Registration for an Account

Argument Type Description
input RegistrationCreateForAccountInput!

The input type with the account to create the Registration for
createInvoice : RegistrationActionResponse!

Create an Invoice from a Registration.

Argument Type Description
input RegistrationIdInput!
delete : RegistrationDeleteResponse!

Delete an uninvoiced Registration

Argument Type Description
input RegistrationDeleteInput!

The input type with the Registration to be deleted
redeemTokens : RegistrationActionResponse!

Redeem Training Tokens for a Registration.

Argument Type Description
input RegistrationIdInput!
registerLearner : RegistrationUpdateResponse!

Register a Contact as a Learner on a Registration

Argument Type Description
input RegistrationRegisterLearnerInput!

The input type with the contact to be registered on the Registration as a Learner
registerUnnamedLearners : RegistrationUpdateResponse!

Register unnamed Learners on a Registration

Argument Type Description
input RegistrationRegisterUnnamedLearnerInput!

The input type with a quantity (default 1) of unnamed Learners to add to the Registration
reissueInvoiceForLearner : RegistrationActionResponse!

Credit and reissue an Event Learner's Invoice at a new amount.

Argument Type Description
input RegistrationLearnerReissueInvoiceInput!
update : RegistrationUpdateResponse!

Update a Registration

Argument Type Description
input RegistrationUpdateInput!

The input type with the registration to be updated
updateDetails : RegistrationActionResponse!

Update fields displayed on a Registration detail page.

Argument Type Description
input RegistrationDetailsUpdateInput!
updateRegisterable : RegistrationActionResponse!

Update a Learner or Learning Path Learner on a Registration.

Argument Type Description
input RegistrationRegisterableUpdateInput!
Back to top

RegistrationPrivateEvent

A billable event on a Registration

Related types: RegistrationItem

description : String

The Description of the Registration Item

event : Event

The Private Event related to the Registration

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
id : ID!

The ID of the Registration Item

name : String!

The Name of the Registration Item

price : Decimal!

The Price of the Registration Item

quantity : Int!

The Quantity of the Registration Item

total : Decimal!

The Total Amount of the Registration Item

Back to top

RegistrationPrivateLearningPath

A billable Learning Path on a Registration

Related types: RegistrationItem

description : String

The Description of the Registration Item

id : ID!

The ID of the Registration Item

learningPath : LearningPath

The Private Learning Path related to the Registration

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
name : String!

The Name of the Registration Item

price : Decimal!

The Price of the Registration Item

quantity : Int!

The Quantity of the Registration Item

total : Decimal!

The Total Amount of the Registration Item

Back to top

RegistrationRegisterableUpdateInput

Registration-specific values to update on a Registerable.

registerableId : ID!
notes : String
quantity : Int
amount : Decimal
taxTypeId : ID
Back to top

RegistrationRegisterLearnerInput

An Input for registering a Contact on a Registration

registrationId : ID!
eventId : ID!
contactId : ID!
brandId : ID
notes : String
priceLevelId : ID
pricingAgreementPriceId : ID
amount : Decimal
taxTypeId : ID
Back to top

RegistrationRegisterUnnamedLearnerInput

An Input for registering a defined quantity of unnamed Learners

registrationId : ID!
eventId : ID!
notes : String
amount : Decimal
taxTypeId : ID
quantity : Int
Back to top

RegistrationRule

Automatic Learning Path Registration Rules

Related types: Node

activatedAt : TimeZonedDateTime

The date and time when the Rule was activated if it is active

affectedContacts : ContactConnection!

Contacts affected by the Registration Rule

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
archivedAt : TimeZonedDateTime

The date and time when the Rule was archived if it is archived

createdAt : TimeZonedDateTime!

The date and time when the Rule was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Rule

jobRoles : JobRoleConnection!

Job Roles associated with the Registration Rule

Argument Type Description
filters = [] [JobRoleFieldGraphFilter]
order = "__EMPTY__" JobRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [JobRoleFieldGraphOrder]
learningPaths : LearningPathConnection!

Learning Paths associated with the Registration Rule

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Rule

status : RegistrationRuleStatus!

Whether the Rule is active, draft, or archived

updatedAt : TimeZonedDateTime!

The date and time when the Rule was last updated

workplaces : WorkplaceConnection!

Workplaces associated with the Registration Rule

Argument Type Description
filters = [] [WorkplaceFieldGraphFilter]
order = "__EMPTY__" WorkplaceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WorkplaceFieldGraphOrder]
Back to top

RegistrationRuleArchiveInput

An Input for archiving a Registration Rule

registrationRuleId : ID!

The id of the Registration Rule to archive

Back to top

RegistrationRuleConnection

A connection containing page information and edges for RegistrationRule

edges : [RegistrationRuleEdge!]!

The list of RegistrationRule edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

RegistrationRuleCreateInput

The input for creating a Learning Path Automatic Registration Rule

name : String!

The name of the Registration Rule to be created

jobRoleIds : [ID]

An optional list of Job Role IDs which will be used to match Contacts to this Registration Rule

learningPathIds : [ID]

An optional list of Learning Path IDs to automatically register Contacts onto

workplaceIds : [ID]

An optional list of Workplace IDs which will be used to match Contacts to this Registration Rule

addTriggerJob : Boolean

Optionally adds a job to the rule trigger queue to run the rule against the affected Contacts.

Back to top

RegistrationRuleDeleteInput

An Input for deleting a Registration Rule

registrationRuleId : ID!

The id of the Registration Rule to delete

Back to top

RegistrationRuleEdge

Contains cursor and node information for type RegistrationRule

cursor : String!

A string that can be used for cursor-based pagination

node : RegistrationRule!

The RegistrationRule node.

Back to top

RegistrationRuleField

Fields for filtering and ordering Registration Rules

id
name
workplaceId
jobRoleId
learningPathId
status
Back to top

RegistrationRuleFieldGraphFilter

Filter that can be applied to limit which RegistrationRule nodes are returned

field : RegistrationRuleField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

RegistrationRuleFieldGraphOrder

Specifies the order in which RegistrationRule nodes are returned via the Connection

field : RegistrationRuleField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

RegistrationRuleMutationResponse

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

registrationRule : RegistrationRule

The Learning Path Automatic Registration Rule created by the mutation

Back to top

RegistrationRuleMutations

archive : RegistrationRuleMutationResponse!

Archive a Registration Rule

Argument Type Description
input RegistrationRuleArchiveInput!
create : RegistrationRuleMutationResponse!

Create a new Learning Path Automatic Registration Rule

Argument Type Description
input RegistrationRuleCreateInput!
delete : RegistrationRuleMutationResponse!

Delete a Registration Rule

Argument Type Description
input RegistrationRuleDeleteInput!
publish : RegistrationRuleMutationResponse!

Publish a Registration Rule

Argument Type Description
input RegistrationRulePublishInput!
unarchive : RegistrationRuleMutationResponse!

Unarchive a Registration Rule

Argument Type Description
input RegistrationRuleUnarchiveInput!
update : RegistrationRuleMutationResponse!

Update a Registration Rule

Argument Type Description
input RegistrationRuleUpdateInput!
Back to top

RegistrationRulePublishInput

An Input for publishing a Registration Rule

registrationRuleId : ID!

The id of the Registration Rule to publish

addTriggerJob : Boolean

Optionally adds a job to the rule trigger queue to run the rule against the affected Contacts.

Back to top

RegistrationRuleStatus

The current Status of the Registration Rule

ACTIVE
DRAFT
ARCHIVED
Back to top

RegistrationRuleUnarchiveInput

An Input for unarchiving a Registration Rule

registrationRuleId : ID!

The id of the Registration Rule to unarchive

addTriggerJob : Boolean

Optionally adds a job to the rule trigger queue to run the rule against the affected Contacts.

Back to top

RegistrationRuleUpdateInput

The input for updating a Learning Path Automatic Registration Rule

registrationRuleId : ID!
name : String
jobRoleIds : [ID]
learningPathIds : [ID]
workplaceIds : [ID]
addTriggerJob : Boolean
Back to top

RegistrationStockItem

A billable Stock Item on a Registration

Related types: RegistrationItem

description : String

The Description of the Registration Item

id : ID!

The ID of the Registration Item

name : String!

The Name of the Registration Item

price : Decimal!

The Price of the Registration Item

quantity : Int!

The Quantity of the Registration Item

stockItem : StockItem

The Stock Item related to the Registration

Argument Type Description
filters = [] [StockItemFieldGraphFilter]
order = "__EMPTY__" StockItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StockItemFieldGraphOrder]
total : Decimal!

The Total Amount of the Registration Item

Back to top

RegistrationUpdateInput

An Input for updating a Registration

registrationId : ID!
bookingContactId : ID
accountId : ID
orderDate : LocalDateTime
Back to top

RegistrationUpdateResponse

A Response for updating a Registration

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

registration : Registration

The Registration that was updated

Back to top

RemoteMeeting

A Remote Meeting that can be used to attend classes virtually

id : String

The ID that may be assigned to the remote meeting by the remote meeting vendor

type : RemoteMeetingTypes

The type of remote meeting (e.g. "zoom", "skype", etc)

url : String

The URL used to attend the remote meeting

Back to top

RemoteMeetingProvider

A Remote Meeting Provider that can be used to schedule virtual meetings.

hasServiceUser : Boolean!

Whether the webhook for this provider has been configured with a service user (service_user_email or service_user_id). When true, the meeting host does not need to be manually specified.

status : RemoteMeetingProviderStatus!

The status of the Remote Meeting Provider (active if configured, inactive otherwise)

type : String!

The type of the Remote Meeting Provider (e.g., "zoom", "msteams", "msteams_live_event")

Back to top

RemoteMeetingProviderStatus

The status of a Remote Meeting Provider

active

The provider is configured and ready to use.

inactive

The provider is not configured.

Back to top

RemoteMeetingType

An enumeration.

custom
zoom
msteams
msteams_live_event
Back to top

RemoteMeetingTypes

An enumeration.

custom
zoom
msteams
msteams_live_event
Back to top

RemoveBrandIdentityProviderConfigurationInput

An Input for removing an Identity Provider configuration

brandId : ID!

The ID of the Brand of the configuration to remove

identityProviderId : ID!

The ID of the Identity Provider of the configuration to remove

Back to top

RemoveCalendarsInput

An input for removing an Entity's calendar.

entityId : ID!

The ID of the Administrate Entity the calendar is connected to (at the moment, only Contact IDs are supported)

calendarType : String!

the Calendar Type to be removed

calendarId : ID!

the ID of the calendar to be removed

Back to top

RemoveCalendarsResponse

The response to a request to remove Entity connected calendars

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

RemoveCreditNoteAllocationResponse

A Response from removing a Credit Note allocation from an Invoice

Related types: MutationResponse

allocation : InvoiceCreditNoteAllocation

The allocation that was removed

errors : [FieldError!]!

The errors returned by the mutation

invoice : Invoice

The updated Invoice after the allocation was removed

Back to top

RemoveEventStaffInput

An Input for removing existing Staff from an Event

staffId : ID!

The ID of the staff to be removed from the Event.

notifyStaff : Boolean

Boolean to indicate whether to notify Staff of removal via email, defaults to False

Back to top

RemovePortalEmailTemplateMapInput

The input type with the value use to remove the mapping of a Communication Template to a Portal

portalId : ID!

The Id of the Portal to remove its mapping to a Communication Template

emailTemplateId : ID!

The ID of the Communication Template to remove its mapping to a Portal

Back to top

RemoveRoomCalendarsInput

An input for removing a Room Calendar

calendarId : String!

ID for the Resource Calendars to be deleted

Back to top

RemoveStaffRoleInput

An input for removing a batch of Staff Roles

staffRoleId : ID!

the ID of the Staff Role to remove

Back to top

RemoveWebLinkPaymentProviderDefinitionsInput

The input type with the values used to remove Attribute Definitions from a WebLink Portal Payment Provider

portalId : ID!

The ID of the WebLink Portal

paymentProviderType : WebLinkPaymentProviderType!

The type of the WebLink Portal Payment Provider

definitionKeys : [ID]!

The identifiers for the Attribute Definitions to remove from the Payment Provider

Back to top

RemoveWebLinkPaymentProviderInput

The Input type for Removing a WebLink Payment Provider

paymentProviderId : String!

The ID of the Payment Provider to remove.

Back to top

Report

A saved report definition

Related types: Node

company : Company

The Company the Report belongs to, null for all companies

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
filteredEntity : String

The root entity the Report is filtered on

id : ID!

ID of the Report

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Report

owner : User

The User that owns the Report, null when unowned

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

ReportConnection

A connection containing page information and edges for Report

edges : [ReportEdge!]!

The list of Report edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ReportEdge

Contains cursor and node information for type Report

cursor : String!

A string that can be used for cursor-based pagination

node : Report!

The Report node.

Back to top

ReportField

Fields for filtering and ordering Reports

id
name
filteredEntity
ownerId
companyId
Back to top

ReportFieldGraphFilter

Filter that can be applied to limit which Report nodes are returned

field : ReportField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ReportFieldGraphOrder

Specifies the order in which Report nodes are returned via the Connection

field : ReportField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

RepriceOpportunityInput

An Input to recalculate the prices on an Opportunity and its associated Interests

opportunityId : ID!

The ID of the Opportunity to recalculate the prices on

Back to top

ReservePlacesForEventInterestInput

An Input to reserve places on an Event from an Opportunity Event Interest

interestId : ID!

The ID of the Opportunity Event Interest to reserve places for

Back to top

ReservePlacesForInterestsInput

An Input to reserve places on Events from Opportunity Event or Learning Path Interests

interestIds : [ID]!

List of IDs of the Opportunity Event or Learning Path Interests to reserve places for

Back to top

Resource

A reusable asset that may be booked to meet training needs

Related types: Node

bookings : ResourceBookingConnection

ResourceBookings belonging to this Resource

Argument Type Description
filters = [] [ResourceBookingFieldGraphFilter]
order = "__EMPTY__" ResourceBookingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceBookingFieldGraphOrder]
calendarIntegrations : [CalendarIntegration!]

The Calendar Integrations configured for this Resource

Argument Type Description
status [CalendarIntegrationStatus]

only include integrations in the provided status
capacity : Int

Capacity of resource

customFieldValues : [CustomFieldValue!]!

Custom Field values for this Resource

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Resource

isOutOfService : Boolean!

Is the Resource out of service

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

location : Location

Location of the Resource

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
name : String

Name of the Resource

type : ResourceType

Type of the Resource

Argument Type Description
filters = [] [ResourceTypeFieldGraphFilter]
order = "__EMPTY__" ResourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceTypeFieldGraphOrder]
Deprecated fields (1)
custom : [CustomField!]!

Custom Fields of the Resource

Removal date: TBD.

Replaced by customFieldValues

Back to top

ResourceAttempt

Related types: LmsAttempt Node

completedAt : TimeZonedDateTime

The date and time when the Attempt was completed

completedByAdmin : Boolean!

Whether the Attempt has been manually completed by an Admin

content : LmsContent!

The Attempt's Content

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Attempt

isCompleted : Boolean!

Whether the Attempt has been completed

isPassed : Boolean!

Whether the Attempt has been passed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

updatedAt : TimeZonedDateTime

The date and time when the Attempt was updated

Back to top

ResourceBooking

An allocation of a Resource to an Event or Session

Related types: Node

bookingReason : ResourceBookingReason

The reason for the Resource Booking

Argument Type Description
filters = [] [ResourceBookingReasonFieldGraphFilter]
order = "__EMPTY__" ResourceBookingReasonFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceBookingReasonFieldGraphOrder]
bookingType : ResourceBookingType!

The type of booking this entity represents

conflictingBookings : [ResourceBooking!]!

List of Resource Bookings for the smae resource that overlap this Booking.

details : String

Details about the Resource Booking

end : LocalDateTime!

Date and time the ResourceBooking ends

externalIdentifier : String

The identifier this booking has in the external calendar it came from. Only set on a booking of type external; every other kind of booking originates in Administrate and has none.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the ResourceBooking

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

resource : Resource!

The Resource which is being booked

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
session : Session

The Session for which the Resource is booked

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
sourceIdentifier : String

The identifier of the external calendar this booking was imported from. Only set on a booking of type external; every other kind of booking originates in Administrate and has none.

start : LocalDateTime!

Date and time the ResourceBooking starts

timeZone : String

Time zone of the ResourceBooking

timeZonedEnd : TimeZonedDateTime

Date and time the ResourceBooking ends with time zone information

timeZonedStart : TimeZonedDateTime

Date and time the ResourceBooking starts with time zone information

title : String

A descriptive title for this Resource booking

Back to top

ResourceBookingBulkDeleteResponse

A response from bulk removing a number of Resource Bookings

Related types: MutationResponse

count : Int!

The number of removed Resource Bookings

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ResourceBookingBulkMutateResponse

A response from a bulk mutation of a number of Resource Bookings

Related types: MutationResponse

entityIds : [ID!]!

The entity IDs that were inserted or updated

errors : [FieldError!]!

The errors returned by the mutation

Back to top

ResourceBookingConflictIssue

A Resource booked on a Session is booked for something else at the same time

Related types: ResourceIssue

bookingId : ID

The Resource's own booking on the Session, or null when the issue was reported for a Resource that is not booked on the Event yet

category : ResourceIssueCategory!

The category this issue belongs to, used for client-side filtering

conflict : ResourceBooking!

The booking that clashes with this Session

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the booking. Count the entries where this is false: that is what ResourceIssueGroup.issueCount reports and what every badge in Administrate shows.

resourceId : ID!

The ID of the Resource with the clash

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [ResourceIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

ResourceBookingConnection

A connection containing page information and edges for ResourceBooking

edges : [ResourceBookingEdge!]!

The list of ResourceBooking edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ResourceBookingCreateStandaloneInput

An Input for creating a Standalone Resource Booking

bookingReasonId : ID!

The ID of the Resource Booking Reason

resourceId : ID!

The ID of the Resource being booked

start : LocalDateTime!

The booking start time

end : LocalDateTime!

The booking end time

timeZone : String!

The booking timezone

details : String

The booking details

Back to top

ResourceBookingDeleteInput

An Input for deleting a Resource Booking or Standalone Resource Booking

resourceBookingId : ID!

The ID of the Resource Booking to be deleted

Back to top

ResourceBookingEdge

Contains cursor and node information for type ResourceBooking

cursor : String!

A string that can be used for cursor-based pagination

node : ResourceBooking!

The ResourceBooking node.

Back to top

ResourceBookingField

Fields for filtering and ordering ResourceBookings

id
bookingType
end
eventId
rangeInEventId
rangeInRequirementsForEventId
resourceId
sessionId
start
timeZone
timeZonedEnd
timeZonedStart
includePlans
planId
rangeInEventNeedId
rangeInRequirementsForEventNeedId
eventNeedId
Back to top

ResourceBookingFieldGraphFilter

Filter that can be applied to limit which ResourceBooking nodes are returned

field : ResourceBookingField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ResourceBookingFieldGraphOrder

Specifies the order in which ResourceBooking nodes are returned via the Connection

field : ResourceBookingField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ResourceBookingMutateResponse

A response from Resource Booking Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

resourceBooking : ResourceBooking

A Resource Booking that has been mutated

Back to top

ResourceBookingMutations

Mutations for a Resource Booking

assignExternalBookings : ResourceBookingBulkMutateResponse!

Adds External Calendar Events for a contact

Argument Type Description
input [ExternalResourceBookingInput]!

A List of inputs for the external resource bookings to be created
createEvent : ResourceBookingBulkMutateResponse!

Creates a booking for the specified Resource on all the Sessions of an Event, or only the Sessions that require the Resource type. Bookings will start and end at the Session start and end times respectively.

Argument Type Description
input [CreateEventBookingInput]!
createSession : ResourceBookingBulkMutateResponse!

Creates a booking for the specified Resource on the specified Session, specifying optional start and end times if they differ from the Session's.

Argument Type Description
input [CreateSessionBookingInput]!
createStandalone : ResourceBookingMutateResponse!

Creates a Standalone Resource Booking

Argument Type Description
input ResourceBookingCreateStandaloneInput!

The input type with values used to create a Standalone Resource Booking
delete : ResourceBookingMutateResponse!

Deletes a Resource Booking for an Event

Argument Type Description
input ResourceBookingDeleteInput!

The input type with values used to delete a Resource Booking
deleteExternalBookings : ResourceBookingBulkDeleteResponse!

Removes external bookings in bulk for a given resource and source identifier, optionally restricted to specific booking IDs.

Argument Type Description
input [ExternalResourceBookingDeleteInput]!
updateExternalBookings : ResourceBookingBulkMutateResponse!

Updates existing external resource bookings

Argument Type Description
input [ExternalResourceBookingUpdateInput]!

A List of inputs for the external resource bookings to be updated
updateSession : ResourceBookingBulkMutateResponse!

Updates bookings of Resources on event Sessions to change start or end times or update the booking details.

Argument Type Description
input [UpdateSessionBookingInput]!
updateStandalone : ResourceBookingMutateResponse!

Updates a Standalone Resource Booking

Argument Type Description
input ResourceBookingUpdateStandaloneInput!

The input type with values used to update a Standalone Resource Booking
Back to top

ResourceBookingReason

A Reason that can be associate with a Resource Booking

Related types: Node

createdAt : TimeZonedDateTime!

The Date and Time the Resource Booking Reason was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Resource Booking Reason

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Resource Booking Reason

updatedAt : TimeZonedDateTime!

The Date and Time the Resource Booking Reason was last updated

Back to top

ResourceBookingReasonConnection

A connection containing page information and edges for ResourceBookingReason

edges : [ResourceBookingReasonEdge!]!

The list of ResourceBookingReason edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ResourceBookingReasonCreateInput

An Input for creating a Resource Booking Reason

name : String!

The Resource Booking Reason name

Back to top

ResourceBookingReasonDeleteInput

An Input for deleting a Resource Booking Reason

resourceBookingReasonId : ID!

The ID of the Resource Booking Reason to be deleted

Back to top

ResourceBookingReasonEdge

Contains cursor and node information for type ResourceBookingReason

cursor : String!

A string that can be used for cursor-based pagination

node : ResourceBookingReason!

The ResourceBookingReason node.

Back to top

ResourceBookingReasonField

Fields for filtering and ordering Resource Booking Reasons

id
name
createdAt
updatedAt
Back to top

ResourceBookingReasonFieldGraphFilter

Filter that can be applied to limit which ResourceBookingReason nodes are returned

field : ResourceBookingReasonField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ResourceBookingReasonFieldGraphOrder

Specifies the order in which ResourceBookingReason nodes are returned via the Connection

field : ResourceBookingReasonField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ResourceBookingReasonMutateResponse

A response from Resource Booking Reason Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

resourceBookingReason : ResourceBookingReason

A Resource Booking Reason that has been mutated

Back to top

ResourceBookingReasonMutations

Mutations for a Resource Booking Reason

create : ResourceBookingReasonMutateResponse!

Mutation to create a new Resource Booking Reason

Argument Type Description
input ResourceBookingReasonCreateInput!

The input type with values to create the Resource Booking Reason
delete : ResourceBookingReasonMutateResponse!

Mutation to delete a Resource Booking Reason

Argument Type Description
input ResourceBookingReasonDeleteInput!

The input type with values to delete the Resource Booking Reason
update : ResourceBookingReasonMutateResponse!

Mutation to update the Name of an existing Resource Booking Reason

Argument Type Description
input ResourceBookingReasonUpdateInput!

The input type with values to update the Resource Booking Reason
Back to top

ResourceBookingReasonUpdateInput

An Input for updating a Resource Booking Reason

resourceBookingReasonId : ID!

The ID of the Resource Booking Reason being updated

name : String!

The new name for the Resource Booking Reason

Back to top

ResourceBookingType

The different kinds of Resource Booking types

session
standalone
external
sessionNeed
Back to top

ResourceBookingUpdateStandaloneInput

An Input for updating a Standalone Resource Booking Reason

resourceBookingId : ID!

The ID of the Resource Booking being updated

bookingReasonId : ID

The ID of the Resource Booking Reason

resourceId : ID

The ID of the Resource being booked

start : LocalDateTime

The booking start time

end : LocalDateTime

The booking end time

timeZone : String

The booking timezone

details : String

The booking details

Back to top

ResourceCalendar

An external Resource Calendar which can be synced with Administrate Resources

calendarType : String!

Calendar type of the Calendar Integration

email : String!

Email Address of the Calendar

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Calendar Integration

lastSyncedAt : TimeZonedDateTime

Last time the calendar was synced

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

mappedResource : Resource

Resource mapped as part of the calendar integration

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
name : String!

Name of the Resource associated with the calendar integration

status : CalendarIntegrationStatus!

Status of the Calendar Integration

vendorId : String!

The External Calendar ID supplied by the Vendor

Back to top

ResourceConflict

A Conflict for a specific Resource when duplicating a Session.

resource : Resource

The Resource which could not be booked

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
Back to top

ResourceConflictIssue

A Resource booked on a Session has another booking overlapping its time

Related types: EventIssue

category : EventIssueCategory!

The category this issue belongs to, used for client-side filtering

conflict : ResourceBooking!

The conflicting Resource Booking

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the Event. Count the entries where this is false: that is the Event's issue count, and what every badge and tally in Administrate shows. Reading this rather than testing for NoticeEventIssue is what a client wants — an EventPersonnelIssue or EventResourceIssue restating a personnel or resource notice is a notice too, and answers true here.

resourceId : ID!

The ID of the booked Resource that has a conflicting booking

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [IssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

ResourceConnection

A connection containing page information and edges for Resource

edges : [ResourceEdge!]!

The list of Resource edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ResourceContentResult

A summary of results for a Learner on a piece of EventContent

Related types: LearnerContentResult

completedAttempts : Int!

The number of complete attempts the Learner has had on this EventContent

content : LmsContent!

The EventContent this result relates to

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
contentId : ID!

The ID to the piece of EventContent this result relates to

id : ID!

The ID of the LearnerContentResult

isRequired : Boolean

Whether the EventContent is required for the Learner to complete the Event

lastAccessed : TimeZonedDateTime

The date and time when the EventContent was last accessed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
lmsAttempts : LmsAttemptConnection!

The learner attempts on the EventContent

Argument Type Description
filters = [] [LmsAttemptFieldGraphFilter]
order = "__EMPTY__" LmsAttemptFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LmsAttemptFieldGraphOrder]
numberOfAttempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

progress : Decimal

The percentage complete the Learner has achieved on the EventContent

score : Decimal

The score the Learner has achieved on the EventContent

scorePercent : Decimal

The score percent the Learner has achieved on the EventContent

status : ContentResultStatus!

The current status of the EventContent

Deprecated fields (1)
attempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

Removal date: TBD.

Replaced by numberOfAttempts

Back to top

ResourceEdge

Contains cursor and node information for type Resource

cursor : String!

A string that can be used for cursor-based pagination

node : Resource!

The Resource node.

Back to top

ResourceField

Fields for filtering and ordering Resources

id
name
isOutOfService
locationId
typeId
regionId
capacity
Back to top

ResourceFieldGraphFilter

Filter that can be applied to limit which Resource nodes are returned

field : ResourceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ResourceFieldGraphOrder

Specifies the order in which Resource nodes are returned via the Connection

field : ResourceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ResourceIssue

An issue surfaced when evaluating a Resource's booking on an Event. Polymorphic on category — concrete subtypes expose category-specific context.

Related types: ResourceBookingConflictIssue ResourceOutOfServiceIssue ResourceMislocatedIssue GenericResourceIssue NoticeResourceIssue

category : ResourceIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the booking. Count the entries where this is false: that is what ResourceIssueGroup.issueCount reports and what every badge in Administrate shows.

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [ResourceIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

ResourceIssueCategory

Category of a ResourceIssue surfaced when evaluating Resource bookings on an Event. Members are kept in sync with domain_training.entities.resource_issue.ResourceIssueCategory.

conflict
out_of_service
mislocated
notice
generic
Back to top

ResourceIssueGroup

A Resource and every issue detected for it on a given Event.

issueCount : Int!

How many issues were detected for this Resource. Notices are not issues and are not counted, though issues still reports them — branch on isNotice to tell the two apart

issues : [ResourceIssue!]!

Every issue detected for this Resource on the Event, and any notice raised about it — isNotice says which is which

resource : Resource!

The Resource this group of issues applies to

Back to top

ResourceIssueSource

Provenance metadata for a ResourceIssue. An issue may carry multiple sources after dedup — for instance, when both Administrate and a Custom Business Rule independently surface the same fact.

annotation : String

Optional one-line note attached by the source

kind : ResourceIssueSourceKind!

Where the source came from: default (Administrate) or rule (a Custom Business Rule)

ruleId : ID

When kind is rule, the ID of the rule that produced the issue

Back to top

ResourceIssueSourceKind

Where a ResourceIssue's data came from. default for issues produced by Administrate's own checks; rule for issues produced by a Custom Business Rule.

default
rule
Back to top

ResourceMislocatedIssue

A Resource booked on a Session belongs to a different Location

Related types: ResourceIssue

category : ResourceIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the booking. Count the entries where this is false: that is what ResourceIssueGroup.issueCount reports and what every badge in Administrate shows.

resourceId : ID!

The ID of the mislocated Resource

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [ResourceIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

ResourceMutations

Mutations for Resources

create : Resource!

Create a new Resource

Argument Type Description
name String!
typeId ID!
locationId ID
custom [CustomFieldValueInput]
capacity Int
update : Resource!

Update an existing Resource

Argument Type Description
id ID!
name String!
outOfService Boolean
custom [CustomFieldValueInput]
input ResourceUpdateInput
capacity Int
Back to top

ResourceOutOfServiceIssue

A Resource booked on a Session is marked out of service

Related types: ResourceIssue

category : ResourceIssueCategory!

The category this issue belongs to, used for client-side filtering

isNotice : Boolean!

Whether this entry only informs the reader rather than reporting something wrong with the booking. Count the entries where this is false: that is what ResourceIssueGroup.issueCount reports and what every badge in Administrate shows.

resourceId : ID!

The ID of the out-of-service Resource

sessionId : ID

The ID of the Session this issue applies to, or null for Event-level issues

sources : [ResourceIssueSource!]!

Provenance: every system that produced or confirmed this issue

Back to top

ResourceStat

Aggregated statistics for a Resource

bookings : BookingStat!

Booking-related statistics for the Resource

resource : Resource!

The Resource this statistic is for

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
Back to top

ResourceStatConnection

A connection containing page information and edges for ResourceStat

edges : [ResourceStatEdge!]!

The list of ResourceStat edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ResourceStatEdge

Contains cursor and node information for type ResourceStat

cursor : String!

A string that can be used for cursor-based pagination

node : ResourceStat!

The ResourceStat node.

Back to top

ResourceStatFieldGraphFilter

Filter that can be applied to limit which ResourceStat nodes are returned

field : ResourceStatFilterField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ResourceStatFieldGraphOrder

Specifies the order in which ResourceStat nodes are returned via the Connection

field : ResourceStatOrderField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ResourceStatFilterField

An enumeration.

id
name
isOutOfService
locationId
typeId
regionId
capacity
bookingType
end
eventId
rangeInEventId
rangeInRequirementsForEventId
sessionId
start
timeZone
timeZonedEnd
timeZonedStart
includePlans
planId
rangeInEventNeedId
rangeInRequirementsForEventNeedId
eventNeedId
Back to top

ResourceStatOrderField

An enumeration.

id
name
bookingsTotalCount
Back to top

ResourcesWithConflictingBookings

Details of Resources which can not be automatically rescheduled with their conflicting Resource Bookings

conflicts : ResourceBookingConnection!

Details of the conflicts

Argument Type Description
filters = [] [ResourceBookingFieldGraphFilter]
order = "__EMPTY__" ResourceBookingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceBookingFieldGraphOrder]
resource : Resource!

Details of Resources that have conflicts

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
Back to top

ResourceType

A category of Resources having common properties

Related types: Node CustomFieldTemplate

customFieldDefinitions : [CustomFieldDefinition!]!

Set of custom field definitions for this resource type

description : String!

Description of the ResourceType

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the ResourceType

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the ResourceType

resources : ResourceConnection

Resources belonging to this ResourceType

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
Deprecated fields (1)
customProperties : [CustomProperty]!

Custom properties assignable to Resources of this ResourceType

Removal date: TBD.

Replaced by customFieldDefinitions

Back to top

ResourceTypeConnection

A connection containing page information and edges for ResourceType

edges : [ResourceTypeEdge!]!

The list of ResourceType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ResourceTypeCreateInput

Values used to create a Resource Type.

name : String!
description : String
Back to top

ResourceTypeCustomFieldInput

A custom field belonging to a Resource Type.

label : String!
id : ID
includeInSearch : Boolean

Whether values of this field are included in global search. Omitted, a new field is off and an existing one keeps its setting.

Back to top

ResourceTypeDeleteInput

The Resource Type to delete.

resourceTypeId : ID!
Back to top

ResourceTypeEdge

Contains cursor and node information for type ResourceType

cursor : String!

A string that can be used for cursor-based pagination

node : ResourceType!

The ResourceType node.

Back to top

ResourceTypeField

Fields for filtering and ordering ResourceTypes

name
description
Back to top

ResourceTypeFieldGraphFilter

Filter that can be applied to limit which ResourceType nodes are returned

field : ResourceTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ResourceTypeFieldGraphOrder

Specifies the order in which ResourceType nodes are returned via the Connection

field : ResourceTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ResourceTypeMutateResponse

The result of a Resource Type mutation.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

resourceType : ResourceType

The changed Resource Type, when one remains.

Back to top

ResourceTypeMutations

Mutations for Resource Types.

create : ResourceTypeMutateResponse!

Create a Resource Type.

Argument Type Description
input ResourceTypeCreateInput!
delete : ResourceTypeMutateResponse!

Delete a Resource Type and its associated Resources.

Argument Type Description
input ResourceTypeDeleteInput!
update : ResourceTypeMutateResponse!

Update a Resource Type.

Argument Type Description
input ResourceTypeUpdateInput!
Back to top

ResourceTypeUpdateInput

Values used to update a Resource Type.

resourceTypeId : ID!
name : String!
description : String
Back to top

ResourceUpdateInput

An Input for Location and Resource Type updates

locationId : ID

The locationId for a resource

typeId : ID

The typeId for a Resource

Back to top

ResourceUserConnectionStatus

An enumeration.

connected
disconnected
error
Back to top

RevokeClientCredentialResponse

A Response for revoking a Client Credential

Related types: MutationResponse

clientKey : String

The client key that has been revoked

errors : [FieldError!]!

The errors returned by the mutation

Back to top

SalesDocument

A document containing the information about a sale

Related types: Invoice CreditNote TrainingTokenReceipt SalesOrder SalesPayment

account : Account

The Account linked to this Sales Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
company : Company

The Company that issued this Sales Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Sales Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
discount : Discount

The Discount applied to this Sales Document

discountAmount : Decimal!

The total amount of discount applied to this Sales Document excluding any Tax

id : ID!

The ID of this Sales Document

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

number : String!

The sequence number used to identify this Sales Document

region : Region

The Region in which the Sales Document is located in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
subTotalAmount : Decimal!

The amount of this Sales Document excluding any Tax or Discount

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Sales Document

totalAmount : Decimal!

The total amount of this Sales Document including Tax and Discounts

totalRemaining : Decimal!

The total remaining credit or debit on this SalesStatement

Back to top

SalesDocumentConnection

A connection containing page information and edges for SalesDocument

edges : [SalesDocumentEdge!]!

The list of SalesDocument edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

SalesDocumentEdge

Contains cursor and node information for type SalesDocument

cursor : String!

A string that can be used for cursor-based pagination

node : SalesDocument!

The SalesDocument node.

Back to top

SalesDocumentFieldGraphFilter

Filter that can be applied to limit which SalesDocument nodes are returned

field : SalesDocumentTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SalesDocumentFieldGraphOrder

Specifies the order in which SalesDocument nodes are returned via the Connection

field : SalesDocumentTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

SalesDocumentTypeField

Fields for filtering and ordering Sales Ledger entries

id
number
accountId
companyId
date
createdAt
lifecycleState
type
totalRemaining
Back to top

SalesOrder

A Sales Order describing a potential Invoice

Related types: SalesDocument Node

account : Account

The Account linked to this Sales Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
company : Company

The Company that issued this Sales Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Sales Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
discount : Discount

The Discount applied to this Sales Document

discountAmount : Decimal!

The total amount of discount applied to this Sales Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Sales Document

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : InvoiceLifecycleState!

The lifecycle state of this Sales Order

lines : [SalesOrderLine!]!

A list of lines containing the information about the ordered items

number : String!

The sequence number used to identify this Sales Document

region : Region

The Region in which the Sales Document is located in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
subTotalAmount : Decimal!

The amount of this Sales Document excluding any Tax or Discount

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Sales Document

totalAmount : Decimal!

The total amount of this Sales Document including Tax and Discounts

totalRemaining : Decimal!

The total remaining credit or debit on this SalesStatement

Back to top

SalesOrderLine

A line item of a Sales Order

description : String

Text which describes what was sold

discount : Discount

The discount applied to each unit

extendedAmount : Decimal!

The amount for all units sold, inclusive of tax

financialAccount : FinancialAccount!

Which account in the Chart of Accounts that line item financial transaction is recorded in

giftVoucher : GiftVoucher

The gift voucher transaction source linked to this line.

id : ID!

The ID of the Invoice

isDiscountable : Boolean!

Whether this line should have invoice discounts applied.

isTaxable : Boolean!

Whether this line should have tax applied.

itemPrice : StockItemPrice

The selected item price used to create this line.

linkedSellable : InterestItem

The Event or Learning Path that is optionally linked to the line for grouping.

quantity : Int!

The number of units which were sold

registerable : Registerable

The Learner or Learning Path Learner associated with this Line Item

Argument Type Description
filters = [] [RegisterableFieldGraphFilter]
order = "__EMPTY__" RegisterableFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegisterableFieldGraphOrder]
revenueType : String

The IHT revenue type linked to this line.

sellable : InterestItem

The Interest Item this line represents.

serviceDate : Date

The date of service for the line.

tag : EventTag

The legacy event tag linked to this line.

taxAmount : Decimal!

The amount of tax charged for each unit

taxType : TaxType

The type of tax charged on the line item

tokenTransaction : TrainingTokenTransaction

The token transaction linked to this line.

tokenType : TrainingTokenType

The token type linked to this line.

trainingPassTypeOption : TrainingPassTypeOption

The training pass type option linked to this line.

unitAmount : Decimal!

The price charged for each unit after discount has been applied

value : Decimal!

The original price for each unit without discount or tax

Deprecated fields (1)
linkedEvent : Event

The Event that is optionally linked to the line item

Removal date: TBD.

Replaced by linkedSellable

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
Back to top

SalesPayment

A payment row in a Sales full ledger

Related types: SalesDocument Node

account : Account

The Account linked to this Sales Document

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
company : Company

The Company that issued this Sales Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Sales Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
date : Date

The date when the payment was made

discount : Discount

The Discount applied to this Sales Document

discountAmount : Decimal!

The total amount of discount applied to this Sales Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Sales Document

isRefund : Boolean!

Whether this payment row is a refund

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

number : String!

The sequence number used to identify this Sales Document

region : Region

The Region in which the Sales Document is located in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
status : SalesPaymentStatus!

Clearing status for this payment row

subTotalAmount : Decimal!

The amount of this Sales Document excluding any Tax or Discount

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Sales Document

totalAmount : Decimal!

The total amount of this Sales Document including Tax and Discounts

totalRemaining : Decimal!

Payment rows do not have a remaining balance in the full ledger

Back to top

SalesPaymentStatus

Clearing status for a Sales full ledger payment row

Cleared
Uncleared
Back to top

SaveExternalActivityAccessInput

An input for saving details of a Learner's access of an External Activity

learnerId : ID!

The ID of the Learner with the External Activity

contentId : ID!

The ID of the External Activity

accompanyingDocumentation : String!

Up to 64kb of data to store relevant to this External Activity

trainingPassId : ID

The ID of the Learner's Training Pass that provided access to this External Activity

Back to top

Schedule

A schedule for the event tied to the Course

Related types: ClassroomSchedule LmsSchedule BlendedSchedule

registrationDeadlineOffset : RegistrationDeadlineOffset

The Schedule registration deadline offset

Back to top

ScheduleClassroomSessionInput

repeatPattern : [Day]!
repeatCount : Int!
startTime : Time
endTime : Time
repeatInterval : SessionRepeatInterval
repeatSkip : Int
startDay : Day
Back to top

ScheduleDuration

An enumeration.

days
weeks
Back to top

ScheduleOffsetContext

An enumeration.

before_start
after_start
before_end
after_end
Back to top

ScheduleSession

A schedule for a Session

duration : Int

Course session duration (in minutes)

endTime : Time

Course session end time

repeatCount : Int

Course session repeat every number of days

repeatInterval : SessionRepeatInterval

Course session repeat interval

repeatPattern : [Day!]

Course session repeat week days

repeatSkip : Int

Course session repeat after occurrences

startDay : Day

Course start day

startTime : Time

Course session start time

Back to top

ScormAttempt

Related types: LmsAttempt Node

completedAt : TimeZonedDateTime

The date and time when the Attempt was completed

completedByAdmin : Boolean!

Whether the Attempt has been manually completed by an Admin

content : LmsContent!

The Attempt's Content

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
data : String!

Information about the ScormAttempt

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Attempt

interactions : ScormAttemptInteractionConnection!

The Learner's interactions with this Attempt

Argument Type Description
filters = [] [ScormAttemptInteractionFieldGraphFilter]
order = "__EMPTY__" ScormAttemptInteractionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ScormAttemptInteractionFieldGraphOrder]
isCompleted : Boolean!

Whether the Attempt has been completed

isPassed : Boolean!

Whether the Attempt has been passed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

score : Decimal

The score the Learner has achieved on this Attempt

scorePercent : Decimal

The score percent the Learner has achieved on this Attempt

timeSpent : Duration!

The time spent by the Learner on this Attempt

updatedAt : TimeZonedDateTime

The date and time when the Attempt was updated

Back to top

ScormAttemptInteraction

A summary of a Learner's interactions with an LMS resource

Related types: Node

answer : String!

The Learner's response to the question

answerCorrect : Boolean!

The result of the Learner's response to the question

attempt : ScormAttempt!

The SCORM attempt for this interaction

contentResult : LearnerContentResult!

The SCORM content results for this ScormAttemptInteraction

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the ScormAttemptInteraction

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

question : String!

The quiz question asked

questionId : String!

The ID of the quiz question being asked

Back to top

ScormAttemptInteractionConnection

A connection containing page information and edges for ScormAttemptInteraction

edges : [ScormAttemptInteractionEdge!]!

The list of ScormAttemptInteraction edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

ScormAttemptInteractionEdge

Contains cursor and node information for type ScormAttemptInteraction

cursor : String!

A string that can be used for cursor-based pagination

node : ScormAttemptInteraction!

The ScormAttemptInteraction node.

Back to top

ScormAttemptInteractionField

ScormAttemptInteraction Fields for Filtering and Ordering

id
Back to top

ScormAttemptInteractionFieldGraphFilter

Filter that can be applied to limit which ScormAttemptInteraction nodes are returned

field : ScormAttemptInteractionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

ScormAttemptInteractionFieldGraphOrder

Specifies the order in which ScormAttemptInteraction nodes are returned via the Connection

field : ScormAttemptInteractionField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

ScormContentResult

A summary of results for a Learner on a piece of SCORM type EventContent

Related types: LearnerContentResult

completedAttempts : Int!

The number of complete attempts the Learner has had on this EventContent

content : LmsContent!

The EventContent this result relates to

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
contentId : ID!

The ID to the piece of EventContent this result relates to

id : ID!

The ID of the LearnerContentResult

isRequired : Boolean

Whether the EventContent is required for the Learner to complete the Event

lastAccessed : TimeZonedDateTime

The date and time when the EventContent was last accessed

latestAttempt : ScormAttempt

Information on the last attempt the Learner made on the SCORM Content

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
lmsAttempts : LmsAttemptConnection!

The learner attempts on the EventContent

Argument Type Description
filters = [] [LmsAttemptFieldGraphFilter]
order = "__EMPTY__" LmsAttemptFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LmsAttemptFieldGraphOrder]
numberOfAttempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

progress : Decimal

The percentage complete the Learner has achieved on the EventContent

score : Decimal

The score the Learner has achieved on the EventContent

scorePercent : Decimal

The score percent the Learner has achieved on the EventContent

status : ContentResultStatus!

The current status of the EventContent

Deprecated fields (1)
attempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

Removal date: TBD.

Replaced by numberOfAttempts

Back to top

SearchResult

Results returned by Global Search query

accounts : AccountConnection!

The list of Accounts that matches the given query string. The fields used are id, name and email)

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
achievements : AchievementConnection!

The list of Achievements that matches the given query string. The fields used are id and identifier

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
companies : CompanyConnection!

The list of Companies found through a custom field value that matches the given query string.

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
contacts : ContactConnection!

The list of contacts that matches the given query string. The fields used are id, firstName, lastName and email)

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
courseTemplates : CourseTemplateConnection!

The list of Course Templates that matches the given query string. The fields used are (id, code and title)

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
customFieldMatches : [CustomFieldMatches!]!

The custom field values that matched the query, for the given records (at most 200 ids; more is an error). Only enabled, visible fields whose value matched are listed, and only for records the caller can access: each record is fetched with the caller's permissions before anything is read. Ask for the ids a page shows; it does not run the search, so it can be requested alone.

Argument Type Description
nodeIds [ID]!

the IDs of the records to report matches for
documents : DocumentConnection!

The list of Documents that matches the given query string. The fields used are (id and name). Report-backed documents are included by default; pass includeReports: "false" to omit them, for example when reports are shown from the reports field instead.

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
includeReports String
events : EventConnection!

The list of Events that matches the given query string. The fields used are (id and title)

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
formSubmissions : FormSubmissionConnection!

The list of Form Submissions found through a custom field value that matches the given query string.

Argument Type Description
filters = [] [FormSubmissionFieldGraphFilter]
order = "__EMPTY__" FormSubmissionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FormSubmissionFieldGraphOrder]
learningPaths : LearningPathConnection!

The list of Learning Paths that matches the given query string. The fields used are Name and Code

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
mayHaveHiddenResults : Boolean!

True when the query matched records that permission filtering may then have removed. When this is true but every connection in the result is empty, matches exist that the caller is not permitted to see — distinct from nothing having matched at all. Always false for super users: nothing is permission-filtered from them, so their empty page with matches means the records were dropped for another reason (deleted, for example) rather than hidden. ID-lookup suggestions (the nodes field) are not counted.

nodes : [Node!]!

The list of supported entities where the ID match

opportunities : OpportunityConnection!

The list of Opportunities that matches the given query string. The field used is name

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
payments : PaymentConnection!

The list of Payments that matches the given query string. The field used is Number

Argument Type Description
filters = [] [PaymentFieldGraphFilter]
order = "__EMPTY__" PaymentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PaymentFieldGraphOrder]
purchaseCreditNotes : PurchaseCreditNoteConnection!

The list of Purchase Credit Notes that matches the given query string. The field used is Number

Argument Type Description
filters = [] [PurchaseCreditNoteFieldGraphFilter]
order = "__EMPTY__" PurchaseCreditNoteFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PurchaseCreditNoteFieldGraphOrder]
purchaseInvoices : PurchaseInvoiceConnection!

The list of Purchase Invoices that matches the given query string. The field used is Number

Argument Type Description
filters = [] [PurchaseInvoiceFieldGraphFilter]
order = "__EMPTY__" PurchaseInvoiceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PurchaseInvoiceFieldGraphOrder]
purchaseOrders : PurchaseOrderConnection!

The list of Purchase Orders that matches the given query string. The field used is Number

Argument Type Description
filters = [] [PurchaseOrderFieldGraphFilter]
order = "__EMPTY__" PurchaseOrderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PurchaseOrderFieldGraphOrder]
registrations : RegistrationConnection!

The list of Registrations that matches the given query string. The fields used are (id and number)

Argument Type Description
filters = [] [RegistrationFieldGraphFilter]
order = "__EMPTY__" RegistrationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegistrationFieldGraphOrder]
reports : ReportConnection!

The list of saved Reports that matches the given query string. The field used is Name

Argument Type Description
filters = [] [ReportFieldGraphFilter]
order = "__EMPTY__" ReportFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ReportFieldGraphOrder]
resources : ResourceConnection!

The list of Resources that matches the given query string. The field used is Identifier

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
salesCreditNotes : CreditNoteConnection!

The list of Sales Credit Notes that matches the given query string. The field used is Number

Argument Type Description
filters = [] [CreditNoteFieldGraphFilter]
order = "__EMPTY__" CreditNoteFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CreditNoteFieldGraphOrder]
salesInvoices : InvoiceConnection!

The list of Sales Invoices that matches the given query string. The field used is Number

Argument Type Description
filters = [] [InvoiceFieldGraphFilter]
order = "__EMPTY__" InvoiceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InvoiceFieldGraphOrder]
stockItems : StockItemConnection!

The list of Stock Items found through a custom field value that matches the given query string.

Argument Type Description
filters = [] [StockItemFieldGraphFilter]
order = "__EMPTY__" StockItemFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StockItemFieldGraphOrder]
truncatedTypes : [String!]!

Entity types whose matches hit the per-entity cap. Their totals are a floor rather than a count, so a caller should mark them as such rather than present them as the whole answer. The records behind them are the lowest ids that matched, not the closest matches, and the cap is applied before permissions.

Back to top

SellableDefaultPrice

The Default Price (without Price Levels) for a Sellable

Related types: SellablePrice

amount : Decimal!

The monetary value of the Sellable Default Price

financialUnit : FinancialUnit!

Financial Unit in which this value is expressed, e.g. the Currency

Back to top

SellableDefaultPriceWithPriceLevel

The Default Price with Price Level for a Sellable

Related types: SellablePrice

amount : Decimal!

The monetary value of the Sellable Default Price

financialUnit : FinancialUnit!

Financial Unit in which this value is expressed, e.g. the Currency

priceLevel : PriceLevel!

Price Level of the price

Back to top

SellableDefaultPriceWithTaxType

The Default Price with a Tax Type for a Sellable

Related types: SellablePrice

amount : Decimal!

The monetary value of the Sellable Default Price

financialUnit : FinancialUnit!

Financial Unit in which this value is expressed, e.g. the Currency

taxType : TaxType!

The Tax Type associated with the Sellable Default Price

Back to top

SellablePrice

An Interface for Sellable Prices

Related types: SellablePricingAgreementPrice SellableDefaultPrice SellableDefaultPriceWithTaxType SellableDefaultPriceWithPriceLevel

amount : Decimal!

The monetary value of the Pricing Agreement Price

financialUnit : FinancialUnit!

Financial Unit in which this value is expressed

Back to top

SellablePricingAgreementPrice

A Pricing Agreement Price for a Sellable

Related types: SellablePrice

amount : Decimal!

The monetary value of the Sellable Pricing Agreement Price

financialUnit : FinancialUnit!

Financial Unit in which this value is expressed, e.g. the Currency

pricingAgreement : PricingAgreement!

The ID of the Pricing Agreement this Sellable Price is applicable to

pricingAgreementPrice : PricingAgreementPrice!

The ID of the Sellable Pricing Agreement Price

Back to top

SellableType

An enumeration.

private_course
public_course
learning_path
item
Back to top

SendBulkContactAdhocEmailInput

The input for sending an adhoc email to Contacts on an Event. Either a subject and body must be specified, or a template ID must be specified. If subject and/or body are specified alongside a template ID, the values for these will override the template.

contactIds : [String]!

A list of individual Contact IDs to send emails to. This is a required parameter. An empty list is not a valid input.

eventId : String

The ID of the event

subject : String

The subject of the email. This will override the subject if a communication template is also specified.

body : String

The body of the email. This will override the body if a communication template is also specified.

templateId : ID

The communication template ID to use for the email subject and body.

sendingAddressId : ID

The ID of the sending email address from which the emails should originate.

attachments : [BulkAdhocEmailAttachment]

A list of ID/Type mappings of DMS or communication template documents to attach to the email.

ccList : [String]

A list of valid email addresses to send a copy of the email to. NB. This will send a copy of each email sent to each contact; use with caution when sending to large amounts of contacts.

contentLocaleId : ID

The ID of the Locale the subject and body are written in, so that merge fields resolve in the same language. Defaults to the language the Event is delivered in.

Back to top

SendBulkLearnerAdhocEmailInput

The input for sending an adhoc email to categories of Learners on an Event. Either a subject and body must be specified, or a template ID must be specified. If subject and/or body are specified alongside a template ID, the values for these will override the template.

eventId : String!

The ID of the event on which the Learners exist

audience : [BulkLearnerEmailAudience]

The subset of Learners to send the email to. Defaults to all students.

subject : String

The subject of the email. This will override the subject if a communication template is also specified.

body : String

The body of the email. This will override the body if a communication template is also specified.

templateId : ID

The communication template ID to use for the email subject and body.

sendingAddressId : ID

The ID of the sending email address from which the emails should originate.

attachments : [BulkAdhocEmailAttachment]

A list of ID/Type mappings of DMS or communication template documents to attach to the email.

ccList : [String]

A list of valid email addresses to send a copy of the email to. NB. This will send a copy of each email sent to each student; use with caution when sending to large amounts of students.

learnerIds : [String]

A list of individual Learner IDs to send emails to. This will override the audience if specified. An empty list is not a valid input.

contentLocaleId : ID

The ID of the Locale the subject and body are written in, so that merge fields resolve in the same language. Defaults to the language the Event is delivered in.

Back to top

SendBulkStaffAdhocEmailInput

The input for sending an adhoc email to Staff on an Event. Either a subject and body must be specified, or a template ID must be specified. If subject and/or body are specified alongside a template ID, the values for these will override the template.

eventId : String!

The ID of the event on which the Learners exist

subject : String

The subject of the email. This will override the subject if a communication template is also specified.

body : String

The body of the email. This will override the body if a communication template is also specified.

templateId : ID

The communication template ID to use for the email subject and body.

sendingAddressId : ID

The ID of the sending email address from which the emails should originate.

attachments : [BulkAdhocEmailAttachment]

A list of ID/Type mappings of DMS or communication template documents to attach to the email.

ccList : [String]

A list of valid email addresses to send a copy of the email to. NB. This will send a copy of each email sent to each student; use with caution when sending to large amounts of students.

staffIds : [String]

A list of individual Staff IDs to send emails to. If not specified, all staff will be sent the email. An empty list is not a valid input.

contentLocaleId : ID

The ID of the Locale the subject and body are written in, so that merge fields resolve in the same language. Defaults to the language the Event is delivered in.

Back to top

SendingAddressMutations

createEmailAddress : SendingEmailAddressResponse!

Create a new sending email address, which will receive a verification email. The new Sending Address cannot be used until it is verified by following the instructions in the verification email.

Argument Type Description
input CreateSendingEmailAddressInput!

The input type with the values to be set on the new sending email address
Back to top

SendingEmailAddress

An email address that emails are sent from

Related types: Node

address : String!

The email address

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the SendingEmailAddress

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Sending Email Address

verified : Boolean!

Whether the email has been verified as owned by a User

Back to top

SendingEmailAddressConnection

A connection containing page information and edges for SendingEmailAddress

edges : [SendingEmailAddressEdge!]!

The list of SendingEmailAddress edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

SendingEmailAddressEdge

Contains cursor and node information for type SendingEmailAddress

cursor : String!

A string that can be used for cursor-based pagination

node : SendingEmailAddress!

The SendingEmailAddress node.

Back to top

SendingEmailAddressField

SendingEmailAddress Fields for Filtering and Ordering

address
id
name
verified
Back to top

SendingEmailAddressFieldGraphFilter

Filter that can be applied to limit which SendingEmailAddress nodes are returned

field : SendingEmailAddressField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SendingEmailAddressFieldGraphOrder

Specifies the order in which SendingEmailAddress nodes are returned via the Connection

field : SendingEmailAddressField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

SendingEmailAddressResponse

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

sendingEmailAddress : SendingEmailAddress

The updated sending email address

Back to top

SendingPhoneNumber

A phone number that SMS are sent from

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
fromName : String

The name that receivers of the SMS will be told the SMS is from

id : ID!

The ID of the SendingPhoneNumber

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Sending Phone Number

number : String!

The phone number

Back to top

SendingPhoneNumberConnection

A connection containing page information and edges for SendingPhoneNumber

edges : [SendingPhoneNumberEdge!]!

The list of SendingPhoneNumber edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

SendingPhoneNumberEdge

Contains cursor and node information for type SendingPhoneNumber

cursor : String!

A string that can be used for cursor-based pagination

node : SendingPhoneNumber!

The SendingPhoneNumber node.

Back to top

SendingPhoneNumberField

SendingPhoneNumber Fields for Filtering and Ordering

fromName
id
name
number
Back to top

SendingPhoneNumberFieldGraphFilter

Filter that can be applied to limit which SendingPhoneNumber nodes are returned

field : SendingPhoneNumberField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SendingPhoneNumberFieldGraphOrder

Specifies the order in which SendingPhoneNumber nodes are returned via the Connection

field : SendingPhoneNumberField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

Session

A period of time used for learning or teaching

Related types: Node Calendarable ContactBookingEntity

breakoutGroup : EventBreakoutGroup

The Breakout Group this Session belongs to

Argument Type Description
filters = [] [EventBreakoutGroupFieldGraphFilter]
order = "__EMPTY__" EventBreakoutGroupFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventBreakoutGroupFieldGraphOrder]
cancelledAt : String

The date this Session was cancelled

code : String!

A code used to refer to the Session

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Session

Argument Type Description
filter CustomFieldFilterInput
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Session

learners : LearnerConnection!

Learners that have been enrolled onto this Session

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : SessionLifecycleState!

The state of the Session in its lifecycle

location : Location

Location at which the Event takes place

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
locationName : String

The name of the Location at which the Session takes place

notes : String

Notes for the Session

parentEvent : Event

The parent Event to which the Session belongs

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
resourceBookings : ResourceBookingConnection!

The Resources that have been booked against the Session

Argument Type Description
filters = [] [ResourceBookingFieldGraphFilter]
order = "__EMPTY__" ResourceBookingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceBookingFieldGraphOrder]
staff : StaffConnection!

Staff attached to a Session

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
timeZoneName : String

The time zone in which the Session is scheduled

timeZonedEnd : TimeZonedDateTime

Time zone offset date and time the Session ends

timeZonedStart : TimeZonedDateTime

Time zone offset date and time the Session starts

title : String!

Title of the Session

venue : Venue

Venue for the event

Argument Type Description
filters = [] [VenueFieldGraphFilter]
order = "__EMPTY__" VenueFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [VenueFieldGraphOrder]
Deprecated fields (4)
end : LocalDateTime

Date and time the Session ends

Removal date: TBD.

Replaced by timeZonedEnd

maxPlaces : Int

Maximum number of booked learners possible for the Session

Removal date: 2026-12-01.

Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces

minPlaces : Int

Minimum number of booked learners required for the Session

Removal date: 2026-12-01.

Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces

start : LocalDateTime

Date and time the Session starts

Removal date: TBD.

Replaced by timeZonedStart

Back to top

SessionAddStaffInput

An Input for adding new Staff to a Session

contactIds : [ID]!

A list of Contact IDs to add to the Session as the specified type of Staff.

sessionId : ID!

The ID of the Session to add the Staff to.

staffRoleId : ID

The ID of the Role this Staff should be added to the Session as.

staffType : StaffType

DEPRECATED (replaced by staffRoleId) - The type of staff to be added

notes : String

An optional note on the Staff

Back to top

SessionConnection

A connection containing page information and edges for Session

edges : [SessionEdge!]!

The list of Session edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

SessionCreateDetailsInput

An Input describing a Session to create alongside its Event.

Only the start and end are required.

start : LocalDateTime!

The start datetime of the Session

end : LocalDateTime!

The end datetime of the Session

code : String

The code used to refer to the Session (defaults to the Event code)

title : String

The title of the Session (defaults to the Event title)

locationId : ID

The location of the Session (defaults to the Event location)

venueId : ID

The venue of the Session (defaults to the Event venue)

timeZoneName : String

The timezone of the Session (defaults to the Event timezone)

minPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Minimum number of booked learners required for the Session (defaults to the Event minPlaces)

maxPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Maximum number of booked learners possible for the Session (defaults to the Event maxPlaces)

lifecycleState : SessionLifecycleState

The lifecycle state of the Session (defaults to the Event's, which it must match when the Event is draft or cancelled)

notes : String

Notes for the Session

locationName : String

A free-text location name for a Session on a private Event (instead of a saved Location)

customFieldValues : [CustomFieldValueInput]

Any custom field values to set on the new Session

Back to top

SessionCreateInput

An Input for creating a Session

parentEventId : ID!

The parent event ID of the Session

code : String!

The code used to refer to the Session

title : String!

The title of the Session

start : LocalDateTime!

The start datetime of the Session

end : LocalDateTime!

The end datetime of the Session

locationId : ID

The location of the Session (defaults to Event location)

venueId : ID

The venue of the Session

timeZoneName : String

The timezone of the Session (defaults to Event timezone)

minPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Minimum number of booked learners required for the Session (defaults to Event minPlaces)

maxPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Maximum number of booked learners possible for the Session (default to Event maxPlaces)

lifecycleState : SessionLifecycleState

The lifecycle state of the Session (defaults to draft; must be cancelled when the parent Event is cancelled)

notes : String

Notes for the Session

locationName : String

A free-text location name for a Session on a private Event (instead of a saved Location)

copyParentEventStaff : Boolean

Whether to copy the parent Event's Staff onto the new Session

customFieldValues : [CustomFieldValueInput]

Any custom field values to set on the new Session

Back to top

SessionDeleteInput

An Input for deleting a list of Sessions

sessionIds : [ID]!

The list of Session IDs to delete

Back to top

SessionDetail

A summary of sessions details

attendanceMark : LearnerAttendanceStatus!

The attendance Status of the Learner

session : Session!

Sessions that belong to the Event

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
Back to top

SessionDetailConnection

A connection containing page information and edges for SessionDetail

edges : [SessionDetailEdge!]!

The list of SessionDetail edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

SessionDetailEdge

Contains cursor and node information for type SessionDetail

cursor : String!

A string that can be used for cursor-based pagination

node : SessionDetail!

The SessionDetail node.

Back to top

SessionDetailField

LearnerContentResult Fields for Filtering and Ordering

learnerId
Back to top

SessionDetailFieldGraphFilter

Filter that can be applied to limit which SessionDetail nodes are returned

field : SessionDetailField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SessionDetailFieldGraphOrder

Specifies the order in which SessionDetail nodes are returned via the Connection

field : SessionDetailField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

SessionDuplicateInput

An Input for duplicating a Session

newStart : LocalDateTime!

The new start datetime of the new Session

Back to top

SessionDuplicateResponse

A Response for a Session Duplicate Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

resourceConflicts : [ResourceConflict!]!

Resource bookings that were not duplicated due to conflicts

session : Session

The Session that was created from the duplication

staffConflicts : [ContactConflict!]!

Staff assignments that were duplicated that had conflicts

Back to top

SessionEdge

Contains cursor and node information for type Session

cursor : String!

A string that can be used for cursor-based pagination

node : Session!

The Session node.

Back to top

SessionField

Fields for filtering and ordering Sessions

id
title
code
parentId
start
end
timeZonedStart
timeZonedEnd
lifecycleState
cancelledAt
breakoutGroupId
Back to top

SessionFieldGraphFilter

Filter that can be applied to limit which Session nodes are returned

field : SessionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SessionFieldGraphOrder

Specifies the order in which Session nodes are returned via the Connection

field : SessionField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

SessionLifecycleState

The lifecycle state of a Session

draft
published
cancelled
Back to top

SessionMutationResponse

A Response for a Session Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

session : Session

The Session that was mutated

Back to top

SessionMutations

Available Mutations on a Session

addStaff : SessionMutationResponse!

Add Staff to a Session

Argument Type Description
input SessionAddStaffInput!

The input type with Staff details to be added to the Session
create : SessionMutationResponse!

Updates the details of a Session

Argument Type Description
input SessionCreateInput!

The input type containing the details of the new Session
delete : BulkSessionMutationResponse!

Deletes a list of Sessions Cannot delete sessions with active students

Argument Type Description
input SessionDeleteInput!

The input type with the Session IDs to delete
duplicate : SessionDuplicateResponse!

Creates a duplicate of a Session

Argument Type Description
sessionId ID!

The ID of the Session being duplicated
input SessionDuplicateInput!

The input type containing details to be changed on the new Session created by the duplication
removeStaff : SessionMutationResponse!

Remove Staff from a Session

Argument Type Description
input SessionRemoveStaffInput!

The input type with the Staff to be removed from the Session
update : SessionMutationResponse!

Updates the details of a Session

Argument Type Description
sessionId ID!

The ID of the Session being updated
input SessionUpdateInput!

The input type with the values to be updated
updateStaff : BulkSessionMutationResponse!

Update Staff on a Session

Argument Type Description
input [SessionUpdateStaffInput]!

The input type with a list of Staff details to be updated on the Session
Back to top

SessionNeed

Related types: ContactBookingEntity

id : ID!

ID of Session Need

solution : SessionNeedSolution

The proposed solution to satisfy the Session Need

Back to top

SessionNeedField

Fields for filtering and ordering SessionNeeds

id
Back to top

SessionNeedFieldGraphFilter

Filter that can be applied to limit which SessionNeed nodes are returned

field : SessionNeedField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SessionNeedFieldGraphOrder

Specifies the order in which SessionNeed nodes are returned via the Connection

field : SessionNeedField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

SessionNeedMutateResponse

A Response from mutating a SessionNeed

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

plan : Plan

The Plan output by the mutation

sessionNeeds : [SessionNeed!]

The SessionNeeds output by the mutation

Back to top

SessionNeedSolution

end : LocalDateTime!

The proposed Session end time for the Session Need

resources : [Resource!]!

The list of proposed Resources assigned to the Session Need

staff : [SessionNeedStaff!]!

The list of proposed Staff assigned to the Session Need

start : LocalDateTime!

The proposed Session start time for the Session Need

Back to top

SessionNeedStaff

Record of a Staff member on an Event

contact : Contact!

The Contact record of the individual assigned as Staff

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
staffRole : StaffRole!

The Staff Role

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
Back to top

SessionRemoveStaffInput

An Input for removing existing Staff from a Session

staffId : ID!

The ID of the Staff to be removed from the Session.

notifyStaff : Boolean

Boolean to indicate whether to notify Staff of removal via email, defaults to False

Back to top

SessionRepeatInterval

An enumeration.

daily
weekly
Back to top

SessionRequirement

Requirement info of a single session, currently only for Resources

end : TimeZonedDateTime!

The end TimeZonedDatetime of the session

id : ID!

The id of the session

start : TimeZonedDateTime!

The start TimeZonedDatetime of the session

Deprecated fields (11)
hasAllRequiredResources : Boolean!

If this session has all required resources

Removal date: 2026-09-15.

Use EventRequirement.issues instead: a MissingResourceTypeIssue with this session's sessionId is present when resources are missing.

hasAnInstructor : Boolean!

If this session has at least one instructor

Removal date: 2026-09-15.

Use EventRequirement.issues instead: a MissingInstructorIssue with this session's sessionId is present when no instructor is assigned. Not emitted for LMS events, nor when any session on the event defines staff-role requirements (a MissingStaffRoleIssue is emitted instead).

hasInactiveInstructors : Boolean!

True if any instructors are inactive

Removal date: 2026-09-15.

Use EventRequirement.issues instead: one InactiveInstructorIssue with this session's sessionId per inactive instructor. Not emitted for LMS events.

inactiveInstructorContactIds : [ID!]!

The list of Contact IDs for any Instructor Contact that has been marked inactive

Removal date: 2026-09-15.

Use EventRequirement.issues instead: one InactiveInstructorIssue with this session's sessionId per inactive instructor, carrying its contactId. Not emitted for LMS events.

inactiveResources : [Resource!]!

List of all inactive Resources booked for this Session

Removal date: 2026-09-15.

Use EventRequirement.issues instead: one InactiveResourceIssue per inactive resource, or under the Personnel Issues preview one EventResourceIssue, with this session's sessionId.

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
instructorConflicts : [InstructorConflict!]!

List of all instructor conflicts on this session

Removal date: 2026-09-15.

Use EventRequirement.issues instead: one InstructorConflictIssue per conflict, or under the Personnel Issues preview one EventPersonnelIssue, with this session's sessionId.

instructorCount : Int!

The number of instructors assigned to this session

Removal date: 2026-09-15.

Use EventRequirement.issues instead: a MissingInstructorIssue with this session's sessionId signals a session with no instructor. Not emitted for LMS events, nor when any session on the event defines staff-role requirements (a MissingStaffRoleIssue is emitted instead).

mislocatedResources : [Resource!]!

List of all Resources that have a location which is different from the Session's location

Removal date: 2026-09-15.

Use EventRequirement.issues instead: one MislocatedResourceIssue per mislocated resource, or under the Personnel Issues preview one EventResourceIssue, with this session's sessionId.

Argument Type Description
filters = [] [ResourceFieldGraphFilter]
order = "__EMPTY__" ResourceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ResourceFieldGraphOrder]
missingResourceTypes : [MissingResourceType!]!

If there are any missing resources, the list of the resource type that is required

Removal date: 2026-09-15.

Use EventRequirement.issues instead: one MissingResourceTypeIssue with this session's sessionId per missing resource type.

resourceConflicts : [ResourceBooking!]!

List of all Resource Booking conflicts on this Session

Removal date: 2026-09-15.

Use EventRequirement.issues instead: one ResourceConflictIssue per conflict, or under the Personnel Issues preview one EventResourceIssue, with this session's sessionId.

staffRoleFulfillment : [SessionStaffRoleFulfillment!]!

A summary list of each Staff Role required and how many Personnel for the role are booked or missing

Removal date: 2026-09-15.

Use EventRequirement.issues instead: one MissingStaffRoleIssue with this session's sessionId per unfilled staff role. Not emitted for LMS events.

Back to top

SessionResourceBookingUpsertInput

An Input describing a Resource to book on a Session.

A Resource already booked on the Session is left as it is, so the same input can be sent repeatedly. Bookings are never removed by their absence from a later call.

resourceId : ID

The Resource to book on the Session. Give this or resourceExternalId, not both

resourceExternalId : ExternalIdInput

The External ID of the Resource to book on the Session

details : String

Notes to store with the booking

start : TimeZonedDateTime

The booking start time (defaults to the Session start when omitted)

end : TimeZonedDateTime

The booking end time (defaults to the Session end when omitted)

Back to top

SessionStaffRoleFulfillment

Simplified Staff Role object with the id and name of the Staff Role that is missing on a session

id : ID!

The ID of the Staff Role that is missing

name : String!

The name of the Staff Role that is missing

numBooked : Int!

The number of Staff with this Role booked on the Session

numMissing : Int!

The number of Staff with this Role missing from the Session

numRequired : Int!

The number of Staff with this Role required on the Session

Back to top

SessionStaffUpsertInput

An Input describing Staff to book on a Session.

Staff already on the Session in the same Role are left as they are, so the same input can be sent repeatedly. Staff are never removed by their absence from a later call.

staffRoleId : ID!

The Role to book the Contact under. The Contact must already hold it.

contactId : ID

The Contact to book onto the Session. Give this or contactExternalId, not both

contactExternalId : ExternalIdInput

The External ID of the Contact to book onto the Session

notes : String

Notes about this particular booking of the Staff

Back to top

SessionTemplate

Defines a pattern used to create Sessions which represent an instance of an Event

Related types: Node

code : String

A code used to refer to the Session

courseBreakoutGroup : CourseBreakoutGroup

The Course Breakout Group this Session Template belongs to

Argument Type Description
filters = [] [CourseBreakoutGroupFieldGraphFilter]
order = "__EMPTY__" CourseBreakoutGroupFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseBreakoutGroupFieldGraphOrder]
dayNumber : Int!

Session start time

duration : Int

The duration of the Session in minutes

endTime : Time

Session end time

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

Unique identifier for this Session Template

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

startTime : Time

Session start time

title : String

Name of the Session

Back to top

SessionTemplateConnection

A connection containing page information and edges for SessionTemplate

edges : [SessionTemplateEdge!]!

The list of SessionTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

SessionTemplateCreateInput

An input to create a Session Template on a Course Template

courseTemplateId : ID!
dayNumber : Int!
startTime : Time
endTime : Time
code : String
title : String
Back to top

SessionTemplateDeleteInput

An input to update a Session Template on a Course Template

sessionTemplateId : ID!
Back to top

SessionTemplateEdge

Contains cursor and node information for type SessionTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : SessionTemplate!

The SessionTemplate node.

Back to top

SessionTemplateField

Fields for filtering and ordering SessionTemplates

id
dayNumber
startTime
endTime
code
title
Back to top

SessionTemplateFieldGraphFilter

Filter that can be applied to limit which SessionTemplate nodes are returned

field : SessionTemplateField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SessionTemplateFieldGraphOrder

Specifies the order in which SessionTemplate nodes are returned via the Connection

field : SessionTemplateField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

SessionTemplateResponse

A Response for a CourseTemplate SessionTemplate Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

sessionTemplate : SessionTemplate

The SessionTemplate that was created or updated

Back to top

SessionTemplateUpdateInput

An input to update a SessionTemplate on a CourseTemplate

sessionTemplateId : ID!
dayNumber : Int
startTime : Time
endTime : Time
code : String
title : String
Back to top

SessionUpdateInput

An Input for updating a Session

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Session to update

code : String

The code used to refer to the Session

title : String

The title of the Session

start : LocalDateTime

The start datetime of the Session

end : LocalDateTime

The end datetime of the Session

locationId : ID

The location of the Session

venueId : ID

The venue of the Session

timeZoneName : String

The timezone of the Session

lifecycleState : SessionLifecycleState

The lifecycle state of the Session

minPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Minimum number of booked learners required for the Session

maxPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Maximum number of bookable slots for the Session

notes : String

Notes for the Session

locationName : String

A free-text location name for a Session on a private Event (instead of a saved Location)

Back to top

SessionUpdateStaffInput

An Input for updating Staff on a Session

staffId : ID!

The ID of the Staff being updated

notes : String

Notes on the Staff to be updated

Back to top

SessionUpsertByExternalIdDetailsInput

An Input describing a Session to create or update on an Event by External ID.

Give a Session an externalId to address it on future calls: a matching externalId updates that Session in place, while omitting one always adds a new Session. A Session's parent Event is fixed once tagged, so an externalId that already belongs to a Session under a different Event is rejected.

Note: Events and Sessions share an External ID namespace, so reusing the exact same name and value across an Event and a Session is not supported - use a distinct name for Session External IDs.

start : LocalDateTime!

The start datetime of the Session

end : LocalDateTime!

The end datetime of the Session

code : String

The code used to refer to the Session (defaults to the Event code when omitted)

title : String

The title of the Session (defaults to the Event title when omitted)

externalId : ExternalIdInput

Identifies this Session for future upsert calls. Omitting it always adds a new Session, even when one already exists for the same details.

locationId : ID

The location of the Session (defaults to the Event location on create)

venueId : ID

The venue of the Session (defaults to the Event venue on create)

timeZoneName : String

The timezone of the Session (defaults to the Event timezone on create)

lifecycleState : SessionLifecycleState

The lifecycle state of the Session. On create it defaults to the parent Event's lifecycle state, which a Session must match when the Event is draft or cancelled. On update it is applied to the existing Session matched by externalId

minPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Minimum number of booked learners required for the Session (defaults to the Event minPlaces on create)

maxPlaces : Int

DEPRECATED (2026-09-01, Session places do not affect capacity; use the parent Event's minPlaces/maxPlaces) - Maximum number of booked learners possible for the Session (defaults to the Event maxPlaces on create)

notes : String

Notes for the Session. Applied on create and when updating an existing Session matched by externalId

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Session. Only applied when updating an existing Session matched by externalId

staff : [SessionStaffUpsertInput]

The Staff to book on this Session. Staff already booked in the same Role are left alone, and Staff omitted from a later call are not removed

resourceBookings : [SessionResourceBookingUpsertInput]

The Resources to book on this Session. Resources already booked are left alone, and bookings omitted from a later call are not removed

Back to top

SessionWithConflicts

A representation of a Session with a list of conflicts

code : String!

The code of this Session

conflicts : [ContactBooking!]!

The list of Bookings this Instructor has that conflict with this Session

end : TimeZonedDateTime!

The timezoned End of this Session

eventId : ID!

The ID of the Parent Event of this Session

id : ID!

The ID of this Session

staff : Staff!

The Staff for this Session

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
start : TimeZonedDateTime!

The timezoned Start of this Session

timezone : String!

The IANA zone name of this Session

title : String!

The title of this Session

Deprecated fields (1)
staffId : ID!

The Staff ID of the Instructor for this Session

Removal date: 2026-05-03.

Replaced by staff

Back to top

SetExternalActivityInput

An input for setting completion status for External Activities"

isCompleted : Boolean!

Whether the Learner has completed the External Activity

learnerId : ID

The ID of the Learner with the External Activity. Do not use with learnerExternalId.

learnerExternalId : ExternalIdInput

The External ID of the Learner with the External Activity. Do not use with learnerId.

contentId : ID

The ID of the External Activity. Do not use with contentExternalId.

contentExternalId : ExternalIdInput

The External ID of the External Activity. Do not use with contentId.

completedByAdmin : Boolean

Whether the content has been manually completed by an Admin

Back to top

SetPrimaryContactAccountMembershipInput

contactId : ID!

The Contact ID of the Membership

accountId : ID!

The Account ID of the primary Membership

Back to top

SetStaffToPrimaryInput

An Input for making a Staff primary

staffId : ID!
Back to top

SetStandardFieldValidationsInput

Back to top

SliceResolution

A time resolution to aggregate a time series by.

HOURLY
DAILY
WEEKLY
MONTHLY
QUARTERLY
ANNUALLY
WHOLE
Back to top

SolveStatus

An enumeration.

UNSOLVED
SOLVING
ERR_TIMEOUT
SUCCESS
UNFEASIBLE
ERR_INVALID
ERR_FAILED
Back to top

SsoUriInfo

Shows the URI's required to set up SSO

authorization : String!
tokenExchange : String!
userInfo : String!
Back to top

Staff

Record of a Staff member on an Event

Related types: Node

account : Account

The Account to which the Staff belongs

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
booking : Calendarable

An Event or a Session this Staff is booked on

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
contact : Contact

The Contact record of the individual assigned as Staff

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime!

A timestamp of the time this Staff was created

customFieldValues : [CustomFieldValue!]!

Custom Field values for this Staff

Argument Type Description
filter CustomFieldFilterInput
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Staff

isPrimary : Boolean!

Whether this Staff member is the Primary instance of their role on the Event

isQualified : Boolean!

Returns whether the Contact staffing this Event in this Role is qualified to staff it given the Event Requirements set on the Event or any Staff Exceptions on the Course Template

learnerAssessments : LearnerAssessmentConnection!

Assessments associated with the Events the Staff is teaching

Argument Type Description
filters = [] [LearnerAssessmentFieldGraphFilter]
order = "__EMPTY__" LearnerAssessmentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerAssessmentFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

notes : String

The notes about a member of staff on the event

sessionStaff : [Staff!]!

Any session bookings for the Event booking

staffRole : StaffRole!

The Staff Role

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
updatedAt : TimeZonedDateTime!

A timestamp of the last time this Staff was updated

Deprecated fields (2)
bio : String

The bio of an individual Staff

Removal date: TBD.

Replaced by notes

staffType : StaffType!

The type or role of the Staff such as instructor or administrator.

Removal date: 2026-05-11.

Replaced by staffRole

Back to top

StaffConnection

A connection containing page information and edges for Staff

edges : [StaffEdge!]!

The list of Staff edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

StaffEdge

Contains cursor and node information for type Staff

cursor : String!

A string that can be used for cursor-based pagination

node : Staff!

The Staff node.

Back to top

StaffException

The approval for a Contact to staff any Events for a Course Template as a specific Staff Role

Related types: Node

contact : Contact!

The Contact this Staff Exception relates to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of this Staff Exception

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

staffRole : StaffRole!

The Staff Role this exception is for

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
Back to top

StaffExceptionConnection

A connection containing page information and edges for StaffException

edges : [StaffExceptionEdge!]!

The list of StaffException edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

StaffExceptionEdge

Contains cursor and node information for type StaffException

cursor : String!

A string that can be used for cursor-based pagination

node : StaffException!

The StaffException node.

Back to top

StaffExceptionField

Fields for filtering and ordering StaffException

id
contactId
staffRoleId
Back to top

StaffExceptionFieldGraphFilter

Filter that can be applied to limit which StaffException nodes are returned

field : StaffExceptionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

StaffExceptionFieldGraphOrder

Specifies the order in which StaffException nodes are returned via the Connection

field : StaffExceptionField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

StaffExceptionsAddInput

An Input for adding Personnel that are always allowed to staff Events from a Course Template

courseTemplateId : ID!

the ID of the Course Template this exception is for

contactId : ID!
staffRoleId : ID!

the ID of the Staff Role the Contact is allowed to assume when staffing Events

Back to top

StaffExceptionsRemoveInput

An Input for removing Personnel that are always allowed to staff Events from a Course Template

staffExceptionId : ID!

the ID of the Staff Exception to remove

Back to top

StaffField

Fields for filtering and ordering Staff

id
eventId
contactId
staffRoleName
staffRoleId
contactName
contactEmailAddress
contactMobilePhoneNumber
isEmployee
start
end
timeZonedStart
timeZonedEnd
bookingType
contactHasLeftCompany
isPrimary
createdAt
updatedAt
bookingLifecycleState
Deprecated values (1)
staffType

Removal date: 2026-05-11.

replaced by staffRoleId

Back to top

StaffFieldGraphFilter

Filter that can be applied to limit which Staff nodes are returned

field : StaffField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

StaffFieldGraphOrder

Specifies the order in which Staff nodes are returned via the Connection

field : StaffField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

StaffNeed

StaffNeed(contactId: str, staffRoleId: str | None = None)

contactId : String!
staffRoleId : String
Back to top

StaffRole

A role for a Staff member on an Event

Related types: Node

checkConflicts : Boolean!

Whether the assignment of a Staff with this Role to an Event generates a conflict with any other assignments the Staff member may have

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Staff Role

isSystem : Boolean!

Returns whether this is a system factory role that cannot be edited, archived or deleted.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : StaffRoleLifecycleState!

The lifecycle state of the Staff Role, which can be active or archived

name : String!

The name of the Staff Role

Back to top

StaffRoleConnection

A connection containing page information and edges for StaffRole

edges : [StaffRoleEdge!]!

The list of StaffRole edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

StaffRoleEdge

Contains cursor and node information for type StaffRole

cursor : String!

A string that can be used for cursor-based pagination

node : StaffRole!

The StaffRole node.

Back to top

StaffRoleField

Fields for filtering and ordering Staff Role

id
name
lifecycleState
checkConflicts
Back to top

StaffRoleFieldGraphFilter

Filter that can be applied to limit which StaffRole nodes are returned

field : StaffRoleField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

StaffRoleFieldGraphOrder

Specifies the order in which StaffRole nodes are returned via the Connection

field : StaffRoleField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

StaffRoleLifecycleState

An enumeration.

active
archived
Back to top

StaffRoleMutationResponse

A Response for a mutation updating a batch of Staff Roles

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

staffRoles : [StaffRole!]!

The Staff Roles that were mutated

Back to top

StaffRoleMutations

Mutations for Staff Roles

addStaffRoles : StaffRoleMutationResponse!

Adds a batch of Staff Roles

Argument Type Description
input [AddStaffRoleInput]!
archiveStaffRoles : StaffRoleMutationResponse!

Archives a batch of Staff Roles so they are not available for new Staff.

Argument Type Description
input [ArchiveStaffRoleInput]!
removeStaffRoles : StaffRoleMutationResponse!

Removes a batch of Staff Roles. Roles can only be removed if not assigned to any Staff.

Argument Type Description
input [RemoveStaffRoleInput]!
updateStaffRoles : StaffRoleMutationResponse!

Updates a batch of Staff Roles

Argument Type Description
input [UpdateStaffRoleInput]!
Back to top

StaffType

The type or role of the Staff such as instructor or administrator. instructor - A Contact leading the learning activities administrator - A Contact assisting with activities related to the Event other than teaching partner - DEPRECATED - Replaced by partners on Event notfound - A type was not found

instructor
administrator
notfound
Back to top

StaffUnavailability

Record of a Staff Unavailability

Related types: Node ContactBookingEntity

contact : Contact

The Contact record of the individual who is unavailable

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
description : String

Description of the Staff Unavailability

endDateTime : LocalDateTime

Date and time the Staff Unavailability ends

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Staff Unavailability

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

reason : InstructorAbsenceReason

The reason for the absence

Argument Type Description
filters = [] [InstructorAbsenceReasonFieldGraphFilter]
order = "__EMPTY__" InstructorAbsenceReasonFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InstructorAbsenceReasonFieldGraphOrder]
startDateTime : LocalDateTime

Date and time the Staff Unavailability starts

timeZone : String

Time zone of the Staff Unavailability

timeZonedEnd : TimeZonedDateTime

Date and time the Staff Unavailability ends with time zone information

timeZonedStart : TimeZonedDateTime

Date and time the Staff Unavailability starts with time zone information

type : StaffUnavailabilityType!

Type of the Staff Unavailability

workingDays : Decimal

The number of Working Days that the Staff Unavailability covers

Deprecated fields (2)
end : Date

The date the Staff Unavailability ends

Removal date: TBD.

Replaced by endDateTime

start : Date

The date the Staff Unavailability starts

Removal date: TBD.

Replaced by startDateTime

Back to top

StaffUnavailabilityConnection

A connection containing page information and edges for StaffUnavailability

edges : [StaffUnavailabilityEdge!]!

The list of StaffUnavailability edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

StaffUnavailabilityDeleteInput

An Input for deleting a Staff Unavailability

staffUnavailabilityId : ID!

The ID of Staff Unavailability to delete

Back to top

StaffUnavailabilityEdge

Contains cursor and node information for type StaffUnavailability

cursor : String!

A string that can be used for cursor-based pagination

node : StaffUnavailability!

The StaffUnavailability node.

Back to top

StaffUnavailabilityField

Fields for filtering and ordering Staff Unavailability

contactId
type
description
end
id
start
isEmployee
contactHasLeftCompany
Back to top

StaffUnavailabilityFieldGraphFilter

Filter that can be applied to limit which StaffUnavailability nodes are returned

field : StaffUnavailabilityField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

StaffUnavailabilityFieldGraphOrder

Specifies the order in which StaffUnavailability nodes are returned via the Connection

field : StaffUnavailabilityField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

StaffUnavailabilityMutateResponse

A response from Staff Unavailability Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

staffUnavailability : StaffUnavailability

A Staff Unavailability that has been mutated

Back to top

StaffUnavailabilityMutations

Mutations for Staff Unavailability

createGlobal : StaffUnavailabilityMutateResponse!

Creates a Global Staff Unavailability

Argument Type Description
input GlobalStaffUnavailabilityCreateInput!

The input type with values used to create a Global Staff Unavailability
createPersonal : StaffUnavailabilityMutateResponse!

Creates a Personal Staff Unavailability

Argument Type Description
input PersonalStaffUnavailabilityCreateInput!

The input type with values used to create a Personal Staff Unavailability
delete : StaffUnavailabilityMutateResponse!

Deletes a Staff Unavailability

Argument Type Description
input StaffUnavailabilityDeleteInput!

The input type with values used to delete a Staff Unavailability
update : StaffUnavailabilityMutateResponse!

Updates a Staff Unavailability

Argument Type Description
input StaffUnavailabilityUpdateInput!

The input type with values used to update a Staff Unavailability
Back to top

StaffUnavailabilityType

Type of Staff Unavailability

Global

The unavailability applies to the whole company

Personal

The unavailability only applies to a specific Staff member

Back to top

StaffUnavailabilityUpdateInput

An Input for updating a Staff Unavailability

staffUnavailabilityId : ID!

The ID of Staff Unavailability to update

start : LocalDateTime

Start datetime of the absence

end : LocalDateTime

End datetime of the absence

workingDays : Decimal

Number of working days

timeZone : String

The absence timezone

contactId : ID

The ID of the Contact that will be absent

description : String

Description of the absence

absenceReasonId : ID

The ID of the Absence Reason

Back to top

StaffWithConflicts

Details of Staff which can not be automatically rescheduled with their conflicts

conflicts : [EventStaffConflict!]!

Details of the conflicts

staff : Staff!

Details of Staff who have conflicts

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
Back to top

StandardCustomFieldDefinition

Related types: CustomFieldDefinition

canEdit : Boolean!

Whether the custom field can be edited by the current user

definitionLocator : String

Human readable name of the Custom Field

description : String

A description explaining the use of the Custom Field

includeInSearch : Boolean!

Whether values of this custom field are included in global search

isRequired : Boolean!

Whether the custom field is required

isRestricted : Boolean!

Whether the custom field is required

key : ID!

The identifier for this definition

label : String!

The label of the CustomFieldDefinition

options : [Option!]

Choices to present for a Custom Field with choice options

permissionGrants : [CustomFieldDefinitionPermission!]!

Role permission grants on editing or viewing this custom field's data

roles : [ID!]!

User Roles which have permissions to view and edit the data in this field (empty means no restrictions)

type : CustomFieldType!

The type of value allowed for this Custom Field

Back to top

StandardFieldValidation

attributeSelector : String!

The selector rule for an Attribute on this Entity. This can be an Attribute name, or a nested Attribute path using dot-notion, e.g. personal_name.first_name.

entityType : StandardFieldValidationEntityType!

The type of the Entity these validations are for.

required : Boolean!

Is the selected attribute required or not.

Back to top

StandardFieldValidationEntityType

An enumeration.

Account
Contact
CreditNote
Invoice
Back to top

StandardFieldValidationInput

attributeSelector : String!
required : Boolean!
Back to top

StandardFieldValidationMutations

setStandardFieldValidations : StandardFieldValidationsResponse!
Argument Type Description
input SetStandardFieldValidationsInput!
Back to top

StandardFieldValidationsResponse

standardFieldValidations : [StandardFieldValidation!]!
Back to top

StockItem

Related types: Node InterestItem

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Stock Item

Argument Type Description
filter CustomFieldFilterInput
description : String!

The description of the Stock Item

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Stock Item

learningCategories : LearningCategoryConnection!

The Learning Categories of the Stock Item

Argument Type Description
filters = [] [LearningCategoryFieldGraphFilter]
order = "__EMPTY__" LearningCategoryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningCategoryFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Stock Item

prices : StockItemPriceConnection!

The Prices of the Stock Item

Argument Type Description
filters = [] [StockItemPriceFieldGraphFilter]
order = "__EMPTY__" StockItemPriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StockItemPriceFieldGraphOrder]
Back to top

StockItemConnection

A connection containing page information and edges for StockItem

edges : [StockItemEdge!]!

The list of StockItem edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

StockItemCreateInput

An Input for creating a Stock Item

name : String!

The name of the StockItem

description : String!

The description of the StockItem

financialAccountId : String!

ID of the associated sales financial account

purchaseAccountId : String!

ID of the associated purchase financial account

linkedChildIds : [String]

Optional list of linked child item IDs

childItemIds : [String]

Optional list of child item IDs

customFieldValues : [CustomFieldValueInput]

Optional list of custom field values

Back to top

StockItemEdge

Contains cursor and node information for type StockItem

cursor : String!

A string that can be used for cursor-based pagination

node : StockItem!

The StockItem node.

Back to top

StockItemField

Fields for filtering and ordering Stock Items

id
name
Back to top

StockItemFieldGraphFilter

Filter that can be applied to limit which StockItem nodes are returned

field : StockItemField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

StockItemFieldGraphOrder

Specifies the order in which StockItem nodes are returned via the Connection

field : StockItemField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

StockItemMutations

Available Mutations on a Stock Items

create : StockItemUpdateResponse!

Create a new Stock Item

Argument Type Description
input StockItemCreateInput!

The input type with the values used to create a Stock Item
update : StockItemUpdateResponse!

Update a Stock Item

Argument Type Description
input StockItemUpdateInput!

The input type with the values used to update a Stock Item
Back to top

StockItemPrice

The Stock Item Price

Related types: Node

amount : Decimal!

The amount of the Stock Item Price

currency : Currency!

The Currency of the Stock Item Price

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
description : String!

The description of the Stock Item Price

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Stock Item Price

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

region : Region!

The Region of the Stock Item Price

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

StockItemPriceConnection

A connection containing page information and edges for StockItemPrice

edges : [StockItemPriceEdge!]!

The list of StockItemPrice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

StockItemPriceEdge

Contains cursor and node information for type StockItemPrice

cursor : String!

A string that can be used for cursor-based pagination

node : StockItemPrice!

The StockItemPrice node.

Back to top

StockItemPriceField

Fields for filtering and ordering Stock Item Prices

id
regionId
currencyCode
Back to top

StockItemPriceFieldGraphFilter

Filter that can be applied to limit which StockItemPrice nodes are returned

field : StockItemPriceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

StockItemPriceFieldGraphOrder

Specifies the order in which StockItemPrice nodes are returned via the Connection

field : StockItemPriceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

StockItemUpdateInput

stockItemId : ID!

The ID of the Stock Item being updated

customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Stock Item to update

Back to top

StockItemUpdateResponse

A Response for an Stock Item Update Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

item : StockItem

The Stock Item that was updated

Back to top

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Back to top

StringSuggestionServiceCategory

Categories of available suggestions in suggestString

accountName
companyName
contactEmail
contactFullName
coreUserFullName
courseTemplateCode
courseTemplateTitle
eventTitle
eventCode
learningCategoryName
learningPathName
location
opportunityName
opportunityStageName
opportunityStepName
opportunityStateName
Back to top

Summary

A Summary of platform activity for a given date range

Related types: Node

createdAt : TimeZonedDateTime!

When the Summary compilation was created

end : TimeZonedDateTime!

When the Summary period end

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The unique identifier

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

sections : [SummarySection!]!

List of sections containing Summary descriptions

start : TimeZonedDateTime!

When the Summary period begins

Back to top

SummaryIntegrationMutations

Updates Summary integration information.

fetchToken : SummaryIntegrationTokenResponse!

Fetches a short-lived API token to be used by the Summary integration

remove : SummaryIntegrationResponse!

Removes the Summary API connection

Back to top

SummaryIntegrationResponse

The response to a request to disconnect the Summary integration

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

SummaryIntegrationTokenResponse

The response to request a token for the Summary integration

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

summaryToken : SummaryToken

The Summary integration token

Back to top

SummarySection

A Summary of platform activity for a given date range

content : String!

The HTML content for the section

Back to top

SummaryToken

A token to fetch a Summary from our integration partner

expiresAt : TimeZonedDateTime!

When the Summary period begins

token : String!

The short-lived token

Back to top

SupportedEntities

An enumeration.

all
learning_path
event
Back to top

SupportsCustomField

Types that support Custom Field Definitions

CourseTemplate
Account
Event
Contact
Opportunity
Learner
LearningPath
Session
OpportunityEventInterestLearner
LearningPathLearner
OpportunityPathInterestLearner
StockItem
Company
Achievement
OpportunityStockItemInterest
Course
Content
OpportunityPassInterestLearner
TokenIssue
EventBreakoutGroup
Personnel
CourseBreakoutGroup
Back to top

SupportsCustomFieldPortalEntities

Types that support Custom Field Definitions on a Portal

Viewer
CourseCard
LearningPathCard
Back to top

SupportsExternalIDType

Node types where an External ID can be stored

AccountProject
Achievement
AchievementType
AchievementDocument
AchievementDMSDocument
AchievementDocumentURL
AchievementNumberSequence
AutomatorAutomation
AutomatorConnection
AutomatorUser
Brand
BrandIdentityProviderConfiguration
CalendarEntry
CertificateTemplate
CertificateGenerationLog
CommunicationTemplate
CertificateType
Company
ContactCredentials
LmsContent
ContentComment
Event
Survey
CourseItem
CourseLevel
CancellationRequest
CancellationReason
CourseTemplate
CourseTemplateLmsContent
CreditNote
Discount
DiscountPromotionCode
Document
DocumentCategory
JobRole
MembershipJobRole
MarketingActivity
MarketingCampaign
DocumentTemplate
EventCost
EventTag
FinancialAccount
Folder
GiftVoucher
GiftVoucherConfiguration
GiftVoucherPortalConfiguration
GradeTemplate
Industry
Invoice
Learner
LearnerAssessment
LearnerContentResult
LmsAttempt
Locale
ScormAttemptInteraction
LearningCategory
LearningPath
LearningPathEventSelectionOption
LearningPathLearner
LearningObjective
LearningOutcome
LearningPathPrice
Location
MarketingSourceType
Membership
Opportunity
Interest
OpportunityStage
OpportunityStep
OpportunityTransition
OpportunitySection
OpportunityAttribute
Account
Payment
Contact
Portal
PriceLevel
PromotionCampaign
PurchaseOrder
PurchaseInvoice
PurchaseCreditNote
Refund
Region
Registration
Resource
ResourceBooking
ResourceType
UserRole
SendingEmailAddress
SendingPhoneNumber
Session
SessionTemplate
Staff
StaffRole
StaffUnavailability
StockItem
StockItemPrice
Task
TaxType
TrainingTokenAccount
TrainingTokenIssue
TrainingTokenTransaction
TrainingTokenType
TrainingTokenReceipt
TrainingTokenReceiptLine
TrainingPass
TrainingPassAssignment
TrainingPassType
TrainingPassTypeOption
TrainingPassTypeOptionPrice
User
Webhook
Workplace
WorkingPattern
Address
ExternalCalendarEvent
Back to top

SupportsPointOfSaleField

Types that support Point of Sale Field Definitions

OpportunityEventInterestLearner
OpportunityPathInterestLearner
OpportunityStockItemInterest
OpportunityPassInterestLearner
Back to top

Survey

The instance of an event survey

Related types: Node

courseCount : Int!

The number of courses using this survey

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
external_id : ID!

External ID of the Survey

id : ID!

ID of the Survey

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

provider : String

The provider of the survey, e.g. "surveymonkey"

public_url : String

The public link to the survey, if available

questions : [SurveyQuestion!]!

The questions of the survey

selected : Boolean!

Whether this survey is the selected survey for this event or not

title : String!

Title of the Survey

url : String!

The URL of the survey to analyze the results

Back to top

SurveyConnection

A connection containing page information and edges for Survey

edges : [SurveyEdge!]!

The list of Survey edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

SurveyEdge

Contains cursor and node information for type Survey

cursor : String!

A string that can be used for cursor-based pagination

node : Survey!

The Survey node.

Back to top

SurveyField

Fields for filtering and ordering Survey

id
external_id
Back to top

SurveyFieldGraphFilter

Filter that can be applied to limit which Survey nodes are returned

field : SurveyField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SurveyFieldGraphOrder

Specifies the order in which Survey nodes are returned via the Connection

field : SurveyField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

SurveyQuestion

A question on a Survey

externalId : String!

The external ID of the question

family : String!

The family of the question

id : ID!

The ID of the question

isInstructorQuestion : Boolean!

Whether the question is the instructor rating question

max : Int

The maximum value of the question

min : Int

The minimum value of the question

question : String!

The text of the question

subtype : String!

The subtype of the question

surveyId : String!

The ID of the survey this question belongs to

Back to top

SyncCalendarsInput

An input for syncing an Entity's calendar.

entityId : ID!

The ID of the Administrate Entity the calendar is connected to

Back to top

SyncCalendarsResponse

The response to a request to sync Entity connected calendars

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

SyncDirection

The direction this field is synced in for the integration

toVendor
toAdministrate
both
Back to top

SyncResourceCalendarsInput

An input for syncing External Calendars with Resources

calendarId : String!

ID for the External Calendar to be synced

Back to top

SystemFontFamily

Font families that are available across common operating systems

arial
arialBlack
courier
courierNew
garamond
georgia
helvetica
palatino
sansSerif
serif
times
timesNewRoman
trebuchet
verdana
Back to top

SystemSetting

Editable metadata for a SystemSettings row.

Related types: Node

description : String!

The setting description.

displayName : String

The human-readable setting label.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
help : String

Additional help text for the setting.

id : ID!

The SystemSettings row identifier.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The unique SystemSettings name.

possibleOptions : String

Pipe-separated option values for option-based input types.

section : String!

The display section derived from the setting name prefix.

type : String

The legacy setting input type.

value : String

The current setting value.

Back to top

SystemSettingConnection

A connection containing page information and edges for SystemSetting

edges : [SystemSettingEdge!]!

The list of SystemSetting edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

SystemSettingEdge

Contains cursor and node information for type SystemSetting

cursor : String!

A string that can be used for cursor-based pagination

node : SystemSetting!

The SystemSetting node.

Back to top

SystemSettingField

SystemSetting fields for filtering and ordering.

id
name
section
type
Back to top

SystemSettingFieldGraphFilter

Filter that can be applied to limit which SystemSetting nodes are returned

field : SystemSettingField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

SystemSettingFieldGraphOrder

Specifies the order in which SystemSetting nodes are returned via the Connection

field : SystemSettingField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

SystemSettings

Editable SystemSettings administration queries.

entries : SystemSettingConnection!

Returns editable SystemSettings rows for superusers.

Argument Type Description
filters = [] [SystemSettingFieldGraphFilter]
order = "__EMPTY__" SystemSettingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SystemSettingFieldGraphOrder]
sections : [SystemSettingsSection!]!

Returns editable SystemSettings sections for superusers.

Back to top

SystemSettingsMutations

Mutations for editable SystemSettings values.

update : SystemSettingsUpdateResponse!

Updates editable SystemSettings values.

Argument Type Description
input [SystemSettingUpdateInput]!
Back to top

SystemSettingsSection

A SystemSettings editor section.

name : String!

The section display name.

settingCount : Int!

The number of editable settings in this section.

Back to top

SystemSettingsUpdateResponse

Response for updating SystemSettings values.

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

settings : [SystemSetting!]!

The updated settings.

Back to top

SystemSettingUpdateInput

A SystemSettings value update.

name : String!
value : String!
Back to top

Task

Related types: Node

account : Account

The Account linked to this Task

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
assignee : User

The User this Task is assigned to

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
completedAt : TimeZonedDateTime

The Date and Time the Task was completed. For existing or older data where the completion date cannot be determined, the value may be returned as null.

contact : Contact

The Contact linked to this Task

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime!

The Date and Time the Task was created

dueDate : LocalDateTime

The Date and Time the Task is due

endDate : LocalDateTime

The Date and Time the Task ends

event : Event

The Event linked to this Task

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Task

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Task

notes : String

The notes of the Task

opportunity : Opportunity

The Opportunity linked to this Task

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
showOnCalendar : Boolean

Whether this Task will be displayed on the calendar

staffRole : StaffRole

The Staff Role an Event Task is for. The first Staff to be added to an Event for this Role will be assigned the Task.

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
status : TaskStatus!

The status of the Task

timeZoneName : String

The TimeZone Name of the Task

type : TaskType!

The TaskType of the Task

Argument Type Description
filters = [] [TaskTypeFieldGraphFilter]
order = "__EMPTY__" TaskTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskTypeFieldGraphOrder]
updatedAt : TimeZonedDateTime!

The Date and Time the Task was updated

Back to top

TaskAuditLogEntry

One entry from a Task's audit log.

Related types: Node

action : String!

What happened to the Task: created, started, completed, updated...

changes : [AuditLogChange!]!

The entry's changes, one row per field, in the same shape as the Event audit log's changes.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the audit log entry.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

occurredAt : TimeZonedDateTime!

When the change was recorded, in UTC.

taskName : String

The name of the Task the entry belongs to.

userName : String

The name of the User who made the change.

Back to top

TaskAuditLogEntryConnection

A connection containing page information and edges for TaskAuditLogEntry

edges : [TaskAuditLogEntryEdge!]!

The list of TaskAuditLogEntry edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TaskAuditLogEntryEdge

Contains cursor and node information for type TaskAuditLogEntry

cursor : String!

A string that can be used for cursor-based pagination

node : TaskAuditLogEntry!

The TaskAuditLogEntry node.

Back to top

TaskAuditLogEntryField

Fields for filtering and ordering Task audit log entries.

id
taskId
eventId
occurredAt
Back to top

TaskAuditLogEntryFieldGraphFilter

Filter that can be applied to limit which TaskAuditLogEntry nodes are returned

field : TaskAuditLogEntryField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TaskAuditLogEntryFieldGraphOrder

Specifies the order in which TaskAuditLogEntry nodes are returned via the Connection

field : TaskAuditLogEntryField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TaskConnection

A connection containing page information and edges for Task

edges : [TaskEdge!]!

The list of Task edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TaskCreateInput

An Input for creating a Task

taskTypeId : ID!

The ID of the Task Type

name : String!

The name of the Task

dueDate : LocalDateTime!

The due date of the Task

timeZoneName : String!

The timezone of the Task

userId : ID

The ID of the User to assign the Task to

staffRoleId : ID

The ID of the Staff Role this Task is for (only applicable to Event tasks)

description : String

The description of the Task

status : TaskStatus

The Status of the Task

showOnCalendar : Boolean

Whether to display this Task on the calendar

endDate : LocalDateTime

The end date of the Task

Back to top

TaskDeleteInput

An Input for deleting a Task

taskId : ID!

The ID of the Task to be deleted

Back to top

TaskEdge

Contains cursor and node information for type Task

cursor : String!

A string that can be used for cursor-based pagination

node : Task!

The Task node.

Back to top

TaskField

Fields for filtering and ordering Tasks

id
name
assigneeId
taskTypeId
dueDate
endDate
status
eventId
opportunityId
accountId
contactId
contactAccountId
createdAt
updatedAt
completedAt
Back to top

TaskFieldGraphFilter

Filter that can be applied to limit which Task nodes are returned

field : TaskField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TaskFieldGraphOrder

Specifies the order in which Task nodes are returned via the Connection

field : TaskField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TaskMutateResponse

A Response from Task Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

task : Task

A Task that has been mutated

Back to top

TaskMutations

Mutations for a Task

createAccountTask : TaskMutateResponse!

Mutation to create a new Account Task

Argument Type Description
input AccountTaskCreateInput!

The input type with values to create the Task
createContactTask : TaskMutateResponse!

Mutation to create a new Contact Task

Argument Type Description
input ContactTaskCreateInput!

The input type with values to create the Task
createEventTask : TaskMutateResponse!

Mutation to create a new Event Task

Argument Type Description
input EventTaskCreateInput!

The input type with values to create the Task
createOpportunityTask : TaskMutateResponse!

Mutation to create a new Opportunity Task

Argument Type Description
input OpportunityTaskCreateInput!

The input type with values to create the Task
createPersonalTask : TaskMutateResponse!

Mutation to create a personal Task

Argument Type Description
input TaskCreateInput!

The input type with values to create the Task
delete : TaskMutateResponse!

Mutation to delete an existing Task

Argument Type Description
input TaskDeleteInput!

The input type with values to delete the Task
update : TaskMutateResponse!

Mutation to update an existing Task

Argument Type Description
input TaskUpdateInput!

The input type with values to update the Task
Back to top

TaskStatus

An enumeration.

todo
doing
done
Back to top

TaskTemplate

A Template for creating Event Tasks

Related types: Node

assignee : User

The User to which the new Task will be assigned by default

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Task Template

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Task created from this template

notes : String

The notes of the Task created from this template

offset : Int!

The amount of days from the event date specified in offsetType on which to set the new Task due date

offsetType : TaskTemplateOffsetType!

The Event date (start or end) from which the offset will be applied to calculate a new Task due date

staffRole : StaffRole

A Staff Role to assign the new Task to, which will cause it to be assigned to the first Personnel to assume that Role on the Task's Event

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
type : TaskType!

The type of Task created from this template

Argument Type Description
filters = [] [TaskTypeFieldGraphFilter]
order = "__EMPTY__" TaskTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskTypeFieldGraphOrder]
Back to top

TaskTemplateConnection

A connection containing page information and edges for TaskTemplate

edges : [TaskTemplateEdge!]!

The list of TaskTemplate edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TaskTemplateCreateInput

An Input for creating a Task Template

typeId : ID!

The Type of the Task created from this template

name : String!

The name of the Task created from this template

offset : Int!

The amount of days from the event date specified in offsetType on which to set the new Task due date A positive integer means 'after' the offsetType, a negative integer means 'before'.

offsetType : TaskTemplateOffsetType!

The Event date (start or end) from which the offset will be applied to calculate a new Task due date

taskWorkflowGroupId : ID

The Workflow Group this Template will be part of (DEPRECATED - replaced by taskWorkflowId)

taskWorkflowId : ID

The Workflow this Template will be part of

notes : String

The notes of the Task created from this template

assigneeId : ID

User to which any Tasks created from this template will be assigned to. Either an assigneeId or a staffRoleId is required.

staffRoleId : ID

Staff Role which determines Personnel to assign any Event Tasks created from this template. Either an assigneeId or a staffRoleId is required.

Back to top

TaskTemplateDeleteInput

An Input for deleting a Task template

taskTemplateId : ID!

The Task template to be deleted

Back to top

TaskTemplateEdge

Contains cursor and node information for type TaskTemplate

cursor : String!

A string that can be used for cursor-based pagination

node : TaskTemplate!

The TaskTemplate node.

Back to top

TaskTemplateFieldGraphFilter

Filter that can be applied to limit which TaskTemplate nodes are returned

field : TaskTemplateTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TaskTemplateFieldGraphOrder

Specifies the order in which TaskTemplate nodes are returned via the Connection

field : TaskTemplateTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TaskTemplateMutateResponse

A response from mutating a Task Template

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

taskTemplates : [TaskTemplate!]!

The Task Templates that have been mutated

Back to top

TaskTemplateMutations

Mutations for Task Templates

create : TaskTemplateMutateResponse!

Create new Task Templates

Argument Type Description
input [TaskTemplateCreateInput]!
delete : TaskTemplateMutateResponse!

Deletes Task Templates

Argument Type Description
input [TaskTemplateDeleteInput]!
update : TaskTemplateMutateResponse!

Updates Task Templates

Argument Type Description
input [TaskTemplateUpdateInput]!
Back to top

TaskTemplateOffsetType

The event triggering the offset calculation for a Task due date created from this Task Template

eventStart
eventEnd
Back to top

TaskTemplateTypeField

Fields for filtering and ordering Task Templates

id
Back to top

TaskTemplateUpdateInput

An Input for updating a Task Template

taskTemplateId : ID!

The Task template to be updated

typeId : ID

The Type of the Task created from this template

name : String

The name of the Task created from this template

offset : Int

The amount of days from the event date specified in offsetType on which to set the new Task due date A positive integer means 'after' the offsetType, a negative integer means 'before'.

offsetType : TaskTemplateOffsetType

The Event date (start or end) from which the offset will be applied to calculate a new Task due date

notes : String

The notes of the Task created from this template

assigneeId : ID

User to which any Tasks created from this template will be assigned to. Providing this value will unset any staffRoleId previously set.

staffRoleId : ID

Staff Role which determines Personnel to assign any Event Tasks created from this template. Providing this value will unset any assigneeId previously set.

Back to top

TaskType

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Task Type

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Task Type

Back to top

TaskTypeConnection

A connection containing page information and edges for TaskType

edges : [TaskTypeEdge!]!

The list of TaskType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TaskTypeEdge

Contains cursor and node information for type TaskType

cursor : String!

A string that can be used for cursor-based pagination

node : TaskType!

The TaskType node.

Back to top

TaskTypeField

Fields for filtering and ordering Task Types

id
name
Back to top

TaskTypeFieldGraphFilter

Filter that can be applied to limit which TaskType nodes are returned

field : TaskTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TaskTypeFieldGraphOrder

Specifies the order in which TaskType nodes are returned via the Connection

field : TaskTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TaskUpdateInput

An Input for updating a Task

taskId : ID!

The Id of the Task to update

taskTypeId : ID

The ID of the new Task Type

userId : ID

The ID of the new User to assign the Task to

staffRoleId : ID

The ID of the Staff Role this Task is for. Task will be assigned to the User for the first Personnel with the role added to the Event

name : String

The new name of the Task

description : String

The new description of the Task

dueDate : LocalDateTime

The new due date of the Task

endDate : LocalDateTime

The new end date of the Task

timeZoneName : String

The new timezone of the Task

status : TaskStatus

The new Status of the Task

showOnCalendar : Boolean

Whether to display this Task on the calendar

Back to top

TaskWorkflow

A collection of Task templates that can be associated with a Course Template and will be used to generate Tasks for Events created from the Course Template.

Related types: Node

company : Company

The Company associated with this Task Workflow.

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Task Workflow.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Task Workflow.

taskTemplates : TaskTemplateConnection!

The Task Templates that belong to this Workflow

Argument Type Description
filters = [] [TaskTemplateFieldGraphFilter]
order = "__EMPTY__" TaskTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskTemplateFieldGraphOrder]
Back to top

TaskWorkflowConnection

A connection containing page information and edges for TaskWorkflow

edges : [TaskWorkflowEdge!]!

The list of TaskWorkflow edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TaskWorkflowCreateInput

An Input for creating a Task Workflow

name : String!

The Task Workflow name

companyId : String

The Company ID for the Task Workflow

Back to top

TaskWorkflowDeleteInput

An Input for deleting a Task Workflow

taskWorkflowId : ID!

The ID of Task Workflow to be deleted

Back to top

TaskWorkflowEdge

Contains cursor and node information for type TaskWorkflow

cursor : String!

A string that can be used for cursor-based pagination

node : TaskWorkflow!

The TaskWorkflow node.

Back to top

TaskWorkflowFieldGraphFilter

Filter that can be applied to limit which TaskWorkflow nodes are returned

field : TaskWorkflowTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TaskWorkflowFieldGraphOrder

Specifies the order in which TaskWorkflow nodes are returned via the Connection

field : TaskWorkflowTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TaskWorkflowGroup

A group of tasks to be attached to an event.

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Deprecated fields (5)
company : Company

The Company associated with this Task Workflow Group.

Removal date: 2026-06-26.

Replaced by TaskWorkflow.company

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
displayId : String!

A unique number which can be used by a user to quickly reference a specific Task Workflow Group.

Removal date: 2026-06-26.

Do not use

id : ID!

ID of the Task Workflow Group.

Removal date: 2026-06-26.

Replaced by TaskWorkflow.id

name : String!

Name of the Task Workflow Group.

Removal date: 2026-06-26.

Replaced by TaskWorkflow.name

taskTemplates : TaskTemplateConnection!

The Task Templates that belong to this Group

Removal date: 2026-06-26.

Replaced by TaskWorkflow.taskTemplates

Argument Type Description
filters = [] [TaskTemplateFieldGraphFilter]
order = "__EMPTY__" TaskTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskTemplateFieldGraphOrder]
Back to top

TaskWorkflowGroupConnection

A connection containing page information and edges for TaskWorkflowGroup

edges : [TaskWorkflowGroupEdge!]!

The list of TaskWorkflowGroup edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TaskWorkflowGroupCreateInput

An Input for creating a Task Workflow Group

name : String!

The Task Workflow Group name

companyId : String

The Company ID for the Task Workflow Group

Back to top

TaskWorkflowGroupDeleteInput

An Input for deleting a Task Workflow Group

taskWorkflowGroupId : ID!

The ID of Task Workflow Group to be deleted

Back to top

TaskWorkflowGroupEdge

Contains cursor and node information for type TaskWorkflowGroup

cursor : String!

A string that can be used for cursor-based pagination

node : TaskWorkflowGroup!

The TaskWorkflowGroup node.

Back to top

TaskWorkflowGroupFieldGraphFilter

Filter that can be applied to limit which TaskWorkflowGroup nodes are returned

field : TaskWorkflowGroupTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TaskWorkflowGroupFieldGraphOrder

Specifies the order in which TaskWorkflowGroup nodes are returned via the Connection

field : TaskWorkflowGroupTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TaskWorkflowGroupMutateResponse

A response from Task Workflow Group Mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

taskWorkflowGroup : TaskWorkflowGroup

A Task Workflow Group that has been mutated

Back to top

TaskWorkflowGroupMutations

Mutations for a Task Workflow Group

Deprecated fields (3)
create : TaskWorkflowGroupMutateResponse!

Creates a new Task Workflow

Removal date: 2026-06-26.

Replaced by TaskWorkflowMutations.create

Argument Type Description
input TaskWorkflowGroupCreateInput!
delete : TaskWorkflowGroupMutateResponse!

Deletes an existing Task Workflow Group

Removal date: 2026-06-26.

Replaced by TaskWorkflowMutations.delete

Argument Type Description
input TaskWorkflowGroupDeleteInput!
update : TaskWorkflowGroupMutateResponse!

Updates an existing Task Workflow Group

Removal date: 2026-06-26.

Replaced by TaskWorkflowMutations.update

Argument Type Description
input TaskWorkflowGroupUpdateInput!
Back to top

TaskWorkflowGroupTypeField

Fields for filtering and ordering Task Workflow Group Types

id
displayId
name
Back to top

TaskWorkflowGroupUpdateInput

An Input for updating a Task Workflow Group

taskWorkflowGroupId : ID!

The ID of the Task Workflow Group being updated

name : String

The new name for the Task Workflow Group

companyId : String

The new Company ID for the Task Workflow Group

Back to top

TaskWorkflowMutateResponse

A response from mutating a Task Workflow

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

taskWorkflow : TaskWorkflow

The Task Workflow that has been mutated

Back to top

TaskWorkflowMutations

Mutations for Task Workflows

create : TaskWorkflowMutateResponse!

Creates a new Task Workflow

Argument Type Description
input TaskWorkflowCreateInput!
delete : TaskWorkflowMutateResponse!

Deletes an existing Task Workflow

Argument Type Description
input TaskWorkflowDeleteInput!
update : TaskWorkflowMutateResponse!

Updates an existing Task Workflow

Argument Type Description
input TaskWorkflowUpdateInput!
Back to top

TaskWorkflowTypeField

Fields for filtering and ordering Task Workflows

id
name
Back to top

TaskWorkflowUpdateInput

An Input for updating a Task Workflow

taskWorkflowId : ID!

The ID of the Task Workflow being updated

name : String

The new name for the Task Workflow

companyId : String

The new Company ID for the Task Workflow

Back to top

TaxType

A named Tax Type which can be applied to a financial amount to calculate tax

Related types: Node

applyAfterDiscount : Boolean!

If tax rate is applied after any discounts

effectiveRate : Decimal!

The tax rate that is applied

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
financialAccount : FinancialAccount!

The financial account that the tax type is linked to

Argument Type Description
filters = [] [FinancialAccountFieldGraphFilter]
order = "__EMPTY__" FinancialAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [FinancialAccountFieldGraphOrder]
id : ID!
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name given to the Tax Type

Back to top

TaxTypeConnection

A connection containing page information and edges for TaxType

edges : [TaxTypeEdge!]!

The list of TaxType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TaxTypeCreateInput

The input for creating a Tax Type

creditAccountId : ID!

The ID of the Credit Account assigned to the Tax Type

name : String!

The name of the Tax Type

effectiveRate : String!

The tax rate that is applied by this Tax Type

applyAfterDiscount : Boolean!

If tax rate is applied after any discounts

Back to top

TaxTypeEdge

Contains cursor and node information for type TaxType

cursor : String!

A string that can be used for cursor-based pagination

node : TaxType!

The TaxType node.

Back to top

TaxTypeField

Fields for filtering and ordering TaxTypes

id
name
Back to top

TaxTypeFieldGraphFilter

Filter that can be applied to limit which TaxType nodes are returned

field : TaxTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TaxTypeFieldGraphOrder

Specifies the order in which TaxType nodes are returned via the Connection

field : TaxTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TaxTypeMutationReponse

A Response for mutating a Credit Note

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

taxType : TaxType

The Tax Type that has been mutated

Back to top

TaxTypeMutations

Mutations of Tax Types

create : TaxTypeMutationReponse!

Creates a new Tax Type

Argument Type Description
input TaxTypeCreateInput!
createDigitalTax : [DigitalTaxMutationResponse!]!

Creates a new Digital Tax which associates a Tax Type to a Country (and optional Province) so that any digital product purchases will be taxed according to the purchasing Account billing address.

Argument Type Description
input [DigitalTaxCreateInput]!
deleteDigitalTax : [DigitalTaxMutationResponse!]!

Removes an existing Digital Tax

Argument Type Description
input [DigitalTaxDeleteInput]!
Back to top

TemplateLocaleData

Communication Template data for a specific locale

attachments : CommunicationTemplateAttachmentConnection!

Attachments for the Locale Data

Argument Type Description
filters = [] [CommunicationTemplateAttachmentFieldGraphFilter]
order = "__EMPTY__" CommunicationTemplateAttachmentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CommunicationTemplateAttachmentFieldGraphOrder]
body : String

The body of the Locale Data

id : ID!

The ID of the Localized Template Data

isDefault : Boolean!

Whether or not this Locale Data is default for the Communication Template

locale : Locale!

The Locale of the Locale Data

Argument Type Description
filters = [] [LocaleFieldGraphFilter]
order = "__EMPTY__" LocaleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocaleFieldGraphOrder]
subject : String

The subject of the Locale Data

Back to top

Time

A time of day as an ISO 8601 formatted string without date or timezone information

Back to top

TimeRange

The Time Range given by the filter scalar, a range specified by two Year-Months. The Filter scalar is defined as a string in the format: "MMM YYYY - MMM YYYY" with casing and spacing being optional as all spaces are stripped and all casing is set to upper internally

fromMonth : MonthYear!

The initial month of the range, the first moment of the month is the datetime used

toMonth : MonthYear!

The last month of the range. The first moment of the next month is the datetime used

Back to top

TimeZonedDateTime

A date and time as an ISO 8601 formatted string with a time zone offset

Back to top

TokenBalanceAdjustmentInput

An input for adjusting a Token Balance

tokenIssueId : ID!

The ID of Token Issue to adjust

amount : Int!

The amount to increase/decrease the Token Balance

notes : String

Optional notes describing the adjustment

Back to top

TokenBalanceAdjustmentResponse

A Response from adjusting a Token Balance

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

tokenIssue : TrainingTokenIssue

The adjusted Token Issue

transaction : TrainingTokenTransaction

The Transaction that adjusted the Token Issue

Back to top

TokenBalanceMutations

Mutations for Token Balances

adjust : TokenBalanceAdjustmentResponse!

Adjust the Current Balance of a Training Token Account

Argument Type Description
input TokenBalanceAdjustmentInput!

The input type with the values to be adjust a Token Balance
Back to top

TokenIssueCreateInput

An Input for Creating a Token Issue

accountId : ID!

The ID of the Account to Issue the Tokens to

quantity : Int!

The amount of Tokens to Issue

tokenTypeId : String!

The ID of the Token Type

originOpportunityId : ID

The Opportunity that the Token Issues originated from

expireOnOverride : Date

Overrides the default expiry for the Token Type

customFieldValues : [CustomFieldValueInput]

The list of Custom Field Values of the Token Issue to create

contactIds : [ID]
Back to top

TokenIssueExtendInput

An Input for extending a Token Issue expiry date

tokenIssueId : ID!

The ID of the Token Issue being updated

expiresAt : Date!

The new expire date of the Token

Back to top

TokenIssueMutationResponse

A Response for a Token Issue Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

tokenIssue : TrainingTokenIssue

The Token Issue that was updated

Back to top

TokenIssueMutations

Available Mutations on a Token Issue

create : TokenIssueMutationResponse!
Argument Type Description
input TokenIssueCreateInput!
extend : TokenIssueMutationResponse!

Extends the Token Issue expiry date

Argument Type Description
input TokenIssueExtendInput!

The input type with the values used to extend the Token Issue
setContacts : TokenIssueSetContactsMutationResponse!

Sets Contacts for a Token Issue. These Contacts will receive Communications about this Token Issue

Argument Type Description
input TokenIssueSetContactsInput!

The input type with the values used to set Communication Contacts on a Token Issue
update : TokenIssueMutationResponse!

Updates the details of a Token Issue

Argument Type Description
input TokenIssueUpdateInput!

The input type with the values to be updated
Back to top

TokenIssueSetContactsInput

An Input for setting Contacts on a Token Issue

tokenIssueId : ID!

The ID of the Token Issue to set the Contacts on

contactIds : [ID]!

The IDs of the Contacts to set on the Token Issue

Back to top

TokenIssueSetContactsMutationResponse

A Response for the setContacts Token Issue Mutation

errors : [FieldError!]!

The errors returned by the mutation

tokenIssue : TrainingTokenIssue

The Token Issue that was updated

Back to top

TokenIssueUpdateInput

An Input for updating a Token Issue

tokenIssueId : ID!

The ID of the Token Issue being updated

expiresAt : Date
customFieldValues : [CustomFieldValueInput]

The list of CustomFieldValues of the Token Issue to update

Back to top

TokenTransactionInput

The input identifying the Token Transaction to be refunded

tokenTransactionId : ID!

The ID of the Token Transaction to refund

Back to top

TokenTransactionMutations

refund : TokenTransactionResponse!

Refund a Token Transaction

Argument Type Description
input TokenTransactionInput!
Back to top

TokenTransactionResponse

A Response from refunding a Token Transaction

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

tokenTransaction : TrainingTokenTransaction

The refunded Token transaction

Back to top

TrainingPass

A Training Pass

Related types: Node

account : Account

The Account linked to the Training Pass

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
assignments : TrainingPassAssignmentConnection!

Shows the assignment history for this Training Pass.

Argument Type Description
filters = [] [TrainingPassAssignmentFieldGraphFilter]
order = "__EMPTY__" TrainingPassAssignmentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassAssignmentFieldGraphOrder]
contact : Contact

The Contact linked to the Training Pass

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Training Pass

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : TrainingPassLifecycleState!

Current status of this Training Pass. This is the only field you have to check if you want to know if the Training Pass is active. This field is always up to date.

opportunityInterest : Interest

The Opportunity Interest this Training Pass was Issued from

Argument Type Description
filters = [] [InterestFieldGraphFilter]
order = "__EMPTY__" InterestFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InterestFieldGraphOrder]
trainingPassType : TrainingPassType!

The Training Pass Type linked to the Training Pass

Argument Type Description
filters = [] [TrainingPassTypeFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeFieldGraphOrder]
trainingPassTypeOption : TrainingPassTypeOption

The Training Pass Type Option chosen when issuing/renewing the pass

Argument Type Description
filters = [] [TrainingPassTypeOptionFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeOptionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeOptionFieldGraphOrder]
validFrom : TimeZonedDateTime!

The UTC date and time this Training Pass should be valid from. To get current Training Pass status always use lifecycleState.

validUntil : TimeZonedDateTime!

The UTC date and time this Training Pass should be valid until. To get current Training Pass status always use lifecycleState.

Back to top

TrainingPassAssignContactInput

Input fields for Assigning a Training Pass to a Contact

trainingPassId : ID!

The ID of the Training Pass the contact will be assigned to

contactId : ID!

The ID of the contact that will be assigned to the training pass

Back to top

TrainingPassAssignment

A Training Pass Assignment

Related types: Node

assignedAt : TimeZonedDateTime!

The UTC date and time that the Training Pass was assigned to the Contact.

contact : Contact

The Contact linked to the Assignment

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
contactId : ID!

ID of the Contact in the Training Pass Assignment

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Training Pass Assignment

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

renewedAt : TimeZonedDateTime

The UTC date and time that the Training Pass was renewed at.

trainingPass : TrainingPass!

The Training Pass linked to this Assignment

Argument Type Description
filters = [] [TrainingPassFieldGraphFilter]
order = "__EMPTY__" TrainingPassFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassFieldGraphOrder]
unassignedAt : TimeZonedDateTime

The UTC date and time that the Training Pass was unassigned from the Contact. If the value is empty, the record shows current Contact assignment.

Back to top

TrainingPassAssignmentConnection

A connection containing page information and edges for TrainingPassAssignment

edges : [TrainingPassAssignmentEdge!]!

The list of TrainingPassAssignment edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingPassAssignmentEdge

Contains cursor and node information for type TrainingPassAssignment

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingPassAssignment!

The TrainingPassAssignment node.

Back to top

TrainingPassAssignmentField

Fields for filtering and ordering Training Pass Assignments

id
trainingPassId
contactId
assignedAt
unassignedAt
renewedAt
Back to top

TrainingPassAssignmentFieldGraphFilter

Filter that can be applied to limit which TrainingPassAssignment nodes are returned

field : TrainingPassAssignmentField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingPassAssignmentFieldGraphOrder

Specifies the order in which TrainingPassAssignment nodes are returned via the Connection

field : TrainingPassAssignmentField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingPassConnection

A connection containing page information and edges for TrainingPass

edges : [TrainingPassEdge!]!

The list of TrainingPass edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingPassDetailsAddInput

An Input containing the details required by a Training Pass Interest

validFrom : LocalDateTime

(DEPRECATED) Use 'timeZonedValidFrom' instead. The effective start date and time of the created pass(es).

validUntil : LocalDateTime

(DEPRECATED) Use 'timeZonedValidUntil' instead. The expiration date and time of the created pass(es).

timeZonedValidFrom : TimeZonedDateTime

The effective start date and time (with timezone) of the created pass(es).

timeZonedValidUntil : TimeZonedDateTime

The expiration date and time (with timezone) of the created pass(es).

Back to top

TrainingPassDetailsUpdateInput

An Input containing the details required by an Training Pass Interest

Back to top

TrainingPassEdge

Contains cursor and node information for type TrainingPass

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingPass!

The TrainingPass node.

Back to top

TrainingPassField

Fields for filtering and ordering Training Passes

id
trainingPassTypeId
validFrom
validUntil
lifecycleState
contactId
accountId
opportunityInterestId
validForEventId
Back to top

TrainingPassFieldGraphFilter

Filter that can be applied to limit which TrainingPass nodes are returned

field : TrainingPassField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingPassFieldGraphOrder

Specifies the order in which TrainingPass nodes are returned via the Connection

field : TrainingPassField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingPassInput

Input Fields for a Training Pass

trainingPassTypeId : ID!

The ID of the Type of Training Pass

validFrom : TimeZonedDateTime!

When the Training Pass is valid from

validUntil : TimeZonedDateTime!

When the Training Pass is valid until

accountId : ID

The ID of the Account the Training Pass is assigned to

contactId : ID

The ID of the Contact the Training Pass is assigned to

trainingPassTypeOptionId : ID

The ID of the Option used when the Training Pass was issued

Back to top

TrainingPassLifecycleState

The Lifecycle State of the Training Pass

active
inactive
cancelled
Back to top

TrainingPassMutateResponse

The response from calling a Training Pass mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

trainingPass : TrainingPass

The Training Pass that was created or updated

Back to top

TrainingPassMutations

Mutations for Training Passes

addContentToPassType : TrainingPassTypeMutateResponse!

Adds specified content to a Training Pass Type

Argument Type Description
input TrainingPassTypeContentInput!

The input type with values identifying the Training Pass Type and Content
assignContactToPass : TrainingPassMutateResponse!

Assigns a given Contact to Training Pass

Argument Type Description
input TrainingPassAssignContactInput!

The input type with values identifying the Contact and Training Pass
bulkAddContentToPassType : TrainingPassTypeMutateResponse!

Adds specified content to a Training Pass Type

Argument Type Description
input TrainingPassTypeBulkContentInput!

The input type with values identifying the Training Pass Type and Content
createType : TrainingPassTypeMutateResponse!

Creates a Training Pass Type

Argument Type Description
input TrainingPassTypeInput!

The input type with the values to be set on the new Training Pass Type
createTypeOption : TrainingPassTypeOptionMutateResponse!

Creates a Training Pass Type Option for a given Training Pass Type.

Argument Type Description
input TrainingPassTypeOptionCreateInput!

The input type with the values to be set on the new Training Pass Type Option.
createTypeOptionPrice : TrainingPassTypeOptionPriceMutateResponse!

Creates a Training Pass Type Option Price for a given Training Pass Type Option.

Argument Type Description
input TrainingPassTypeOptionPriceCreateInput!

The input type with the values to be set on the new Training Pass Type Option Price.
issuePass : TrainingPassMutateResponse!

Issues a Training Pass to contact / account

Argument Type Description
input TrainingPassInput!

The input type with the values to be set on the new Training Pass
raiseCreditNote : CreditNoteMutationReponse!

Raises a Credit Note for a cancelled Training Pass

Argument Type Description
input CreditTrainingPassInput!

The input type with values identifying the pass to be refunded via Credit Note
removeContentFromPassType : TrainingPassTypeMutateResponse!

Removes specified content from a Training Pass Type

Argument Type Description
input TrainingPassTypeContentInput!

The input type with values identifying the Training Pass Type and Content
removePassType : TrainingPassTypeMutateResponse!

Removes a draft Training Pass Type and any options, prices, and content linked to it.

Argument Type Description
input TrainingPassTypeRemoveInput!

The input type with a value to identify the Training Pass Type to remove
removeTypeOption : TrainingPassTypeMutateResponse!

Removes the specified option from a Training Pass Type. Both the Training Pass Type and the Training Pass Type Option must not be in 'draft' status.

Argument Type Description
input TrainingPassTypeOptionRemoveInput!

The input type with a value to identify the Training Pass Type Option to remove
removeTypeOptionPrice : TrainingPassTypeOptionMutateResponse!

Removes the specified price from a Training Pass Type Option. The price cannot be removed if it is the last price on an active Training Pass Type Option.

Argument Type Description
input TrainingPassTypeOptionPriceRemoveInput!

The input type with a value to identify the Training Pass Type Option Price to be removed
renewPass : TrainingPassMutateResponse!

Renews a contact's active Training Pass

Argument Type Description
input TrainingPassRenewInput!

The input type with values identifying the pass to be renewed
revokePass : TrainingPassMutateResponse!

Revokes active Training Pass.

Argument Type Description
input TrainingPassRevokeInput!

The input type with values identifying the pass to be revoked
update : TrainingPassMutateResponse!

Updates an existing Training Pass

Argument Type Description
input TrainingPassUpdateInput!

The input type with the values that can be updated for this Training Pass.
updateType : TrainingPassTypeMutateResponse!

Updates an existing Training Pass Type

Argument Type Description
input TrainingPassTypeUpdateInput!

The input type with the values that can be changed for this Type.
updateTypeOption : TrainingPassTypeOptionMutateResponse!

Updates an existing Training Pass Type Option.

Argument Type Description
input TrainingPassTypeOptionUpdateInput!

The input type with the values that can be changed for this Type Option.
updateTypeOptionPrice : TrainingPassTypeOptionPriceMutateResponse!

Updates an existing Training Pass Type Option Price.

Argument Type Description
input TrainingPassTypeOptionPriceUpdateInput!

The input type with the values that can be changed for this Type Option Price.
Back to top

TrainingPassRenewInput

Input fields for renewing a Training Pass

trainingPassId : ID!

The ID of the Training Pass that will be updated

validUntil : TimeZonedDateTime!

The value validUntil will be updated to

trainingPassTypeOptionId : ID

The ID of the Training Pass Option that was chosen for renewal purposes, if any

Back to top

TrainingPassRevokeInput

Input fields for revoking a Training Pass

trainingPassId : ID!

The ID of the Training Pass to be revoked

Back to top

TrainingPassType

A Training Pass Type

Related types: Node

code : String

Code for the Training Pass Type

content : TrainingPassTypeContentConnection!

Content available for this Training Pass Type.

Argument Type Description
filters = [] [TrainingPassTypeContentFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeContentFieldGraphOrder]
courseTemplateCount : Int!

The number of Course Templates included in the Training Pass Type

description : String

Description of the Training Pass Type

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Training Pass Type

learningPathCount : Int!

The number of Learning Paths included in the Training Pass Type

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : TrainingPassTypeLifecycleState!

The Lifecycle State of the Training Pass Type

name : String!

Name of the Training Pass Type

options : TrainingPassTypeOptionConnection!

The Training Pass Type Options that are set for this Training Pass Type.

Argument Type Description
filters = [] [TrainingPassTypeOptionFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeOptionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeOptionFieldGraphOrder]
Back to top

TrainingPassTypeBulkContentInput

Input fields for bulk-adding Content to a Training Pass Type

trainingPassTypeId : ID!

The ID of the Training Pass Type

filters : [CatalogueItemFieldGraphFilter]

Catalogue filters that are used to select Content to add

search : String

Search string for Catalogue Content

excludeIds : [ID]

List of Content ID to exclude from bulk add

Back to top

TrainingPassTypeConnection

A connection containing page information and edges for TrainingPassType

edges : [TrainingPassTypeEdge!]!

The list of TrainingPassType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingPassTypeContent

Content available for given Training Pass Type.

Related types: CourseTemplate LearningPath

id : ID!

The ID of the Content

Back to top

TrainingPassTypeContentConnection

A connection containing page information and edges for TrainingPassTypeContent

edges : [TrainingPassTypeContentEdge!]!

The list of TrainingPassTypeContent edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingPassTypeContentEdge

Contains cursor and node information for type TrainingPassTypeContent

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingPassTypeContent!

The TrainingPassTypeContent node.

Back to top

TrainingPassTypeContentField

Fields for filtering and ordering Training Pass Type Content. type: The Type (CourseTemplate or LearningPath) of Content to return

id
type
name
Back to top

TrainingPassTypeContentFieldGraphFilter

Filter that can be applied to limit which TrainingPassTypeContent nodes are returned

field : TrainingPassTypeContentField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingPassTypeContentFieldGraphOrder

Specifies the order in which TrainingPassTypeContent nodes are returned via the Connection

field : TrainingPassTypeContentField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingPassTypeContentInput

Input fields for assigning Content to a Training Pass Type

trainingPassTypeId : ID!

The ID of the Training Pass Type

pathIds : [ID]

An optional list of Learning Path IDs

courseIds : [ID]

An optional list of Course IDs

courseResourceIds : [ID]

An optional list of Course Resource IDs

eventResourceIds : [ID]

An optional list of Event Resource IDs

Back to top

TrainingPassTypeEdge

Contains cursor and node information for type TrainingPassType

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingPassType!

The TrainingPassType node.

Back to top

TrainingPassTypeField

Fields for filtering and ordering Training Pass Types

id
name
code
lifecycleState
hasAccessToLearningPathId
hasAccessToCourseTemplateId
Back to top

TrainingPassTypeFieldGraphFilter

Filter that can be applied to limit which TrainingPassType nodes are returned

field : TrainingPassTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingPassTypeFieldGraphOrder

Specifies the order in which TrainingPassType nodes are returned via the Connection

field : TrainingPassTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingPassTypeInput

Input for Training Pass Types

name : String!

The name of the Training Pass Type

lifecycleState : TrainingPassTypeLifecycleState

The lifecycle state of the Training Pass Type

code : String

The Training Pass Type code

description : String

A description of the Training Pass Type

Back to top

TrainingPassTypeLifecycleState

The Lifecycle State of the Training Pass Type

draft
published
archived
Back to top

TrainingPassTypeMutateResponse

The response from mutating a Training Pass Type

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

trainingPassType : TrainingPassType

The Training Pass Type that was created or updated

Back to top

TrainingPassTypeOption

A Training Pass Type Option

Related types: Node InterestItem

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Training Pass Type Option

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : TrainingPassTypeOptionLifecycleState!

The Lifecycle State of the Training Pass Type Option

name : String!

Name of the Training Pass Type Option

prices : TrainingPassTypeOptionPriceConnection!

Prices available for this Training Pass Type Option

Argument Type Description
filters = [] [TrainingPassTypeOptionPriceFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeOptionPriceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeOptionPriceFieldGraphOrder]
trainingPassType : TrainingPassType!

The Training Pass Type this Type Option belongs to.

Argument Type Description
filters = [] [TrainingPassTypeFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeFieldGraphOrder]
validityPeriod : DateDelta!

The Validity Period of the Training Pass Type Option

Back to top

TrainingPassTypeOptionConnection

A connection containing page information and edges for TrainingPassTypeOption

edges : [TrainingPassTypeOptionEdge!]!

The list of TrainingPassTypeOption edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingPassTypeOptionCreateInput

Input fields for creating a Training Pass Type Option

trainingPassTypeId : ID!

The ID of the Training Pass Type the new Type Option is being created for.

name : String!

This Type Option name. It has to be unique within given Training Pass Type.

validityPeriod : DateDeltaInput!

The Validity Period of this Type Option. Set using the DateDeltaInput type.

lifecycleState : TrainingPassTypeOptionLifecycleState

The Lifecycle State of this Type Option.

Back to top

TrainingPassTypeOptionEdge

Contains cursor and node information for type TrainingPassTypeOption

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingPassTypeOption!

The TrainingPassTypeOption node.

Back to top

TrainingPassTypeOptionField

Fields for filtering and ordering Training Pass Type Options

id
name
lifecycleState
Back to top

TrainingPassTypeOptionFieldGraphFilter

Filter that can be applied to limit which TrainingPassTypeOption nodes are returned

field : TrainingPassTypeOptionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingPassTypeOptionFieldGraphOrder

Specifies the order in which TrainingPassTypeOption nodes are returned via the Connection

field : TrainingPassTypeOptionField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingPassTypeOptionLifecycleState

The Lifecycle State of the Training Pass Type Option

draft
published
archived
Back to top

TrainingPassTypeOptionMutateResponse

The response from mutating a Training Pass Type Option

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

trainingPassTypeOption : TrainingPassTypeOption

The Training Pass Type Option that was created or updated

Back to top

TrainingPassTypeOptionPrice

A Training Pass Type Option Price.

Related types: Node

amount : Decimal!

The Training Pass Type Option Price Amount expressed in Financial Unit.

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
financialUnit : FinancialUnit!

The Financial Unit of the Training Pass Type Option Price, which can be either a Currency or a Training Token Type.

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
id : ID!

ID of the Training Pass Type Option Price.

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

option : TrainingPassTypeOption!

The Training Pass Type Option this Price belongs to.

Argument Type Description
filters = [] [TrainingPassTypeOptionFieldGraphFilter]
order = "__EMPTY__" TrainingPassTypeOptionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassTypeOptionFieldGraphOrder]
region : Region!

The Region of the Training Pass Type Option Price.

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
Back to top

TrainingPassTypeOptionPriceConnection

A connection containing page information and edges for TrainingPassTypeOptionPrice

edges : [TrainingPassTypeOptionPriceEdge!]!

The list of TrainingPassTypeOptionPrice edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingPassTypeOptionPriceCreateInput

Input fields for creating a Training Pass Type Option Price

trainingPassTypeOptionId : ID!

The ID of the Type Option the new Type Option Price is being created for.

regionId : ID!

The ID of the Region the new Type Option Price is being created in.

amount : Decimal!

The Amount for which to create this Type Option Price. Specified in the chosen Financial Unit.

currencyCode : String

Currency Code for this Type Option Price to be used as Financial Unit. Either this or trainingTokenTypeId has to be specified.

trainingTokenTypeId : ID

Training Token Type ID for this Type Option Price to be used as Financial Unit. Either this or currencyCode has to be specified.

Back to top

TrainingPassTypeOptionPriceEdge

Contains cursor and node information for type TrainingPassTypeOptionPrice

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingPassTypeOptionPrice!

The TrainingPassTypeOptionPrice node.

Back to top

TrainingPassTypeOptionPriceField

Fields for filtering and ordering Training Pass Type Option Prices

id
regionId
currencyCode
Back to top

TrainingPassTypeOptionPriceFieldGraphFilter

Filter that can be applied to limit which TrainingPassTypeOptionPrice nodes are returned

field : TrainingPassTypeOptionPriceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingPassTypeOptionPriceFieldGraphOrder

Specifies the order in which TrainingPassTypeOptionPrice nodes are returned via the Connection

field : TrainingPassTypeOptionPriceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingPassTypeOptionPriceMutateResponse

The response from mutating a Training Pass Type Option Price

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

trainingPassTypeOptionPrice : TrainingPassTypeOptionPrice

The Training Pass Type Option Price that was created or updated

Back to top

TrainingPassTypeOptionPriceRemoveInput

Input fields for removing a Training Pass Type Option Price

optionPriceId : ID!

The id of the Training Pass Type Option Price to be removed

Back to top

TrainingPassTypeOptionPriceUpdateInput

Input fields for updating a Training Pass Type Option Price

trainingPassTypeOptionPriceId : ID!

The ID of the Type Option Price being updated.

regionId : ID

The ID of the Region to update.

amount : Decimal

The Amount to update the Type Option Price with. Specified in the chosen Financial Unit.

currencyCode : String

Currency Code for this Type Option Price to be used as Financial Unit. Either this or trainingTokenTypeId has to be present in the updated entity.

trainingTokenTypeId : ID

Training Token Type ID for this Type Option Price to be used as Financial Unit. Either this or currencyCode has to be present in the updated entity.

Back to top

TrainingPassTypeOptionRemoveInput

Input fields for removing a Training Pass Type Option

optionId : ID!

The id of the Training Pass Type Option to be removed

Back to top

TrainingPassTypeOptionUpdateInput

Input fields for updating a Training Pass Type Option

trainingPassTypeOptionId : ID!

The ID of the Type Option being updated.

name : String

The updated name of this Type Option. It has to be unique within given Training Pass Type.

lifecycleState : TrainingPassTypeOptionLifecycleState

The updated Lifecycle State of this Type Option.

validityPeriod : DateDeltaInput

The updated Validity Period of this Type Option. Set using the DateDeltaInput type. This field can only be changed as a whole (both unit and value at the same time).

Back to top

TrainingPassTypeRemoveInput

Input fields for removing a Training Pass Type

trainingPassTypeId : ID!

The id of the Training Pass Type to be removed

Back to top

TrainingPassTypeUpdateInput

Input fields for updating a Training Pass Type

trainingPassTypeId : ID!

The ID of the Training Pass Type to be updated

name : String

The name of the Training Pass Type

lifecycleState : TrainingPassTypeLifecycleState

The lifecycle state of the Training Pass Type

code : String

The code for the Training Pass Type

description : String

A description of the Training Pass Type

Back to top

TrainingPassUpdateInput

Input fields for updating a Training Pass Type

trainingPassId : ID!

The ID of the Training Pass that will be updated

validFrom : TimeZonedDateTime

The value validFrom will be set to

validUntil : TimeZonedDateTime

The value validUntil will be set to

Back to top

TrainingRequestCreateInput

An Input for creating an Opportunity

name : String!

The name given to the Opportunity

interestDetails : InterestDetailsAddInput!

The Interest to be added when this Opportunity is created

contactId : ID

An existing Contact associated with this Opportunity

brandId : ID

An existing Brand associated with this Opportunity

Back to top

TrainingRequestWorkflow

The Training request workflow for a Weblink Portal

enabled : Boolean!

A setting boolean to describe whether the Training Request Workflow is enabled

id : ID!

The ID of the Training Request Workflow

marketingSourceType : MarketingSourceType!

The Marketing source type set on the Opportunities generated by this Training Request

Argument Type Description
filters = [] [MarketingSourceTypeFieldGraphFilter]
order = "__EMPTY__" MarketingSourceTypeFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [MarketingSourceTypeFieldGraphOrder]
privateEntryStep : OpportunityStep!

The Entry Step on an Opportunity for a private Training Request

publicEntryStep : OpportunityStep!

The Entry Step on an Opportunity for a public Training Request

successMessage : String

The message shown on successful Training Request Workflow form submission

workflowFields : [TrainingRequestWorkflowField!]!

The Workflow Fields linked to this Training Request form

Back to top

TrainingRequestWorkflowField

A Field on a Weblink Portal Training Request Workflow form

id : ID!

The ID of the Training Request Workflow Field

label : String!

The label of the Training Request Workflow Field

opportunityAttribute : CustomFieldDefinition!

The Custom Field Definition linked to the Training Request Workflow Field

position : Int!

The display position of the Training Request Workflow Field on the Request form

required : Boolean!

Whether this Training Request Workflow Field is required to be filled out

Back to top

TrainingRequestWorkflowFieldGraphFilter

Filter that can be applied to limit which TrainingRequestWorkflow nodes are returned

field : TrainingRequestWorkflowFilterField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingRequestWorkflowFieldGraphOrder

Specifies the order in which TrainingRequestWorkflow nodes are returned via the Connection

field : TrainingRequestWorkflowFilterField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingRequestWorkflowFilterField

Fields for filtering and ordering Training Request Workflows

id
Back to top

TrainingTokenAccount

Collection of Training Token transactions in a specific Token Type

Related types: Node

account : Account!
Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
currentBalance : Int!

Current balance of the Token Account

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

Training Token Type ID

issues : TrainingTokenIssueConnection!

All Issues for this Training Token to this Account

Argument Type Description
filters = [] [TrainingTokenIssueFieldGraphFilter]
order = "__EMPTY__" TrainingTokenIssueFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenIssueFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

trainingTokenType : TrainingTokenType!

Token Type of this Token Account

transactions : TrainingTokenTransactionConnection!

All Transactions for this Token Account

Argument Type Description
filters = [] [TrainingTokenTransactionFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTransactionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTransactionFieldGraphOrder]
Back to top

TrainingTokenAccountConnection

A connection containing page information and edges for TrainingTokenAccount

edges : [TrainingTokenAccountEdge!]!

The list of TrainingTokenAccount edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingTokenAccountEdge

Contains cursor and node information for type TrainingTokenAccount

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingTokenAccount!

The TrainingTokenAccount node.

Back to top

TrainingTokenAccountField

An enumeration.

id
trainingTokenTypeId
trainingTokenTypeName
Back to top

TrainingTokenAccountFieldGraphFilter

Filter that can be applied to limit which TrainingTokenAccount nodes are returned

field : TrainingTokenAccountField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingTokenAccountFieldGraphOrder

Specifies the order in which TrainingTokenAccount nodes are returned via the Connection

field : TrainingTokenAccountField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingTokenDetailsAddInput

An Input containing the details required by a Training Token Interest"

expiresAt : LocalDateTime

"Date and time of the token expiry. Set to null if the token does not expire. If omitted it will use the token default"

Back to top

TrainingTokenIssue

A Block of Tokens Issued To An Account

Related types: Node

contacts : ContactConnection!

Contacts who will receive Communications about this Token Issue

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime!

A timestamp representing when the Training Token was issued

currentBalance : Int!

The number of unredeemed and unexpired tokens for this Token Issue

customFieldValues : [CustomFieldValue!]!

Custom Field values for the Token Issue

Argument Type Description
filter CustomFieldFilterInput
expiresAt : TimeZonedDateTime

A timestamp representing when any remaining unused quantity of Tokens will be forfeited

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Node

initialBalance : Int!

The number of tokens which were originally issued

isExpired : Boolean!

Whether or not the expiresAt date has passed

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

opportunity : Opportunity

The Opportunity that created this Token Issue, if there was one

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
paymentCode : TrainingTokenIssuePaymentCode

The Payment Code used for Paying using this Token Issue. Also contains the value for any Imported Payment Code which was generated on a system out-with Administrate

tokenAccount : TrainingTokenAccount!

The Token Account that contains the Token Issue

Argument Type Description
filters = [] [TrainingTokenAccountFieldGraphFilter]
order = "__EMPTY__" TrainingTokenAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenAccountFieldGraphOrder]
tokenType : TrainingTokenType!

The type of Training Token

Argument Type Description
filters = [] [TrainingTokenAccountFieldGraphFilter]
order = "__EMPTY__" TrainingTokenAccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenAccountFieldGraphOrder]
totalRedeemed : Int!

The number of tokens redeemed for this Token Issue

transactions : TrainingTokenTransactionConnection!

The Training Token Transactions against this Token Issue

Argument Type Description
filters = [] [TrainingTokenTransactionFieldGraphFilter]
order = "__EMPTY__" TrainingTokenTransactionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenTransactionFieldGraphOrder]
Back to top

TrainingTokenIssueConnection

A connection containing page information and edges for TrainingTokenIssue

edges : [TrainingTokenIssueEdge!]!

The list of TrainingTokenIssue edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingTokenIssueEdge

Contains cursor and node information for type TrainingTokenIssue

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingTokenIssue!

The TrainingTokenIssue node.

Back to top

TrainingTokenIssueField

An enumeration.

id
createdAt
expiresAt
initialBalance
currentBalance
isExpired
pointOfContactId
Back to top

TrainingTokenIssueFieldGraphFilter

Filter that can be applied to limit which TrainingTokenIssue nodes are returned

field : TrainingTokenIssueField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingTokenIssueFieldGraphOrder

Specifies the order in which TrainingTokenIssue nodes are returned via the Connection

field : TrainingTokenIssueField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingTokenIssuePaymentCode

importedAlias : String
lifecycleState : String!
value : String!
Back to top

TrainingTokenReceipt

A Token Receipt corresponding to the purchase of a Billable item

Related types: Node SalesDocument

account : Account

The Account this Token Order is for

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
company : Company

The Company that issued this Sales Document

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
currency : Currency

The Currency this Sales Document was issued in

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
discount : Discount

The Discount applied to this Sales Document

discountAmount : Decimal!

The total amount of discount applied to this Sales Document excluding any Tax

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Token Receipt

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lines : [TrainingTokenReceiptLine!]!

A list of lines containing the information about the ordered items

number : String!

The number of the Token Receipt

region : Region

The Region in which the Sales Document is located in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
subTotalAmount : Decimal!

The amount of tokens used

taxSummary : [InvoiceTaxSummary!]!

A list of Tax Types and corresponding amounts applied to this Sales Document

totalAmount : Decimal!

The amount of tokens used

totalRemaining : Decimal!

The total remaining credit or debit on this SalesStatement

Deprecated fields (1)
tokenReceiptNumber : String!

The number of the Token Receipt

Removal date: TBD.

Replaced by number

Back to top

TrainingTokenReceiptLine

A line in a Token Receipt corresponding to the purchase of a Billable item

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Node

item : Billable!

The item purchased

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

tokenAmount : Int!

The amount of tokens used

tokenReceipt : TrainingTokenReceipt!

The receipt for the Token purchase

tokenTransaction : TrainingTokenTransaction

The transaction linked to this receipt line

tokenType : TrainingTokenType!

The type of Token used to purchase

Back to top

TrainingTokenTransaction

A record of a balance change in a Token Account

Related types: Node

account : Account!

The Account this transaction belongs to.

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
allocations : [TrainingTokenTransactionLine!]!

Allocations of the transaction that link to the Token Issues the tokens are associated with

balanceDelta : Int!

The amount by which the Account balance changed

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Node

interest : Interest

The Opportunity Interest that generated this Transaction, if the Tokens were generated from an Opportunity.

Argument Type Description
filters = [] [InterestFieldGraphFilter]
order = "__EMPTY__" InterestFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [InterestFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

notes : String!

Notes describing the adjustment

occurredAt : TimeZonedDateTime!

When this Transaction occurred

tokenReceiptLine : TrainingTokenReceiptLine

The TokenReceiptLine for this transaction

type : String!

Reason for the Training Token balance change

Back to top

TrainingTokenTransactionConnection

A connection containing page information and edges for TrainingTokenTransaction

edges : [TrainingTokenTransactionEdge!]!

The list of TrainingTokenTransaction edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingTokenTransactionEdge

Contains cursor and node information for type TrainingTokenTransaction

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingTokenTransaction!

The TrainingTokenTransaction node.

Back to top

TrainingTokenTransactionField

An enumeration.

id
occurredAt
type
Back to top

TrainingTokenTransactionFieldGraphFilter

Filter that can be applied to limit which TrainingTokenTransaction nodes are returned

field : TrainingTokenTransactionField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingTokenTransactionFieldGraphOrder

Specifies the order in which TrainingTokenTransaction nodes are returned via the Connection

field : TrainingTokenTransactionField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TrainingTokenTransactionLine

The number of tokens adjusted in a Token Issue in a Token Transaction

balanceDeltaPart : Int!

The number of tokens that were added or removed from the Token Issue

issue : TrainingTokenIssue

The Token Issue a number of tokens was added or removed from. May be empty in the case of zero tokens adjusted.

Back to top

TrainingTokenType

A category of Training Tokens, use to implement business redemption rules.

Related types: FinancialUnit Node InterestItem

defaultDaysToRedeem : Int

The default amount of days before Training Tokens of this type expire

description : String

Short description providing additional details for the Training Token Type

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

Training Token Type ID

isArchived : Boolean

Whether the Training Token Type is still in use

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name given to the Training Token Type

Back to top

TrainingTokenTypeConnection

A connection containing page information and edges for TrainingTokenType

edges : [TrainingTokenTypeEdge!]!

The list of TrainingTokenType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TrainingTokenTypeEdge

Contains cursor and node information for type TrainingTokenType

cursor : String!

A string that can be used for cursor-based pagination

node : TrainingTokenType!

The TrainingTokenType node.

Back to top

TrainingTokenTypeField

An enumeration.

id
name
isArchived
Back to top

TrainingTokenTypeFieldGraphFilter

Filter that can be applied to limit which TrainingTokenType nodes are returned

field : TrainingTokenTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TrainingTokenTypeFieldGraphOrder

Specifies the order in which TrainingTokenType nodes are returned via the Connection

field : TrainingTokenTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TransferLearnerFinancialInformationInput

An Input for financial actions required for transferring a Learner

raiseCreditNote : Boolean

Whether to raise a Credit Note if the learner has been invoiced

raiseInvoice : Boolean

Whether to raise a Invoice for the new Event

finaliseNewCreditNote : Boolean

Whether the new credit note will be automatically finalised after the transfer

finaliseNewInvoice : Boolean

Whether the new invoice will be automatically finalised after the transfer

Back to top

TransferLearnerInput

An Input for transfering a Learner

learnerId : ID!

The ID of the Learner to transfer

eventId : ID!

The ID of the Event the Learner is being transferred to

stockItemId : ID

The Stock Item ID of the transfer

eventPriceId : ID

The Event Price ID of the Event that the Learner is being transferred to

financialInformation : TransferLearnerFinancialInformationInput

An Input for financial actions required for transferring a Learner

overridePriceAmount : Decimal

The optional override of the price for the new registration

trainingPassTypeId : ID
breakoutGroups : [EventBreakoutGroupSelectionInput]

selection of Breakout Groups on the destination Event to assign the transferred Learner to

Back to top

TransferLearnerResponse

The Response for a Learner transfer

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

learner : Learner

The Learner that has been transferred

Back to top

Trigger

Communication Triggers

Related types: Node

audience : TriggerAudience

The group of recipients that this Trigger will send to

audienceStaffRole : StaffRole

The Staff Role this Trigger will send to, when its audience is Staff with a Role

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
blended : Boolean!

Communication Trigger will fire for Blended events

classroom : Boolean!

Communication Trigger will fire for Classroom events

code : String!

The code of the Trigger

communicationTemplate : CommunicationTemplate

The Communication Template that the Trigger will use

Argument Type Description
filters = [] [CommunicationTemplateFieldGraphFilter]
order = "__EMPTY__" CommunicationTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CommunicationTemplateFieldGraphOrder]
communicationType : TriggerCommunicationType

Communication type

company : Company

The Company linked to a Trigger

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
courseTemplates : CourseTemplateConnection!

The target course templates for this Trigger

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
createdAt : LocalDateTime

The date and time that the Trigger was created

event : Event

The target event for this Trigger

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
eventType : EventType

Type of the Event (public/private) that the Trigger applies to

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Trigger

isArchived : Boolean!

Is the Trigger archived

isAutomatic : Boolean!

Is the Trigger automatic

isDisabled : Boolean!

Is the Trigger disabled

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lms : Boolean!

Communication Trigger will fire for LMS events

location : Location

The location of Event linked to a Trigger

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
name : String!

The name of the Trigger

offsetInHours : Int

The offset (in hours) before or after the trigger action that the Trigger will fire

recipientEmailAddresses : String

The Email Addresses of the Recipients of the Trigger

region : Region

The Region of the Event linked to a Trigger

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
sendingEmailAddress : SendingEmailAddress

The email address to send from - only applicable when the communication type is email

Argument Type Description
filters = [] [SendingEmailAddressFieldGraphFilter]
order = "__EMPTY__" SendingEmailAddressFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingEmailAddressFieldGraphOrder]
sendingPhoneNumber : SendingPhoneNumber

The phone number to send from - only applicable when the communication type is sms

Argument Type Description
filters = [] [SendingPhoneNumberFieldGraphFilter]
order = "__EMPTY__" SendingPhoneNumberFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingPhoneNumberFieldGraphOrder]
target : TriggerTarget

The Target of the Trigger

timeZoneName : String

The Timezone name for the scheduled hour in Scheduled Triggers

trigger : TriggerTrigger

The action that will cause the trigger to fire

Back to top

TriggerAudience

An enumeration.

delegates
staff
administrators
instructors
booking_contacts
opportunity_owner
opportunity_contact
learning_assignments
payment_billing_email
opportunity_recipient
training_pass_recipient
training_token_contact
opportunity_billing_contact
Back to top

TriggerCloneInput

The input for cloning a trigger

triggerId : ID!

The ID of the Trigger to clone.

code : String!
Back to top

TriggerCloneMutationResponse

The response type for the trigger clone mutation

errors : [FieldError!]!

The errors returned by the mutation

trigger : Trigger

The Trigger that was mutated

Back to top

TriggerCommunicationInput

The input for sending an trigger email or sms from a trigger log.

triggerLogId : ID!

The log ID for the email

subject : String

The subject of the email. This will override the subject of the associated communication template. Only valid for emails.

body : String

The body of the email. This will override the body of the associated communication template.

attachments : [BulkAdhocEmailAttachment]

A list of the ID/Type mappings of DMS or communication template documents to attach to the email. Only valid for emails.

ccList : [String]

A list of valid email addresses to send a copy (CC) of the email to. Only valid for emails.

contentLocaleId : ID

The ID of the Locale the subject and body are written in, so that merge fields resolve in the same language. Defaults to the language the Event is delivered in.

Back to top

TriggerCommunicationInputMutationsResponse

The response type for ad-hoc trigger email mutations

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

Back to top

TriggerCommunicationType

An enumeration.

email
sms
Back to top

TriggerConnection

A connection containing page information and edges for Trigger

edges : [TriggerEdge!]!

The list of Trigger edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TriggerCourseMapInput

The input for mapping Course Templates to course-based Triggers

triggerId : ID!

The ID of the Trigger to be updated.

courseTemplateIds : [ID]!

The IDs of the Course Templates participating in this mutation

Back to top

TriggerEdge

Contains cursor and node information for type Trigger

cursor : String!

A string that can be used for cursor-based pagination

node : Trigger!

The Trigger node.

Back to top

TriggerEmail

Trigger Emails

attachments : [EmailAttachment!]

The attachments added to the Trigger Email

body : String

The Body of the Trigger Email

ccAddresses : String

The Addresses CC'd to the Trigger Email

clickedAt : LocalDateTime

The date and time that the Trigger Email was clicked

id : ID!

ID of the Trigger Email

openedAt : LocalDateTime

The date and time that the Trigger Email was opened

recipientContact : Contact

The contact to whom the notification will be sent.

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
sentAt : LocalDateTime

The date and time that the Trigger Email was sent

sentByUser : User

The User of the Trigger Email

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
status : TriggerEmailStatus

The status of the Trigger Email

subject : String

The Subject of the Trigger Email

toAddress : String

The Address of the recipient of the Trigger Email

toName : String

The Name of the recipient of the Trigger Email

Back to top

TriggerEmailConnection

A connection containing page information and edges for TriggerEmail

edges : [TriggerEmailEdge!]!

The list of TriggerEmail edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TriggerEmailEdge

Contains cursor and node information for type TriggerEmail

cursor : String!

A string that can be used for cursor-based pagination

node : TriggerEmail!

The TriggerEmail node.

Back to top

TriggerEmailField

Fields for filtering and ordering Trigger Emails

id
status
sentAt
openedAt
clickedAt
toName
toAddress
ccAddresses
subject
body
sentByUser
Back to top

TriggerEmailFieldGraphFilter

Filter that can be applied to limit which TriggerEmail nodes are returned

field : TriggerEmailField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TriggerEmailFieldGraphOrder

Specifies the order in which TriggerEmail nodes are returned via the Connection

field : TriggerEmailField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TriggerEmailStatus

An enumeration.

pending
sent
delivered
opened
clicked
invalid
bounced
rejected
soft_bounced
timed_out
sending
awaiting_render
processed
dropped
deferred
bounce
open
click
spamreport
unsubscribe
group_unsubscribe
group_resubscribe
error
hold
Back to top

TriggerField

Fields for filtering and ordering Triggers

id
code
name
target
audience
templateId
communicationType
sendingEmailAddressId
sendingPhoneNumberId
blended
classroom
companyId
courseTemplateId
event_type
lms
locationId
regionId
isDisabled
isAutomatic
isStaffAudience
Back to top

TriggerFieldGraphFilter

Filter that can be applied to limit which Trigger nodes are returned

field : TriggerField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TriggerFieldGraphOrder

Specifies the order in which Trigger nodes are returned via the Connection

field : TriggerField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TriggerForEvent

Communication Triggers as applied to a particular event

audience : TriggerAudience

The group of recipients that this Trigger will send to

audienceStaffRole : StaffRole

The Staff Role this Trigger will send to, when its audience is Staff with a Role

Argument Type Description
filters = [] [StaffRoleFieldGraphFilter]
order = "__EMPTY__" StaffRoleFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffRoleFieldGraphOrder]
blended : Boolean!

Communication Trigger will fire for Blended events

classroom : Boolean!

Communication Trigger will fire for Classroom events

code : String!

The code of the Trigger

communicationTemplate : CommunicationTemplate

The Communication Template that the Trigger will use

Argument Type Description
filters = [] [CommunicationTemplateFieldGraphFilter]
order = "__EMPTY__" CommunicationTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CommunicationTemplateFieldGraphOrder]
communicationType : TriggerCommunicationType

Communication type

company : Company

The Company linked to a Trigger

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
courseTemplates : CourseTemplateConnection!

The target course templates for this Trigger

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
createdAt : LocalDateTime

The date and time that the Trigger was created

event : Event

The target event for this Trigger

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
eventType : EventType

Type of the Event (public/private) that the Trigger applies to

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Trigger

isArchived : Boolean!

Is the Trigger archived

isAutomatic : Boolean!

Is the Trigger automatic

isDisabled : Boolean!

Is the Trigger disabled

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lms : Boolean!

Communication Trigger will fire for LMS events

location : Location

The location of Event linked to a Trigger

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
name : String!

The name of the Trigger

offsetInHours : Int

The offset (in hours) before or after the trigger action that the Trigger will fire

recipientEmailAddresses : String

The Email Addresses of the Recipients of the Trigger

region : Region

The Region of the Event linked to a Trigger

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
sendingEmailAddress : SendingEmailAddress

The email address to send from - only applicable when the communication type is email

Argument Type Description
filters = [] [SendingEmailAddressFieldGraphFilter]
order = "__EMPTY__" SendingEmailAddressFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingEmailAddressFieldGraphOrder]
sendingPhoneNumber : SendingPhoneNumber

The phone number to send from - only applicable when the communication type is sms

Argument Type Description
filters = [] [SendingPhoneNumberFieldGraphFilter]
order = "__EMPTY__" SendingPhoneNumberFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingPhoneNumberFieldGraphOrder]
target : TriggerTarget

The Target of the Trigger

timeZoneName : String

The Timezone name for the scheduled hour in Scheduled Triggers

trigger : TriggerTrigger

The action that will cause the trigger to fire

triggerAt : [TimeZonedDateTime!]!

The specific times this trigger will fire at, or empty list if not applicable.

Deprecated fields (1)
sendAt : LocalDateTime

The time this trigger will fire at - if applicable

Removal date: 2025-01-20.

Replaced by triggerAt

Back to top

TriggerLog

Communication Trigger Logs

achievement : Achievement

The Achievement that the Trigger Log references

Argument Type Description
filters = [] [AchievementFieldGraphFilter]
order = "__EMPTY__" AchievementFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AchievementFieldGraphOrder]
contact : Contact

The Contact of a Trigger that the Trigger Log references

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
error : String

Trigger Log Errors

event : Event

The Event that the Trigger Log references

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
id : ID!

ID of the Trigger Log

learner : Learner

The Learner that the Trigger Log references

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
learningPath : LearningPath

The Learning Path that the Trigger Log references

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
learningPathLearner : LearningPathLearner

The Learning Path Learner that the Trigger Log references

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
opportunity : Opportunity

The Opportunity that the Trigger Log references

Argument Type Description
filters = [] [OpportunityFieldGraphFilter]
order = "__EMPTY__" OpportunityFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityFieldGraphOrder]
payment : Payment

The Opportunity that the Trigger Log references

Argument Type Description
filters = [] [PaymentFieldGraphFilter]
order = "__EMPTY__" PaymentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PaymentFieldGraphOrder]
scheduledEmailAddress : String

The Scheduled Email Address that the Trigger Log references

session : Session

The Session that the Trigger Log references

Argument Type Description
filters = [] [SessionFieldGraphFilter]
order = "__EMPTY__" SessionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SessionFieldGraphOrder]
staff : Staff

The Staff that the Trigger Log references

Argument Type Description
filters = [] [StaffFieldGraphFilter]
order = "__EMPTY__" StaffFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [StaffFieldGraphOrder]
status : TriggerLogStatus!

The Status of the Trigger Log

trainingPass : TrainingPass

The Training Pass that the Trigger Log references

Argument Type Description
filters = [] [TrainingPassFieldGraphFilter]
order = "__EMPTY__" TrainingPassFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingPassFieldGraphOrder]
trainingTokenIssue : TrainingTokenIssue

The Training Token Issue that the Trigger Log references

Argument Type Description
filters = [] [TrainingTokenIssueFieldGraphFilter]
order = "__EMPTY__" TrainingTokenIssueFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingTokenIssueFieldGraphOrder]
trigger : Trigger

The Trigger that the Trigger Log references

Argument Type Description
filters = [] [TriggerFieldGraphFilter]
order = "__EMPTY__" TriggerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerFieldGraphOrder]
triggerEmail : TriggerEmail

Trigger Emails

Argument Type Description
filters = [] [TriggerEmailFieldGraphFilter]
order = "__EMPTY__" TriggerEmailFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerEmailFieldGraphOrder]
triggerSms : TriggerSms

Trigger SMS

Argument Type Description
filters = [] [TriggerSmsFieldGraphFilter]
order = "__EMPTY__" TriggerSmsFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TriggerSmsFieldGraphOrder]
type : TriggerLogCommunicationType

Communication type

Back to top

TriggerLogCommunicationType

An enumeration.

email
sms
Back to top

TriggerLogConnection

A connection containing page information and edges for TriggerLog

edges : [TriggerLogEdge!]!

The list of TriggerLog edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TriggerLogEdge

Contains cursor and node information for type TriggerLog

cursor : String!

A string that can be used for cursor-based pagination

node : TriggerLog!

The TriggerLog node.

Back to top

TriggerLogField

Fields for filtering and ordering Trigger Logs

id
status
type
communicationOrLogStatus
communicationSentAt
triggerId
contactId
eventId
learnerId
bookingContactId
learningPathId
learningPathLearnerId
staffId
opportunityId
paymentId
achievementId
trainingPassId
trainingTokenIssueId
error
scheduledEmail
sentByUser
triggerName
triggerAudience
contactName
learnerName
bookingContactName
learnerLifecycleState
communicationTemplateName
eventTitle
staffStatus
Back to top

TriggerLogFieldGraphFilter

Filter that can be applied to limit which TriggerLog nodes are returned

field : TriggerLogField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TriggerLogFieldGraphOrder

Specifies the order in which TriggerLog nodes are returned via the Connection

field : TriggerLogField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TriggerLogStatus

An enumeration.

future
hold
pending
done
error
timed_out
historical
unsubscribed
no_address
no_communications
not_applicable
Back to top

TriggerMutationResponse

A response from a trigger mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

trigger : Trigger

The Trigger that was mutated

Back to top

TriggerMutations

Mutations for Communication Triggers

addCourses : TriggerMutationResponse!

Adds the specified courses to the provided trigger

Argument Type Description
input TriggerCourseMapInput!
clone : TriggerCloneMutationResponse!

Clones a trigger

Argument Type Description
input TriggerCloneInput!
removeCourses : TriggerMutationResponse!

Removes the specified courses from the provided trigger

Argument Type Description
input TriggerCourseMapInput!
sendTriggerCommunication : TriggerCommunicationInputMutationsResponse!

Sends an email or sms from a specified Trigger Log with optional overrides

Argument Type Description
input TriggerCommunicationInput!
Back to top

TriggerSms

Trigger SMS

body : String

The Body of the Trigger SMS

id : ID!

ID of the Trigger SMS

manuallySendingUser : User

The details of the User that manually sent the Trigger SMS

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
sendingAddressDetails : SendingPhoneNumber

The Address details of the Trigger SMS Sender

Argument Type Description
filters = [] [SendingPhoneNumberFieldGraphFilter]
order = "__EMPTY__" SendingPhoneNumberFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingPhoneNumberFieldGraphOrder]
sentAt : LocalDateTime

The date and time that the Trigger SMS was sent

status : TriggerSmsStatus

The status of the Trigger Email

toName : String

The Name of the recipient of the Trigger SMS

toNumber : String

The Number of the recipient of the Trigger SMS

Back to top

TriggerSmsConnection

A connection containing page information and edges for TriggerSms

edges : [TriggerSmsEdge!]!

The list of TriggerSms edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

TriggerSmsEdge

Contains cursor and node information for type TriggerSms

cursor : String!

A string that can be used for cursor-based pagination

node : TriggerSms!

The TriggerSms node.

Back to top

TriggerSmsField

Fields for filtering and ordering Trigger SMS

id
status
toName
toNumber
body
sentAt
sendingAddressId
Back to top

TriggerSmsFieldGraphFilter

Filter that can be applied to limit which TriggerSms nodes are returned

field : TriggerSmsField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

TriggerSmsFieldGraphOrder

Specifies the order in which TriggerSms nodes are returned via the Connection

field : TriggerSmsField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

TriggerSmsStatus

An enumeration.

PENDING
INVALID
DELIVERED
SENT
AWAITING_RENDER
Back to top

TriggerTarget

An enumeration.

all_events
all_sessions
course
course_sessions
event
scheduled
tracks
all_tracks
opportunity
payment
training_pass
training_token
Back to top

TriggerTrigger

An enumeration.

event_start
event_end
event_classroom_start
event_classroom_end
event_lms_start
event_lms_end
lms_expiry
event_registration
cancel_learner
transfer_learner
session_start
session_end
event_attended
event_absent
learning_path_assigned
learning_path_completed
learning_path_registration
learning_path_cancel_learner
lms_resource_start
lms_resource_finish
lms_resource_pass
lms_resource_fail
opportunity_transition
achievement_award
invoice_payment
scheduled
training_pass_issued
training_pass_renewed
training_pass_cancelled
training_pass_expired
training_token_issued
training_token_contacts_updated
training_token_redeemed
training_token_expired
training_token_expiry_updated
Back to top

Type

The type of a CustomProperty

string
text
email
integer
money
number
percent
url
country
language
locale
timezone
date
datetime
time
checkbox
choice
multichoice
Back to top

UnlinkDocumentAccountInput

An Input to unlink a Document from an Account

accountId : ID!

The ID of the Account to unlink the Document from

documentId : ID!

The ID of the Document to be unlinked from the Account

Back to top

UnlinkDocumentContactInput

An Input to unlink a Document from a Contact

contactId : ID!

The ID of the Contact to unlink from the Document

documentId : ID!

The ID of the Document to be unlinked from the Contact

Back to top

UnnamedLearnerDetail

Details of existing Learners associated with an Interest

Related types: LearnerDetail

attributes : [CustomFieldValue!]!

The attributes of the Existing Learner

Argument Type Description
filter CustomFieldFilterInput
communicationsCcAddresses : [String!]!

Additional email addresses that will be included as CC in all Learner communications

communicationsContact : Contact

The Contact to whom all communications regarding this Learner will be sent to

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
id : ID!

ID of the Content

Back to top

UnnamedLearnerOpportunityInterest

An Input containing the Point of Sale values for an unnamed interest learner

notes : String

Notes regarding the unnamed Learner

communicationsContactId : String

The ID of a Contact to whom all communications regarding this Learner will be sent to

communicationsCcAddresses : [String]

Additional email addresses that will be included as CC in all Learner communications

Back to top

UnregisteredLearnerGroup

availableEvents : EventConnection!

The list of Events that unregistered contacts may be registered to in order to satisfy the scheduling need

Argument Type Description
filters = [] [EventFieldGraphFilter]
order = "__EMPTY__" EventFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [EventFieldGraphOrder]
courseTemplate : CourseTemplate!

The Course onto which Learners still need to be registered

Argument Type Description
filters = [] [CourseTemplateFieldGraphFilter]
order = "__EMPTY__" CourseTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CourseTemplateFieldGraphOrder]
learningPath : LearningPath!

The LearningPath which has scheduling needs

Argument Type Description
filters = [] [LearningPathFieldGraphFilter]
order = "__EMPTY__" LearningPathFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathFieldGraphOrder]
unregisteredLearners : LearningPathLearnerConnection!

The list of Learning Path Learners that are not registered as Learners on the Course

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
workplace : Workplace

The workplace corresponding to the unregistered Learners

Argument Type Description
filters = [] [WorkplaceFieldGraphFilter]
order = "__EMPTY__" WorkplaceFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WorkplaceFieldGraphOrder]
Back to top

UnregisteredLearnerGroupConnection

A connection containing page information and edges for UnregisteredLearnerGroup

edges : [UnregisteredLearnerGroupEdge!]!

The list of UnregisteredLearnerGroup edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

UnregisteredLearnerGroupEdge

Contains cursor and node information for type UnregisteredLearnerGroup

cursor : String!

A string that can be used for cursor-based pagination

node : UnregisteredLearnerGroup!

The UnregisteredLearnerGroup node.

Back to top

UnregisteredLearnerGroupField

Fields for filtering and ordering UnregisteredLearnerGroupTypes

learningPathId
courseTemplateId
workplaceId
Back to top

UnregisteredLearnerGroupFieldGraphFilter

Filter that can be applied to limit which UnregisteredLearnerGroup nodes are returned

field : UnregisteredLearnerGroupField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

UnregisteredLearnerGroupFieldGraphOrder

Specifies the order in which UnregisteredLearnerGroup nodes are returned via the Connection

field : UnregisteredLearnerGroupField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

UpdateClientCredentialInput

An input for updating a Client Credential

clientKey : String!

The key of the client credential to update

name : String

The new name of the client credential

description : String

The new description of the client credential

userId : String

The ID for the User the token will be changed to

Back to top

UpdateEventLearningModeInput

An Input for updating the Learning Mode of an Event

learningMode : EventLearningMode!

The type of Learning Mode to be updated to.

Back to top

UpdateFinancialUnitInput

An Input for creating a new version of an existing Opportunity in a different Financial Unit. Only Token Financial Units are currently supported.

opportunityId : ID!

The ID of the existing Opportunity whos Financial Unit we want to update

financialUnitId : ID!

The Code of the Currency or Training Token Type ID that the Opportunity will be priced in

Back to top

UpdateInvoicesPaymentAllocationInput

Input for the allocation you with to update

allocationId : ID!
invoiceId : ID
amount : Decimal
Back to top

UpdateLearnersLmsAccessEndDateInput

An Input for changing LMS Access End Date on an Event for many Learners at once.

eventId : ID!

The ID of the Event to change the Learners for.

onlyChangeActiveLearners : Boolean!

Choose whether to only modify active Learners or all Learners, including expired and cancelled. If you choose the latter, expired Learners may get their LMS access for this Event restored, but cancelled Learners will not be reactivated.

newExpiresOn : Date

The date to change the LMS Access End Date for the Learners to. This required parameter can be set to null, to remove the LMS Access End Date from the Learners, but only if the Event LMS End Date is not specified.

oldExpiresOn : Date

Optional parameters that will limit the Learners for which to change the dates for. Only Learners that currently have the expiry date set to the specified value will be changed. This parameter can be set to null in order to only select Learners without the date specified.

Back to top

UpdateLmsResourceCustomFieldsInput

An input to update an LMS Resource Custom Fields on an Event

resourceId : ID!

The ID of the LMS Resource being updated.

customFieldValues : [CustomFieldValueInput]!

The list of Custom Fields for this LMS Resource.

Back to top

UpdateLmsResourceInput

An input to update an LMS Resource on an Event

resourceId : ID!

The ID of the LMS Resource being updated.

resourceType : String

The LMS Resource type.

displayName : String

The LMS Resource's display name.

htmlDescription : String

A Description for the LMS Resource.

ordering : Int

The LMS Resource's position in the list of LMS Resource.

maxCompletions : Int

The maximum number of attempts on this piece of LMS Resource.

externalActivityURL : String

The URL for external activity LMS Resource.

isRequired : Boolean

Is the LMS Resource required to complete the Event.

documentId : ID

The ID of the DMS Document to add as LMS Resource.

isArchived : Boolean

Is the LMS Resource archived.

isHidden : Boolean

Is the LMS Resource hidden.

isPublic : Boolean

Public LMS Resources can be displayed to learners outside of an Administrate Portal in an embedded context.

thumbnailDocumentId : ID

The ID of Image from DMS Documents that should be used as a thumbnail.

learningTags : [ID]

The list of LearningTag IDs for this Event.

customFieldValues : [CustomFieldValueInput]

The list of Custom Fields for this LMS Resource.

autoComplete : Boolean

Flag if the resource will be auto completed after a learner has accessed it

Back to top

UpdateObjectiveInput

An Input for changing a Learner's Event selection on an Obective

learningPathLearnerId : ID!

The Learning Path Learner whos Objective will be updated

objectiveId : ID!

The Learning Path Objective to be updated

eventId : ID!

The ID of the Event to replace this Objective's Event

Back to top

UpdatePaymentAllocationsInput

The input for updating Payment allocations

paymentId : ID!

The id of the Payment we wish to update its allocations

allocations : [UpdateInvoicesPaymentAllocationInput]!

The list of allocations we wish to update

Back to top

UpdatePaymentMethodInput

A method of payment

id : ID

Unique identifier for this Payment Method

reference : String

Identifying information about this Payment Method

Back to top

UpdatePricingAgreementInput

An Input for updating a Pricing Agreement for an Account

pricingAgreementId : ID!

The Pricing Agreement ID to update

name : String

The new Name given to the Pricing Agreement

startDateTime : LocalDateTime

The new DateTime of when the Pricing Agreement commences

endDateTime : LocalDateTime

The new DateTime of when the Pricing Agreement ceases

timeZoneName : String

The new Time Zone which the Pricing Agreement respects for startDateTime and endDateTime

lifecycleState : PricingAgreementLifecycleState

The Lifecycle State of the Pricing Agreement

isInheritedByChildAccounts : Boolean

Whether or not the Pricing Agreement should be inherited by child accounts

Back to top

UpdatePricingAgreementPriceInput

An Input for updating a Price for a Pricing Agreement Price

pricingAgreementPriceId : ID!

The Pricing Agreement Price ID to update

amount : Decimal

The price amount for the applied Sellable in the Pricing Agreement

currencyCode : String

The Code of the Currency for the updated Pricing Agreement Price

regionId : ID

The region_id for the updated Pricing Agreement Price

taxTypeId : ID

The default Tax Type ID used for the applied Price

lifecycleState : PricingAgreementPriceLifecycleState

The Lifecycle State of the Pricing Agreement Price

priceLevelId : ID
Back to top

UpdateSessionBookingInput

An Input for updating the booking of a Resource on en Event's Session

resourceBookingId : ID!

The ID of the booking to be updated

start : TimeZonedDateTime

The new booking start time. If not provided, current start time is left unchanged.

end : TimeZonedDateTime

The new booking end time. If not provided, current end time is left unchanged.

details : String

Optional notes to store with the booking.

Back to top

UpdateStaffRoleInput

An input for updating a batch of Staff Roles

staffRoleId : ID!

the ID of the Staff Role to update

name : String

The name of the Staff Role

checkConflicts : Boolean

Whether this Staff Role generates conflicts for any Staff calendar assigned this role on a booking

Back to top

UploadDetails

The URL and payload, that you can use (along with your file) to build a multipart/form-data HTTP POST request which will upload the file

payload : String!

A serialised JSON object containing key-value pairs for the multipart/form-data HTTP POST request

url : String!

The URL to perform the multipart/form-data HTTP POST request to

Back to top

URL

A universal resource locator that can be used to fetch data.

Back to top

URLObjective

Related types: Node LearningObjective

credits : Int

The number of credits that this LearningObjective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!
isMandatory : Boolean!

Denotes whether or not the LearningObjective is mandatory

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningObjective in the set of LearningPath objectives

url : String!
Back to top

URLOutcome

Related types: Node LearningOutcome

credits : Int

The number of credits that the LearningOutcome represents

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!
isCompleted : Boolean

Denotes whether or not the LearningOutcome has been completed by the Learner

isMandatory : Boolean!

Denotes whether or not the LearningOutcome is mandatory

learningObjective : LearningObjective!

The LearningObjective to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningObjectiveFieldGraphFilter]
order = "__EMPTY__" LearningObjectiveFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningObjectiveFieldGraphOrder]
learningPathLearner : LearningPathLearner!

The LearningPathLearner to which the LearningOutcome refers

Argument Type Description
filters = [] [LearningPathLearnerFieldGraphFilter]
order = "__EMPTY__" LearningPathLearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearningPathLearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

order : Int

The order of this LearningOutcome in the set of LearningAssignment outcomes

url : String!
Back to top

UsageStats

Platform usage statistics over the time period specified.

achievementsIssued : Int!

Number of Achievements Issued within the timeframe

activeLMSLearners : Int!

Learners that were active and using with LMS within the time period specified.

activeLearners : Int!

Learners that were active within the time period specified.

administratorUpdatedEvents : Int!

Events that have been updated by an Administrator during the time period specified

attendanceRecorded : Int!

Attendances that have been marked as present during the time period specified.

attendanceTaken : Int!

Number of times attendance was recorded during the time period specified.

cancelledEvents : Int!

Number of Events that have been cancelled within the Timeframe on an Event

communicationStats : CommunicationStats!

Communication Stats for Time Period

createdEvents : Int!

Number of Events that have been created within the Timeframe on an Event

createdLearners : EventCount!

Learners that were created within the time period specified.

fillRate : Float!

Average fill rate of Events based on registrations and the max number of places within the Timeframe

financialStats : FinancialStats!

Financial Stats for Time Period

generatedCertificates : Int!

Number of Certificates that have been Generated within the Timeframe

learnersTransferred : Int!

Learners that have been transferred within the time period specified.

learningPathRegistrations : Int!

Number of Learning Path Registrations That Have been created within the Timeframe

opportunityBookings : OpportunityBookingsCount!

Number of Automated Bookings within the time range

peopleStats : PeopleStats!

People Stats for the Time Period

resourceBookings : Int!

Number of Resources that have been booked within the Timeframe

resourceBookingsMade : Int!

Number of Resource bookings that have been made within the Timeframe

startingEvents : EventCount!

Events that fall within the time period specified.

tasksOnEvents : Int!

Number of Tasks that have been completed within the Timeframe on an Event

users : [UserStats!]!

Billable users that existed within the time period specified.

webhookStats : WebhookStats!

Webhooks Stats for the Time Period

workflowTasks : Int!

Number of Tasks that have been assigned for that period from a Workflow Group

Back to top

User

A user of the System

Related types: Node

authenticationType : UserAuthentication!

Authentication type of the User

calendarEntries : CalendarEntryConnection!

The Calendar Entries assigned to this User

Argument Type Description
filters = [] [CalendarEntryFieldGraphFilter]
order = "__EMPTY__" CalendarEntryFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CalendarEntryFieldGraphOrder]
company : Company

The Company associated with the User

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
contact : Contact

The Contact record for the User

Argument Type Description
filters = [] [ContactFieldGraphFilter]
order = "__EMPTY__" ContactFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContactFieldGraphOrder]
createdAt : TimeZonedDateTime!

The timestamp for when the User was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
firstName : String

First name of the User

fullName : String

Full name of the User

id : ID!

ID of the User

identity : String!

Identity of the User

initials : String

Initials of the User

isAllCompanies : Boolean!

Flag indicating if the User is a Super Company User

isSuperUser : Boolean!

Flag indicating if the User is a Super User

isSuspended : Boolean!

Flag indicating if the User is a Suspended

lastName : String

Last name of the User

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

selected_2fa_method : String

The multi factor auth method of the user

tasks : TaskConnection!

The Tasks assigned to this User

Argument Type Description
filters = [] [TaskFieldGraphFilter]
order = "__EMPTY__" TaskFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TaskFieldGraphOrder]
timeZoneName : String

The name of the timezone associated with the User

type : UserType

The type of User

updatedAt : TimeZonedDateTime!

The timestamp for when the User details were last updated

userRoles : [UserRole!]!

The User Roles of the User

Deprecated fields (1)
email : String!

The email address used to login to the Adminstrate application

Removal date: TBD.

Replaced by identity

Back to top

UserAuthentication

The User authentication types

password
sso
Back to top

UserConnection

A connection containing page information and edges for User

edges : [UserEdge!]!

The list of User edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

UserCreateInput

The input type with the User details to be created

firstName : String!

The User's first name

lastName : String!

The User's last name

identity : String!

Unique field denoting the User's identity

isSuperUser : Boolean

Flag indicating if the User is a Super User

isAllCompanies : Boolean

Flag indicating if the User is a Super Company User

companyId : ID

The Company ID to associate with the User

contactId : ID

The Contact ID to associate with the User

initials : String

Initials of the User

Back to top

UserDisableSelected2FAMethodInput

The input type with the ID of a User

userId : ID!

The ID of the User whose selected 2fa method is being reset

Back to top

UserEdge

Contains cursor and node information for type User

cursor : String!

A string that can be used for cursor-based pagination

node : User!

The User node.

Back to top

UserField

Fields for filtering and ordering Users

id
email
isSuspended
isSuperUser
firstName
lastName
fullName
companyId
type
Back to top

UserFieldGraphFilter

Filter that can be applied to limit which User nodes are returned

field : UserField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

UserFieldGraphOrder

Specifies the order in which User nodes are returned via the Connection

field : UserField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

UserMutateResponse

A Response from mutating a User

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

user : User

The User that was mutated

Back to top

UserMutations

Mutations for User

createUser : UserMutateResponse!

Creates a User that can access the Administrate application

Argument Type Description
input UserCreateInput!
disableUser2FAMethod : UserMutateResponse!

Resets the users 2FA method

Argument Type Description
input UserDisableSelected2FAMethodInput!
suspendUser : UserMutateResponse!

Suspends a User

Argument Type Description
input UserSuspendInput!
unsuspendUser : UserMutateResponse!

Unsuspends a User

Argument Type Description
input UserUnsuspendInput!
updateUser : UserMutateResponse!

Updates the details of a User

Argument Type Description
input UserUpdateInput!
updateUserRoles : UserMutateResponse!

Updates the Roles of a User

Argument Type Description
input UserRolesUpdateInput!
Back to top

UserRole

Roles are groups of permissions may be allocated to a User

Related types: Node

company : Company

The Company the role is applicable to

Argument Type Description
filters = [] [CompanyFieldGraphFilter]
order = "__EMPTY__" CompanyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CompanyFieldGraphOrder]
description : String

A description of the role

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the UserRole

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

A name given to identify the role

Back to top

UserRoleConnection

A connection containing page information and edges for UserRole

edges : [UserRoleEdge!]!

The list of UserRole edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

UserRoleEdge

Contains cursor and node information for type UserRole

cursor : String!

A string that can be used for cursor-based pagination

node : UserRole!

The UserRole node.

Back to top

UserRoleField

Fields for filtering and ordering UserRoles

id
name
companyId
Back to top

UserRoleFieldGraphFilter

Filter that can be applied to limit which UserRole nodes are returned

field : UserRoleField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

UserRoleFieldGraphOrder

Specifies the order in which UserRole nodes are returned via the Connection

field : UserRoleField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

UserRolesUpdateInput

The input type with the new User's Roles IDs

userId : ID!

The ID of the User being updated

roleIds : [ID]!

A list with the ID’s of the Roles to be updated for a User

Back to top

UserStats

User statistics over the time period specified.

count : Int!

The number of users.

type : String!

The type of user, super, regular etc.

Back to top

UserSuspendInput

The input type with the ID of a User to be suspended

userId : ID!

The ID of the User being suspended

Back to top

UserType

The User types

UI
VC
API
Back to top

UserUnsuspendInput

The input type with the ID of a User to be unsuspended

userId : ID!

The ID of the User being unsuspended

Back to top

UserUpdateInput

The input type with the User details to be updated

userId : ID!

The ID of the User being updated

firstName : String

The User's new first name

lastName : String

The User's new last name

initials : String

Initials of the User

identity : String

The User's new identity

isSuperUser : Boolean

The flag indicating if the User is a Super User

isAllCompanies : Boolean

The new flag indicating if the User is an All Companies User

companyId : ID

The new Company ID to associate with the User

contactId : ID

The new Contact ID to associate with the User

Back to top

VendorAccount

Vendor Accounts for an LMS integration vendor

id : String!

The ID of the vendor account

name : String!

The name of the vendor account

Back to top

VendorCustomField

Custom fields for an LMS integration vendor

entity : LmsCompatibleEntity!

The entity this custom field is associated with

fieldType : CustomFieldType!

The type of the custom field

id : String!

The ID of the custom field

isRequired : Boolean!

Whether the custom field is required

label : String!

The label of the custom field

mappedCustomField : StandardCustomFieldDefinition

The CustomFieldDefinition associated with the Vendor Custom Field

syncDirection : SyncDirection!

The direction this field is synced in for the integration

Back to top

Venue

account : AccountConnection!

Account of the Venue

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
description : String

A description of the Venue

id : ID!

The ID of the Venue

latitude : String

The latitude of the Venue

location : Location!

The location linked to this Venue

Argument Type Description
filters = [] [LocationFieldGraphFilter]
order = "__EMPTY__" LocationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LocationFieldGraphOrder]
longitude : String

The longitude of the Venue

name : String!

The name of the Venue

Back to top

VenueConnection

A connection containing page information and edges for Venue

edges : [VenueEdge!]!

The list of Venue edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

VenueEdge

Contains cursor and node information for type Venue

cursor : String!

A string that can be used for cursor-based pagination

node : Venue!

The Venue node.

Back to top

VenueField

Venue Fields for Filtering and Ordering

id
name
accountId
locationId
Back to top

VenueFieldGraphFilter

Filter that can be applied to limit which Venue nodes are returned

field : VenueField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

VenueFieldGraphOrder

Specifies the order in which Venue nodes are returned via the Connection

field : VenueField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

VideoContentResult

A summary of results for a Learner on a piece of Video Content

Related types: LearnerContentResult

completedAttempts : Int!

The number of complete attempts the Learner has had on this EventContent

content : LmsContent!

The EventContent this result relates to

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
contentId : ID!

The ID to the piece of EventContent this result relates to

id : ID!

The ID of the LearnerContentResult

isRequired : Boolean

Whether the EventContent is required for the Learner to complete the Event

lastAccessed : TimeZonedDateTime

The date and time when the EventContent was last accessed

latestAttempt : ScormAttempt

Information on the last attempt the Learner made on the Video Content

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
lmsAttempts : LmsAttemptConnection!

The learner attempts on the EventContent

Argument Type Description
filters = [] [LmsAttemptFieldGraphFilter]
order = "__EMPTY__" LmsAttemptFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LmsAttemptFieldGraphOrder]
numberOfAttempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

progress : Decimal

The percentage complete the Learner has achieved on the EventContent

score : Decimal

The score the Learner has achieved on the EventContent

scorePercent : Decimal

The score percent the Learner has achieved on the EventContent

startAt : Int!

The position in seconds to start playing the Video Content at, based on previous progress

status : ContentResultStatus!

The current status of the EventContent

Deprecated fields (1)
attempts : Int!

The number of complete and incomplete attempts the Learner has had on this EventContent

Removal date: TBD.

Replaced by numberOfAttempts

Back to top

VideoResourceAttempt

Related types: LmsAttempt Node

completedAt : TimeZonedDateTime

The date and time when the Attempt was completed

completedByAdmin : Boolean!

Whether the Attempt has been manually completed by an Admin

content : LmsContent!

The Attempt's Content

Argument Type Description
filters = [] [ContentFieldGraphFilter]
order = "__EMPTY__" ContentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ContentFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Attempt

isCompleted : Boolean!

Whether the Attempt has been completed

isPassed : Boolean!

Whether the Attempt has been passed

learner : Learner!

The Learner this result relates to

Argument Type Description
filters = [] [LearnerFieldGraphFilter]
order = "__EMPTY__" LearnerFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [LearnerFieldGraphOrder]
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

updatedAt : TimeZonedDateTime

The date and time when the Attempt was updated

Back to top

Viewer

Information about the currently logged in user

companyIdsForPermission : [String!]!
Argument Type Description
type String!
operation String!
enquiriesPendingProcessingCount : Int!

The number of Enquiries requiring processing by the Viewer

formSubmissionsPendingProcessingCount : Int!

The number of Form Submissions requiring processing by the Viewer

locationIdsForPermission : [String!]!
Argument Type Description
type String!
operation String!
purchasesPendingApprovalCount : Int!

The number of purchases requiring an approval decision from the Viewer

user : User!

The User that is currently accessing the API

Argument Type Description
filters = [] [UserFieldGraphFilter]
order = "__EMPTY__" UserFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [UserFieldGraphOrder]
Back to top

VirtualMeetingLinkHost

The virtual meeting link host

administrate
docebo
Back to top

WebConferencingIntegration

An Integration with a Web Conferencing Provider

Related types: Node

createdAt : TimeZonedDateTime

The Date and Time the Web Conferencing Integration was created

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Web Conferencing Integration

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : WebConferencingIntegrationLifecycleState!

The lifecycle state of the Web Conferencing Integration

name : String

Name of the Web Conferencing Integration

updatedAt : TimeZonedDateTime

The Date and Time the Web Conferencing Integration was updated

webConferencingIntegrationType : WebConferencingIntegrationIntegration!

The type of the Web Conferencing Integration

webhook : Webhook

The Webhook used to trigger the Web Conferencing Integration

Back to top

WebConferencingIntegrationIntegration

An enumeration.

automatic
Back to top

WebConferencingIntegrationLifecycleState

An enumeration.

disabled
Back to top

WebFont

Settings that define a Web Font hosted externally

cssUrl : URL!

The URL of the CSS that defines this font-face (e.g. https://fonts.googleapis.com/css?family=Open+Sans)

name : String!

The name of the font-face defined in the CSS (e.g. Open Sans)

Back to top

WebFontInput

An Input describing a Typeface name and the source CSS of the font definition

cssUrl : URL!

The URL of the CSS that defines this font-face (e.g. https://fonts.googleapis.com/css?family=Open+Sans)

name : String!

The name of the font-face defined in the CSS (e.g. Open Sans)

Back to top

Webhook

The Webhooks configured in your instance of Administrate

Related types: Node

allowReRunOnSuccess : Boolean!

Denotes whether a Webhook can be retried on Success

executionsInLastDay : Int!

Total number of executions for Webhook within a rolling 24 hour period

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
filterExpression : String

A JMESPath filter expression which, if set, will cause the webhook not to fire if its evaluation on the JSON returned from the GraphQL query returns anything other than true

hasConfigSet : Boolean!

Denotes whether a config has been set on the Webhook

id : ID!

The ID of the Webhook

lastExecution : WebhookLog

The Most Recent Execution for this Webhook. Can filter by objectId, which is the ID of the object that triggered the Webhook, if applicable

Argument Type Description
filters = [] [WebhookLogFieldGraphFilter]
order = "__EMPTY__" WebhookLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WebhookLogFieldGraphOrder]
objectId ID
legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : WebhookLifecycleState!

The current lifecycle state of the Webhook

name : String!

The name of the Webhook

notificationEmails : [String!]

The list of email addresses to notify if a failure occurs after firing the webhook

query : String

The GraphQL query that will be executed against the API when the Webhook is triggered

url : String!

The URL that the Webhook will send data to when it is triggered

webhookType : WebhookType!

The Type of the Webhook

Deprecated fields (1)
emailAddress : String

The Email Address to notify about issues with this Webhook

Removal date: 2024-08-07.

Replaced by notificationEmails

Back to top

WebhookConnection

A connection containing page information and edges for Webhook

edges : [WebhookEdge!]!

The list of Webhook edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

WebhookCreateInput

An input for creating a Webhook

webhookTypeId : ID!

The ID of the WebhookType for the Webhook

name : String!

The name of the Webhook

url : String!

The URL that the Webhook will send data to

notificationEmails : [String]!

email addresses to notify when this webhook fails after multiple retries, or is disabled after repeated failures

query : String

The GraphQL query that will be executed when the Webhook is triggered

config : String

Extra configuration values in JSON format that will be sent when the Webhook is triggered

filterExpression : String

A JMESPath filter expression which, if set, will cause the webhook not to fire if its evaluation on the JSON returned from the GraphQL query returns anything other than true

Back to top

WebhookCreateResponse

A Response for a Webhook Create Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

webhook : Webhook

The Webhook that was created

Back to top

WebhookEdge

Contains cursor and node information for type Webhook

cursor : String!

A string that can be used for cursor-based pagination

node : Webhook!

The Webhook node.

Back to top

WebhookExecutionStatus

The Status of a Webhook Execution

pending
success
failed
Back to top

WebhookField

An enumeration.

id
name
typeId
typeTrigger
url
lifecycleState
executionsInLastDay
Back to top

WebhookFieldGraphFilter

Filter that can be applied to limit which Webhook nodes are returned

field : WebhookField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

WebhookFieldGraphOrder

Specifies the order in which Webhook nodes are returned via the Connection

field : WebhookField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

WebhookLifecycleState

The lifecycle state of a Webhook

active

The Webhook will trigger as expected.

disabled

The Webhook will trigger, but it won’t be delivered to the endpoint. It will only be saved in the database, so that a user can retry it later.

inactive

The Webhook won’t trigger and will be completely ignored.

Back to top

WebhookLog

The logs from attempted Webhooks for your instance of Administrate

Related types: Node

createdAt : TimeZonedDateTime!

Time the webhook log record was created.

error : String

Name of the error raised during the execution of the Webhook if applicable

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
filterExpression : String

The JMESPath filter expression that was set on the webhook when it was fired

finishedProcessingAt : TimeZonedDateTime

Time the webhook payload was generated and ready to send to the Webhook URL

id : ID!

The ID of the WebhookLog

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

matchesFilter : Boolean

Whether the webhook paylaod matched the filter expression

objectId : ID

ID of the object that triggered the Webhook

payload : String

Payload sent to the URL excluding config

query : String

Query used to create the payload

response : String

Data sent back from the Webhook's URL

Argument Type Description
unescape = false Boolean

whether to process any escaped Unicode characters in the response (for example, "\u20ac 500.00" to "€ 500.00")
responseCode : Int

HTTP response code from the Webhook's URL

status : WebhookLogStatus!

The Status of this Webhook Log record

success : Boolean!

Was the Webhook run successfully?

triggeredAt : TimeZonedDateTime!

Time database change occured and triggered the Webhook

updatedAt : TimeZonedDateTime!

Time the webhook log record was last updated.

url : String!

The URL that the Webhook sent data to

webhook : Webhook!

The Webhook that was run

Argument Type Description
filters = [] [WebhookFieldGraphFilter]
order = "__EMPTY__" WebhookFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [WebhookFieldGraphOrder]
webhookReceivedAt : TimeZonedDateTime

Time the webhook payload was sent to the Webhook URL and a successful HTTP code was received from it. This is only set if the Webhook was successful.

Deprecated fields (2)
requestedAt : TimeZonedDateTime!

Time Webhook was requested

Removal date: TBD.

Replaced by triggeredAt

runAt : TimeZonedDateTime

Time Webhook was run

Removal date: TBD.

Replaced by finishedProcessingAt

Back to top

WebhookLogConnection

A connection containing page information and edges for WebhookLog

edges : [WebhookLogEdge!]!

The list of WebhookLog edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

WebhookLogEdge

Contains cursor and node information for type WebhookLog

cursor : String!

A string that can be used for cursor-based pagination

node : WebhookLog!

The WebhookLog node.

Back to top

WebhookLogField

An enumeration.

error
id
requestedAt
runAt
success
status
url
webhookId
webhookTypeId
objectId
response
payload
triggeredAt
finishedProcessingAt
webhookReceivedAt
createdAt
updatedAt
isRetry
Back to top

WebhookLogFieldGraphFilter

Filter that can be applied to limit which WebhookLog nodes are returned

field : WebhookLogField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

WebhookLogFieldGraphOrder

Specifies the order in which WebhookLog nodes are returned via the Connection

field : WebhookLogField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

WebhookLogStatus

An enumeration.

pending
success
failed
notSent
throttled
Back to top

WebhookManualTriggerResponse

A Response for a Webhook Manual Trigger Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

status : WebhookExecutionStatus!

The status for this execution result

webhookLog : WebhookLog

The Webhook Log that was created

Back to top

WebhookMutations

Updates that can be made to Webhooks

create : WebhookCreateResponse!

Creates a Webhook configuration

Argument Type Description
input WebhookCreateInput!

The input type with the values used to create a Webhook
retrigger : WebhookUpdateResponse!

Re-trigger a Webhook, identified by a Webhook Log entry

Argument Type Description
input WebhookRetriggerInput!

The input type with the values used to Re-trigger a Webhook Log
triggerManual : WebhookManualTriggerResponse!

Manually trigger a Webhook for a given object

Argument Type Description
input WebhookTriggerManualInput!

The input type with the object and webhook to trigger
update : WebhookUpdateResponse!

Updates a Webhook configuration

Argument Type Description
input WebhookUpdateInput!

The input type with the values used to update a Webhook
Back to top

WebhookRetriggerInput

An input for retriggering a Webhook Log

webhookLogId : ID!

The ID of the Webhook Log to Retrigger

Back to top

WebhookStats

Webhook Statistics over the time period specified

executionsUsed : Int!

The number of executions used within that Period

failures : Int!

The number of failures within that Period

Back to top

WebhookTrigger

The type of trigger for a WebhookType

automatic
manual
Back to top

WebhookTriggerManualInput

An input for triggering a Manual Webhook

objectId : ID!

The ID of the Object to Trigger the Webhook for

webhookId : ID!

The ID of the Webhook to Trigger

Back to top

WebhookType

The types of Webhooks that can be configured from the Administrate system

Related types: Node

description : String!

The description of the Webhook Type

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Webhook Type

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

The name of the Webhook Type

trigger : WebhookTrigger!

The way a Webhook Type will trigger

Back to top

WebhookTypeConnection

A connection containing page information and edges for WebhookType

edges : [WebhookTypeEdge!]!

The list of WebhookType edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

WebhookTypeEdge

Contains cursor and node information for type WebhookType

cursor : String!

A string that can be used for cursor-based pagination

node : WebhookType!

The WebhookType node.

Back to top

WebhookTypeField

Fields for filtering and ordering WebhookTypes

id
name
trigger
Back to top

WebhookTypeFieldGraphFilter

Filter that can be applied to limit which WebhookType nodes are returned

field : WebhookTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

WebhookTypeFieldGraphOrder

Specifies the order in which WebhookType nodes are returned via the Connection

field : WebhookTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

WebhookUpdateInput

An input for updating a Webhook

webhookId : ID!

The ID of the Webhook that is being updated

name : String

The name of the Webhook

lifecycleState : WebhookLifecycleState

The lifecycle state of the Webhook

url : String

The URL that the Webhook will send data to

notificationEmails : [String]

email addresses to notify when this webhook fails after multiple retries, or is disabled after repeated failures

query : String

The GraphQL query that will be executed when the Webhook is triggered

config : String

Extra configuration values in JSON format that will be sent when the Webhook is triggered

filterExpression : String

A JMESPath filter expression which, if set, will cause the webhook not to fire if its evaluation on the JSON returned from the GraphQL query returns anything other than true

Back to top

WebhookUpdateResponse

A Response for a Webhook Update Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

webhook : Webhook

The Webhook that was updated

Back to top

WebLinkApprovalPaymentProvider

Settings used by a WebLink Portal to handle approval payments

Related types: WebLinkPaymentProvider

approvalEntryStep : OpportunityStep!

The Opportunity Step for a newly created approval request

approvalSignOffSteps : [OpportunityStep!]!

The list of Opportunity steps that this request must go through in order to be approved

attributeDefinitions : [CustomFieldDefinition!]!

The Attribute Definitions linked to this Payment Provider

checkoutCompleteOpportunityStep : OpportunityStep

The Opportunity Step to progress to when payment has been successful

createdAt : TimeZonedDateTime!

When this Payment Provider was created

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed using this Payment Provider

emailTemplate : DocumentTemplate

The Document Template emailed to a buyer when a WebLink Order has been completed using this Payment Provider

id : ID!

The ID of the Payment Provider

includeInvoice : Boolean!

Indicates whether invoices should be included on correspondence such as Weblink order confirmation emails.

name : String!

The Name of this Payment Provider

paymentAccount : FinancialAccount

The Financial Account that payments made on WebLink Orders using this Payment Provider will be categorised under

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

requestApprovedStep : OpportunityStep!

The Opportunity Step that indicates this request for approval was approved

requestOnWaitlistStep : OpportunityStep!

The Opportunity Step that indicates this request for approval is on a waitlist

requestRejectedStep : OpportunityStep!

The Opportunity Step that indicates this request for approval was rejected

sendingEmailAddress : SendingEmailAddress!

The Email Address used to email a buyer when a WebLink Order has been completed using this Payment Provider

updatedAt : TimeZonedDateTime!

When this Payment Provider was last updated

Back to top

WebLinkApprovalPaymentProviderInput

The input type with the values used to set an Approval Payment Provider on a WebLink Portal

name : String!

The Name of this WebLink Approval Payment Provider

emailSubject : String!

The subject of the email sent when this Approval has been processed

webLinkPortalId : ID!

The ID of the WebLink Portal

paymentMethodId : ID!

The Payment Method Type that will be used to classify these Approval Payments

paymentAccountId : ID!

The Financial Account Approvals created on WebLink Orders will be categorised under

documentTemplateId : ID!

The Document Template emailed to a buyer when an Approval has been processed

sendingEmailAddressId : ID!

The Sending Email Address used to email a buyer when an Approval has been processed

approvalEntryStepId : ID!

The Opportunity Step for a newly created approval request

requestRejectedStepId : ID!

The Opportunity Step that indicates this request for approval was rejected

requestApprovedStepId : ID!

The Opportunity Step that indicates this request for approval was approved

requestOnWaitlistStepId : ID!

The Opportunity Step that indicates this request for approval is on a waitlist

approvalSignOffStepIds : [ID]

The list of Opportunity steps that this request must go through in order to be approved

checkoutCompleteOpportunityStepId : ID
includeInvoice : Boolean
Back to top

WebLinkCheckPaymentProvider

Settings used by a WebLink Portal to take payments by Check

Related types: WebLinkPaymentProvider

attributeDefinitions : [CustomFieldDefinition!]!

The Attribute Definitions linked to this Payment Provider

checkoutCompleteOpportunityStep : OpportunityStep

The Opportunity Step to progress to when payment has been successful

createdAt : TimeZonedDateTime!

When this Payment Provider was created

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed using this Payment Provider

emailTemplate : DocumentTemplate

The Document Template emailed to a buyer when a WebLink Order has been completed using this Payment Provider

id : ID!

The ID of the Payment Provider

includeInvoice : Boolean!

Indicates whether invoices should be included on correspondence such as Weblink order confirmation emails.

mailingAddress : PostalAddress!

The PostalAddress

name : String!

The Name of this Payment Provider

paymentAccount : FinancialAccount

The Financial Account that payments made on WebLink Orders using this Payment Provider will be categorised under

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

sendingEmailAddress : SendingEmailAddress!

The Email Address used to email a buyer when a WebLink Order has been completed using this Payment Provider

updatedAt : TimeZonedDateTime!

When this Payment Provider was last updated

Back to top

WebLinkCheckPaymentProviderInput

The input type with the values used to set Check as a Payment Provider on a WebLink Portal

name : String!

The Name of this WebLink Check Payment Provider

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed with a Check payment

webLinkPortalId : ID!

The ID of the WebLink Portal

documentTemplateId : ID!

The Document Template emailed to a buyer when a WebLink Order has been completed with this Payment Provider

sendingEmailAddressId : ID!

The Sending Email Address used to email a buyer when a WebLink Order has been completed with a Check payment

mailingAddress : PostalAddressInput!

The Address to which the check payment should be delivered

paymentMethodId : ID

The Payment Method Type that will be used to classify Check payments on Invoices created via WebLink Orders

paymentAccountId : ID

The Financial Account that Check payments made on WebLink Orders will be categorised under

checkoutCompleteOpportunityStepId : ID
includeInvoice : Boolean
Back to top

WebLinkConvergePaymentProvider

Settings used by a WebLink Portal to take payments by Converge

Related types: WebLinkPaymentProvider

attributeDefinitions : [CustomFieldDefinition!]!

The Attribute Definitions linked to this Payment Provider

checkoutCompleteOpportunityStep : OpportunityStep

The Opportunity Step to progress to when payment has been successful

createdAt : TimeZonedDateTime!

When this Payment Provider was created

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed using this Payment Provider

emailTemplate : DocumentTemplate

The Document Template emailed to a buyer when a WebLink Order has been completed using this Payment Provider

id : ID!

The ID of the Payment Provider

includeInvoice : Boolean!

Indicates whether invoices should be included on correspondence such as Weblink order confirmation emails.

isLive : Boolean!

Whether this Payment Provider is considered to be "Live" i.e. will process real transactions for a production Converge account

merchantId : String!

The ID of the merchant

name : String!

The Name of this Payment Provider

paymentAccount : FinancialAccount

The Financial Account that payments made on WebLink Orders using this Payment Provider will be categorised under

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

pinNumber : String!

Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway

sendingEmailAddress : SendingEmailAddress!

The Email Address used to email a buyer when a WebLink Order has been completed using this Payment Provider

updatedAt : TimeZonedDateTime!

When this Payment Provider was last updated

userId : String!

The private user ID

Back to top

WebLinkConvergePaymentProviderInput

The input type with the values used to set Converge as a Payment Provider on a WebLink Portal

name : String!

The Name of this WebLink Converge Payment Provider

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed with a Converge payment

webLinkPortalId : ID!

The ID of the WebLink Portal

paymentMethodId : ID!

The Payment Method Type that will be used to classify Converge payments on Invoices created via WebLink Orders

paymentAccountId : ID!

The Financial Account that Converge payments made on WebLink Orders will be categorised under

documentTemplateId : ID!

The Document Template emailed to a buyer when a WebLink Order has been completed with this Payment Provider

sendingEmailAddressId : ID!

The Sending Email Address used to email a buyer when a WebLink Order has been completed with a Converge payment

merchantId : String!

The ID of the merchant

userId : String!

The private user ID

pinNumber : String!

Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway

isLive : Boolean!

Whether this Payment Provider is considered to be "Live" i.e. will process real transactions for a production Converge account

checkoutCompleteOpportunityStepId : ID
includeInvoice : Boolean
Back to top

WebLinkCourseDetailsField

Types of WebLink Course Details Custom Fields

teaserDescription
description
prerequisites
topicsCovered
faqs
outcomes
Back to top

WebLinkCourseDetailsFieldMapping

Course Template Custom Field IDs that are used to map to fields on a WebLink Course

courseTemplateCustomFieldDefinition : ID!

The Course Template Custom Field ID that is mapped to the corresponding WebLink Course Field

id : ID!

The ID of this WebLink Course Details Field Mapping

webLinkCourseDetailsField : WebLinkCourseDetailsField!

The WebLink Course Field that is mapped to the corresponding Course Template Custom Field ID

Back to top

WebLinkInvoicePaymentProvider

Settings used by a WebLink Portal to take payments by Invoice

Related types: WebLinkPaymentProvider

attributeDefinitions : [CustomFieldDefinition!]!

The Attribute Definitions linked to this Payment Provider

checkoutCompleteOpportunityStep : OpportunityStep

The Opportunity Step to progress to when payment has been successful

createdAt : TimeZonedDateTime!

When this Payment Provider was created

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed using this Payment Provider

emailTemplate : DocumentTemplate

The Document Template emailed to a buyer when a WebLink Order has been completed using this Payment Provider

id : ID!

The ID of the Payment Provider

includeInvoice : Boolean!

Indicates whether invoices should be included on correspondence such as Weblink order confirmation emails.

name : String!

The Name of this Payment Provider

opportunityStep : OpportunityStep!

The opportunity step at which this payment method becomes active

paymentAccount : FinancialAccount

The Financial Account that payments made on WebLink Orders using this Payment Provider will be categorised under

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

sendingEmailAddress : SendingEmailAddress!

The Email Address used to email a buyer when a WebLink Order has been completed using this Payment Provider

updatedAt : TimeZonedDateTime!

When this Payment Provider was last updated

Back to top

WebLinkInvoicePaymentProviderInput

The input type with the values used to set Invoice as a Payment Provider on a WebLink Portal

name : String!

The Name of this WebLink Invoice Payment Provider

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed with an Invoice payment

webLinkPortalId : ID!

The ID of the WebLink Portal

documentTemplateId : ID!

The Document Template emailed to a buyer when a WebLink Order has been completed with this Payment Provider

sendingEmailAddressId : ID!

The Sending Email Address used to email a buyer when a WebLink Order has been completed with this Payment Provider

paymentMethodId : ID

The Payment Method Type that will be used to classify Invoice payments on Invoices created via WebLink Orders

paymentAccountId : ID

The Financial Account that Invoice payments made on WebLink Orders will be categorised under

checkoutCompleteOpportunityStepId : ID

The Opportunity step that this payment method becomes active

includeInvoice : Boolean
Back to top

WebLinkMultiSafepayEnvironment

An enumeration.

test
live
Back to top

WebLinkMultiSafepayPaymentProvider

Settings used by a WebLink Portal to take payments with MultiSafepay

Related types: WebLinkPaymentProvider

apiKey : String

The API Key provided by Multi Safepay to make a charge

attributeDefinitions : [CustomFieldDefinition!]!

The Attribute Definitions linked to this Payment Provider

checkoutCompleteOpportunityStep : OpportunityStep

The Opportunity Step to progress to when payment has been successful

createdAt : TimeZonedDateTime!

When this Payment Provider was created

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed using this Payment Provider

emailTemplate : DocumentTemplate

The Document Template emailed to a buyer when a WebLink Order has been completed using this Payment Provider

environment : String

The Environment for this Payment Provider e.g. test/live

id : ID!

The ID of the Payment Provider

includeInvoice : Boolean!

Indicates whether invoices should be included on correspondence such as Weblink order confirmation emails.

name : String!

The Name of this Payment Provider

paymentAccount : FinancialAccount

The Financial Account that payments made on WebLink Orders using this Payment Provider will be categorised under

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

sendingEmailAddress : SendingEmailAddress!

The Email Address used to email a buyer when a WebLink Order has been completed using this Payment Provider

updatedAt : TimeZonedDateTime!

When this Payment Provider was last updated

Back to top

WebLinkMultiSafepayPaymentProviderInput

The input type with the values used to set MultiSafepay as a Payment Provider on a WebLink Portal

name : String!

The Name of this WebLink MultiSafepay Payment Provider

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed with a MultiSafepay payment

apiKey : String!

The API Key provided by MultiSafepay to make a charge

environment : WebLinkMultiSafepayEnvironment!

The Environment for this Payment Provider e.g. test/live

webLinkPortalId : ID!

The ID of the WebLink Portal

paymentMethodId : ID!

The Payment Method Type that will be used to classify MultiSafepay payments on Invoices created via WebLink Orders

paymentAccountId : ID!

The Financial Account that MultiSafepay payments made on WebLink Orders will be categorized under

documentTemplateId : ID!

The Document Template emailed to a buyer when a WebLink Order has been completed with this Payment Provider

sendingEmailAddressId : ID!
checkoutCompleteOpportunityStepId : ID
includeInvoice : Boolean
Back to top

WebLinkOpportunitySteps

Settings used by a WebLink Portal to configure where an order is recorded in the Opportunity workflow

entryStep : OpportunityStep!

The Opportunity Step where a new WebLink order is created, prior to the checkout process

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
orderRetrievalStep : OpportunityStep

The Opportunity Step where a WebLink order has been validated for purchase by the Administrator

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
orderReviewStep : OpportunityStep

The Opportunity Step where a WebLink order waits for validation for purchase by the Administrator

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
pendingPaymentStep : OpportunityStep

The Opportunity Step where a WebLink order is awaiting pending payment verification by a Payment Provider

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
wonStep : OpportunityStep!

The Opportunity Step where a WebLink order is progressed to following a successful checkout

Argument Type Description
filters = [] [OpportunityStepFieldGraphFilter]
order = "__EMPTY__" OpportunityStepFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [OpportunityStepFieldGraphOrder]
Back to top

WeblinkOrderConfirmation

The Weblink Portal Order Confirmation used as default

documentTemplate : DocumentTemplate!

The default Document Template emailed to a buyer when a WebLink Order has been completed

Argument Type Description
filters = [] [DocumentTemplateFieldGraphFilter]
order = "__EMPTY__" DocumentTemplateFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentTemplateFieldGraphOrder]
emailSubject : String!

The default subject of the email sent to a buyer when a WebLink Order has been completed

includeInvoice : Boolean!

Denotes whether the Invoice for the WebLink Order should be included in the email sent to the buyer

sendingEmailAddress : SendingEmailAddress!

The default Sending Email Address used to email a buyer when a WebLink Order has been completed

Argument Type Description
filters = [] [SendingEmailAddressFieldGraphFilter]
order = "__EMPTY__" SendingEmailAddressFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [SendingEmailAddressFieldGraphOrder]
Back to top

WeblinkOverrideUrls

cart : URL

The optional override to redirect Users to if they navigate to the Cart

catalogue : URL

The optional override to redirect Users to if they navigate to the Catalogue

Back to top

WebLinkPaymentProvider

Settings used to configure the payment settings for a Portal

Related types: WebLinkCheckPaymentProvider WebLinkStripePaymentProvider WebLinkInvoicePaymentProvider WebLinkWorldpayPaymentProvider WebLinkMultiSafepayPaymentProvider WebLinkConvergePaymentProvider WebLinkApprovalPaymentProvider

attributeDefinitions : [CustomFieldDefinition!]!

The Attribute Definitions linked to this Payment Provider

checkoutCompleteOpportunityStep : OpportunityStep

The Opportunity Step to progress to when payment has been successful

createdAt : TimeZonedDateTime!

When this Payment Provider was created

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed using this Payment Provider

emailTemplate : DocumentTemplate

The Document Template emailed to a buyer when a WebLink Order has been completed using this Payment Provider

id : ID!

The ID of the Payment Provider

includeInvoice : Boolean!

Indicates whether invoices should be included on correspondence such as Weblink order confirmation emails.

name : String!

The Name of this Payment Provider

paymentAccount : FinancialAccount

The Financial Account that payments made on WebLink Orders using this Payment Provider will be categorised under

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

sendingEmailAddress : SendingEmailAddress!

The Email Address used to email a buyer when a WebLink Order has been completed using this Payment Provider

updatedAt : TimeZonedDateTime!

When this Payment Provider was last updated

Back to top

WebLinkPaymentProviderFieldGraphFilter

Filter that can be applied to limit which WebLinkPaymentProvider nodes are returned

field : WebLinkPaymentProviderTypeField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

WebLinkPaymentProviderFieldGraphOrder

Specifies the order in which WebLinkPaymentProvider nodes are returned via the Connection

field : WebLinkPaymentProviderTypeField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

WebLinkPaymentProviderType

An enumeration.

stripe
invoice
approval
multiSafepay
check
Back to top

WebLinkPaymentProviderTypeField

Fields for filtering and ordering Payment Providers.

id
Back to top

WebLinkPortal

A separate website that Contacts can access for example: An LMS or Web Store

Related types: Node Portal

analyticsConfiguration : PortalAnalyticsConfiguration!

Configuration for any data analytics providers configured for this portal

autoProvisionLearnersViaSingleSignOn : Boolean!

Indicates if new contacts and contact credentials are created when unknown learners log in via Single Sign On

availabilityState : PortalAvailabilityState!

The current availability of this Portal

bookingTerms : BookingTerms

Terms connected to this WebLink Portal

brand : Brand!

The Brand that owns this Portal

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
canSelfCheckoutByInvoice : Boolean!

Denotes whether the B2B Portal this Weblink Portal is linked to can be used to self-checkout using an Invoice Payment Provider. Takes precedence over the individual account setting

cancellationMessage : String

The optional message displayed when attempting to cancel a Booking

cartlessCheckout : Boolean!

Denotes whether this WebLink Portal will bypass the add to cart step so a course could be purchased directly

catalogLinkedPortal : LMSPortal

The optional LMS Portal to redirect to when clicking on a Catalog Item in the WebLink Catalog

Argument Type Description
filters = [] [PortalFieldGraphFilter]
order = "__EMPTY__" PortalFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalFieldGraphOrder]
catalogOptions : CatalogOptions
categories : [LearningCategory]!

The Learning Categories associated with this Portal

confirmEmails : Boolean!

Denotes whether this WebLink Portal will display 'Confirm Email' fields on booking forms

courseDetailsCustomFieldMap : [PortalCourseDetailsFieldMapping]!

Custom Field Mappings that define how fields on a Course Template map to fields on a Portal Course

currency : Currency

The Currency this WebLink Portal will use

Argument Type Description
filters = [] [CurrencyFieldGraphFilter]
order = "__EMPTY__" CurrencyFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [CurrencyFieldGraphOrder]
customFieldFilters : PortalCustomFieldFilterConnection!

Custom Field Mappings for the filters available on this Portal

Argument Type Description
filters = [] [PortalCustomFieldFilterFieldGraphFilter]
order = "__EMPTY__" PortalCustomFieldFilterFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalCustomFieldFilterFieldGraphOrder]
customFieldTemplate : PortalCustomFieldTemplate!

Fetches the Custom Field Template associated with this Portal for a type

Argument Type Description
type SupportsCustomFieldPortalEntities!
defaultErrorMessage : String

The default error message to be used for this WebLink Portal

emailTemplateMappings : PortalEmailTemplateMappingConnection!

Fetches the mapping between Portals and Communication Templates

Argument Type Description
filters = [] [PortalEmailTemplateMappingFieldGraphFilter]
order = "__EMPTY__" PortalEmailTemplateMappingFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [PortalEmailTemplateMappingFieldGraphOrder]
externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
externalOriginsAllowList : [String!]!

Origin URLs allowed to send events from

featuredCatalogueItemIds : [ID!]!

The list of ID's for featured items that will appear at the top of this Portal's Catalogue

giftVoucherConfigurationMapping : GiftVoucherPortalConfiguration

Fetches the Gift Voucher Configuration that is mapped to this Portal

Argument Type Description
filters = [] [GiftVoucherPortalConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherPortalConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherPortalConfigurationFieldGraphOrder]
giftVoucherConfigurations : GiftVoucherConfigurationConnection!

Fetches the Gift Voucher Configurations associated with this Portal

Argument Type Description
filters = [] [GiftVoucherConfigurationFieldGraphFilter]
order = "__EMPTY__" GiftVoucherConfigurationFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [GiftVoucherConfigurationFieldGraphOrder]
googleAnalyticsCode : String

The Google Analytics code for this WebLink Portal

hideCompanyFieldForBooker : Boolean!

Denotes whether the Company field should be displayed during the checkout process on this WebLink Portal

hidePrices : Boolean!

Denotes whether this WebLink Portal will hide prices for catalog items

hidePricesBeforePricingAgreementApplied : Boolean!

Denotes whether this WebLink Portal will hide prices for catalog items before the checkout stage where Pricing Agreements are applied.

id : ID!

The ID of this Portal

identityProviders : IdentityProviderConnection!

The Identity Providers for this Portal

Argument Type Description
filters = [] [IdentityProviderFieldGraphFilter]
order = "__EMPTY__" IdentityProviderFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [IdentityProviderFieldGraphOrder]
indexable : Boolean!

Denotes whether this WebLink Portal is indexable by search engines

isBookingPortal : Boolean!

Dictates if Booking Portal behaviours are enabled for this Portal

isSelfRegistrationPortal : Boolean!

Dictates if Self-Registration behaviours are enabled for this Portal

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

multilingualCoursesEnabled : Boolean!

Denotes whether Course content translations are enabled on this instance

opportunitySteps : WebLinkOpportunitySteps

Opportunity Step mappings which define where WebLink orders are recorded at different stages of the checkout lifecycle

orderConfirmation : WeblinkOrderConfirmation

Default Weblink Order Confirmation details used to email a buyer after booking

overrideUrls : WeblinkOverrideUrls!

Contains any potential override Urls for this Weblink Portal

paymentProviders : [WebLinkPaymentProvider]!

Configured Providers that can be used to take payment in this WebLink Portal

paymentRegions : [PortalPaymentRegion!]!

The Payment Regions attached to this Weblink Portal. Region/Currency combinations linked to Payment Providers and used to segregate Catalog Items on a per Portal basis.

postalCountries : [Country!]

List of Postal Countries mapped to this Weblink Portal

priceLevels : [PriceLevel]!

The Price Levels associated with this Portal

region : Region

The Region this WebLink Portal is in

Argument Type Description
filters = [] [RegionFieldGraphFilter]
order = "__EMPTY__" RegionFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [RegionFieldGraphOrder]
requireAuthentication : Boolean!

Denotes whether this WebLink Portal is publicly accessible

requireBookerBillingAddress : Boolean!

Denotes whether WebLink Portals require the booker to enter their billing address

requireLearnerDetails : Boolean!

Denotes whether this WebLink Portal will not require Learner Details to be entered at checkout. Any learners whose details have not been submitted prior to checkout will be registered as 'Unnamed Learners'.

requireLoginOnCheckout : Boolean!

Denotes whether returning users will have to sign In to complete a purchase

reservationValiditySeconds : Int

The number of seconds any seat reservations will be valid for when an item is added to cart. If not set, seat reservations will only be made when the user begins checkout.

showEventsWithNoRemainingPlaces : Boolean!

Denotes whether Events with no remaining places should be displayed in this WebLink Portal

showPrivateTraining : Boolean!

Denotes whether the Portal will list any private training (such as Private Events) the User can access via their Account.

singleSignOnOnly : Boolean!

Indicates if Contacts can log into this Portal only by Single Sign On

splitUnnamedLearners : Boolean!

Denotes whether this WebLink Portal will split unnamed Learners into separate records when registered on Events. This setting only has effect if requireLearnerDetails is true.

taxInclusive : Boolean!

Denotes whether this WebLink Portal should display prices inclusive of tax

termsAndConditions : String

The terms and conditions for Portal checkout flow

trainingRequestWorkflow : TrainingRequestWorkflow
Argument Type Description
filters = [] [TrainingRequestWorkflowFieldGraphFilter]
order = "__EMPTY__" TrainingRequestWorkflowFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [TrainingRequestWorkflowFieldGraphOrder]
trainingTokens : [TrainingTokenType!]!

Training Token Types for which Token Issue Payment Codes can be used during checkout. Only available if "Enable Token Issues to be Considered as Independent Balances" is set to yes.

transferMessage : String

The optional message displayed when attempting to transfer a Booking

url : URL!

The URL of this Portal

vanityUrl : URL

The URL that proxies to this Portal, usually for branding

Deprecated fields (5)
analyticsEnabled : Boolean!

Whether the analytics are enabled on the instance hosting the portal.

Removal date: TBD.

Feature removed, always returns false

courseDetailsFieldMap : [WebLinkCourseDetailsFieldMapping]!

Custom Field Mappings that define how fields on a Course Template map to fields on a WebLink Course

Removal date: TBD.

Replaced by courseDetailsCustomFieldMap

featuredCatalogueItems : [CatalogueItem!]!

The list of featured items that will appear at the top of this Portal's Catalogue

Removal date: TBD.

Replaced by featuredCatalogueItemIds

isTaxInclusiveOnly : Boolean!

Denotes whether prices set in the TMS are already tax inclusive No new portals should use this setting, please use taxInclusive instead

Removal date: TBD.

This setting should not longer be used, use taxInclusive instead

multiRegion : Boolean!

Whether the Portal is multi-region or not. Based on the "Multi Region Weblink" feature flag

Removal date: TBD.

Multi-region support has been removed, this always returns false.

Back to top

WebLinkPortalBookingTermsInput

The input type with the values used to set the Booking Terms for a Weblink Portal

portalId : ID!

The ID of the Portal

bookingTerms : [CustomPortalTerm]!

The list Booking Terms assigned for the Portal

Back to top

WebLinkPortalOpportunityStepsInput

The input type with the values used to set the Opportunity Steps on a WebLink Portal

webLinkPortalId : ID!

The ID of the WebLink Portal

entryStepId : ID!

The ID of the Opportunity Step where a new WebLink order is created, prior to the checkout process

wonStepId : ID!

The ID of the Opportunity Step where a WebLink order is progressed to following a successful checkout

pendingPaymentStepId : ID
orderRetrievalStepId : ID

The ID of the Opportunity Step where a WebLink order has been validated for purchase by the Administrator

orderReviewStepId : ID

The ID of the Opportunity Step where a WebLink order waits for validation for purchase by the Administrator

Back to top

WeblinkPortalOrderConfirmationInput

The input type with values for a default Weblink Portal Order Confirmation

documentTemplateId : ID!

The default Document Template emailed to a buyer when a WebLink Order has been completed

sendingEmailAddressId : ID!

The default Sending Email Address used to email a buyer when a WebLink Order has been completed

emailSubject : String!

The default subject of the email sent to a buyer when a WebLink Order has been completed

includeInvoice : Boolean!

Denotes whether the Invoice for the WebLink Order should be included in the email sent to the buyer

Back to top

WeblinkPortalSetFeaturedItemsInput

The input type with the values used to set Featured Items for a Weblink Portal

portalId : ID!

The ID of the Weblink Portal

courseTemplateIds : [ID]

The list of the IDs of Course Templates to feature in this Weblink Portal

learningPathIds : [ID]

The list of the IDs of Learning Paths to feature in this Weblink Portal

Back to top

WebLinkPortalSetTrainingRequestWorkflowInput

The input type with the values used to set Training Request Workflow for portal

portalId : ID!

The ID of the Portal

enabled : Boolean!

A flag indicating whether the Portal Training Request Workflow is enabled

privateEntryStepId : ID!

The Opportunity Step ID used for Private Training Requests

publicEntryStepId : ID!

The Opportunity Step ID used for Public Training Requests

marketingSourceTypeId : ID!

The Marketing Source Type ID to be set on the created Opportunity

successMessage : String

The message returned when a Training Request is successfully processed

Back to top

WebLinkPortalTrainingRequestWorkflowAddFieldInput

An input for adding a Field to a Portal Training Request Workflow

portalId : ID!

The ID of the Portal with the Request Workflow to add the Field to

label : String!

The label of the Field

required : Boolean!

Whether or not it is required for the user to fill in this Field

opportunityAttributeId : ID!

The ID of the Opportunity Attribute to be linked to the Field

Back to top

WebLinkPortalTrainingRequestWorkflowDeleteFieldInput

The input type to delete a Field from a Portal Training Request Workflow

portalId : ID!

The ID of the Portal

workflowFieldId : ID!

The ID of the Field to be deleted

Back to top

WebLinkPortalTrainingRequestWorkflowEditFieldInput

An input for editing a Field on a Portal Training Request Workflow

portalId : ID!

The ID of the Portal with the Request Workflow to edit the Field on

workflowFieldId : ID!

The ID of the Field to edit on the Request Workflow

label : String

The label of the Field

required : Boolean

Whether or not it is required for the user to fill in this Field

opportunityAttributeId : ID

The ID of the Opportunity Attribute to be linked to the Field

Back to top

WebLinkPortalTrainingRequestWorkflowReorderFieldsInput

An input for reordering Fields on the Portal Training Request Workflow. Must provide all existing field IDs in the order desired as part of the workflowFieldIds parameter

portalId : ID!

The ID of the Portal the Training Request Workflow is linked to

workflowFieldIds : [ID]!

A list of Training Workflow Field IDs in the updated order

Back to top

WebLinkStripePaymentProvider

Settings used by a WebLink Portal to take payments with Stripe

Related types: WebLinkPaymentProvider

attributeDefinitions : [CustomFieldDefinition!]!

The Attribute Definitions linked to this Payment Provider

checkoutCompleteOpportunityStep : OpportunityStep

The Opportunity Step to progress to when payment has been successful

createdAt : TimeZonedDateTime!

When this Payment Provider was created

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed using this Payment Provider

emailTemplate : DocumentTemplate

The Document Template emailed to a buyer when a WebLink Order has been completed using this Payment Provider

id : ID!

The ID of the Payment Provider

includeInvoice : Boolean!

Indicates whether invoices should be included on correspondence such as Weblink order confirmation emails.

name : String!

The Name of this Payment Provider

paymentAccount : FinancialAccount

The Financial Account that payments made on WebLink Orders using this Payment Provider will be categorised under

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

sendPaymentReceiptFromStripe : Boolean!

Denotes whether or not Stripe should send an automatic payment receipt email to the email address of the Booker. This does not affect any emails sent by Administrate

sendingEmailAddress : SendingEmailAddress!

The Email Address used to email a buyer when a WebLink Order has been completed using this Payment Provider

stripePublicKey : String

The Public Key provided by Stripe to make a charge

stripeSecretKey : String

The Secret Key provided by Stripe to make a charge

updatedAt : TimeZonedDateTime!

When this Payment Provider was last updated

Back to top

WebLinkStripePaymentProviderInput

The input type with the values used to set Stripe as a Payment Provider on a WebLink Portal

name : String!

The Name of this WebLink Stripe Payment Provider

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed with a Stripe payment

stripeSecretKey : String!

The Secret Key provided by Stripe to make a charge

stripePublicKey : String!

The Public Key provided by Stripe used to generate Card Tokens

webLinkPortalId : ID!

The ID of the WebLink Portal

paymentMethodId : ID!

The Payment Method Type that will be used to classify Stripe payments on Invoices created via WebLink Orders

paymentAccountId : ID!

The Financial Account that Stripe payments made on WebLink Orders will be categorised under

documentTemplateId : ID!

The Document Template emailed to a buyer when a WebLink Order has been completed with this Payment Provider

sendingEmailAddressId : ID!
sendPaymentReceiptFromStripe : Boolean
checkoutCompleteOpportunityStepId : ID
includeInvoice : Boolean
Back to top

WebLinkWorldpayPaymentProvider

Settings used by a WebLink Portal to take payments with Worldpay

Related types: WebLinkPaymentProvider

attributeDefinitions : [CustomFieldDefinition!]!

The Attribute Definitions linked to this Payment Provider

checkoutCompleteOpportunityStep : OpportunityStep

The Opportunity Step to progress to when payment has been successful

createdAt : TimeZonedDateTime!

When this Payment Provider was created

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed using this Payment Provider

emailTemplate : DocumentTemplate

The Document Template emailed to a buyer when a WebLink Order has been completed using this Payment Provider

id : ID!

The ID of the Payment Provider

includeInvoice : Boolean!

Indicates whether invoices should be included on correspondence such as Weblink order confirmation emails.

installationId : String!

The unique identifier for the Hosted Payment Page within Worldpay

isLive : Boolean!

Whether this Payment Provider is considered to be "Live" i.e. will process real transactions for a live Worldpay account

merchantCode : String!

The unique identifier for the merchant account within Worldpay

name : String!

The Name of this Payment Provider

password : String!

The XML password provided by Worldpay

paymentAccount : FinancialAccount

The Financial Account that payments made on WebLink Orders using this Payment Provider will be categorised under

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

sendingEmailAddress : SendingEmailAddress!

The Email Address used to email a buyer when a WebLink Order has been completed using this Payment Provider

updatedAt : TimeZonedDateTime!

When this Payment Provider was last updated

username : String!

The username provided by Worldpay

Back to top

WebLinkWorldpayPaymentProviderInput

The input type with the values used to set Worldpay as a Payment Provider on a WebLink Portal

name : String!

The name of this WebLink Worldpay Payment Provider

emailSubject : String!

The subject of the email sent to a buyer when a WebLink Order has been completed with a Worldpay payment

username : String!

The username provided by Worldpay

password : String!

The XML password provided by Worldpay

merchantCode : String!

The unique identifier for the merchant account within Worldpay

installationId : String!

The unique identifier for the Hosted Payment Page within Worldpay

isLive : Boolean!

Whether this Payment Provider is considered to be "Live" i.e. will process real transactions for a live Worldpay account

webLinkPortalId : ID!

The ID of the WebLink Portal

paymentMethodId : ID!

The Payment Method Type that will be used to classify Worldpay payments on Invoices created via WebLink Orders

paymentAccountId : ID!

The Financial Account that Worldpay payments made on WebLink Orders will be categorised under

documentTemplateId : ID!

The Document Template emailed to a buyer when a WebLink Order has been completed with a Worldpay payment

sendingEmailAddressId : ID!
checkoutCompleteOpportunityStepId : ID
includeInvoice : Boolean
Back to top

WelcomeMessage

Related types: Node

body : String!

The body of the Welcome Message

brand : Brand!

The Brand this Welcome Message is associated with

Argument Type Description
filters = [] [BrandFieldGraphFilter]
order = "__EMPTY__" BrandFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [BrandFieldGraphOrder]
buttonText : String!

The dismiss button text

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

The ID of the Welcome Message

imageDocument : Document

The image DMS Document used in the Welcome Message

Argument Type Description
filters = [] [DocumentFieldGraphFilter]
order = "__EMPTY__" DocumentFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [DocumentFieldGraphOrder]
isEnabled : Boolean!

The status of if the Welcome Message is enabled

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

Back to top

WelcomeMessageConnection

A connection containing page information and edges for WelcomeMessage

edges : [WelcomeMessageEdge!]!

The list of WelcomeMessage edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

WelcomeMessageCreateInput

The input type with the Welcome Message details to be created

brandId : ID!

The ID of the Brand this Welcome Message is associated with

isEnabled : Boolean!

The Welcome Message is enabled

body : String!

The body of the Welcome Message

buttonText : String!

The dismiss button text

imageDocumentId : ID

The ID of the image DMS Document

Back to top

WelcomeMessageEdge

Contains cursor and node information for type WelcomeMessage

cursor : String!

A string that can be used for cursor-based pagination

node : WelcomeMessage!

The WelcomeMessage node.

Back to top

WelcomeMessageField

An enumeration.

id
brandId
isEnabled
body
imageDocumentId
Back to top

WelcomeMessageFieldGraphFilter

Filter that can be applied to limit which WelcomeMessage nodes are returned

field : WelcomeMessageField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

WelcomeMessageFieldGraphOrder

Specifies the order in which WelcomeMessage nodes are returned via the Connection

field : WelcomeMessageField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

WelcomeMessageMutateResponse

A Response from creating or updating a Welcome Message

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

welcomeMessage : WelcomeMessage

The Welcome Message that was created or updated

Back to top

WelcomeMessageMutations

Mutations for WelcomeMessage

createWelcomeMessage : WelcomeMessageMutateResponse!

Creates a Welcome Message for a specific Brand

Argument Type Description
input WelcomeMessageCreateInput!
updateWelcomeMessage : WelcomeMessageMutateResponse!

Updates the details of a Welcome Message

Argument Type Description
input WelcomeMessageUpdateInput!
Back to top

WelcomeMessageUpdateInput

The input type with the Welcome Message details to be updated

welcomeMessageId : ID!

The ID of the Welcome Message to update

isEnabled : Boolean

The Welcome Message is enabled

body : String

The body of the Welcome Message

buttonText : String

The dismiss button text

imageDocumentId : ID

The ID of the image DMS Document

Back to top

WorkingPattern

A pattern describing an individual's working shifts

Related types: Node

account : Account

Primary Account the Contact belongs to

Argument Type Description
filters = [] [AccountFieldGraphFilter]
order = "__EMPTY__" AccountFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [AccountFieldGraphOrder]
description : String

Extra information about the Working Pattern

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
id : ID!

ID of the Working Pattern

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

name : String!

Name of the Working Pattern

period : ISODuration!

The period that this pattern repeats for in ISO 8601 format

rotations : [WorkingPatternRotation!]!

The rotations of this Working Pattern

shifts : [WorkingPatternShift!]!

The Time Shifts that this Working Pattern supports

Back to top

WorkingPatternConnection

A connection containing page information and edges for WorkingPattern

edges : [WorkingPatternEdge!]!

The list of WorkingPattern edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

WorkingPatternCreateInput

An Input for creating a Company Working Pattern

name : String!

The Name of the Working Pattern

period : ISODuration!

The period that this Working Pattern repeats for as an ISO 8601 formatted string

shifts : [WorkingPatternShiftInput]!

A list of details about the Working Pattern Shift

rotations : [WorkingPatternRotationInput]!

A list of details about the Working Pattern Rotation

description : String

Extra information to describe the Working Pattern

accountId : String

The account ID to optionally associate this working pattern with

Back to top

WorkingPatternDeleteInput

An Input for deleting a Company Working Pattern

workingPatternId : ID!

The ID of the Working Pattern to delete

Back to top

WorkingPatternEdge

Contains cursor and node information for type WorkingPattern

cursor : String!

A string that can be used for cursor-based pagination

node : WorkingPattern!

The WorkingPattern node.

Back to top

WorkingPatternField

Fields for filtering and ordering Working Patterns

id
name
accountId
description
Back to top

WorkingPatternFieldGraphFilter

Filter that can be applied to limit which WorkingPattern nodes are returned

field : WorkingPatternField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

WorkingPatternFieldGraphOrder

Specifies the order in which WorkingPattern nodes are returned via the Connection

field : WorkingPatternField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

WorkingPatternMutationResponse

A Response for a Working Pattern Mutation

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

workingPattern : WorkingPattern

The Working Pattern that was mutated

Back to top

WorkingPatternMutations

Available Mutations on a Working Pattern

create : WorkingPatternMutationResponse!

Creates a Working Pattern

Argument Type Description
input WorkingPatternCreateInput!

The input type with the values to create on this Working Pattern
delete : WorkingPatternMutationResponse!

Deletes a Working Pattern

Argument Type Description
input WorkingPatternDeleteInput!

the input type with the Working Pattern ID delete
update : WorkingPatternMutationResponse!

Updates a Working Pattern

Argument Type Description
input WorkingPatternUpdateInput!

The input type with the values to update on this Working Pattern
Back to top

WorkingPatternRealization

The Working Pattern Realization

continuousTimeGrains : [Int!]!

A list of half hour Time Grains that a learner is available. Time grains start counting from midnight of the realization start date and do not reset day to day.

rotation : WorkingPatternRotation!

The Rotation of this Working Pattern Realization

timeGrains : [WorkingPatternRealizationTimeGrain!]!

A list of Time Grains for this Working Pattern Realization

workingSpans : [WorkingPatternRealizationSpan!]!

The spans that Learners are working on based on their Working Pattern

Back to top

WorkingPatternRealizationSpan

The Spans of the Working Pattern Realization

duration : ISODuration!

The spans that Learners are working on based on their Working Pattern

startDateTime : LocalDateTime!

The start DateTime of this Working Pattern Realization Span

Back to top

WorkingPatternRealizationTimeGrain

A the list of the number of half-hours since midnight (0-47) for a given date

date : Date!

The date for these Time Grains

indexes : [Int!]!

The indexes of the current Time Grain based on a half hour partitioned day, ranging from 0-47 and starting at midnight

Back to top

WorkingPatternRotation

A Working Pattern Rotation concretizing the start date that this abstract Pattern applies for

id : ID!

ID of the Working Pattern Rotation

name : String!

The Working Pattern Rotation's name

startDate : Date!

The Working Pattern Rotation's start date in an ISO 8601 format

Back to top

WorkingPatternRotationField

Fields for filtering and ordering Working Pattern Rotations

id
name
Back to top

WorkingPatternRotationFieldGraphFilter

Filter that can be applied to limit which WorkingPatternRotation nodes are returned

field : WorkingPatternRotationField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

WorkingPatternRotationFieldGraphOrder

Specifies the order in which WorkingPatternRotation nodes are returned via the Connection

field : WorkingPatternRotationField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

WorkingPatternRotationInput

An Input for creating a Company Working Pattern Rotation

name : String!

The name of the Rotation

startDate : Date!

The startDate that this Rotation starts applying from

id : ID
Back to top

WorkingPatternShift

A Working Pattern Shift containing information about contiguous time worked on a given day of the period

duration : ISODuration!

The Working Pattern's duration in ISO 8601 format

offset : ISODuration!

The Working Pattern's offset from the start date in ISO 8601 format

Back to top

WorkingPatternShiftInput

An Input for creating a Company Working Pattern Shift

offset : ISODuration!

The offset of the Working Pattern Shift from the start date as an ISO 8601 formatted string

duration : ISODuration!

The duration of the Working Pattern Shift as an ISO 8601 formatted string

Back to top

WorkingPatternUpdateInput

An Input for updating a Company Working Pattern

workingPatternId : ID!
name : String

The Name of the Working Pattern

period : ISODuration

The period that this Working Pattern repeats for as an ISO 8601 formatted string

shifts : [WorkingPatternShiftInput]

A list of details about the Working Pattern Shift

rotations : [WorkingPatternRotationInput]

A list of details about the Working Pattern Rotation

description : String

Extra information to describe the Working Pattern

accountId : ID

The ID of the Account to associate this pattern with

Back to top

Workplace

Related types: Node

externalIds : [ExternalId!]!

List of External IDs associated with this Node

externalLogs : ExternalLogConnection

List of External Logs associated with this Node

Argument Type Description
filters = [] [ExternalLogFieldGraphFilter]
order = "__EMPTY__" ExternalLogFieldGraphOrder
first = "__EMPTY__" Int
offset = "__EMPTY__" Int
after = "__EMPTY__" String
orderBy = [] [ExternalLogFieldGraphOrder]
hasAssociatedContacts : Boolean!

If the Workplace has any Contacts associated with it

id : ID!

The ID of the Workplace

legacyId : String!

Record identifier used in previous versions of Administrate's API and should only be used for integrations requiring crossover between versions.

lifecycleState : String!

The lifecycle state of the Workplace

locations : [Location]!

The Locations associated with this Workplace

name : String!

The name of the Workplace

Back to top

WorkplaceActivateInput

An Input for activating an archived Workplace

workplaceId : ID!

The id of the Workplace to activate

Back to top

WorkplaceArchiveInput

An Input for archiving a Workplace

workplaceId : ID!

The id of the Workplace to archive

Back to top

WorkplaceConnection

A connection containing page information and edges for Workplace

edges : [WorkplaceEdge!]!

The list of Workplace edges.

pageInfo : PageInfo!

Information about the pages (batches) of data returned in a query

Back to top

WorkplaceCreateInput

An Input for creating a Workplace

name : String!

The name of the new Workplace

locationIds : [ID]

The ids of Locations associated with the new Workplace

Back to top

WorkplaceDeleteInput

An Input for deleting a Workplace

workplaceId : ID!

The id of the Workplace to delete

Back to top

WorkplaceEdge

Contains cursor and node information for type Workplace

cursor : String!

A string that can be used for cursor-based pagination

node : Workplace!

The Workplace node.

Back to top

WorkplaceField

Fields for filtering and ordering Workplaces

id
name
lifecycleState
Back to top

WorkplaceFieldGraphFilter

Filter that can be applied to limit which Workplace nodes are returned

field : WorkplaceField!

Name of the field to filter on

operation : FilterOperation!

FilterOperation to apply

value : String

Value to filter

values : [String]

Values to filter for, used with in operations

Back to top

WorkplaceFieldGraphOrder

Specifies the order in which Workplace nodes are returned via the Connection

field : WorkplaceField!

Name of the field to order by

direction : OrderDirection!

Direction to order

Back to top

WorkplaceMutationResponse

A Response from mutating a Workplace

Related types: MutationResponse

errors : [FieldError!]!

The errors returned by the mutation

workplace : Workplace

The Workplace that was mutated

Back to top

WorkplaceMutations

Mutations available for Workplace

activate : WorkplaceMutationResponse!

Activates an archived Workplace

Argument Type Description
input WorkplaceActivateInput!

The input type with the values used to activate a Workplace
archive : WorkplaceMutationResponse!

Archives a Workplace

Argument Type Description
input WorkplaceArchiveInput!

The input type with the values used to archive a Workplace
create : WorkplaceMutationResponse!

Creates a Workplace

Argument Type Description
input WorkplaceCreateInput!

The input type with the values used to create a Workplace
delete : WorkplaceMutationResponse!

Deletes a Workplace

Argument Type Description
input WorkplaceDeleteInput!

The input type with the values used to delete a Workplace
update : WorkplaceMutationResponse!

Updates a Workplace

Argument Type Description
input WorkplaceUpdateInput!

The input type with the values used to update a Workplace
Back to top

WorkplaceUpdateInput

An Input for updating a Workplace

workplaceId : ID!

The id of the Workplace to update

name : String

The edited name of the Workplace

locationIds : [ID]

The Location ids now associated with the Workplace

Back to top

Schema version: 0ba7d074f9bf